Package org.apache.poi.hssf.record.chart
Class LineFormatRecord
- java.lang.Object
-
- org.apache.poi.hssf.record.RecordBase
-
- org.apache.poi.hssf.record.Record
-
- org.apache.poi.hssf.record.StandardRecord
-
- org.apache.poi.hssf.record.chart.LineFormatRecord
-
- All Implemented Interfaces:
org.apache.poi.common.Duplicatable,GenericRecord
public final class LineFormatRecord extends StandardRecord
Describes a line format record. The line format record controls how a line on a chart appears.
-
-
Field Summary
Fields Modifier and Type Field Description static shortLINE_PATTERN_DARK_GRAY_PATTERNstatic shortLINE_PATTERN_DASHstatic shortLINE_PATTERN_DASH_DOTstatic shortLINE_PATTERN_DASH_DOT_DOTstatic shortLINE_PATTERN_DOTstatic shortLINE_PATTERN_LIGHT_GRAY_PATTERNstatic shortLINE_PATTERN_MEDIUM_GRAY_PATTERNstatic shortLINE_PATTERN_NONEstatic shortLINE_PATTERN_SOLIDstatic shortsidstatic shortWEIGHT_HAIRLINEstatic shortWEIGHT_MEDIUMstatic shortWEIGHT_NARROWstatic shortWEIGHT_WIDE
-
Constructor Summary
Constructors Constructor Description LineFormatRecord()LineFormatRecord(LineFormatRecord other)LineFormatRecord(RecordInputStream in)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LineFormatRecordcopy()shortgetColourPaletteIndex()Get the colour palette index field for the LineFormat record.shortgetFormat()Get the format field for the LineFormat record.java.util.Map<java.lang.String,java.util.function.Supplier<?>>getGenericProperties()HSSFRecordTypesgetGenericRecordType()intgetLineColor()Get the line color field for the LineFormat record.shortgetLinePattern()Get the line pattern field for the LineFormat record.shortgetSid()return the non static version of the id for this record.shortgetWeight()Get the weight field for the LineFormat record.booleanisAuto()automatic formatbooleanisDrawTicks()draw tick marksbooleanisUnknown()book marks this as reserved = 0 but it seems to do somethingvoidserialize(LittleEndianOutput out)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.-
Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serialize
-
Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize, toString
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord
getGenericChildren
-
-
-
-
Field Detail
-
sid
public static final short sid
- See Also:
- Constant Field Values
-
LINE_PATTERN_SOLID
public static final short LINE_PATTERN_SOLID
- See Also:
- Constant Field Values
-
LINE_PATTERN_DASH
public static final short LINE_PATTERN_DASH
- See Also:
- Constant Field Values
-
LINE_PATTERN_DOT
public static final short LINE_PATTERN_DOT
- See Also:
- Constant Field Values
-
LINE_PATTERN_DASH_DOT
public static final short LINE_PATTERN_DASH_DOT
- See Also:
- Constant Field Values
-
LINE_PATTERN_DASH_DOT_DOT
public static final short LINE_PATTERN_DASH_DOT_DOT
- See Also:
- Constant Field Values
-
LINE_PATTERN_NONE
public static final short LINE_PATTERN_NONE
- See Also:
- Constant Field Values
-
LINE_PATTERN_DARK_GRAY_PATTERN
public static final short LINE_PATTERN_DARK_GRAY_PATTERN
- See Also:
- Constant Field Values
-
LINE_PATTERN_MEDIUM_GRAY_PATTERN
public static final short LINE_PATTERN_MEDIUM_GRAY_PATTERN
- See Also:
- Constant Field Values
-
LINE_PATTERN_LIGHT_GRAY_PATTERN
public static final short LINE_PATTERN_LIGHT_GRAY_PATTERN
- See Also:
- Constant Field Values
-
WEIGHT_HAIRLINE
public static final short WEIGHT_HAIRLINE
- See Also:
- Constant Field Values
-
WEIGHT_NARROW
public static final short WEIGHT_NARROW
- See Also:
- Constant Field Values
-
WEIGHT_MEDIUM
public static final short WEIGHT_MEDIUM
- See Also:
- Constant Field Values
-
WEIGHT_WIDE
public static final short WEIGHT_WIDE
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
LineFormatRecord
public LineFormatRecord()
-
LineFormatRecord
public LineFormatRecord(LineFormatRecord other)
-
LineFormatRecord
public LineFormatRecord(RecordInputStream in)
-
-
Method Detail
-
serialize
public void serialize(LittleEndianOutput out)
-
getSid
public short getSid()
Description copied from class:Recordreturn the non static version of the id for this record.
-
copy
public LineFormatRecord copy()
- Specified by:
copyin interfaceorg.apache.poi.common.Duplicatable- Specified by:
copyin classStandardRecord
-
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.
-
getGenericRecordType
public HSSFRecordTypes getGenericRecordType()
- Specified by:
getGenericRecordTypein interfaceGenericRecord- Specified by:
getGenericRecordTypein classRecord
-
getGenericProperties
public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()
-
-