org.apache.poi.hssf.record
Class DatRecord

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

public final class DatRecord
extends Record

The dat record is used to store options for the chart.

Author:
Glen Stampoultzis (glens at apache.org)

Field Summary
static short sid
           
 
Constructor Summary
DatRecord()
           
DatRecord(RecordInputStream in)
           
 
Method Summary
 java.lang.Object clone()
           
 short getOptions()
          Get the options field for the Dat record.
 int getRecordSize()
          gives the current serialized size of the record.
 short getSid()
          return the non static version of the id for this record.
 boolean isBorder()
          data table has a border
 boolean isHorizontalBorder()
          has a horizontal border
 boolean isShowSeriesKey()
          shows the series key
 boolean isVerticalBorder()
          has vertical border
 int serialize(int offset, byte[] data)
          called by the class that is responsible for writing this sucker.
 void setBorder(boolean value)
          Sets the border field value.
 void setHorizontalBorder(boolean value)
          Sets the horizontal border field value.
 void setOptions(short field_1_options)
          Set the options field for the Dat record.
 void setShowSeriesKey(boolean value)
          Sets the show series key field value.
 void setVerticalBorder(boolean value)
          Sets the vertical border field value.
 java.lang.String toString()
          get a string representation of the record (for biffview/debugging)
 
Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, 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
Constructor Detail

DatRecord

public DatRecord()

DatRecord

public DatRecord(RecordInputStream in)
Method Detail

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: RecordBase
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 RecordBase
Parameters:
offset - to begin writing at
data - byte array containing instance data
Returns:
number of bytes written

getRecordSize

public int getRecordSize()
Description copied from class: Record
gives the current serialized size of the record. Should include the sid and reclength (4 bytes).

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

getOptions

public short getOptions()
Get the options field for the Dat record.


setOptions

public void setOptions(short field_1_options)
Set the options field for the Dat record.


setHorizontalBorder

public void setHorizontalBorder(boolean value)
Sets the horizontal border field value. has a horizontal border


isHorizontalBorder

public boolean isHorizontalBorder()
has a horizontal border

Returns:
the horizontal border field value.

setVerticalBorder

public void setVerticalBorder(boolean value)
Sets the vertical border field value. has vertical border


isVerticalBorder

public boolean isVerticalBorder()
has vertical border

Returns:
the vertical border field value.

setBorder

public void setBorder(boolean value)
Sets the border field value. data table has a border


isBorder

public boolean isBorder()
data table has a border

Returns:
the border field value.

setShowSeriesKey

public void setShowSeriesKey(boolean value)
Sets the show series key field value. shows the series key


isShowSeriesKey

public boolean isShowSeriesKey()
shows the series key

Returns:
the show series key field value.


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