org.apache.poi.hssf.record
Class SheetPropertiesRecord

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.SheetPropertiesRecord

public final class SheetPropertiesRecord
extends Record

Describes a chart sheet properties record.

Author:
Glen Stampoultzis (glens at apache.org)

Field Summary
static byte EMPTY_INTERPOLATED
           
static byte EMPTY_NOT_PLOTTED
           
static byte EMPTY_ZERO
           
static short sid
           
 
Constructor Summary
SheetPropertiesRecord()
           
SheetPropertiesRecord(RecordInputStream in)
           
 
Method Summary
 java.lang.Object clone()
           
 byte getEmpty()
          Get the empty field for the SheetProperties record.
 short getFlags()
          Get the flags field for the SheetProperties 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 isAutoPlotArea()
          ??
 boolean isChartTypeManuallyFormatted()
          Has the chart type been manually formatted?
 boolean isDefaultPlotDimensions()
          Indicates that the default area dimensions should be used.
 boolean isDoNotSizeWithWindow()
          Do not size the chart when the window changes size
 boolean isPlotVisibleOnly()
          Only show visible cells on the chart.
 int serialize(int offset, byte[] data)
          called by the class that is responsible for writing this sucker.
 void setAutoPlotArea(boolean value)
          Sets the auto plot area field value.
 void setChartTypeManuallyFormatted(boolean value)
          Sets the chart type manually formatted field value.
 void setDefaultPlotDimensions(boolean value)
          Sets the default plot dimensions field value.
 void setDoNotSizeWithWindow(boolean value)
          Sets the do not size with window field value.
 void setEmpty(byte field_2_empty)
          Set the empty field for the SheetProperties record.
 void setFlags(short field_1_flags)
          Set the flags field for the SheetProperties record.
 void setPlotVisibleOnly(boolean value)
          Sets the plot visible only 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

EMPTY_NOT_PLOTTED

public static final byte EMPTY_NOT_PLOTTED
See Also:
Constant Field Values

EMPTY_ZERO

public static final byte EMPTY_ZERO
See Also:
Constant Field Values

EMPTY_INTERPOLATED

public static final byte EMPTY_INTERPOLATED
See Also:
Constant Field Values
Constructor Detail

SheetPropertiesRecord

public SheetPropertiesRecord()

SheetPropertiesRecord

public SheetPropertiesRecord(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

getFlags

public short getFlags()
Get the flags field for the SheetProperties record.


setFlags

public void setFlags(short field_1_flags)
Set the flags field for the SheetProperties record.


getEmpty

public byte getEmpty()
Get the empty field for the SheetProperties record.

Returns:
One of EMPTY_NOT_PLOTTED EMPTY_ZERO EMPTY_INTERPOLATED

setEmpty

public void setEmpty(byte field_2_empty)
Set the empty field for the SheetProperties record.

Parameters:
field_2_empty - One of EMPTY_NOT_PLOTTED EMPTY_ZERO EMPTY_INTERPOLATED

setChartTypeManuallyFormatted

public void setChartTypeManuallyFormatted(boolean value)
Sets the chart type manually formatted field value. Has the chart type been manually formatted?


isChartTypeManuallyFormatted

public boolean isChartTypeManuallyFormatted()
Has the chart type been manually formatted?

Returns:
the chart type manually formatted field value.

setPlotVisibleOnly

public void setPlotVisibleOnly(boolean value)
Sets the plot visible only field value. Only show visible cells on the chart.


isPlotVisibleOnly

public boolean isPlotVisibleOnly()
Only show visible cells on the chart.

Returns:
the plot visible only field value.

setDoNotSizeWithWindow

public void setDoNotSizeWithWindow(boolean value)
Sets the do not size with window field value. Do not size the chart when the window changes size


isDoNotSizeWithWindow

public boolean isDoNotSizeWithWindow()
Do not size the chart when the window changes size

Returns:
the do not size with window field value.

setDefaultPlotDimensions

public void setDefaultPlotDimensions(boolean value)
Sets the default plot dimensions field value. Indicates that the default area dimensions should be used.


isDefaultPlotDimensions

public boolean isDefaultPlotDimensions()
Indicates that the default area dimensions should be used.

Returns:
the default plot dimensions field value.

setAutoPlotArea

public void setAutoPlotArea(boolean value)
Sets the auto plot area field value. ??


isAutoPlotArea

public boolean isAutoPlotArea()
??

Returns:
the auto plot area field value.


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