org.apache.poi.hssf.record
Class PageBreakRecord

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.PageBreakRecord
Direct Known Subclasses:
HorizontalPageBreakRecord, VerticalPageBreakRecord

public abstract class PageBreakRecord
extends Record

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:
HorizontalPageBreakRecord, VerticalPageBreakRecord

Nested Class Summary
 class PageBreakRecord.Break
          Since both records store 2byte integers (short), no point in differentiating it in the records.
 
Constructor Summary
protected PageBreakRecord()
           
  PageBreakRecord(RecordInputStream in)
           
 
Method Summary
 void addBreak(int main, int subFrom, int subTo)
          Adds the page break at the specified parameters
 PageBreakRecord.Break getBreak(int main)
          Retrieves the region at the row/column indicated
 int[] getBreaks()
           
 java.util.Iterator getBreaksIterator()
           
 int getNumBreaks()
           
 int getRecordSize()
          gives the current serialized size of the record.
 void removeBreak(int main)
          Removes the break indicated by the parameter
 int serialize(int offset, byte[] data)
          called by the class that is responsible for writing this sucker.
 java.lang.String toString()
          get a string representation of the record (for biffview/debugging)
 
Methods inherited from class org.apache.poi.hssf.record.Record
clone, cloneViaReserialise, getSid, serialize
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PageBreakRecord

protected PageBreakRecord()

PageBreakRecord

public PageBreakRecord(RecordInputStream in)
Method Detail

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

serialize

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

getNumBreaks

public int getNumBreaks()

getBreaksIterator

public final java.util.Iterator getBreaksIterator()

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

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()


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