io.starter.formats.XLS.charts

Class TextDisp

java.lang.Object

io.starter.formats.XLS.XLSRecord

io.starter.formats.XLS.charts.GenericChartObject

io.starter.formats.XLS.charts.TextDisp

All Implemented Interfaces:

BlockByteConsumer, BiffRec, ChartConstants, ChartObject, XLSConstants, Serializable

public class TextDisp
extends GenericChartObject
implements ChartObject

TextDisp: (Text) Defines Display of Text Fields (0x1025) Used in conjunction with several other records to define alignment, color, position, size, and so on, of text fiedls that appear on the chart. The fields in this record have meaning according to the TEXT record's parent (CHART, LEGEND or DEFAULTTEXT) 4 at 1 Horizontal alignment (1=left, 2= center, 3=bottom, 4= justify, 7=distributed) 5 vat 1 Vertical alignment (1= top, 2= center, 3= bottom, 4= justify, 7=distributed) 6 wBkgMode 2 Display mode of bg 1= transparent, 2= opaque 8 rgbText 4 Color of the text LongRGB Structure: red (1 byte): An unsigned integer that specifies the relative intensity of red. green (1 byte): An unsigned integer that specifies the relative intensity of green. blue (1 byte): An unsigned integer that specifies the relative intensity of blue. reserved (1 byte): MUST be zero, and MUST be ignored. 12 x 4 in SPRC (see Pos); ignore if preceded by DefaultText OR when followed by Pos 16 y 4 in SPRC (see Pos); "" 20 dx 4 A signed integer that specifies the horizontal size of the text, relative to the chart area in SPRC. This value MUST be ignored when this record is followed by a Pos record; otherwise MUST be greater than or equal to 0 and less than or equal to 32767. SHOULD be less than or equal to 4000. 24 dy 4 A signed integer that specifies the vertical size of the text, relative to the chart area in SPRC. This value MUST be ignored when this record is followed by a Pos record; otherwise MUST be greater than or equal to 0 and less than or equal to 32767. SHOULD<128> be less than or equal to 4000. 28 grbit 2 Option flags 30 icvText 2 Index to color value. icv structure. 32 dlp 2 (4 bits): An unsigned integer that specifies the data label positioning of the text, relative to the graph object item the text is attached to. For all data label text fields, MUST be a value from the following table: Data label position Value Value for chart group type Auto 0x0 Pie chart group Right 0x0 Line, Bubble, or Scatter chart group Outside 0x0 Bar or Column chart group with fStacked equal to 0 Center 0x0 Bar or Column chart group with fStacked equal to 1 Outside End 0x1 Bar, Column, or Pie chart group Inside End 0x2 Bar, Column, or Pie chart group Center 0x3 Bar, Column, Line, Bubble, Scatter, or Pie chart group Inside Base 0x4 Bar or Column chart group Above 0x5 Line, Bubble, or Scatter chart group Below 0x6 Line, Bubble, or Scatter chart group Left 0x7 Line, Bubble, or Scatter chart group Right 0x8 Line, Bubble, or Scatter chart group Auto 0x9 Pie chart group Moved by user 0xA All unused 10 bits iReadingOrder 2 bits 34 trot An unsigned integer that specifies the text rotation. MUST be a value from the following table: Value Angle description 0 to 90 Text rotated 0 to 90 degrees counter-clockwise 91 to 180 Text rotated 1 to 90 degrees clockwise (angle is trot – 90) 255 Text top-to-bottom with letters upright grbit 0 0x1 fAutoColor 1= auto color, 0= user-selected 1 0x2 fShowKey 1= the text is attached to a legend key. 2 0x4 fShowValue 1= the value, or the vertical value on bubble or scatter chart groups, is displayed in the data label. If the current attached label contains a DataLabExtContents record and the fPercent field of the DataLabExtContents record equals 0, this field MUST equal the fValue field of the DataLabExtContents record. If the current attached label does not contain a DataLabExtContents record and fShowLabelAndPerc equals 1, this field MUST equal 0. This field MUST equal 0 if the current attached label does not contain a DataLabExtContents record and one or more of the following conditions are satisfied: The fShowLabelAndPerc field equals 1. The fShowPercent field equals 1. 3 0x8 fVert unused 4 0x10 fAutoText 1= autogenerated text string 5 0x20 fGenerated 1= default 0= modified 6 0x40 zfDeleted 1= an automatic label has been deleted by user 7 0x80 fAutoMode 1= Bg is set to auto 10-8 0x700 unused 11 0x800 fShowLblPct 1= show category name and the value, represented as a percentage of the sum of the values of the series the data label is associated with, MUST equal 0 if the chart group type of the corresponding chart group, series, or data point, is not a bar of pie, doughnut, pie, or pie of pie chart group. This field MUST equal 1 if the current attached label contains a DataLabExtContents record and both of the following conditions are satisfied: The fCatName and fPercent fields of the DataLabExtContents record equal 1. The fSerName, fValue, and fBubSizes fields of the DataLabExtContents record equal 0. This field MUST equal 0 if the current attached label contains a DataLabExtContents record and one or more of the following conditions is satisfied: The fCatName or fPercent fields of the DataLabExtContents record equal 0. The fSerName, fValue, or fBubSizes fields of the DataLabExtContents record equal 1. MUST be ignored if fAutoText equals 0. 12 0x1000 fShowPct A bit that specifies whether the value, represented as a percentage of the sum of the values of the series the data label is associated with, is displayed in the data label. MUST equal 0 if the chart group type of the corresponding chart group, series, or data point is not a bar of pie, doughnut, pie, or pie of pie chart group. If the current attached label contains a DataLabExtContents record, this field MUST equal the value of the fPercent field of the DataLabExtContents record. If the current attached label does not contain a DataLabExtContents record and fShowLabelAndPerc equals 1, this field MUST equal 1. MUST be ignored if fAutoText equals 0. 13 0x2000 fShowBubbleSizes 1= show bubble sizes 14 0x4000 fShowCatLabel bit that specifies whether the category (3), or the horizontal value on bubble or scatter chart groups, is displayed in the data label on a non-area chart group, or the series name is displayed in the data label on an area chart group. This field MUST equal the fCatNameLabel field of the DataLabExtContents record if the current attached label contains a DataLabExtContents record, the chart group is non-area, and both of the following conditions are satisfied: The fValue field of the DataLabExtContents record equals 0. The fShowLabelAndPerc field equals 1 or the fPercent field equals 0. This field MUST equal the fCatNameLabel field of the DataLabExtContents record if the current attached label contains a DataLabExtContents record, the chart group is area or filled radar, and the following condition is satisfied: The fValue field of the DataLabExtContents record equals 0. If the current attached label contains a DataLabExtContents record and the fValue field of the DataLabExtContents record equals 1, this field MUST equal 0. This field MUST equal 0 if the current attached label does not contain a DataLabExtContents record and one of the following conditions is satisfied: The fShowValue field equals 1. The fShowLabelAndPerc field equals 0 and the fShowPercent field equals 1. MUST be ignored if fAutoText equals 0.

