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
public 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
Nested Classes Modifier and Type Class Description class
PageBreakRecord.Break
Since both records store 2byte integers (short), no point in differentiating it in the records.
-
Field Summary
Fields Modifier and Type Field Description static short
HORIZONTAL_SID
short
sid
static short
VERTICAL_SID
-
Constructor Summary
Constructors Constructor Description PageBreakRecord()
PageBreakRecord(short sid)
PageBreakRecord(RecordInputStream in)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addBreak(short main, short subFrom, short subTo)
Adds the page break at the specified parametersObject
clone()
protected void
fillFields(RecordInputStream in)
called by the constructor, should set class level fields.PageBreakRecord.Break
getBreak(short main)
Retrieves the region at the row/column indicatedIterator
getBreaksIterator()
short
getNumBreaks()
int
getRecordSize()
gives the current serialized size of the record.short
getSid()
return the non static version of the id for this record.void
removeBreak(short main)
Removes the break indicated by the parameterint
serialize(int offset, byte[] data)
called by the class that is responsible for writing this sucker.void
setNumBreaks(short numBreaks)
String
toString()
get a string representation of the record (for biffview/debugging)protected void
validateSid(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 Detail
-
HORIZONTAL_SID
public static final short HORIZONTAL_SID
- See Also:
- Constant Field Values
-
VERTICAL_SID
public static final short VERTICAL_SID
- See Also:
- Constant Field Values
-
sid
public short sid
-
-
Constructor Detail
-
PageBreakRecord
public PageBreakRecord()
-
PageBreakRecord
public PageBreakRecord(short sid)
- Parameters:
sid
-
-
PageBreakRecord
public PageBreakRecord(RecordInputStream in)
-
-
Method Detail
-
fillFields
protected void fillFields(RecordInputStream in)
Description copied from class:Record
called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.- Specified by:
fillFields
in classRecord
- Parameters:
in
- the RecordInputstream to read the record from
-
getSid
public short getSid()
Description copied from class:Record
return the non static version of the id for this record.
-
serialize
public int serialize(int offset, byte[] data)
Description copied from class:Record
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.
-
validateSid
protected void validateSid(short id)
Description copied from class:Record
called by constructor, should throw runtime exception in the event of a record passed with a differing ID.- Specified by:
validateSid
in classRecord
- Parameters:
id
- alleged id for this record
-
getNumBreaks
public short getNumBreaks()
-
setNumBreaks
public void setNumBreaks(short numBreaks)
-
getBreaksIterator
public Iterator getBreaksIterator()
-
toString
public String toString()
Description copied from class:Record
get 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:Record
gives the current serialized size of the record. Should include the sid and reclength (4 bytes).- Overrides:
getRecordSize
in classRecord
-
getBreak
public PageBreakRecord.Break getBreak(short 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.
-
-