Top Description Fields Constructors Methods
org.apache.poi.hssf.record.chart

public final Class ChartFormatRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.hssf.record.HSSFRecordTypes, .RecordInputStream, .StandardRecord, org.apache.poi.util.BitField, .BitFieldFactory, .GenericRecordUtil, .LittleEndianOutput
Class ChartFormatRecord (0x1014)

(As with all chart related records, documentation is lacking. See ChartRecord for more details)

Field Summary

Modifier and TypeField and Description
private int
field1_x_position

private int
field2_y_position

private int
field3_width

private int
field4_height

private int
field5_grbit

private int
field6_unknown

public static final short
sid

private static final BitField
varyDisplayPattern

Constructor Summary

AccessConstructor and Description
public
ChartFormatRecord()

public
ChartFormatRecord(ChartFormatRecord other)

public
ChartFormatRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public ChartFormatRecord
copy()

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

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

protected int
getDataSize()

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

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

public short
getSid()

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

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

public boolean
getVaryDisplayPattern()

public int
getWidth()

public int
getXPosition()

public int
getYPosition()

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
setHeight(int height)

public void
setVaryDisplayPattern(boolean value)

public void
setWidth(int width)

public void
setXPosition(int xPosition)

public void
setYPosition(int yPosition)

Inherited from org.apache.poi.hssf.record.StandardRecord:
getRecordSizeserialize

Field Detail

field1_x_positionback to summary
private int field1_x_position
field2_y_positionback to summary
private int field2_y_position
field3_widthback to summary
private int field3_width
field4_heightback to summary
private int field4_height
field5_grbitback to summary
private int field5_grbit
field6_unknownback to summary
private int field6_unknown
sidback to summary
public static final short sid
varyDisplayPatternback to summary
private static final BitField varyDisplayPattern

Constructor Detail

ChartFormatRecordback to summary
public ChartFormatRecord()
ChartFormatRecordback to summary
public ChartFormatRecord(ChartFormatRecord other)
ChartFormatRecordback to summary
public ChartFormatRecord(RecordInputStream in)

Method Detail

copyback to summary
public ChartFormatRecord copy()

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

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

Returns:ChartFormatRecord

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

a deep copy of the implementing class / instance

Annotations
@Override
getDataSizeback to summary
protected int getDataSize()

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

getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

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

Annotations
@Override
getGenericRecordTypeback 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
getHeightback to summary
public int getHeight()
getSidback 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

getVaryDisplayPatternback to summary
public boolean getVaryDisplayPattern()
getWidthback to summary
public int getWidth()
getXPositionback to summary
public int getXPosition()
getYPositionback to summary
public int getYPosition()
serializeback 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

setHeightback to summary
public void setHeight(int height)
setVaryDisplayPatternback to summary
public void setVaryDisplayPattern(boolean value)
setWidthback to summary
public void setWidth(int width)
setXPositionback to summary
public void setXPosition(int xPosition)
setYPositionback to summary
public void setYPosition(int yPosition)