io.starter.formats.XLS.charts

Class LineFormat

java.lang.Object

io.starter.formats.XLS.XLSRecord

io.starter.formats.XLS.charts.GenericChartObject

io.starter.formats.XLS.charts.LineFormat

All Implemented Interfaces:

BlockByteConsumer, BiffRec, ChartConstants, ChartObject, XLSConstants, Serializable

public class LineFormat
extends GenericChartObject
implements ChartObject

LineFormat: Style of a Line or border(0x1007) 4 rgb 4 Color of line: high byte must be 0 8 lnx 2 Pattern of line (0= solid, 1= dash, 2= dot, 3= dash-dot,4= dash dash-dot, 5= none, 6= dk gray pattern, 7= med. gray, 8= light gray When the value of this field is 0x0005 (None), the values of we and icv MUST be set to: Line thickness (we)= 0xFFFF (Hairline) Line color (icv) 0x004D 10 we 2 Weight of line (-1= hairline, 0= narrow, 1= med (double), 2= wide (triple) 12 grbit 2 flags 14 icv Index to color of line. An Icv that specifies a color from the chart color table. This value MUST be greater than or equal to 0x0000 and less than or equal to 0x0041, or greater than or equal to 0x004D and less than or equal to 0x00004F. This value SHOULD NOT be less than 0x0008. 0x0040 == Default foreground color. This is the window text color in the sheet display. 0x0041 == Default background color. This is the window background color in the sheet display and is the default background color for a cell. 0x004D == Default chart foreground color. This is the window text color in the chart display. grbit: 0 0x1 fAuto Automatic format 1 reserved, 0 2 0x4 fAxisOn specifies whether axis line is displayed If the previous record is AxisLine and the value of the id field of the AxisLine record is equal to 0x0000, this field MUST be a value from the following table: fAxisOn Lns Meaning 0 0x0005 The axis line is not displayed. 0 Any legal value except 0x0005 The axis line is displayed. 1 Any legal value The axis line is displayed. If the previous record is not AxisLine and the value of the id field of the AxisLine record is equal to 0x0000, this field MUST be zero, and MUST be ignored. 3 0x8 fAutoColor specifies whether icv= 0x4D. if 1, icv must= 0x4D.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DASH
static int	DASHDASHDOT
static int	DASHDOT
static int	DKGRAY
static int	DOT
static int	LTGRAY
static int	MEDGRAY
static int	NONE
static int	SOLID

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

Method Summary

Modifier and Type	Method and Description
String	getLineColor() return the line color as a hex String
int	getLineStyle() return Pattern of line (0= solid, 1= dash, 2= dot, 3= dash-dot,4= dash dash-dot, 5= none, 6= dk gray pattern, 7= med.
String	getOOXML() if have 2007+v settings, use them.
static XLSRecord	getPrototype()
static XLSRecord	getPrototype(int style, int weight) get new Line Format in desired pattern and weight pattern= Pattern of line (0= solid, 1= dash, 2= dot, 3= dash-dot,4= dash dash-dot, 5= none, 6= dk gray pattern, 7= med.
String	getSVG()
void	init() perform record initialization
void	setFromOOXML(SpPr sp) sets the OOXML settings for this line
void	setLineColor(int clr) Index to color of line
void	setLineStyle(int style) Style of line (0= solid, 1= dash, 2= dot, 3= dash-dot,4= dash dash-dot, 5= none, 6= dk gray pattern, 7= med.
void	setLineWeight(int weight) 10 we 2 Weight of line (-1= hairline, 0= narrow, 1= med (double), 2= wide (triple)
String	toString()

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

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

SOLID

public static final int SOLID

See Also:

Constant Field Values

DASH

public static final int DASH

See Also:

Constant Field Values

DOT

public static final int DOT

See Also:

Constant Field Values

DASHDOT

public static final int DASHDOT

See Also:

Constant Field Values

DASHDASHDOT

public static final int DASHDASHDOT

See Also:

Constant Field Values

NONE

public static final int NONE

See Also:

Constant Field Values

DKGRAY

public static final int DKGRAY

See Also:

Constant Field Values

MEDGRAY

public static final int MEDGRAY

See Also:

Constant Field Values

LTGRAY

public static final int LTGRAY

See Also:

Constant Field Values

Constructor Detail

LineFormat

public LineFormat()

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

getPrototype

public static XLSRecord getPrototype()

getPrototype

public static XLSRecord getPrototype(int style,
                                     int weight)

get new Line Format in desired pattern and weight
pattern= Pattern of line (0= solid, 1= dash, 2= dot, 3= dash-dot,4= dash dash-dot, 5= none, 6= dk gray pattern, 7= med. gray, 8= light gray
Weight of line (-1= hairline, 0= narrow, 1= med (double), 2= wide (triple)
note color is set to default

Returns:

new LineFormat record

setLineWeight

public void setLineWeight(int weight)

10 we 2 Weight of line (-1= hairline, 0= narrow, 1= med (double), 2= wide (triple)

setLineStyle

public void setLineStyle(int style)

Style of line (0= solid, 1= dash, 2= dot, 3= dash-dot,4= dash dash-dot, 5= none, 6= dk gray pattern, 7= med. gray, 8= light gray

Parameters:

style -

getLineStyle

public int getLineStyle()

return Pattern of line (0= solid, 1= dash, 2= dot, 3= dash-dot,4= dash dash-dot, 5= none, 6= dk gray pattern, 7= med. gray, 8= light gray

setLineColor

public void setLineColor(int clr)

Index to color of line

Parameters:

clr -

getLineColor

public String getLineColor()

return the line color as a hex String

Returns:

toString

public String toString()

Overrides:

toString in class XLSRecord

getSVG

public String getSVG()

getOOXML

public String getOOXML()

if have 2007+v settings, use them. Otherwise, interpret line settings to OOXML

Returns:

setFromOOXML

public void setFromOOXML(SpPr sp)

sets the OOXML settings for this line

Parameters:

sp -