Package loci.poi.hssf.record
Class BarRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.BarRecord
The bar record is used to define a bar 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
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a Bar record and sets its fields appropriately. -
Method Summary
Modifier and TypeMethodDescriptionclone()protected voidcalled by the constructor, should set class level fields.shortGet the bar space field for the Bar record.shortGet the category space field for the Bar record.shortGet the format flags field for the Bar record.intSize of record (exluding 4 byte header)shortgetSid()return the non static version of the id for this record.booleandisplay chart values as a percentagebooleantrue to display horizontal bar charts, false for verticalbooleanisShadow()display a shadow for the chartbooleanstack displayed valuesintserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidsetBarSpace(short field_1_barSpace) Set the bar space field for the Bar record.voidsetCategorySpace(short field_2_categorySpace) Set the category space field for the Bar record.voidsetDisplayAsPercentage(boolean value) Sets the display as percentage field value.voidsetFormatFlags(short field_3_formatFlags) Set the format flags field for the Bar record.voidsetHorizontal(boolean value) Sets the horizontal field value.voidsetShadow(boolean value) Sets the shadow field value.voidsetStacked(boolean value) Sets the stacked field value.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:
-
-
Constructor Details
-
BarRecord
public BarRecord() -
BarRecord
Constructs a Bar 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
-
getBarSpace
public short getBarSpace()Get the bar space field for the Bar record. -
setBarSpace
public void setBarSpace(short field_1_barSpace) Set the bar space field for the Bar record. -
getCategorySpace
public short getCategorySpace()Get the category space field for the Bar record. -
setCategorySpace
public void setCategorySpace(short field_2_categorySpace) Set the category space field for the Bar record. -
getFormatFlags
public short getFormatFlags()Get the format flags field for the Bar record. -
setFormatFlags
public void setFormatFlags(short field_3_formatFlags) Set the format flags field for the Bar record. -
setHorizontal
public void setHorizontal(boolean value) Sets the horizontal field value. true to display horizontal bar charts, false for vertical -
isHorizontal
public boolean isHorizontal()true to display horizontal bar charts, false for vertical- Returns:
- the horizontal field value.
-
setStacked
public void setStacked(boolean value) Sets the stacked field value. stack displayed values -
isStacked
public boolean isStacked()stack displayed values- Returns:
- the stacked field value.
-
setDisplayAsPercentage
public void setDisplayAsPercentage(boolean value) Sets the display as percentage field value. display chart values as a percentage -
isDisplayAsPercentage
public boolean isDisplayAsPercentage()display chart values as a percentage- Returns:
- the display as percentage field value.
-
setShadow
public void setShadow(boolean value) Sets the shadow field value. display a shadow for the chart -
isShadow
public boolean isShadow()display a shadow for the chart- Returns:
- the shadow field value.
-