Package org.apache.poi.hssf.record.chart
Class TickRecord
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.TickRecord
The Tick record defines how tick marks and label positioning/formatting
- Author:
- Andrew C. Oliver(acoliver at apache.org)
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()byteGet the background field for the Tick record.protected intintGet the label color rgb field for the Tick record.byteGet the label position field for the Tick record.byteGet the major tick type field for the Tick record.byteGet the minor tick type field for the Tick record.shortGet the options field for the Tick record.shortrotate text (0=none, 1=normal, 2=90 degrees counterclockwise, 3=90 degrees clockwise)shortgetSid()return the non static version of the id for this record.shortGet the tick color field for the Tick record.intgetZero1()Get the zero 1 field for the Tick record.intgetZero2()Get the zero 2 field for the Tick record.shortgetZero3()Get the zero 3 field for the Tick record.booleanautomatically rotate the textbooleanuse the quote unquote automatic color for text backgroundbooleanuse the quote unquote automatic color for textvoidWrite the data content of this BIFF record.voidsetAutorotate(boolean value) Sets the autorotate field value.voidsetAutoTextBackground(boolean value) Sets the auto text background field value.voidsetAutoTextColor(boolean value) Sets the auto text color field value.voidsetBackground(byte field_4_background) Set the background field for the Tick record.voidsetLabelColorRgb(int field_5_labelColorRgb) Set the label color rgb field for the Tick record.voidsetLabelPosition(byte field_3_labelPosition) Set the label position field for the Tick record.voidsetMajorTickType(byte field_1_majorTickType) Set the major tick type field for the Tick record.voidsetMinorTickType(byte field_2_minorTickType) Set the minor tick type field for the Tick record.voidsetOptions(short field_10_options) Set the options field for the Tick record.voidsetRotation(short value) Sets the rotation field value.voidsetTickColor(short field_11_tickColor) Set the tick color field for the Tick record.voidsetZero1(int field_6_zero1) Set the zero 1 field for the Tick record.voidsetZero2(int field_7_zero2) Set the zero 2 field for the Tick record.voidsetZero3(short field_12_zero3) Set the zero 3 field for the Tick record.toString()get a string representation of the record (for biffview/debugging)Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serializeMethods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
-
Constructor Details
-
TickRecord
public TickRecord() -
TickRecord
-
-
Method Details
-
toString
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
serialize
Description copied from class:StandardRecordWrite 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:
serializein classStandardRecord- Parameters:
out- the output object
-
getDataSize
protected int getDataSize()- Specified by:
getDataSizein classStandardRecord
-
getSid
public short getSid()Description copied from class:Recordreturn the non static version of the id for this record. -
clone
-
getMajorTickType
public byte getMajorTickType()Get the major tick type field for the Tick record. -
setMajorTickType
public void setMajorTickType(byte field_1_majorTickType) Set the major tick type field for the Tick record. -
getMinorTickType
public byte getMinorTickType()Get the minor tick type field for the Tick record. -
setMinorTickType
public void setMinorTickType(byte field_2_minorTickType) Set the minor tick type field for the Tick record. -
getLabelPosition
public byte getLabelPosition()Get the label position field for the Tick record. -
setLabelPosition
public void setLabelPosition(byte field_3_labelPosition) Set the label position field for the Tick record. -
getBackground
public byte getBackground()Get the background field for the Tick record. -
setBackground
public void setBackground(byte field_4_background) Set the background field for the Tick record. -
getLabelColorRgb
public int getLabelColorRgb()Get the label color rgb field for the Tick record. -
setLabelColorRgb
public void setLabelColorRgb(int field_5_labelColorRgb) Set the label color rgb field for the Tick record. -
getZero1
public int getZero1()Get the zero 1 field for the Tick record. -
setZero1
public void setZero1(int field_6_zero1) Set the zero 1 field for the Tick record. -
getZero2
public int getZero2()Get the zero 2 field for the Tick record. -
setZero2
public void setZero2(int field_7_zero2) Set the zero 2 field for the Tick record. -
getOptions
public short getOptions()Get the options field for the Tick record. -
setOptions
public void setOptions(short field_10_options) Set the options field for the Tick record. -
getTickColor
public short getTickColor()Get the tick color field for the Tick record. -
setTickColor
public void setTickColor(short field_11_tickColor) Set the tick color field for the Tick record. -
getZero3
public short getZero3()Get the zero 3 field for the Tick record. -
setZero3
public void setZero3(short field_12_zero3) Set the zero 3 field for the Tick record. -
setAutoTextColor
public void setAutoTextColor(boolean value) Sets the auto text color field value. use the quote unquote automatic color for text -
isAutoTextColor
public boolean isAutoTextColor()use the quote unquote automatic color for text- Returns:
- the auto text color field value.
-
setAutoTextBackground
public void setAutoTextBackground(boolean value) Sets the auto text background field value. use the quote unquote automatic color for text background -
isAutoTextBackground
public boolean isAutoTextBackground()use the quote unquote automatic color for text background- Returns:
- the auto text background field value.
-
setRotation
public void setRotation(short value) Sets the rotation field value. rotate text (0=none, 1=normal, 2=90 degrees counterclockwise, 3=90 degrees clockwise) -
getRotation
public short getRotation()rotate text (0=none, 1=normal, 2=90 degrees counterclockwise, 3=90 degrees clockwise)- Returns:
- the rotation field value.
-
setAutorotate
public void setAutorotate(boolean value) Sets the autorotate field value. automatically rotate the text -
isAutorotate
public boolean isAutorotate()automatically rotate the text- Returns:
- the autorotate field value.
-