Class PageBreakRecord

Direct Known Subclasses:
HorizontalPageBreakRecord, VerticalPageBreakRecord

public abstract class PageBreakRecord extends StandardRecord

Record that contains the functionality page breaks (horizontal and vertical)

The other two classes just specifically set the SIDS for record creation.

REFERENCE: Microsoft Excel SDK page 322 and 420

Author:
Danny Mui (dmui at apache dot org)
See Also:
  • Constructor Details

    • PageBreakRecord

      protected PageBreakRecord()
    • PageBreakRecord

      public PageBreakRecord(RecordInputStream in)
  • Method Details

    • isEmpty

      public boolean isEmpty()
    • getDataSize

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

      public final 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
    • getNumBreaks

      public int getNumBreaks()
    • getBreaksIterator

      public final Iterator<PageBreakRecord.Break> getBreaksIterator()
    • toString

      public String toString()
      Description copied from class: Record
      get a string representation of the record (for biffview/debugging)
      Overrides:
      toString in class Record
    • addBreak

      public void addBreak(int main, int subFrom, int subTo)
      Adds the page break at the specified parameters
      Parameters:
      main - Depending on sid, will determine row or column to put page break (zero-based)
      subFrom - No user-interface to set (defaults to minimum, 0)
      subTo - No user-interface to set
    • removeBreak

      public final void removeBreak(int main)
      Removes the break indicated by the parameter
      Parameters:
      main - (zero-based)
    • getBreak

      public final PageBreakRecord.Break getBreak(int main)
      Retrieves the region at the row/column indicated
      Parameters:
      main - FIXME: Document this!
      Returns:
      The Break or null if no break exists at the row/col specified.
    • getBreaks

      public final int[] getBreaks()