Apache POI - Common 5.3.0 · org.apache.poi.hssf.record.chart.LineFormatRecord

Field Summary

Modifier and Type	Field and Description
private static final BitField	auto
private static final BitField	drawTicks
private int	field_1_lineColor
private short	field_2_linePattern
private short	field_3_weight
private short	field_4_format
private short	field_5_colourPaletteIndex
public static final short	LINE_PATTERN_DARK_GRAY_PATTERN
public static final short	LINE_PATTERN_DASH
public static final short	LINE_PATTERN_DASH_DOT
public static final short	LINE_PATTERN_DASH_DOT_DOT
public static final short	LINE_PATTERN_DOT
public static final short	LINE_PATTERN_LIGHT_GRAY_PATTERN
public static final short	LINE_PATTERN_MEDIUM_GRAY_PATTERN
public static final short	LINE_PATTERN_NONE
public static final short	LINE_PATTERN_SOLID
public static final short	sid
private static final BitField	unknown
public static final short	WEIGHT_HAIRLINE
public static final short	WEIGHT_MEDIUM
public static final short	WEIGHT_NARROW
public static final short	WEIGHT_WIDE

Constructor Summary

Access	Constructor and Description
public	LineFormatRecord()
public	LineFormatRecord(LineFormatRecord other)
public	LineFormatRecord(RecordInputStream in)

Method Summary

Modifier and Type	Method and Description
public LineFormatRecord	copy() Implements abstract org.apache.poi.hssf.record.StandardRecord.copy. Implements org.apache.poi.common.Duplicatable.copy.
public short	getColourPaletteIndex() Get the colour palette index field for the LineFormat record.
protected int	getDataSize() Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.
public short	getFormat() Get the format field for the LineFormat record.
public Map<String, Supplier<?>>	getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.
public HSSFRecordTypes	getGenericRecordType() Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType. Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.
public int	getLineColor() Get the line color field for the LineFormat record.
public short	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 getLinePattern() Get the line pattern field for the LineFormat record.
public short	getSid() Implements abstract org.apache.poi.hssf.record.Record.getSid. return the non static version of the id for this record.
public short	Returns: One of WEIGHT_HAIRLINE WEIGHT_NARROW WEIGHT_MEDIUM WEIGHT_WIDE getWeight() Get the weight field for the LineFormat record.
public boolean	Returns: the auto field value. isAuto() automatic format
public boolean	Returns: the draw ticks field value. isDrawTicks() draw tick marks
public boolean	Returns: the unknown field value. isUnknown() book marks this as reserved = 0 but it seems to do something
public void	serialize(LittleEndianOutput the output object out) Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize. Write the data content of this BIFF record.
public void	setAuto(boolean value) Sets the auto field value.
public void	setColourPaletteIndex(short field_5_colourPaletteIndex) Set the colour palette index field for the LineFormat record.
public void	setDrawTicks(boolean value) Sets the draw ticks field value.
public void	setFormat(short field_4_format) Set the format field for the LineFormat record.
public void	setLineColor(int field_1_lineColor) Set the line color field for the LineFormat record.
public void	setLinePattern(short 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 field_2_linePattern) Set the line pattern field for the LineFormat record.
public void	setUnknown(boolean value) Sets the unknown field value.
public void	setWeight(short One of WEIGHT_HAIRLINE WEIGHT_NARROW WEIGHT_MEDIUM WEIGHT_WIDE field_3_weight) Set the weight field for the LineFormat record.

Inherited from org.apache.poi.hssf.record.StandardRecord:: getRecordSize serialize

Field Detail

auto	back to summary
private static final BitField auto

drawTicks	back to summary
private static final BitField drawTicks

field_1_lineColor	back to summary
private int field_1_lineColor

field_2_linePattern	back to summary
private short field_2_linePattern

field_3_weight	back to summary
private short field_3_weight

field_4_format	back to summary
private short field_4_format

field_5_colourPaletteIndex	back to summary
private short field_5_colourPaletteIndex

LINE_PATTERN_DARK_GRAY_PATTERN	back to summary
public static final short LINE_PATTERN_DARK_GRAY_PATTERN

LINE_PATTERN_DASH	back to summary
public static final short LINE_PATTERN_DASH

LINE_PATTERN_DASH_DOT	back to summary
public static final short LINE_PATTERN_DASH_DOT

LINE_PATTERN_DASH_DOT_DOT	back to summary
public static final short LINE_PATTERN_DASH_DOT_DOT

LINE_PATTERN_DOT	back to summary
public static final short LINE_PATTERN_DOT

LINE_PATTERN_LIGHT_GRAY_PATTERN	back to summary
public static final short LINE_PATTERN_LIGHT_GRAY_PATTERN

LINE_PATTERN_MEDIUM_GRAY_PATTERN	back to summary
public static final short LINE_PATTERN_MEDIUM_GRAY_PATTERN

LINE_PATTERN_NONE	back to summary
public static final short LINE_PATTERN_NONE

LINE_PATTERN_SOLID	back to summary
public static final short LINE_PATTERN_SOLID

sid	back to summary
public static final short sid

unknown	back to summary
private static final BitField unknown

WEIGHT_HAIRLINE	back to summary
public static final short WEIGHT_HAIRLINE

WEIGHT_MEDIUM	back to summary
public static final short WEIGHT_MEDIUM

WEIGHT_NARROW	back to summary
public static final short WEIGHT_NARROW

