|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.TickRecord
The Tick record defines how tick marks and label positioning/formatting NOTE: This source is automatically generated please do not modify this file. Either subclass or remove the record in src/records/definitions.
Field Summary | |
static short |
sid
|
Constructor Summary | |
TickRecord()
|
|
TickRecord(short id,
short size,
byte[] data)
Constructs a Tick record and sets its fields appropriately. |
|
TickRecord(short id,
short size,
byte[] data,
int offset)
Constructs a Tick record and sets its fields appropriately. |
Method Summary | |
java.lang.Object |
clone()
|
protected void |
fillFields(byte[] data,
short size,
int offset)
called by the constructor, should set class level fields. |
byte |
getBackground()
Get the background field for the Tick record. |
int |
getLabelColorRgb()
Get the label color rgb field for the Tick record. |
byte |
getLabelPosition()
Get the label position field for the Tick record. |
byte |
getMajorTickType()
Get the major tick type field for the Tick record. |
byte |
getMinorTickType()
Get the minor tick type field for the Tick record. |
short |
getOptions()
Get the options field for the Tick record. |
int |
getRecordSize()
Size of record (exluding 4 byte header) |
short |
getRotation()
rotate text (0=none, 1=normal, 2=90 degrees counterclockwise, 3=90 degrees clockwise) |
short |
getSid()
return the non static version of the id for this record. |
short |
getTickColor()
Get the tick color field for the Tick record. |
short |
getZero1()
Get the zero 1 field for the Tick record. |
short |
getZero2()
Get the zero 2 field for the Tick record. |
short |
getZero3()
Get the zero 3 field for the Tick record. |
boolean |
isAutorotate()
automatically rotate the text |
boolean |
isAutoTextBackground()
use the quote unquote automatic color for text background |
boolean |
isAutoTextColor()
use the quote unquote automatic color for text |
int |
serialize(int offset,
byte[] data)
called by the class that is responsible for writing this sucker. |
void |
setAutorotate(boolean value)
Sets the autorotate field value. |
void |
setAutoTextBackground(boolean value)
Sets the auto text background field value. |
void |
setAutoTextColor(boolean value)
Sets the auto text color field value. |
void |
setBackground(byte field_4_background)
Set the background field for the Tick record. |
void |
setLabelColorRgb(int field_5_labelColorRgb)
Set the label color rgb field for the Tick record. |
void |
setLabelPosition(byte field_3_labelPosition)
Set the label position field for the Tick record. |
void |
setMajorTickType(byte field_1_majorTickType)
Set the major tick type field for the Tick record. |
void |
setMinorTickType(byte field_2_minorTickType)
Set the minor tick type field for the Tick record. |
void |
setOptions(short field_8_options)
Set the options field for the Tick record. |
void |
setRotation(short value)
Sets the rotation field value. |
void |
setTickColor(short field_9_tickColor)
Set the tick color field for the Tick record. |
void |
setZero1(short field_6_zero1)
Set the zero 1 field for the Tick record. |
void |
setZero2(short field_7_zero2)
Set the zero 2 field for the Tick record. |
void |
setZero3(short field_10_zero3)
Set the zero 3 field for the Tick record. |
java.lang.String |
toString()
get a string representation of the record (for biffview/debugging) |
protected void |
validateSid(short id)
Checks the sid matches the expected side for this record |
Methods inherited from class org.apache.poi.hssf.record.Record |
fillFields, isInValueSection, isValue, processContinueRecord, serialize |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final short sid
Constructor Detail |
public TickRecord()
public TickRecord(short id, short size, byte[] data)
id
- id must be 0x101e or an exception
will be throw upon validationsize
- size the size of the data area of the recorddata
- data of the record (should not contain sid/len)public TickRecord(short id, short size, byte[] data, int offset)
id
- id must be 0x101e or an exception
will be throw upon validationsize
- size the size of the data area of the recorddata
- data of the record (should not contain sid/len)offset
- of the record's dataMethod Detail |
protected void validateSid(short id)
validateSid
in class Record
id
- the expected sid.protected void fillFields(byte[] data, short size, int offset)
Record
fillFields
in class Record
data
- raw datasize
- size of dataoffset
- of the record's data (provided a big array of the file)public java.lang.String toString()
Record
toString
in class Record
public int serialize(int offset, byte[] data)
Record
serialize
in class Record
offset
- to begin writing atdata
- byte array containing instance data
public int getRecordSize()
getRecordSize
in class Record
public short getSid()
Record
getSid
in class Record
public java.lang.Object clone()
clone
in class Record
public byte getMajorTickType()
public void setMajorTickType(byte field_1_majorTickType)
public byte getMinorTickType()
public void setMinorTickType(byte field_2_minorTickType)
public byte getLabelPosition()
public void setLabelPosition(byte field_3_labelPosition)
public byte getBackground()
public void setBackground(byte field_4_background)
public int getLabelColorRgb()
public void setLabelColorRgb(int field_5_labelColorRgb)
public short getZero1()
public void setZero1(short field_6_zero1)
public short getZero2()
public void setZero2(short field_7_zero2)
public short getOptions()
public void setOptions(short field_8_options)
public short getTickColor()
public void setTickColor(short field_9_tickColor)
public short getZero3()
public void setZero3(short field_10_zero3)
public void setAutoTextColor(boolean value)
public boolean isAutoTextColor()
public void setAutoTextBackground(boolean value)
public boolean isAutoTextBackground()
public void setRotation(short value)
public short getRotation()
public void setAutorotate(boolean value)
public boolean isAutorotate()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |