io.starter.formats.XLS.charts

Class GenericChartObject

java.lang.Object

io.starter.formats.XLS.XLSRecord

io.starter.formats.XLS.charts.GenericChartObject

All Implemented Interfaces:

BlockByteConsumer, BiffRec, ChartConstants, ChartObject, XLSConstants, Serializable

Direct Known Subclasses:

Ai, AlRuns, Area, AreaFormat, AttachedLabel, Axcent, Axesused, Axis, AxisLineFormat, AxisParent, Bar, Begin, Boppop, BoppopCustom, CatLab, CatserRange, Chart, Chart3DBarShape, ChartFormat, ChartFormatLink, ChartFrtInfo, ChartLine, CrtLayout12, CrtLayout12A, Dat, DataFormat, DataLabExt, DataLabExtContents, DefaultText, Dropbar, End, EndBlock, EndObject, Fbi, Fontx, Frame, FrtFontList, FrtWrapper, GelFrame, Ifmt, Legend, Legendxn, Line, LineFormat, MarkerFormat, ObjectLink, Picf, Pie, PieFormat, PivotChartBits, PivotChartLink, PlotArea, PlotGrowth, Pos, Radar, RadarArea, SbaseRef, Scatter, SerauxErrBar, SerauxTrend, Serfmt, Series, SeriesList, SeriesText, SerParent, SerToCrt, ShtProps, SiIndex, StartBlock, StartObject, Surface, SxViewLink, TextDisp, ThreeD, Tick, Units, ValueRange, YMult

public class GenericChartObject
extends XLSRecord
implements ChartObject, ChartConstants

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ArrayList<XLSRecord>	chartArr
protected int	chartType
protected Chart	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
GenericChartObject()

Method Summary

Modifier and Type	Method and Description
void	addChartRecord(XLSRecord b) Add a chart record to this chart object
void	close() clear out object references in prep for closing workbook
String	getChartOption(String op) get chart option common to almost all chart types
ArrayList	getChartRecords() Return a list of chart records from this chart object.
String	getOptionsXML()
Chart	getParentChart() Return the chart record that this object is associated with
ArrayList	getRecordArray() Get the output array of records, including begin/end records and those of it's children.
static String	getScript(String id) adds html id and handlers for generic chart svg element
boolean	hasShadow()
boolean	is100Percent()
boolean	isStacked()
boolean	setChartOption(String op, String val)
void	setIs100Percent(boolean bOn)
void	setIsStacked(boolean bIsStacked)
void	setParentChart(Chart c) Set the parent chart for this record

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, getPrototype, getRealRecordIndex, getRecDesc, getRecordIndex, getRow, getRowNumber, getSheet, getStreamer, getStringVal, getStringVal, getWorkBook, getXfRec, hasContinues, init, 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

Field Detail

chartType

protected int chartType

chartArr

protected ArrayList<XLSRecord> chartArr

parentChart

protected Chart parentChart

Constructor Detail

GenericChartObject

public GenericChartObject()

Method Detail

setChartOption

public boolean setChartOption(String op,
                              String val)

isStacked

public boolean isStacked()

is100Percent

public boolean is100Percent()

hasShadow

public boolean hasShadow()

setIsStacked

public void setIsStacked(boolean bIsStacked)

setIs100Percent

public void setIs100Percent(boolean bOn)

getChartOption

public String getChartOption(String op)

get chart option common to almost all chart types

Parameters:

op -

Returns:

getOptionsXML

public String getOptionsXML()

Returns:

String XML representation of this chart-type's options

getScript

public static String getScript(String id)

adds html id and handlers for generic chart svg element

Parameters:

title - id of element

Returns:

String html

getChartRecords

public ArrayList getChartRecords()

Description copied from interface: ChartObject

Return a list of chart records from this chart object. This should include begin/end records, along with those of the objects sub-object, correctly ordered.

Specified by:

getChartRecords in interface ChartObject

Returns:

addChartRecord

public void addChartRecord(XLSRecord b)

Description copied from interface: ChartObject

Add a chart record to this chart object

Specified by:

addChartRecord in interface ChartObject

getParentChart

public Chart getParentChart()

Description copied from interface: ChartObject

Return the chart record that this object is associated with

Specified by:

getParentChart in interface ChartObject

Returns:

setParentChart

public void setParentChart(Chart c)

Description copied from interface: ChartObject

Set the parent chart for this record

Specified by:

setParentChart in interface ChartObject

getRecordArray

public ArrayList getRecordArray()

Get the output array of records, including begin/end records and those of it's children.

Specified by:

getRecordArray in interface ChartObject

close

public void close()

clear out object references in prep for closing workbook

Overrides:

close in class XLSRecord