WEIGHT_WIDE	back to summary
public static final short WEIGHT_WIDE

Constructor Detail

LineFormatRecord	back to summary
public LineFormatRecord()

LineFormatRecord	back to summary
public LineFormatRecord(LineFormatRecord other)

LineFormatRecord	back to summary
public LineFormatRecord(RecordInputStream in)

Method Detail

copy	back to summary
public LineFormatRecord copy() Implements abstract org.apache.poi.hssf.record.StandardRecord.copy. Implements org.apache.poi.common.Duplicatable.copy. Returns:LineFormatRecord Doc from org.apache.poi.common.Duplicatable.copy. a deep copy of the implementing class / instance Annotations @Override

copy

back to summary

public LineFormatRecord copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:LineFormatRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations

@Override

getColourPaletteIndex	back to summary
public short getColourPaletteIndex() Get the colour palette index field for the LineFormat record.

getDataSize	back to summary
protected int getDataSize() Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

getFormat	back to summary
public short getFormat() Get the format field for the LineFormat record.

getGenericProperties	back to summary
public Map<String, Supplier<?>> getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties. Annotations @Override

getGenericProperties

back to summary

public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations

@Override

getGenericRecordType	back to summary
public HSSFRecordTypes getGenericRecordType() Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType. Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType. Annotations @Override

getGenericRecordType

back to summary

public HSSFRecordTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

Annotations

@Override

getLineColor	back to summary
public int getLineColor() Get the line color field for the LineFormat record.

getLinePattern	back to summary
public short getLinePattern() Get the line pattern field for the LineFormat record. Returns:short 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

getLinePattern

back to summary

public short getLinePattern()

Get the line pattern field for the LineFormat record.

Returns:short: 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

getSid	back to summary
public short getSid() Implements abstract org.apache.poi.hssf.record.Record.getSid. Doc from org.apache.poi.hssf.record.Record.getSid. return the non static version of the id for this record. Returns:short he id for this record

getSid

back to summary

public short getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

Doc from org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

Returns:short: he id for this record

getWeight	back to summary
public short getWeight() Get the weight field for the LineFormat record. Returns:short One of WEIGHT_HAIRLINE WEIGHT_NARROW WEIGHT_MEDIUM WEIGHT_WIDE

getWeight

back to summary

public short getWeight()

Get the weight field for the LineFormat record.

Returns:short: One of WEIGHT_HAIRLINE WEIGHT_NARROW WEIGHT_MEDIUM WEIGHT_WIDE

isAuto	back to summary
public boolean isAuto() automatic format Returns:boolean the auto field value.

isAuto

back to summary

public boolean isAuto()

automatic format

Returns:boolean: the auto field value.

isDrawTicks	back to summary
public boolean isDrawTicks() draw tick marks Returns:boolean the draw ticks field value.

isDrawTicks

back to summary

public boolean isDrawTicks()

draw tick marks

Returns:boolean: the draw ticks field value.

isUnknown	back to summary
public boolean isUnknown() book marks this as reserved = 0 but it seems to do something Returns:boolean the unknown field value.

isUnknown

back to summary

public boolean isUnknown()

book marks this as reserved = 0 but it seems to do something

Returns:boolean: the unknown field value.

serialize back to summary

serialize	back to summary
public void serialize(LittleEndianOutput out) Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize. Doc from org.apache.poi.hssf.record.StandardRecord.serialize. Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass. The number of bytes written must equal the record size reported by `org.apache.poi.hssf.record.Record#getRecordSize()`} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass). Parameters out:LittleEndianOutput the output object

public void serialize(LittleEndianOutput out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Doc from org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.

The number of bytes written must equal the record size reported by org.apache.poi.hssf.record.Record#getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Parameters

out:LittleEndianOutput: the output object

setAuto	back to summary
public void setAuto(boolean value) Sets the auto field value. automatic format

setColourPaletteIndex	back to summary
public void setColourPaletteIndex(short field_5_colourPaletteIndex) Set the colour palette index field for the LineFormat record.

setDrawTicks	back to summary
public void setDrawTicks(boolean value) Sets the draw ticks field value. draw tick marks

setFormat	back to summary
public void setFormat(short field_4_format) Set the format field for the LineFormat record.

setLineColor	back to summary
public void setLineColor(int field_1_lineColor) Set the line color field for the LineFormat record.

setLinePattern	back to summary
public void setLinePattern(short field_2_linePattern) Set the line pattern field for the LineFormat record. Parameters field_2_linePattern:short 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

back to summary

public void setLinePattern(short field_2_linePattern)

Set the line pattern field for the LineFormat record.

Parameters

field_2_linePattern:short: 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

setUnknown	back to summary
public void setUnknown(boolean value) Sets the unknown field value. book marks this as reserved = 0 but it seems to do something

setWeight	back to summary
public void setWeight(short field_3_weight) Set the weight field for the LineFormat record. Parameters field_3_weight:short One of WEIGHT_HAIRLINE WEIGHT_NARROW WEIGHT_MEDIUM WEIGHT_WIDE

setWeight

back to summary

public void setWeight(short field_3_weight)

Set the weight field for the LineFormat record.

Parameters

field_3_weight:short: One of WEIGHT_HAIRLINE WEIGHT_NARROW WEIGHT_MEDIUM WEIGHT_WIDE

public final Class LineFormatRecord

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail