io.starter.formats.XLS.charts

Class Legend

java.lang.Object

io.starter.formats.XLS.XLSRecord

io.starter.formats.XLS.charts.GenericChartObject

io.starter.formats.XLS.charts.Legend

All Implemented Interfaces:

BlockByteConsumer, BiffRec, ChartConstants, ChartObject, XLSConstants, Serializable

public class Legend
extends GenericChartObject
implements ChartObject, ChartConstants

Legend: Legend Type and Position (0x1015) 4 x 4 x position of upper-left corner -- MUST be ignored and the x1 field from the following Pos record MUST be used instead. 8 y 4 y position of upper-left corner -- MUST be ignored and the y1 field from the following Pos record MUST be used instead. 12 dx 4 width in SPRC -- MUST be ignored and the x2 field from the following Pos record MUST be used instead. 16 dy 4 height in SPRC -- MUST be ignored and the y2 field from the following Pos record MUST be used instead. 20 1 Undefined and MUST be ignored. 21 wSpacing1 Spacing (0= close, 1= medium, 2= open) (0x1= 40 twips==4 pts) 22 grbit 2 Option Flags grbit Option Flags bits Mask 0 01h fAutoPostion Automatic positioning (1= legend is docked) 1 02h fAutoSeries Automatic series distribution 2 04h fAutoPosX X positioning is automatic 3 08h fAutoPosY Y positioning is automatic 4 10h fVert 1= vertical legend, 0= horizontal 5 20h fWasDataTable 1= chart contains data table NOTES: A SPRC is a unit of measurement that is 1/4000th of the height or width of the chart If the field is being used to specify a width or horizontal distance, the SPRC is 1/4000th of the width of the chart. If the field is being used to specify a height or vertical distance, the SPRC is 1/4000th of the height of the chart. Sequence of records: ATTACHEDLABEL = TextDisp Begin Pos [FontX] [AlRuns] AI [FRAME] [ObjectLink] [DataLabExtContents] [CrtLayout12] [TEXTPROPS] [CRTMLFRT] End LD = Legend Begin Pos ATTACHEDLABEL [FRAME] [CrtLayout12] [TEXTPROPS] [CRTMLFRT] End

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	BOTTOM
static int	CORNER
protected int	dx_defunct
protected int	dy_defunct
protected boolean	fAutoPosition
protected boolean	fAutoPosX
protected boolean	fAutoPosY
protected boolean	fAutoSeries
protected boolean	fVert
protected boolean	fWasDataTable
protected short	grbit
static int	LEFT
static int	NOT_DOCKED
static int	RIGHT
static int	TOP
protected byte	wSpacing
protected int	x_defunct
protected int	y_defunct

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
Legend()

Method Summary

Modifier and Type	Method and Description
void	addBox()
void	adjustWidth(HashMap<String,Double> chartMetrics, int chartType, String[] legends) called up change of legend text to adjust width of the legend bounding box
static Legend	createDefaultLegend(WorkBook book)
int[]	getCoords() return the coordinates of the legend box, relative to the chart
int[]	getCoords(int charttype, HashMap<String,Double> chartMetrics, String[] legends, Font f) return the coordinates of the legend box in pixels An approximation at this point
Font	getFnt() tries to get the best match
short	getLegendPosition() legend position: controlled by CrtLayout12 0= bottom, 1= corner, 2= top, 3= right, 4= left
String	getLegendPositionString() return the legend position in string (OOXML) form
void	getMetrics(HashMap<String,Double> chartMetrics, int chartType, ChartSeries s)
static XLSRecord	getPrototype()
String	getSVG(HashMap<String,Double> chartMetrics, ChartType chartobj, ChartSeries s)
boolean	hasBox() returns true if this legend is surrounded by a box (the default)
void	incrementHeight(float h) a rough estimate of expanding legend dimensions of 1 normal entry
void	init() perform record initialization
protected void	parseGrbit() The following records and rules define the significant parts of a legend: The Legend record specifies the layout of the legend and specifies if the legend is automatically positioned.
void	resetPos(double y, double h, double ch, int nLines) reset initial position of legend to accommodate nLines of legend text
void	setAutoPosition(boolean auto) sets or turns off auto positioning [BugTracker 2844]
void	setIsDataTable(boolean isDataTable)
void	setLegendPosition(short pos) set Legend Positon: one of: 0= bottom, 1= corner, 2= top, 3= right, 4= left, 7= not docked
void	setVertical(boolean isVertical)

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

