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
public final class FrameRecord extends StandardRecord implements Cloneable
The frame record indicates whether there is a border around the displayed text of a chart.
-
-
Field Summary
Fields Modifier and Type Field Description static short
BORDER_TYPE_REGULAR
static short
BORDER_TYPE_SHADOW
static short
sid
-
Constructor Summary
Constructors Constructor Description FrameRecord()
FrameRecord(RecordInputStream in)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FrameRecord
clone()
short
getBorderType()
Get the border type field for the Frame record.short
getOptions()
Get the options field for the Frame record.short
getSid()
return the non static version of the id for this record.boolean
isAutoPosition()
excel calculates the position automaticallyboolean
isAutoSize()
excel calculates the size automatically if truevoid
serialize(LittleEndianOutput out)
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.String
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 Detail
-
sid
public static final short sid
- See Also:
- Constant Field Values
-
BORDER_TYPE_REGULAR
public static final short BORDER_TYPE_REGULAR
- See Also:
- Constant Field Values
-
BORDER_TYPE_SHADOW
public static final short BORDER_TYPE_SHADOW
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
FrameRecord
public FrameRecord()
-
FrameRecord
public FrameRecord(RecordInputStream in)
-
-
Method Detail
-
toString
public String toString()
Description copied from class:Record
get a string representation of the record (for biffview/debugging)
-
serialize
public void serialize(LittleEndianOutput out)
-
getSid
public short getSid()
Description copied from class:Record
return the non static version of the id for this record.
-
clone
public FrameRecord 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.
-
-