Package loci.poi.hssf.record
Class PageBreakRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.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 TypeClassDescriptionclassSince both records store 2byte integers (short), no point in differentiating it in the records. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final shortshortstatic final short -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddBreak(short main, short subFrom, short subTo) Adds the page break at the specified parametersclone()protected voidcalled by the constructor, should set class level fields.getBreak(short main) Retrieves the region at the row/column indicatedshortintgives the current serialized size of the record.shortgetSid()return the non static version of the id for this record.voidremoveBreak(short main) Removes the break indicated by the parameterintserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidsetNumBreaks(short numBreaks) toString()get a string representation of the record (for biffview/debugging)protected voidvalidateSid(short id) called by constructor, should throw runtime exception in the event of a record passed with a differing ID.Methods inherited from class loci.poi.hssf.record.Record
isInValueSection, isValue, serialize
-
Field Details
-
HORIZONTAL_SID
public static final short HORIZONTAL_SID- See Also:
-
VERTICAL_SID
public static final short VERTICAL_SID- See Also:
-
sid
public short sid
-
-
Constructor Details
-
PageBreakRecord
public PageBreakRecord() -
PageBreakRecord
public PageBreakRecord(short sid) - Parameters:
sid-
-
PageBreakRecord
-
-
Method Details
-
fillFields
Description copied from class:Recordcalled by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.- Specified by:
fillFieldsin classRecord- Parameters:
in- the RecordInputstream to read the record from
-
getSid
public short getSid()Description copied from class:Recordreturn the non static version of the id for this record. -
serialize
public int serialize(int offset, byte[] data) Description copied from class:Recordcalled 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. -
validateSid
protected void validateSid(short id) Description copied from class:Recordcalled by constructor, should throw runtime exception in the event of a record passed with a differing ID.- Specified by:
validateSidin classRecord- Parameters:
id- alleged id for this record
-
getNumBreaks
public short getNumBreaks() -
setNumBreaks
public void setNumBreaks(short numBreaks) -
getBreaksIterator
-
toString
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
addBreak
public void addBreak(short main, short subFrom, short 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 minumum, 0)subTo- No user-interface to set
-
removeBreak
public void removeBreak(short main) Removes the break indicated by the parameter- Parameters:
main- (zero-based)
-
getRecordSize
public int getRecordSize()Description copied from class:Recordgives the current serialized size of the record. Should include the sid and reclength (4 bytes).- Overrides:
getRecordSizein classRecord
-
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.
-
clone
-