addChartRecord, close, getChartOption, getChartRecords, getOptionsXML, getParentChart, getRecordArray, getScript, hasShadow, is100Percent, isStacked, setChartOption, 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, toString

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

Field Detail

x_defunct

protected int x_defunct

y_defunct

protected int y_defunct

dx_defunct

protected int dx_defunct

dy_defunct

protected int dy_defunct

wSpacing

protected byte wSpacing

grbit

protected short grbit

fAutoPosition

protected boolean fAutoPosition

fAutoSeries

protected boolean fAutoSeries

fAutoPosX

protected boolean fAutoPosX

fAutoPosY

protected boolean fAutoPosY

fVert

protected boolean fVert

fWasDataTable

protected boolean fWasDataTable

BOTTOM

public static final int BOTTOM

See Also:

Constant Field Values

CORNER

public static final int CORNER

See Also:

Constant Field Values

TOP

public static final int TOP

See Also:

Constant Field Values

RIGHT

public static final int RIGHT

See Also:

Constant Field Values

LEFT

public static final int LEFT

See Also:

Constant Field Values

NOT_DOCKED

public static final int NOT_DOCKED

See Also:

Constant Field Values

Constructor Detail

Legend

public Legend()

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

parseGrbit

protected void parseGrbit()

The following records and rules define the significant parts of a legend: The Legend record specifies the layout of the legend and specifies if the legend is automatically positioned. The Pos record, CrtLayout12 record, specify the position of the legend. The sequences of records that conform to the ATTACHEDLABEL (TextDisp ->Pos [FontX] [AlRuns] AI [FRAME] [ObjectLink] [DataLabExtContents] [CrtLayout12] [TEXTPROPS] [CRTMLFRT] ) and TEXTPROPS (RichTextStream|TextPropStream) rules specify the default text formatting for the legend entries. The Pos record of the attached label MUST be ignored. The ObjectLink record of the attached label MUST NOT exist. A series can specify formatting exceptions for individual legend entries. The sequence of records that conforms to the FRAME (Frame ->LineFormat AreaFormat [GELFRAME] [SHAPEPROPS]) rule specifies the fill and border formatting properties of the legend.

setIsDataTable

public void setIsDataTable(boolean isDataTable)

setVertical

public void setVertical(boolean isVertical)

createDefaultLegend

public static Legend createDefaultLegend(WorkBook book)

getPrototype

public static XLSRecord getPrototype()

getLegendPosition

public short getLegendPosition()

legend position: controlled by CrtLayout12 0= bottom, 1= corner, 2= top, 3= right, 4= left

Returns:

getLegendPositionString

public String getLegendPositionString()

return the legend position in string (OOXML) form

Returns:

b, l, r, t, tr

setLegendPosition

public void setLegendPosition(short pos)

set Legend Positon: one of: 0= bottom, 1= corner, 2= top, 3= right, 4= left, 7= not docked

Parameters:

pos -

hasBox

public boolean hasBox()

returns true if this legend is surrounded by a box (the default)

Returns:

addBox

public void addBox()

setAutoPosition

public void setAutoPosition(boolean auto)

sets or turns off auto positioning [BugTracker 2844]

Parameters:

auto -

incrementHeight

public void incrementHeight(float h)

a rough estimate of expanding legend dimensions of 1 normal entry

adjustWidth

public void adjustWidth(HashMap<String,Double> chartMetrics,
                        int chartType,
                        String[] legends)

called up change of legend text to adjust width of the legend bounding box

Parameters:

chartMetrics -

chartType -

legends - String[] text of legends (containing new legend text)

resetPos

public void resetPos(double y,
                     double h,
                     double ch,
                     int nLines)

reset initial position of legend to accommodate nLines of legend text

getCoords

public int[] getCoords(int charttype,
                       HashMap<String,Double> chartMetrics,
                       String[] legends,
                       Font f)

return the coordinates of the legend box in pixels
An approximation at this point

Parameters:

chartMetrics - maps chart coords in pixels x, y, w, h, canvasw, canvash, min, max

fh - -- font height in points

Returns:

int[4] x, y, w, h

getFnt

public Font getFnt()

tries to get the best match

Returns:

getMetrics

public void getMetrics(HashMap<String,Double> chartMetrics,
                       int chartType,
                       ChartSeries s)

getCoords

public int[] getCoords()

return the coordinates of the legend box, relative to the chart

Returns:

int[] coordinates x, y, w, h [fh, legendpos]

getSVG

public String getSVG(HashMap<String,Double> chartMetrics,
                     ChartType chartobj,
                     ChartSeries s)