Package loci.poi.hssf.record

Class BarRecord

  • public class BarRecord
extends Record
    The bar record is used to define a bar chart. 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

      Fields 
      Modifier and Type Field Description
      static short sid  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object clone()  
      protected void fillFields​(RecordInputStream in)
      called by the constructor, should set class level fields.
      short getBarSpace()
      Get the bar space field for the Bar record.
      short getCategorySpace()
      Get the category space field for the Bar record.
      short getFormatFlags()
      Get the format flags field for the Bar record.
      int getRecordSize()
      Size of record (exluding 4 byte header)
      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
      int serialize​(int offset, byte[] data)
      called by the class that is responsible for writing this sucker.
      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)
      protected void validateSid​(short id)
      Checks the sid matches the expected side for this record

      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • BarRecord

        public BarRecord()

      • BarRecord

        public BarRecord​(RecordInputStream in)
        Constructs a Bar 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

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