|
|||||||||||
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.CategorySeriesAxisRecord
This record refers to a category or series axis and is used to specify label/tickmark frequency. 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 | |
CategorySeriesAxisRecord()
|
|
CategorySeriesAxisRecord(short id,
short size,
byte[] data)
Constructs a CategorySeriesAxis record and sets its fields appropriately. |
|
CategorySeriesAxisRecord(short id,
short size,
byte[] data,
int offset)
Constructs a CategorySeriesAxis 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. |
short |
getCrossingPoint()
Get the crossing point field for the CategorySeriesAxis record. |
short |
getLabelFrequency()
Get the label frequency field for the CategorySeriesAxis record. |
short |
getOptions()
Get the options field for the CategorySeriesAxis record. |
int |
getRecordSize()
Size of record (exluding 4 byte header) |
short |
getSid()
return the non static version of the id for this record. |
short |
getTickMarkFrequency()
Get the tick mark frequency field for the CategorySeriesAxis record. |
boolean |
isCrossesFarRight()
axis crosses at the far right |
boolean |
isReversed()
categories are displayed in reverse order |
boolean |
isValueAxisCrossing()
set true to indicate axis crosses between categories and false to cross axis midway |
int |
serialize(int offset,
byte[] data)
called by the class that is responsible for writing this sucker. |
void |
setCrossesFarRight(boolean value)
Sets the crosses far right field value. |
void |
setCrossingPoint(short field_1_crossingPoint)
Set the crossing point field for the CategorySeriesAxis record. |
void |
setLabelFrequency(short field_2_labelFrequency)
Set the label frequency field for the CategorySeriesAxis record. |
void |
setOptions(short field_4_options)
Set the options field for the CategorySeriesAxis record. |
void |
setReversed(boolean value)
Sets the reversed field value. |
void |
setTickMarkFrequency(short field_3_tickMarkFrequency)
Set the tick mark frequency field for the CategorySeriesAxis record. |
void |
setValueAxisCrossing(boolean value)
Sets the value axis crossing field value. |
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 CategorySeriesAxisRecord()
public CategorySeriesAxisRecord(short id, short size, byte[] data)
id
- id must be 0x1020 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 CategorySeriesAxisRecord(short id, short size, byte[] data, int offset)
id
- id must be 0x1020 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 short getCrossingPoint()
public void setCrossingPoint(short field_1_crossingPoint)
public short getLabelFrequency()
public void setLabelFrequency(short field_2_labelFrequency)
public short getTickMarkFrequency()
public void setTickMarkFrequency(short field_3_tickMarkFrequency)
public short getOptions()
public void setOptions(short field_4_options)
public void setValueAxisCrossing(boolean value)
public boolean isValueAxisCrossing()
public void setCrossesFarRight(boolean value)
public boolean isCrossesFarRight()
public void setReversed(boolean value)
public boolean isReversed()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |