Package org.apache.poi.hssf.record

Class CFHeaderBase

java.lang.Object
org.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.StandardRecord
org.apache.poi.hssf.record.CFHeaderBase
All Implemented Interfaces:
Duplicatable, GenericRecord
Direct Known Subclasses:
CFHeader12Record, CFHeaderRecord
public abstract class CFHeaderBase extends StandardRecord
Parent of Conditional Formatting Header records, CFHeaderRecord and CFHeader12Record.

  • Constructor Details

    • CFHeaderBase

      protected CFHeaderBase()

    • CFHeaderBase

      protected CFHeaderBase(CFHeaderBase other)

    • CFHeaderBase

      protected CFHeaderBase(CellRangeAddress[] regions, int nRules)

  • Method Details

    • createEmpty

      protected void createEmpty()

    • read

      protected void read(RecordInputStream in)

    • getNumberOfConditionalFormats

      public int getNumberOfConditionalFormats()

    • setNumberOfConditionalFormats

      public void setNumberOfConditionalFormats(int n)

    • getNeedRecalculation

      public boolean getNeedRecalculation()

    • setNeedRecalculation

      public void setNeedRecalculation(boolean b)

    • getID

      public int getID()

    • setID

      public void setID(int id)

    • getEnclosingCellRange

      public CellRangeAddress getEnclosingCellRange()

    • setEnclosingCellRange

      public void setEnclosingCellRange(CellRangeAddress cr)

    • setCellRanges

      public void setCellRanges(CellRangeAddress[] cellRanges)
      Set cell ranges list to a single cell range and modify the enclosing cell range accordingly.
      Parameters:
      cellRanges - - list of CellRange objects

    • getCellRanges

      public CellRangeAddress[] getCellRanges()

    • getRecordName

      protected abstract String getRecordName()

    • getDataSize

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

    • 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

    • copy

      public abstract CFHeaderBase copy()
      Specified by:
      copy in interface Duplicatable
      Specified by:
      copy in class StandardRecord
      Returns:
      a deep copy of the implementing class / instance

    • getGenericProperties

      public Map<String,Supplier<?>> getGenericProperties()