See Also:

Serialized Form

Field Summary

Fields inherited from class io.starter.formats.XLS.charts.GenericChartObject

chartArr, chartType, parentChart

Fields inherited from class io.starter.formats.XLS.XLSRecord

col, continues, DEBUGLEVEL, hyperlink, idx, isBlank, isBoolean, isContinueMerged, isString, lastidx, myxf, offset, rw, streamer, wkbook, worksheet

Fields inherited from interface io.starter.formats.XLS.charts.ChartConstants

AREACHART, BARCHART, BUBBLECHART, COLCHART, CONEBARCHART, CONECHART, CYLINDERBARCHART, CYLINDERCHART, DOUGHNUTCHART, LINECHART, OFPIECHART, PIECHART, PYRAMIDBARCHART, PYRAMIDCHART, RADARAREACHART, RADARCHART, SCATTERCHART, SHAPECOLUMN, SHAPECONE, SHAPECONETOMAX, SHAPECYLINDER, SHAPEDEFAULT, SHAPEPYRAMID, SHAPEPYRAMIDTOMAX, STOCKCHART, SURFACECHART, XAXIS, XVALAXIS, YAXIS, ZAXIS

Fields inherited from interface io.starter.formats.XLS.XLSConstants

AI, ALLOWDUPES, ALRUNS, AREA, AREAFORMAT, ARRAY, ATTACHEDLABEL, AUTOFILTER, AXCENT, AXESUSED, AXIS, AXISLINEFORMAT, AXISPARENT, BACKUP, BAR, BEGIN, BLANK, BOF, BOOKBOOL, BOOLERR, BOPPOP, BOPPOPCUSTOM, BOTTOM_MARGIN, BOTTOMMARGIN, BOUNDSHEET, CALC_MODE_PROP, CALCCOUNT, CALCMODE, CALCULATE_ALWAYS, CALCULATE_AUTO, CALCULATE_EXPLICIT, CATLAB, CATSERRANGE, CF, CF12, CHART, CHART3DBARSHAPE, CHARTFORMAT, CHARTFORMATLINK, CHARTFRTINFO, CHARTLINE, CODENAME, COLINFO, CONDFMT, CONDFMT12, CONTINUE, COUNTRY, CRN, CRTLAYOUT12, CRTLAYOUT12A, DAT, DATAFORMAT, DATALABEXT, DATALABEXTCONTENTS, DATE1904, DBCELL, DCON, DCONBIN, DCONNAME, DCONREF, DEBUG_HIGH, DEBUG_LOW, DEBUG_MEDIUM, DEFAULTENCODING, DEFAULTROWHEIGHT, DEFAULTTEXT, DEFCOLWIDTH, DELTA, DIMENSIONS, DROPBAR, DSF, DV, DVAL, END, ENDBLOCK, ENDEXTSST, ENDOBJECT, EOF, EXCEL2K, EXTERNCOUNT, EXTERNNAME, EXTERNSHEET, EXTSST, FBI, FEATHEADR, FILE_LOCK, FILEPASS, FONT, FONTBASIS, FONTX, FOOTERREC, FORMAT, FORMULA, FRAME, FRTFONTLIST, FRTWRAPPER, GARBAGE, GELFRAME, GUTS, HCENTER, HEADERREC, HLINK, HORIZONTAL_PAGE_BREAKS, IFMT, INDEX, INTERFACE_HDR, ITERATION, LABEL, LABELSST, LEFT_MARGIN, LEFTMARGIN, LEGEND, LEGENDXN, LINE, LINEFORMAT, MARKERFORMAT, MAXCOLS, MAXCOLS_BIFF8, MAXRECLEN, MAXROWS, MAXROWS_BIFF8, MERGEDCELLS, MSODRAWING, MSODRAWINGGROUP, MSODRAWINGSELECTION, MULBLANK, MULRK, NAME, NOTE, NUMBER, OBJ, OBJECTLINK, OBJPROTECT, OBPROJ, PALETTE, PANE, PASSWORD, PHONETIC, PICF, PIE, PIEFORMAT, PIVOTCHARTBITS, PIVOTCHARTLINK, PLOTAREA, PLOTGROWTH, PLS, PLV, POS, PRECISION, PRINT_GRIDLINES, PRINT_ROW_HEADERS, PRINTGRID, PRINTROWCOL, PROT4REV, PROTECT, QSISXTAG, RADAR, RADARAREA, RANGEPROTECTION, REFMODE, REFTRACK_PROP, RIGHT_MARGIN, RIGHTMARGIN, RK, ROW, RRD_HEAD, RRD_INFO, RSTRING, RTENTEXU, RTMERGECELLS, SBASEREF, SCATTER, SCENPROTECT, SCL, SELECTION, SERAUXERRBAR, SERAUXTREND, SERFMT, SERIES, SERIESLIST, SERIESTEXT, SERPARENT, SERTOCRT, SETUP, SHAREDUPES, SHEETLAYOUT, SHEETPROTECTION, SHRFMLA, SHTPROPS, SIIINDEX, SST, STARTBLOCK, STARTOBJECT, STRING_ENCODING_AUTO, STRING_ENCODING_COMPRESSED, STRING_ENCODING_UNICODE, STRINGREC, STYLE, SUPBOOK, SURFACE, SXADDL, SXBOOL, SXDB, SXDBB, SXDBEX, SXDI, SXEX, SXFDB, SXFDBTYPE, SXFORMAT, SXIVD, SXLI, SXNUM, SXPI, SXSTREAMID, SXSTRING, SXVD, SXVDEX, SXVI, SXVIEW, SXVIEWEX9, SXVIEWLINK, SXVS, TABID, TABLE, TABLESTYLES, TEXTDISP, THREED, TICK, TOP_MARGIN, TOPMARGIN, TXO, TYPE_BLANK, TYPE_BOOLEAN, TYPE_DOUBLE, TYPE_FORMULA, TYPE_FP, TYPE_INT, TYPE_STRING, UNICODEENCODING, UNITS, USERBVIEW, USERSVIEWBEGIN, USERSVIEWEND, USETEMPFILE_PROP, USR_EXCL, VALIDATEWORKBOOK, VALUERANGE, VB_MODULE, VCENTER, VERTICAL_PAGE_BREAKS, WINDOW_PROTECT, WINDOW1, WINDOW2, WK_CHART, WK_FILE, WK_GLOBALS, WK_MACROSHEET, WK_WORKSHEET, WSBOOL, XCT, XF, XLS_MAX_COLS, YMULT

