Package org.apache.poi.hssf.record
Class PageBreakRecord
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.PageBreakRecord
- Direct Known Subclasses:
HorizontalPageBreakRecord
,VerticalPageBreakRecord
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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
Since both records store 2byte integers (short), no point in differentiating it in the records. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addBreak
(int main, int subFrom, int subTo) Adds the page break at the specified parametersfinal PageBreakRecord.Break
getBreak
(int main) Retrieves the region at the row/column indicatedfinal int[]
final Iterator<PageBreakRecord.Break>
protected int
int
boolean
isEmpty()
final void
removeBreak
(int main) Removes the break indicated by the parameterfinal void
Write the data content of this BIFF record.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
clone, cloneViaReserialise, getSid, serialize
-
Constructor Details
-
PageBreakRecord
protected PageBreakRecord() -
PageBreakRecord
-
-
Method Details
-
isEmpty
public boolean isEmpty() -
getDataSize
protected int getDataSize()- Specified by:
getDataSize
in classStandardRecord
-
serialize
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 classStandardRecord
- Parameters:
out
- the output object
-
getNumBreaks
public int getNumBreaks() -
getBreaksIterator
-
toString
Description copied from class:Record
get a string representation of the record (for biffview/debugging) -
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
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()
-