Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.poi.hssf.record.chart
Class BarRecord

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.StandardRecord
              extended by org.apache.poi.hssf.record.chart.BarRecord
All Implemented Interfaces:
java.lang.Cloneable
public final class BarRecord
extends StandardRecord
implements java.lang.Cloneable

The bar record is used to define a bar chart.

Field Summary
static short sid
           
 
Constructor Summary
BarRecord()
           
BarRecord(RecordInputStream in)
           
 
Method Summary
 BarRecord clone()
           
 short getBarSpace()
          Get the bar space field for the Bar record.
 short getCategorySpace()
          Get the category space field for the Bar record.
protected  int getDataSize()
           
 short getFormatFlags()
          Get the format flags field for the Bar record.
 short getSid()
          return the non static version of the id for this record.
 boolean isDisplayAsPercentage()
          display chart values as a percentage
 boolean isHorizontal()
          true to display horizontal bar charts, false for vertical
 boolean isShadow()
          display a shadow for the chart
 boolean isStacked()
          stack displayed values
 void serialize(LittleEndianOutput out)
          Write the data content of this BIFF record.
 void setBarSpace(short field_1_barSpace)
          Set the bar space field for the Bar record.
 void setCategorySpace(short field_2_categorySpace)
          Set the category space field for the Bar record.
 void setDisplayAsPercentage(boolean value)
          Sets the display as percentage field value.
 void setFormatFlags(short field_3_formatFlags)
          Set the format flags field for the Bar record.
 void setHorizontal(boolean value)
          Sets the horizontal field value.
 void setShadow(boolean value)
          Sets the shadow field value.
 void setStacked(boolean value)
          Sets the stacked 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.StandardRecord
getRecordSize, serialize
 
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

BarRecord

public BarRecord()

BarRecord

public BarRecord(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 void serialize(LittleEndianOutput out)
Description copied from class: StandardRecord
Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.

The number of bytes written must equal the record size reported by RecordBase.getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Specified by:
serialize in class StandardRecord
Parameters:
out - the output object

getDataSize

protected int getDataSize()
Specified by:
getDataSize in class StandardRecord

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
Returns:
he id for this record

clone

public BarRecord clone()
Overrides:
clone in class Record

getBarSpace

public short getBarSpace()
Get the bar space field for the Bar record.

setBarSpace

public void setBarSpace(short field_1_barSpace)
Set the bar space field for the Bar record.

getCategorySpace

public short getCategorySpace()
Get the category space field for the Bar record.

setCategorySpace

public void setCategorySpace(short field_2_categorySpace)
Set the category space field for the Bar record.

getFormatFlags

public short getFormatFlags()
Get the format flags field for the Bar record.

setFormatFlags

public void setFormatFlags(short field_3_formatFlags)
Set the format flags field for the Bar record.

setHorizontal

public void setHorizontal(boolean value)
Sets the horizontal field value. true to display horizontal bar charts, false for vertical

isHorizontal

public boolean isHorizontal()
true to display horizontal bar charts, false for vertical

Returns:
the horizontal field value.

setStacked

public void setStacked(boolean value)
Sets the stacked field value. stack displayed values

isStacked

public boolean isStacked()
stack displayed values

Returns:
the stacked field value.

setDisplayAsPercentage

public void setDisplayAsPercentage(boolean value)
Sets the display as percentage field value. display chart values as a percentage

isDisplayAsPercentage

public boolean isDisplayAsPercentage()
display chart values as a percentage

Returns:
the display as percentage field value.

setShadow

public void setShadow(boolean value)
Sets the shadow field value. display a shadow for the chart

isShadow

public boolean isShadow()
display a shadow for the chart

Returns:
the shadow field value.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD