|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.poi.hssf.record.Record | +--org.apache.poi.hssf.record.LineFormatRecord
Describes a line format record. The line format record controls how a line on a chart appears. 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 |
LINE_PATTERN_DARK_GRAY_PATTERN
|
static short |
LINE_PATTERN_DASH
|
static short |
LINE_PATTERN_DASH_DOT
|
static short |
LINE_PATTERN_DASH_DOT_DOT
|
static short |
LINE_PATTERN_DOT
|
static short |
LINE_PATTERN_LIGHT_GRAY_PATTERN
|
static short |
LINE_PATTERN_MEDIUM_GRAY_PATTERN
|
static short |
LINE_PATTERN_NONE
|
static short |
LINE_PATTERN_SOLID
|
static short |
sid
|
static short |
WEIGHT_HAIRLINE
|
static short |
WEIGHT_MEDIUM
|
static short |
WEIGHT_NARROW
|
static short |
WEIGHT_WIDE
|
Constructor Summary | |
LineFormatRecord()
|
|
LineFormatRecord(short id,
short size,
byte[] data)
Constructs a LineFormat record and sets its fields appropriately. |
|
LineFormatRecord(short id,
short size,
byte[] data,
int offset)
Constructs a LineFormat record and sets its fields appropriately. |
Method Summary | |
protected void |
fillFields(byte[] data,
short size,
int offset)
called by the constructor, should set class level fields. |
short |
getColourPaletteIndex()
Get the colour palette index field for the LineFormat record. |
short |
getFormat()
Get the format field for the LineFormat record. |
int |
getLineColor()
Get the line color field for the LineFormat record. |
short |
getLinePattern()
Get the line pattern field for the LineFormat record. |
int |
getRecordSize()
Size of record (exluding 4 byte header) |
short |
getSid()
return the non static version of the id for this record. |
short |
getWeight()
Get the weight field for the LineFormat record. |
boolean |
isAuto()
automatic format |
boolean |
isDrawTicks()
draw tick marks |
boolean |
isUnknown()
book marks this as reserved = 0 but it seems to do something |
int |
serialize(int offset,
byte[] data)
called by the class that is responsible for writing this sucker. |
void |
setAuto(boolean value)
Sets the auto field value. |
void |
setColourPaletteIndex(short field_5_colourPaletteIndex)
Set the colour palette index field for the LineFormat record. |
void |
setDrawTicks(boolean value)
Sets the draw ticks field value. |
void |
setFormat(short field_4_format)
Set the format field for the LineFormat record. |
void |
setLineColor(int field_1_lineColor)
Set the line color field for the LineFormat record. |
void |
setLinePattern(short field_2_linePattern)
Set the line pattern field for the LineFormat record. |
void |
setUnknown(boolean value)
Sets the unknown field value. |
void |
setWeight(short field_3_weight)
Set the weight field for the LineFormat 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 |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final short sid
public static final short LINE_PATTERN_SOLID
public static final short LINE_PATTERN_DASH
public static final short LINE_PATTERN_DOT
public static final short LINE_PATTERN_DASH_DOT
public static final short LINE_PATTERN_DASH_DOT_DOT
public static final short LINE_PATTERN_NONE
public static final short LINE_PATTERN_DARK_GRAY_PATTERN
public static final short LINE_PATTERN_MEDIUM_GRAY_PATTERN
public static final short LINE_PATTERN_LIGHT_GRAY_PATTERN
public static final short WEIGHT_HAIRLINE
public static final short WEIGHT_NARROW
public static final short WEIGHT_MEDIUM
public static final short WEIGHT_WIDE
Constructor Detail |
public LineFormatRecord()
public LineFormatRecord(short id, short size, byte[] data)
id
- id must be 0x1007 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 LineFormatRecord(short id, short size, byte[] data, int offset)
id
- id must be 0x1007 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
org.apache.poi.hssf.record.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
org.apache.poi.hssf.record.Record
offset
- to begin writing atdata
- byte array containing instance datapublic int getRecordSize()
getRecordSize
in class Record
public short getSid()
Record
getSid
in class Record
public int getLineColor()
public void setLineColor(int field_1_lineColor)
public short getLinePattern()
public void setLinePattern(short field_2_linePattern)
field_2_linePattern
- One of
LINE_PATTERN_SOLID
LINE_PATTERN_DASH
LINE_PATTERN_DOT
LINE_PATTERN_DASH_DOT
LINE_PATTERN_DASH_DOT_DOT
LINE_PATTERN_NONE
LINE_PATTERN_DARK_GRAY_PATTERN
LINE_PATTERN_MEDIUM_GRAY_PATTERN
LINE_PATTERN_LIGHT_GRAY_PATTERNpublic short getWeight()
public void setWeight(short field_3_weight)
field_3_weight
- One of
WEIGHT_HAIRLINE
WEIGHT_NARROW
WEIGHT_MEDIUM
WEIGHT_WIDEpublic short getFormat()
public void setFormat(short field_4_format)
public short getColourPaletteIndex()
public void setColourPaletteIndex(short field_5_colourPaletteIndex)
public void setAuto(boolean value)
public boolean isAuto()
public void setDrawTicks(boolean value)
public boolean isDrawTicks()
public void setUnknown(boolean value)
public boolean isUnknown()
|
jakarta-poi 1.7.0-dev | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |