Package loci.poi.hssf.record
Class FrameRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.FrameRecord
The frame record indicates whether there is a border around the displayed text of a chart.
NOTE: This source is automatically generated please do not modify this file. Either subclass or
remove the record in src/records/definitions.
- Author:
- Glen Stampoultzis (glens at apache.org)
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final shortstatic final shortstatic final short -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a Frame record and sets its fields appropriately. -
Method Summary
Modifier and TypeMethodDescriptionclone()protected voidcalled by the constructor, should set class level fields.shortGet the border type field for the Frame record.shortGet the options field for the Frame record.intSize of record (exluding 4 byte header)shortgetSid()return the non static version of the id for this record.booleanexcel calculates the position automaticallybooleanexcel calculates the size automatically if trueintserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidsetAutoPosition(boolean value) Sets the auto position field value.voidsetAutoSize(boolean value) Sets the auto size field value.voidsetBorderType(short field_1_borderType) Set the border type field for the Frame record.voidsetOptions(short field_2_options) Set the options field for the Frame record.toString()get a string representation of the record (for biffview/debugging)protected voidvalidateSid(short id) Checks the sid matches the expected side for this recordMethods inherited from class loci.poi.hssf.record.Record
isInValueSection, isValue, 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
Constructs a Frame record and sets its fields appropriately.- Parameters:
in- the RecordInputstream to read the record from
-
-
Method Details
-
validateSid
protected void validateSid(short id) Checks the sid matches the expected side for this record- Specified by:
validateSidin classRecord- Parameters:
id- the expected sid.
-
fillFields
Description copied from class:Recordcalled by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.- Specified by:
fillFieldsin classRecord- Parameters:
in- the RecordInputstream to read the record from
-
toString
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
serialize
public int serialize(int offset, byte[] data) Description copied from class:Recordcalled by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array. -
getRecordSize
public int getRecordSize()Size of record (exluding 4 byte header)- Overrides:
getRecordSizein classRecord
-
getSid
public short getSid()Description copied from class:Recordreturn 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.
-