|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.PageBreakRecord
public abstract class PageBreakRecord
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
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 |
---|
protected PageBreakRecord()
public PageBreakRecord(RecordInputStream in)
Method Detail |
---|
public int getRecordSize()
Record
getRecordSize
in class Record
public final int serialize(int offset, byte[] data)
RecordBase
serialize
in class RecordBase
offset
- to begin writing atdata
- byte array containing instance data
public int getNumBreaks()
public final java.util.Iterator getBreaksIterator()
public java.lang.String toString()
Record
toString
in class Record
public void addBreak(int main, int subFrom, int subTo)
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 setpublic final void removeBreak(int main)
main
- (zero-based)public final PageBreakRecord.Break getBreak(int main)
main
- FIXME: Document this!
public final int[] getBreaks()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |