Package org.apache.poi.hssf.record.chart
Class FrameRecord
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.FrameRecord
- All Implemented Interfaces:
Cloneable
The frame record indicates whether there is a border around the displayed text of a chart.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final short
static final short
static final short
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
short
Get the border type field for the Frame record.protected int
short
Get the options field for the Frame record.short
getSid()
return the non static version of the id for this record.boolean
excel calculates the position automaticallyboolean
excel calculates the size automatically if truevoid
Write the data content of this BIFF record.void
setAutoPosition
(boolean value) Sets the auto position field value.void
setAutoSize
(boolean value) Sets the auto size field value.void
setBorderType
(short field_1_borderType) Set the border type field for the Frame record.void
setOptions
(short field_2_options) Set the options field for the Frame record.toString()
get a string representation of the record (for biffview/debugging)Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serialize
Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
BORDER_TYPE_REGULAR
public static final short BORDER_TYPE_REGULAR- See Also:
-
BORDER_TYPE_SHADOW
public static final short BORDER_TYPE_SHADOW- See Also:
-
-
Constructor Details
-
FrameRecord
public FrameRecord() -
FrameRecord
-
-
Method Details
-
toString
Description copied from class:Record
get a string representation of the record (for biffview/debugging) -
serialize
Description copied from class:StandardRecord
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
RecordBase.getRecordSize()
} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).- Specified by:
serialize
in classStandardRecord
- Parameters:
out
- the output object
-
getDataSize
protected int getDataSize()- Specified by:
getDataSize
in classStandardRecord
-
getSid
public short getSid()Description copied from class:Record
return the non static version of the id for this record. -
clone
-
getBorderType
public short getBorderType()Get the border type field for the Frame record.- Returns:
- One of BORDER_TYPE_REGULAR BORDER_TYPE_SHADOW
-
setBorderType
public void setBorderType(short field_1_borderType) Set the border type field for the Frame record.- Parameters:
field_1_borderType
- One of BORDER_TYPE_REGULAR BORDER_TYPE_SHADOW
-
getOptions
public short getOptions()Get the options field for the Frame record. -
setOptions
public void setOptions(short field_2_options) Set the options field for the Frame record. -
setAutoSize
public void setAutoSize(boolean value) Sets the auto size field value. excel calculates the size automatically if true -
isAutoSize
public boolean isAutoSize()excel calculates the size automatically if true- Returns:
- the auto size field value.
-
setAutoPosition
public void setAutoPosition(boolean value) Sets the auto position field value. excel calculates the position automatically -
isAutoPosition
public boolean isAutoPosition()excel calculates the position automatically- Returns:
- the auto position field value.
-