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

public final Class FrameRecord

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
The frame record indicates whether there is a border around the displayed text of a chart.

Field Summary

Modifier and TypeField and Description
private static final BitField
autoPosition

private static final BitField
autoSize

public static final short
BORDER_TYPE_REGULAR

public static final short
BORDER_TYPE_SHADOW

private short
field_1_borderType

private short
field_2_options

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
FrameRecord()

public
FrameRecord(FrameRecord other)

public
FrameRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public FrameRecord
copy()

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

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

public short

Returns:

One of BORDER_TYPE_REGULAR BORDER_TYPE_SHADOW
getBorderType()

Get the border type field for the Frame record.

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 short
getOptions()

Get the options field for the Frame 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 boolean

Returns:

the auto position field value.
isAutoPosition()

excel calculates the position automatically

public boolean

Returns:

the auto size field value.
isAutoSize()

excel calculates the size automatically if true

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
setAutoPosition(boolean value)

Sets the auto position field value.

public void
setAutoSize(boolean value)

Sets the auto size field value.

public void
setBorderType(short
One of BORDER_TYPE_REGULAR BORDER_TYPE_SHADOW
field_1_borderType)

Set the border type field for the Frame record.

public void
setOptions(short field_2_options)

Set the options field for the Frame record.

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

Field Detail

autoPositionback to summary
private static final BitField autoPosition
autoSizeback to summary
private static final BitField autoSize
BORDER_TYPE_REGULARback to summary
public static final short BORDER_TYPE_REGULAR
BORDER_TYPE_SHADOWback to summary
public static final short BORDER_TYPE_SHADOW
field_1_borderTypeback to summary
private short field_1_borderType
field_2_optionsback to summary
private short field_2_options
sidback to summary
public static final short sid

Constructor Detail

FrameRecordback to summary
public FrameRecord()
FrameRecordback to summary
public FrameRecord(FrameRecord other)
FrameRecordback to summary
public FrameRecord(RecordInputStream in)

Method Detail

copyback to summary
public FrameRecord copy()

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

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

Returns:FrameRecord

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

a deep copy of the implementing class / instance

Annotations
@Override
getBorderTypeback to summary
public short getBorderType()

Get the border type field for the Frame record.

Returns:short

One of BORDER_TYPE_REGULAR BORDER_TYPE_SHADOW

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
getOptionsback to summary
public short getOptions()

Get the options field for the Frame record.

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

isAutoPositionback to summary
public boolean isAutoPosition()

excel calculates the position automatically

Returns:boolean

the auto position field value.

isAutoSizeback to summary
public boolean isAutoSize()

excel calculates the size automatically if true

Returns:boolean

the auto size field value.

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

setAutoPositionback to summary
public void setAutoPosition(boolean value)

Sets the auto position field value. excel calculates the position automatically

setAutoSizeback to summary
public void setAutoSize(boolean value)

Sets the auto size field value. excel calculates the size automatically if true

setBorderTypeback to summary
public void setBorderType(short field_1_borderType)

Set the border type field for the Frame record.

Parameters
field_1_borderType:short

One of BORDER_TYPE_REGULAR BORDER_TYPE_SHADOW

setOptionsback to summary
public void setOptions(short field_2_options)

Set the options field for the Frame record.