Package loci.poi.hssf.record
Class ExtendedFormatRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.ExtendedFormatRecord
Title: Extended Format Record
Description: Probably one of the more complex records. There are two breeds:
Style and Cell.
It should be noted that fields in the extended format record are somewhat arbitrary. Almost all of the fields are bit-level, but we name them as best as possible by functional group. In some places this is better than others.
REFERENCE: PG 426 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
- Version:
- 2.0-pre
- Author:
- Andrew C. Oliver (acoliver at apache dot org)
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final shortstatic final short -
Constructor Summary
ConstructorsConstructorDescriptionConstructor ExtendedFormatRecordConstructs an ExtendedFormat record and sets its fields appropriately. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidcalled by the constructor, should set class level fields.booleanget some old holdover from lotus 123.shortget for diagonal borders? No idea (its a palette color for the other function we didn't know what was?)shortget the diagonal border line style? Who the heck ever heard of a diagonal border?shortget the additional fill patternintget the additional palette options bitmask (see individual bit getter methods that reference this method)shortget the horizontal alignment of the cell.shortget the alignment options bitmask.shortget the borderline style for the bottom bordershortget the borderline style for the left bordershortget the border options bitmask (see the corresponding bit getter methods that reference back to this one)shortget the borderline style for the right bordershortget the borderline style for the top bordershortget the palette index for the bottom bordershortgets the options bitmask - you can also use corresponding option bit getters (see other methods that reference this one)shortgetDiag()Not sure what this is for (maybe fill lines?) 1 = down, 2 = up, 3 = both, 0 for none..shortget the background palette color indexshortget the foreground palette color indexshortget the fill palette options bitmask (see indivdual bit getters that reference this method)shortget the index to the FONT record (which font to use 0 based)shortget the index to the Format record (which FORMAT to use 0-based)shortget indention (not sure of the units, think its spaces)shortget the indent options bitmask (see corresponding bit getters that reference this field)shortDunno.shortget the palette index for the left border colorbooleanget whether to merge cellsshortget the palette options bitmask (see the individual bit getter methods that reference this one)shortfor cell XF types this is the parent style (usually 0/normal).shortget the reading order for far east versions (0 - Context, 1 - Left to right, 2 - right to left) - We could use some help with support for the far east.intgives the current serialized size of the record.shortget the palette index for the right border colorshortget the degree of rotation.booleanget whether to shrink the text to fitshortgetSid()return the non static version of the id for this record.shortget the palette index for the top bordershortget the vertical alignment of text in the cellbooleanget whether to wrap the text in the cellshortget whether the cell is a cell or style XFRecordbooleanisHidden()get whether the cell is hidden or notbooleanget whether or not to use the alignment in this XF instead of the parent XF.booleanget whether or not to use the border in this XF instead of the parent XF.booleanget whether or not to use the locking/hidden in this XF instead of the parent XF.booleanget whether or not to use the font in this XF instead of the parent XF.booleanget whether or not to use the format in this XF instead of the parent XF.booleanget whether or not to use the pattern in this XF instead of the parent XF.booleanisLocked()get whether the cell is locked or notintserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidset123Prefix(boolean prefix) set some old holdover from lotus 123.voidsetAdtlDiag(short diag) set for diagonal borders? No idea (its a palette color for the other function we didn't know what was?)voidsetAdtlDiagLineStyle(short diag) set the diagonal border line style? Who the heck ever heard of a diagonal border?voidsetAdtlFillPattern(short fill) set the fill patternvoidsetAdtlPaletteOptions(short options) set the additional palette options bitmask (see individual bitsetter methods that reference this method)voidsetAlignment(short align) set the horizontal alignment of the cell.voidsetAlignmentOptions(short options) set the alignment options bitmask.voidsetBorderBottom(short border) set the border line style for the bottom bordervoidsetBorderLeft(short border) set the borderline style for the left bordervoidsetBorderOptions(short options) set the border options bitmask (see the corresponding bitsetter methods that reference back to this one)voidsetBorderRight(short border) set the border line style for the right bordervoidsetBorderTop(short border) set the border line style for the top bordervoidsetBottomBorderPaletteIdx(short border) set the palette index for the bottom bordervoidsetCellOptions(short options) sets the options bitmask - you can also use corresponding option bit setters (see other methods that reference this one)voidsetDiag(short diag) Not sure what this is for (maybe fill lines?) 1 = down, 2 = up, 3 = both, 0 for none..voidsetFillBackground(short color) set the background palette color indexvoidsetFillForeground(short color) set the foreground palette color indexvoidsetFillPaletteOptions(short options) set the fill palette options bitmask (seevoidsetFontIndex(short index) set the index to the FONT record (which font to use 0 based)voidsetFormatIndex(short index) set the index to the Format record (which FORMAT to use 0-based)voidsetHidden(boolean hidden) set whether the cell is hidden or notvoidsetIndent(short indent) set indention (not sure of the units, think its spaces)voidsetIndentionOptions(short options) set the indent options bitmask (see corresponding bitmask setters that reference this field)voidsetIndentNotParentAlignment(boolean alignment) set whether or not to use the alignment in this XF instead of the parent XF.voidsetIndentNotParentBorder(boolean border) set whether or not to use the border in this XF instead of the parent XF.voidsetIndentNotParentCellOptions(boolean options) set whether or not to use the locking/hidden in this XF instead of the parent XF.voidsetIndentNotParentFont(boolean font) set whether or not to use the font in this XF instead of the parent XF.voidsetIndentNotParentFormat(boolean parent) set whether or not to use the format in this XF instead of the parent XF.voidsetIndentNotParentPattern(boolean pattern) Sets whether or not to use the pattern in this XF instead of the parent XF (foreground/background).voidsetJustifyLast(short justify) Dunno.voidsetLeftBorderPaletteIdx(short border) set the palette index for the left border colorvoidsetLocked(boolean locked) set whether the cell is locked or notvoidsetMergeCells(boolean merge) set whether to merge cellsvoidsetPaletteOptions(short options) set the palette options bitmask (see the individual bitsetter methods that reference this one)voidsetParentIndex(short parent) for cell XF types this is the parent style (usually 0/normal).voidsetReadingOrder(short order) set the reading order for far east versions (0 - Context, 1 - Left to right, 2 - right to left) - We could use some help with support for the far east.voidsetRightBorderPaletteIdx(short border) set the palette index for the right border colorvoidsetRotation(short rotation) set the degree of rotation.voidsetShrinkToFit(boolean shrink) set whether to shrink the text to fitvoidsetTopBorderPaletteIdx(short border) set the palette index for the top bordervoidsetVerticalAlignment(short align) set the vertical alignment of text in the cellvoidsetWrapText(boolean wrapped) set whether to wrap the text in the cellvoidsetXFType(short type) set whether the cell is a cell or style XFRecordtoString()get a string representation of the record (for biffview/debugging)protected voidvalidateSid(short id) called by constructor, should throw runtime exception in the event of a record passed with a differing ID.Methods inherited from class loci.poi.hssf.record.Record
clone, isInValueSection, isValue, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
NULL
public static final short NULL- See Also:
-
XF_STYLE
public static final short XF_STYLE- See Also:
-
XF_CELL
public static final short XF_CELL- See Also:
-
NONE
public static final short NONE- See Also:
-
THIN
public static final short THIN- See Also:
-
MEDIUM
public static final short MEDIUM- See Also:
-
DASHED
public static final short DASHED- See Also:
-
DOTTED
public static final short DOTTED- See Also:
-
THICK
public static final short THICK- See Also:
-
DOUBLE
public static final short DOUBLE- See Also:
-
HAIR
public static final short HAIR- See Also:
-
MEDIUM_DASHED
public static final short MEDIUM_DASHED- See Also:
-
DASH_DOT
public static final short DASH_DOT- See Also:
-
MEDIUM_DASH_DOT
public static final short MEDIUM_DASH_DOT- See Also:
-
DASH_DOT_DOT
public static final short DASH_DOT_DOT- See Also:
-
MEDIUM_DASH_DOT_DOT
public static final short MEDIUM_DASH_DOT_DOT- See Also:
-
SLANTED_DASH_DOT
public static final short SLANTED_DASH_DOT- See Also:
-
GENERAL
public static final short GENERAL- See Also:
-
LEFT
public static final short LEFT- See Also:
-
CENTER
public static final short CENTER- See Also:
-
RIGHT
public static final short RIGHT- See Also:
-
FILL
public static final short FILL- See Also:
-
JUSTIFY
public static final short JUSTIFY- See Also:
-
CENTER_SELECTION
public static final short CENTER_SELECTION- See Also:
-
VERTICAL_TOP
public static final short VERTICAL_TOP- See Also:
-
VERTICAL_CENTER
public static final short VERTICAL_CENTER- See Also:
-
VERTICAL_BOTTOM
public static final short VERTICAL_BOTTOM- See Also:
-
VERTICAL_JUSTIFY
public static final short VERTICAL_JUSTIFY- See Also:
-
NO_FILL
public static final short NO_FILL- See Also:
-
SOLID_FILL
public static final short SOLID_FILL- See Also:
-
FINE_DOTS
public static final short FINE_DOTS- See Also:
-
ALT_BARS
public static final short ALT_BARS- See Also:
-
SPARSE_DOTS
public static final short SPARSE_DOTS- See Also:
-
THICK_HORZ_BANDS
public static final short THICK_HORZ_BANDS- See Also:
-
THICK_VERT_BANDS
public static final short THICK_VERT_BANDS- See Also:
-
THICK_BACKWARD_DIAG
public static final short THICK_BACKWARD_DIAG- See Also:
-
THICK_FORWARD_DIAG
public static final short THICK_FORWARD_DIAG- See Also:
-
BIG_SPOTS
public static final short BIG_SPOTS- See Also:
-
BRICKS
public static final short BRICKS- See Also:
-
THIN_HORZ_BANDS
public static final short THIN_HORZ_BANDS- See Also:
-
THIN_VERT_BANDS
public static final short THIN_VERT_BANDS- See Also:
-
THIN_BACKWARD_DIAG
public static final short THIN_BACKWARD_DIAG- See Also:
-
THIN_FORWARD_DIAG
public static final short THIN_FORWARD_DIAG- See Also:
-
SQUARES
public static final short SQUARES- See Also:
-
DIAMONDS
public static final short DIAMONDS- See Also:
-
-
Constructor Details
-
ExtendedFormatRecord
public ExtendedFormatRecord()Constructor ExtendedFormatRecord -
ExtendedFormatRecord
Constructs an ExtendedFormat record and sets its fields appropriately.- Parameters:
in- the RecordInputstream to read the record from
-
-
Method Details
-
validateSid
protected void validateSid(short id) Description copied from class:Recordcalled by constructor, should throw runtime exception in the event of a record passed with a differing ID.- Specified by:
validateSidin classRecord- Parameters:
id- alleged id for this record
-
fillFields
Description copied from class:Recordcalled by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.- Specified by:
fillFieldsin classRecord- Parameters:
in- the RecordInputstream to read the record from
-
setFontIndex
public void setFontIndex(short index) set the index to the FONT record (which font to use 0 based)- Parameters:
index- to the font- See Also:
-
setFormatIndex
public void setFormatIndex(short index) set the index to the Format record (which FORMAT to use 0-based)- Parameters:
index- to the format record- See Also:
-
setCellOptions
public void setCellOptions(short options) sets the options bitmask - you can also use corresponding option bit setters (see other methods that reference this one)- Parameters:
options- bitmask to set
-
setLocked
public void setLocked(boolean locked) set whether the cell is locked or not- Parameters:
locked- - if the cell is locked- See Also:
-
setHidden
public void setHidden(boolean hidden) set whether the cell is hidden or not- Parameters:
hidden- - if the cell is hidden- See Also:
-
setXFType
public void setXFType(short type) set whether the cell is a cell or style XFRecord- Parameters:
type- - cell or style (0/1)- See Also:
-
set123Prefix
public void set123Prefix(boolean prefix) set some old holdover from lotus 123. Who cares, its all over for Lotus. RIP Lotus.- Parameters:
prefix- - the lotus thing to set.- See Also:
-
setParentIndex
public void setParentIndex(short parent) for cell XF types this is the parent style (usually 0/normal). For style this should be NULL.- Parameters:
parent- index of parent XF- See Also:
-
setAlignmentOptions
public void setAlignmentOptions(short options) set the alignment options bitmask. See corresponding bitsetter methods that reference this one.- Parameters:
options- - the bitmask to set
-
setAlignment
public void setAlignment(short align) set the horizontal alignment of the cell.- Parameters:
align- - how to align the cell (see constants)- See Also:
-
setWrapText
public void setWrapText(boolean wrapped) set whether to wrap the text in the cell- Parameters:
wrapped- - whether or not to wrap the cell text- See Also:
-
setVerticalAlignment
public void setVerticalAlignment(short align) set the vertical alignment of text in the cell- Parameters:
align- where to align the text- See Also:
-
setJustifyLast
public void setJustifyLast(short justify) Dunno. Docs just say this is for far east versions.. (I'm guessing it justifies for right-to-left read languages)- Parameters:
justify-- See Also:
-
setRotation
public void setRotation(short rotation) set the degree of rotation. (I've not actually seen this used anywhere)- Parameters:
rotation- the degree of rotation- See Also:
-
setIndentionOptions
public void setIndentionOptions(short options) set the indent options bitmask (see corresponding bitmask setters that reference this field)- Parameters:
options- bitmask to set.
-
setIndent
public void setIndent(short indent) set indention (not sure of the units, think its spaces)- Parameters:
indent- - how far to indent the cell- See Also:
-
setShrinkToFit
public void setShrinkToFit(boolean shrink) set whether to shrink the text to fit- Parameters:
shrink- - shrink to fit or not- See Also:
-
setMergeCells
public void setMergeCells(boolean merge) set whether to merge cells- Parameters:
merge- - merge cells or not- See Also:
-
setReadingOrder
public void setReadingOrder(short order) set the reading order for far east versions (0 - Context, 1 - Left to right, 2 - right to left) - We could use some help with support for the far east.- Parameters:
order- - the reading order (0,1,2)- See Also:
-
setIndentNotParentFormat
public void setIndentNotParentFormat(boolean parent) set whether or not to use the format in this XF instead of the parent XF.- Parameters:
parent- - true if this XF has a different format value than its parent, false otherwise.- See Also:
-
setIndentNotParentFont
public void setIndentNotParentFont(boolean font) set whether or not to use the font in this XF instead of the parent XF.- Parameters:
font- - true if this XF has a different font value than its parent, false otherwise.- See Also:
-
setIndentNotParentAlignment
public void setIndentNotParentAlignment(boolean alignment) set whether or not to use the alignment in this XF instead of the parent XF.- Parameters:
alignment- true if this XF has a different alignment value than its parent, false otherwise.- See Also:
-
setIndentNotParentBorder
public void setIndentNotParentBorder(boolean border) set whether or not to use the border in this XF instead of the parent XF.- Parameters:
border- - true if this XF has a different border value than its parent, false otherwise.- See Also:
-
setIndentNotParentPattern
public void setIndentNotParentPattern(boolean pattern) Sets whether or not to use the pattern in this XF instead of the parent XF (foreground/background).
- Parameters:
pattern-trueif this XF has a different pattern value than its parent, false otherwise.- See Also:
-
setIndentNotParentCellOptions
public void setIndentNotParentCellOptions(boolean options) set whether or not to use the locking/hidden in this XF instead of the parent XF.- Parameters:
options- true if this XF has a different locking or hidden value than its parent, false otherwise.- See Also:
-
setBorderOptions
public void setBorderOptions(short options) set the border options bitmask (see the corresponding bitsetter methods that reference back to this one)- Parameters:
options- - the bit mask to set
-
setBorderLeft
public void setBorderLeft(short border) set the borderline style for the left border- Parameters:
border- - type of border for the left side of the cell- See Also:
-
setBorderRight
public void setBorderRight(short border) set the border line style for the right border- Parameters:
border- - type of border for the right side of the cell- See Also:
-
setBorderTop
public void setBorderTop(short border) set the border line style for the top border- Parameters:
border- - type of border for the top of the cell- See Also:
-
setBorderBottom
public void setBorderBottom(short border) set the border line style for the bottom border- Parameters:
border- - type of border for the bottom of the cell- See Also:
-
setPaletteOptions
public void setPaletteOptions(short options) set the palette options bitmask (see the individual bitsetter methods that reference this one)- Parameters:
options- - the bitmask to set
-
setLeftBorderPaletteIdx
public void setLeftBorderPaletteIdx(short border) set the palette index for the left border color- Parameters:
border- - palette index- See Also:
-
setRightBorderPaletteIdx
public void setRightBorderPaletteIdx(short border) set the palette index for the right border color- Parameters:
border- - palette index- See Also:
-
setDiag
public void setDiag(short diag) Not sure what this is for (maybe fill lines?) 1 = down, 2 = up, 3 = both, 0 for none..- Parameters:
diag- - set whatever it is that this is.- See Also:
-
setAdtlPaletteOptions
public void setAdtlPaletteOptions(short options) set the additional palette options bitmask (see individual bitsetter methods that reference this method)- Parameters:
options- - bitmask to set
-
setTopBorderPaletteIdx
public void setTopBorderPaletteIdx(short border) set the palette index for the top border- Parameters:
border- - palette index- See Also:
-
setBottomBorderPaletteIdx
public void setBottomBorderPaletteIdx(short border) set the palette index for the bottom border- Parameters:
border- - palette index- See Also:
-
setAdtlDiag
public void setAdtlDiag(short diag) set for diagonal borders? No idea (its a palette color for the other function we didn't know what was?)- Parameters:
diag- - the palette index?- See Also:
-
setAdtlDiagLineStyle
public void setAdtlDiagLineStyle(short diag) set the diagonal border line style? Who the heck ever heard of a diagonal border?- Parameters:
diag- - the line style- See Also:
-
setAdtlFillPattern
public void setAdtlFillPattern(short fill) set the fill pattern- Parameters:
fill- - fill pattern??- See Also:
-
setFillPaletteOptions
public void setFillPaletteOptions(short options) set the fill palette options bitmask (see- Parameters:
options-
-
setFillForeground
public void setFillForeground(short color) set the foreground palette color index- Parameters:
color- - palette index- See Also:
-
setFillBackground
public void setFillBackground(short color) set the background palette color index- Parameters:
color- - palette index- See Also:
-
getFontIndex
public short getFontIndex()get the index to the FONT record (which font to use 0 based)- Returns:
- index to the font
- See Also:
-
getFormatIndex
public short getFormatIndex()get the index to the Format record (which FORMAT to use 0-based)- Returns:
- index to the format record
- See Also:
-
getCellOptions
public short getCellOptions()gets the options bitmask - you can also use corresponding option bit getters (see other methods that reference this one)- Returns:
- options bitmask
-
isLocked
public boolean isLocked()get whether the cell is locked or not- Returns:
- locked - if the cell is locked
- See Also:
-
isHidden
public boolean isHidden()get whether the cell is hidden or not- Returns:
- hidden - if the cell is hidden
- See Also:
-
getXFType
public short getXFType()get whether the cell is a cell or style XFRecord- Returns:
- type - cell or style (0/1)
- See Also:
-
get123Prefix
public boolean get123Prefix()get some old holdover from lotus 123. Who cares, its all over for Lotus. RIP Lotus.- Returns:
- prefix - the lotus thing
- See Also:
-
getParentIndex
public short getParentIndex()for cell XF types this is the parent style (usually 0/normal). For style this should be NULL.- Returns:
- index of parent XF
- See Also:
-
getAlignmentOptions
public short getAlignmentOptions()get the alignment options bitmask. See corresponding bitgetter methods that reference this one.- Returns:
- options - the bitmask
-
getAlignment
public short getAlignment()get the horizontal alignment of the cell.- Returns:
- align - how to align the cell (see constants)
- See Also:
-
getWrapText
public boolean getWrapText()get whether to wrap the text in the cell- Returns:
- wrapped - whether or not to wrap the cell text
- See Also:
-
getVerticalAlignment
public short getVerticalAlignment()get the vertical alignment of text in the cell- Returns:
- where to align the text
- See Also:
-
getJustifyLast
public short getJustifyLast()Dunno. Docs just say this is for far east versions.. (I'm guessing it justifies for right-to-left read languages)- Returns:
- justify
- See Also:
-
getRotation
public short getRotation()get the degree of rotation. (I've not actually seen this used anywhere)- Returns:
- rotation - the degree of rotation
- See Also:
-
getIndentionOptions
public short getIndentionOptions()get the indent options bitmask (see corresponding bit getters that reference this field)- Returns:
- options bitmask
-
getIndent
public short getIndent()get indention (not sure of the units, think its spaces)- Returns:
- indent - how far to indent the cell
- See Also:
-
getShrinkToFit
public boolean getShrinkToFit()get whether to shrink the text to fit- Returns:
- shrink - shrink to fit or not
- See Also:
-
getMergeCells
public boolean getMergeCells()get whether to merge cells- Returns:
- merge - merge cells or not
- See Also:
-
getReadingOrder
public short getReadingOrder()get the reading order for far east versions (0 - Context, 1 - Left to right, 2 - right to left) - We could use some help with support for the far east.- Returns:
- order - the reading order (0,1,2)
- See Also:
-
isIndentNotParentFormat
public boolean isIndentNotParentFormat()get whether or not to use the format in this XF instead of the parent XF.- Returns:
- parent - true if this XF has a different format value than its parent, false otherwise.
- See Also:
-
isIndentNotParentFont
public boolean isIndentNotParentFont()get whether or not to use the font in this XF instead of the parent XF.- Returns:
- font - true if this XF has a different font value than its parent, false otherwise.
- See Also:
-
isIndentNotParentAlignment
public boolean isIndentNotParentAlignment()get whether or not to use the alignment in this XF instead of the parent XF.- Returns:
- alignment true if this XF has a different alignment value than its parent, false otherwise.
- See Also:
-
isIndentNotParentBorder
public boolean isIndentNotParentBorder()get whether or not to use the border in this XF instead of the parent XF.- Returns:
- border - true if this XF has a different border value than its parent, false otherwise.
- See Also:
-
isIndentNotParentPattern
public boolean isIndentNotParentPattern()get whether or not to use the pattern in this XF instead of the parent XF. (foregrount/background)- Returns:
- pattern- true if this XF has a different pattern value than its parent, false otherwise.
- See Also:
-
isIndentNotParentCellOptions
public boolean isIndentNotParentCellOptions()get whether or not to use the locking/hidden in this XF instead of the parent XF.- Returns:
- options- true if this XF has a different locking or hidden value than its parent, false otherwise.
- See Also:
-
getBorderOptions
public short getBorderOptions()get the border options bitmask (see the corresponding bit getter methods that reference back to this one)- Returns:
- options - the bit mask to set
-
getBorderLeft
public short getBorderLeft()get the borderline style for the left border- Returns:
- border - type of border for the left side of the cell
- See Also:
-
getBorderRight
public short getBorderRight()get the borderline style for the right border- Returns:
- border - type of border for the right side of the cell
- See Also:
-
getBorderTop
public short getBorderTop()get the borderline style for the top border- Returns:
- border - type of border for the top of the cell
- See Also:
-
getBorderBottom
public short getBorderBottom()get the borderline style for the bottom border- Returns:
- border - type of border for the bottom of the cell
- See Also:
-
getPaletteOptions
public short getPaletteOptions()get the palette options bitmask (see the individual bit getter methods that reference this one)- Returns:
- options - the bitmask
-
getLeftBorderPaletteIdx
public short getLeftBorderPaletteIdx()get the palette index for the left border color- Returns:
- border - palette index
- See Also:
-
getRightBorderPaletteIdx
public short getRightBorderPaletteIdx()get the palette index for the right border color- Returns:
- border - palette index
- See Also:
-
getDiag
public short getDiag()Not sure what this is for (maybe fill lines?) 1 = down, 2 = up, 3 = both, 0 for none..- Returns:
- diag - whatever it is that this is.
- See Also:
-
getAdtlPaletteOptions
public int getAdtlPaletteOptions()get the additional palette options bitmask (see individual bit getter methods that reference this method)- Returns:
- options - bitmask to set
-
getTopBorderPaletteIdx
public short getTopBorderPaletteIdx()get the palette index for the top border- Returns:
- border - palette index
- See Also:
-
getBottomBorderPaletteIdx
public short getBottomBorderPaletteIdx()get the palette index for the bottom border- Returns:
- border - palette index
- See Also:
-
getAdtlDiag
public short getAdtlDiag()get for diagonal borders? No idea (its a palette color for the other function we didn't know what was?)- Returns:
- diag - the palette index?
- See Also:
-
getAdtlDiagLineStyle
public short getAdtlDiagLineStyle()get the diagonal border line style? Who the heck ever heard of a diagonal border?- Returns:
- diag - the line style
- See Also:
-
getAdtlFillPattern
public short getAdtlFillPattern()get the additional fill pattern- Returns:
- fill - fill pattern??
- See Also:
-
getFillPaletteOptions
public short getFillPaletteOptions()get the fill palette options bitmask (see indivdual bit getters that reference this method)- Returns:
- options
-
getFillForeground
public short getFillForeground()get the foreground palette color index- Returns:
- color - palette index
- See Also:
-
getFillBackground
public short getFillBackground()get the background palette color index- Returns:
- color palette index
- See Also:
-
toString
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
serialize
public int serialize(int offset, byte[] data) Description copied from class:Recordcalled by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array. -
getRecordSize
public int getRecordSize()Description copied from class:Recordgives the current serialized size of the record. Should include the sid and reclength (4 bytes).- Overrides:
getRecordSizein classRecord
-
getSid
public short getSid()Description copied from class:Recordreturn the non static version of the id for this record.
-