org.apache.poi.hssf.record
Class AxisLineFormatRecord

java.lang.Object
  extended by org.apache.poi.hssf.record.Record
      extended by org.apache.poi.hssf.record.AxisLineFormatRecord

public class AxisLineFormatRecord
extends Record

The axis line format record defines the axis type details. 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
static short AXIS_TYPE_AXIS_LINE
           
static short AXIS_TYPE_MAJOR_GRID_LINE
           
static short AXIS_TYPE_MINOR_GRID_LINE
           
static short AXIS_TYPE_WALLS_OR_FLOOR
           
static short sid
           
 
Constructor Summary
AxisLineFormatRecord()
           
AxisLineFormatRecord(RecordInputStream in)
          Constructs a AxisLineFormat record and sets its fields appropriately.
 
Method Summary
 java.lang.Object clone()
           
protected  void fillFields(RecordInputStream in)
          called by the constructor, should set class level fields.
 short getAxisType()
          Get the axis type field for the AxisLineFormat record.
 int getRecordSize()
          Size of record (exluding 4 byte header)
 short getSid()
          return the non static version of the id for this record.
 int serialize(int offset, byte[] data)
          called by the class that is responsible for writing this sucker.
 void setAxisType(short field_1_axisType)
          Set the axis type field for the AxisLineFormat 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
cloneViaReserialise, isInValueSection, isValue, serialize
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

sid

public static final short sid
See Also:
Constant Field Values

AXIS_TYPE_AXIS_LINE

public static final short AXIS_TYPE_AXIS_LINE
See Also:
Constant Field Values

AXIS_TYPE_MAJOR_GRID_LINE

public static final short AXIS_TYPE_MAJOR_GRID_LINE
See Also:
Constant Field Values

AXIS_TYPE_MINOR_GRID_LINE

public static final short AXIS_TYPE_MINOR_GRID_LINE
See Also:
Constant Field Values

AXIS_TYPE_WALLS_OR_FLOOR

public static final short AXIS_TYPE_WALLS_OR_FLOOR
See Also:
Constant Field Values
Constructor Detail

AxisLineFormatRecord

public AxisLineFormatRecord()

AxisLineFormatRecord

public AxisLineFormatRecord(RecordInputStream in)
Constructs a AxisLineFormat record and sets its fields appropriately.

Parameters:
in - the RecordInputstream to read the record from
Method Detail

validateSid

protected void validateSid(short id)
Checks the sid matches the expected side for this record

Specified by:
validateSid in class Record
Parameters:
id - the expected sid.

fillFields

protected void fillFields(RecordInputStream in)
Description copied from class: Record
called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.

Specified by:
fillFields in class Record
Parameters:
in - the RecordInputstream to read the record from

toString

public java.lang.String toString()
Description copied from class: Record
get a string representation of the record (for biffview/debugging)

Overrides:
toString in class Record

serialize

public int serialize(int offset,
                     byte[] data)
Description copied from class: Record
called 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.

Specified by:
serialize in class Record
Parameters:
offset - to begin writing at
data - byte array containing instance data
Returns:
number of bytes written

getRecordSize

public int getRecordSize()
Size of record (exluding 4 byte header)

Overrides:
getRecordSize in class Record

getSid

public short getSid()
Description copied from class: Record
return the non static version of the id for this record.

Specified by:
getSid in class Record

clone

public java.lang.Object clone()
Overrides:
clone in class Record

getAxisType

public short getAxisType()
Get the axis type field for the AxisLineFormat record.

Returns:
One of AXIS_TYPE_AXIS_LINE AXIS_TYPE_MAJOR_GRID_LINE AXIS_TYPE_MINOR_GRID_LINE AXIS_TYPE_WALLS_OR_FLOOR

setAxisType

public void setAxisType(short field_1_axisType)
Set the axis type field for the AxisLineFormat record.

Parameters:
field_1_axisType - One of AXIS_TYPE_AXIS_LINE AXIS_TYPE_MAJOR_GRID_LINE AXIS_TYPE_MINOR_GRID_LINE AXIS_TYPE_WALLS_OR_FLOOR


Copyright 2008 The Apache Software Foundation or its licensors, as applicable.