Constructor Summary

Constructors

Constructor and Description
TextDisp()

Method Summary

Modifier and Type	Method and Description
static int	convertType(int axis)
String	getChartOption(String op) Return the string value of the specified option
float[]	getCoords() return the coordinates, in pixels, of the text area, if possible
Font	getFont(WorkBook wb) return the font record that sets the font properties for this text element
int	getFontId() return the id of the Fontx associated with this TextDisp
String	getOptionsXML()
static XLSRecord	getPrototype()
static XLSRecord	getPrototype(int type, String text, WorkBook book) add new TextDisp rec with associated recs, according to type
int	getRotation() return the rotation of this text 0 to 90 Text rotated 0 to 90 degrees counter-clockwise 91 to 180 Text rotated 1 to 90 degrees clockwise (angle is trot – 90) 255 Text top-to-bottom with letters upright
StringBuffer	getSVG(HashMap<String,Double> chartMetrics) return the SVG representation of this Text Display
String	getTextColor() return the text color of the text of this text display
int	getType()
void	init() perform record initialization
protected boolean	isChartTitle()
protected boolean	isXAxisLabel()
protected boolean	isYAxisLabel()
protected boolean	isZAxisLabel()
boolean	setChartOption(String op, String val) Handle setting options from XML in a generic manner
void	setFontId(int id) set the id of the Fontx associated with this TextDisp
void	setFrame(int lw, int lclr, int bgcolor, float[] coords) create a bg frame with the specified settings
void	setRotation(int rot) sets the rotation of this text 0 to 90 Text rotated 0 to 90 degrees counter-clockwise 91 to 180 Text rotated 1 to 90 degrees clockwise (angle is trot – 90) 255 Text top-to-bottom with letters upright
void	setText(String newText) Set the text of this textDisplay object.
String	toString() Return the string associated with this TextDisp object.

Methods inherited from class io.starter.formats.XLS.charts.GenericChartObject

addChartRecord, close, getChartRecords, getParentChart, getRecordArray, getScript, hasShadow, is100Percent, isStacked, setIs100Percent, setIsStacked, setParentChart

Methods inherited from class io.starter.formats.XLS.XLSRecord

addContinue, clone, copyFormat, getBooleanVal, getByteAt, getByteReader, getBytes, getBytesAt, getCellAddress, getCellAddressWithSheet, getCellType, getColNumber, getColorTable, getContinueVect, getData, getDataType, getDblVal, getDefaultVal, getEncryptedByteReader, getFirstBlock, getFloatVal, getFont, getFormatPattern, getFormulaRec, getHyperlink, getInternalVal, getIntLocation, getIntVal, getIxfe, getLastBlock, getLength, getMergeRange, getOffset, getOpcode, getRealRecordIndex, getRecDesc, getRecordIndex, getRow, getRowNumber, getSheet, getStreamer, getStringVal, getStringVal, getWorkBook, getXfRec, hasContinues, initRowCol, isFormula, isNumber, isReadOnly, isValueForCell, mergeContinues, postStream, preStream, remove, removeContinues, resetCacheBytes, setBooleanVal, setByteReader, setCol, setData, setDebugLevel, setDoubleVal, setEncryptedByteReader, setFirstBlock, setFloatVal, setHyperlink, setIndex, setIntVal, setIsValueForCell, setIxfe, setLastBlock, setLength, setMergeRange, setOffset, setOpcode, setRow, setRowCol, setRowNumber, setSheet, setStreamer, setStringVal, setValueForCell, setWorkBook, setXFRecord, setXFRecord, shouldEncrypt, toHexDump

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.starter.formats.XLS.charts.ChartObject

addChartRecord, getChartRecords, getParentChart, getRecordArray, setParentChart

Constructor Detail

TextDisp

public TextDisp()

Method Detail

init

public void init()

Description copied from class: XLSRecord

perform record initialization

Specified by:

init in interface BiffRec

Overrides:

init in class XLSRecord

getType

public int getType()

Returns:

the type of this TextDisp (X, Y, Z axis, title, data series ...

getOptionsXML

public String getOptionsXML()

Overrides:

getOptionsXML in class GenericChartObject

Returns:

String XML representation of this chart-type's options

getFontId

public int getFontId()

return the id of the Fontx associated with this TextDisp

Returns:

FontX id

setFontId

public void setFontId(int id)

set the id of the Fontx associated with this TextDisp

getFont

public Font getFont(WorkBook wb)

return the font record that sets the font properties for this text element

Parameters:

wb -

Returns:

setChartOption

public boolean setChartOption(String op,
                              String val)

Handle setting options from XML in a generic manner

Overrides:

setChartOption in class GenericChartObject

getChartOption

public String getChartOption(String op)

Return the string value of the specified option

Overrides:

getChartOption in class GenericChartObject

Returns:

isChartTitle

protected boolean isChartTitle()

Returns:

isXAxisLabel

protected boolean isXAxisLabel()

isYAxisLabel

protected boolean isYAxisLabel()

isZAxisLabel

protected boolean isZAxisLabel()

Returns:

truth of "This TextDisp represents the Z axis"

toString

public String toString()

Return the string associated with this TextDisp object.

Overrides:

toString in class XLSRecord

Returns:

setText

public void setText(String newText)

Set the text of this textDisplay object. Requires setting the child seriesText object

getPrototype

public static XLSRecord getPrototype(int type,
                                     String text,
                                     WorkBook book)

add new TextDisp rec with associated recs, according to type

See Also:

ObjectLink

getPrototype

public static XLSRecord getPrototype()

convertType

public static int convertType(int axis)

getCoords

public float[] getCoords()

return the coordinates, in pixels, of the text area, if possible

Returns:

getRotation

public int getRotation()

return the rotation of this text 0 to 90 Text rotated 0 to 90 degrees counter-clockwise 91 to 180 Text rotated 1 to 90 degrees clockwise (angle is trot – 90) 255 Text top-to-bottom with letters upright

setRotation

public void setRotation(int rot)

sets the rotation of this text 0 to 90 Text rotated 0 to 90 degrees counter-clockwise 91 to 180 Text rotated 1 to 90 degrees clockwise (angle is trot – 90) 255 Text top-to-bottom with letters upright

getTextColor

public String getTextColor()

return the text color of the text of this text display

Returns:

String hex color string

getSVG

public StringBuffer getSVG(HashMap<String,Double> chartMetrics)

return the SVG representation of this Text Display

Returns:

setFrame

public void setFrame(int lw,
                     int lclr,
                     int bgcolor,
                     float[] coords)

create a bg frame with the specified settings

Parameters:

lw - line width (-1 is none, 0= default ...)

lclr - line color

bgcolor - frame bg color

coords - frame coordinates