public abstract class PageBreakRecord extends StandardRecord
The other two classes just specifically set the SIDS for record creation.
REFERENCE: Microsoft Excel SDK page 322 and 420
HorizontalPageBreakRecord
,
VerticalPageBreakRecord
Modifier and Type | Class and Description |
---|---|
static class |
PageBreakRecord.Break
Since both records store 2byte integers (short), no point in
differentiating it in the records.
|
Modifier | Constructor and Description |
---|---|
protected |
PageBreakRecord() |
protected |
PageBreakRecord(PageBreakRecord other) |
|
PageBreakRecord(RecordInputStream in) |
Modifier and Type | Method and Description |
---|---|
void |
addBreak(int main,
int subFrom,
int subTo)
Adds the page break at the specified parameters
|
abstract PageBreakRecord |
copy() |
PageBreakRecord.Break |
getBreak(int main)
Retrieves the region at the row/column indicated
|
int[] |
getBreaks() |
java.util.Iterator<PageBreakRecord.Break> |
getBreaksIterator() |
protected int |
getDataSize() |
int |
getNumBreaks() |
boolean |
isEmpty() |
void |
removeBreak(int main)
Removes the break indicated by the parameter
|
void |
serialize(LittleEndianOutput out)
Write the data content of this BIFF record.
|
java.lang.String |
toString()
get a string representation of the record (for biffview/debugging)
|
getRecordSize, serialize
cloneViaReserialise, getSid, serialize
protected PageBreakRecord()
protected PageBreakRecord(PageBreakRecord other)
public PageBreakRecord(RecordInputStream in)
public boolean isEmpty()
protected int getDataSize()
getDataSize
in class StandardRecord
public final void serialize(LittleEndianOutput out)
StandardRecord
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).
serialize
in class StandardRecord
out
- the output objectpublic int getNumBreaks()
public final java.util.Iterator<PageBreakRecord.Break> getBreaksIterator()
public java.lang.String toString()
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()
public abstract PageBreakRecord copy()
copy
in interface Duplicatable
copy
in class StandardRecord
Copyright 2020 The Apache Software Foundation or its licensors, as applicable.