| java.lang.Object
 org.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.PageBreakRecord
All known Subclasses: org.apache.poi.hssf.record.HorizontalPageBreakRecord, org.apache.poi.hssf.record.VerticalPageBreakRecord,
| PageBreakRecord | | public class PageBreakRecord extends Record (Code) | | 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
See Also: HorizontalPageBreakRecord
See Also: VerticalPageBreakRecord
author:
Danny Mui (dmui at apache dot org) |
| Inner Class :public class Break | |
| HORIZONTAL_SID | | final public static short HORIZONTAL_SID(Code) | | |
| VERTICAL_SID | | final public static short VERTICAL_SID(Code) | | |
| PageBreakRecord | | public PageBreakRecord()(Code) | | |
| PageBreakRecord | | public PageBreakRecord(short sid)(Code) | |
Parameters:
sid - |
| addBreak | | public void addBreak(short main, short subFrom, short subTo)(Code) | | Adds the page break at the specified parameters
Parameters:
main - Depending on sid, will determine row or column to put page break (zero-based)
Parameters:
subFrom - No user-interface to set (defaults to minumum, 0)
Parameters:
subTo - No user-interface to set |
| getBreak | | public Break getBreak(short main)(Code) | | Retrieves the region at the row/column indicated
Parameters:
main - FIXME: Document this! The Break or null if no break exists at the row/col specified. |
| getNumBreaks | | public short getNumBreaks()(Code) | | |
| getRecordSize | | public int getRecordSize()(Code) | | |
| getSid | | public short getSid()(Code) | | |
| removeBreak | | public void removeBreak(short main)(Code) | | Removes the break indicated by the parameter
Parameters:
main - (zero-based) |
| serialize | | public int serialize(int offset, byte data)(Code) | | |
| setNumBreaks | | public void setNumBreaks(short numBreaks)(Code) | | |
| validateSid | | protected void validateSid(short id)(Code) | | |
|
|