Package loci.poi.hssf.record
Class LineFormatRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.LineFormatRecord
Describes a line format record. The line format record controls how a line on a chart appears.
NOTE: This source is automatically generated please do not modify this file. Either subclass or
remove the record in src/records/definitions.
- Author:
- Glen Stampoultzis (glens at apache.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 short -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a LineFormat record and sets its fields appropriately. -
Method Summary
Modifier and TypeMethodDescriptionclone()protected voidcalled by the constructor, should set class level fields.shortGet the colour palette index field for the LineFormat record.shortGet the format field for the LineFormat record.intGet the line color field for the LineFormat record.shortGet the line pattern field for the LineFormat record.intSize of record (exluding 4 byte header)shortgetSid()return the non static version of the id for this record.shortGet the weight field for the LineFormat record.booleanisAuto()automatic formatbooleandraw tick marksbooleanbook marks this as reserved = 0 but it seems to do somethingintserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidsetAuto(boolean value) Sets the auto field value.voidsetColourPaletteIndex(short field_5_colourPaletteIndex) Set the colour palette index field for the LineFormat record.voidsetDrawTicks(boolean value) Sets the draw ticks field value.voidsetFormat(short field_4_format) Set the format field for the LineFormat record.voidsetLineColor(int field_1_lineColor) Set the line color field for the LineFormat record.voidsetLinePattern(short field_2_linePattern) Set the line pattern field for the LineFormat record.voidsetUnknown(boolean value) Sets the unknown field value.voidsetWeight(short field_3_weight) Set the weight field for the LineFormat record.toString()get a string representation of the record (for biffview/debugging)protected voidvalidateSid(short id) Checks the sid matches the expected side for this recordMethods inherited from class loci.poi.hssf.record.Record
isInValueSection, isValue, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
LINE_PATTERN_SOLID
public static final short LINE_PATTERN_SOLID- See Also:
-
LINE_PATTERN_DASH
public static final short LINE_PATTERN_DASH- See Also:
-
LINE_PATTERN_DOT
public static final short LINE_PATTERN_DOT- See Also:
-
LINE_PATTERN_DASH_DOT
public static final short LINE_PATTERN_DASH_DOT- See Also:
-
LINE_PATTERN_DASH_DOT_DOT
public static final short LINE_PATTERN_DASH_DOT_DOT- See Also:
-
LINE_PATTERN_NONE
public static final short LINE_PATTERN_NONE- See Also:
-
LINE_PATTERN_DARK_GRAY_PATTERN
public static final short LINE_PATTERN_DARK_GRAY_PATTERN- See Also:
-
LINE_PATTERN_MEDIUM_GRAY_PATTERN
public static final short LINE_PATTERN_MEDIUM_GRAY_PATTERN- See Also:
-
LINE_PATTERN_LIGHT_GRAY_PATTERN
public static final short LINE_PATTERN_LIGHT_GRAY_PATTERN- See Also:
-
WEIGHT_HAIRLINE
public static final short WEIGHT_HAIRLINE- See Also:
-
WEIGHT_NARROW
public static final short WEIGHT_NARROW- See Also:
-
WEIGHT_MEDIUM
public static final short WEIGHT_MEDIUM- See Also:
-
WEIGHT_WIDE
public static final short WEIGHT_WIDE- See Also:
-
-
Constructor Details
-
LineFormatRecord
public LineFormatRecord() -
LineFormatRecord
Constructs a LineFormat record and sets its fields appropriately.- Parameters:
in- the RecordInputstream to read the record from
-
-
Method Details
-
validateSid
protected void validateSid(short id) Checks the sid matches the expected side for this record- Specified by:
validateSidin classRecord- Parameters:
id- the expected sid.
-
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
-
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()Size of record (exluding 4 byte header)- Overrides:
getRecordSizein classRecord
-
getSid
public short getSid()Description copied from class:Recordreturn the non static version of the id for this record. -
clone
-
getLineColor
public int getLineColor()Get the line color field for the LineFormat record. -
setLineColor
public void setLineColor(int field_1_lineColor) Set the line color field for the LineFormat record. -
getLinePattern
public short getLinePattern()Get the line pattern field for the LineFormat record.- Returns:
- One of LINE_PATTERN_SOLID LINE_PATTERN_DASH LINE_PATTERN_DOT LINE_PATTERN_DASH_DOT LINE_PATTERN_DASH_DOT_DOT LINE_PATTERN_NONE LINE_PATTERN_DARK_GRAY_PATTERN LINE_PATTERN_MEDIUM_GRAY_PATTERN LINE_PATTERN_LIGHT_GRAY_PATTERN
-
setLinePattern
public void setLinePattern(short field_2_linePattern) Set the line pattern field for the LineFormat record.- Parameters:
field_2_linePattern- One of LINE_PATTERN_SOLID LINE_PATTERN_DASH LINE_PATTERN_DOT LINE_PATTERN_DASH_DOT LINE_PATTERN_DASH_DOT_DOT LINE_PATTERN_NONE LINE_PATTERN_DARK_GRAY_PATTERN LINE_PATTERN_MEDIUM_GRAY_PATTERN LINE_PATTERN_LIGHT_GRAY_PATTERN
-
getWeight
public short getWeight()Get the weight field for the LineFormat record.- Returns:
- One of WEIGHT_HAIRLINE WEIGHT_NARROW WEIGHT_MEDIUM WEIGHT_WIDE
-
setWeight
public void setWeight(short field_3_weight) Set the weight field for the LineFormat record.- Parameters:
field_3_weight- One of WEIGHT_HAIRLINE WEIGHT_NARROW WEIGHT_MEDIUM WEIGHT_WIDE
-
getFormat
public short getFormat()Get the format field for the LineFormat record. -
setFormat
public void setFormat(short field_4_format) Set the format field for the LineFormat record. -
getColourPaletteIndex
public short getColourPaletteIndex()Get the colour palette index field for the LineFormat record. -
setColourPaletteIndex
public void setColourPaletteIndex(short field_5_colourPaletteIndex) Set the colour palette index field for the LineFormat record. -
setAuto
public void setAuto(boolean value) Sets the auto field value. automatic format -
isAuto
public boolean isAuto()automatic format- Returns:
- the auto field value.
-
setDrawTicks
public void setDrawTicks(boolean value) Sets the draw ticks field value. draw tick marks -
isDrawTicks
public boolean isDrawTicks()draw tick marks- Returns:
- the draw ticks field value.
-
setUnknown
public void setUnknown(boolean value) Sets the unknown field value. book marks this as reserved = 0 but it seems to do something -
isUnknown
public boolean isUnknown()book marks this as reserved = 0 but it seems to do something- Returns:
- the unknown field value.
-