Package org.apache.poi.hssf.record
Class PageBreakRecord
- java.lang.Object
-
- org.apache.poi.hssf.record.RecordBase
-
- org.apache.poi.hssf.record.Record
-
- org.apache.poi.hssf.record.StandardRecord
-
- org.apache.poi.hssf.record.PageBreakRecord
-
- All Implemented Interfaces:
org.apache.poi.common.Duplicatable
,GenericRecord
- Direct Known Subclasses:
HorizontalPageBreakRecord
,VerticalPageBreakRecord
public abstract class PageBreakRecord extends StandardRecord
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
,VerticalPageBreakRecord
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PageBreakRecord.Break
Since both records store 2byte integers (short), no point in differentiating it in the records.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
addBreak(int main, int subFrom, int subTo)
Adds the page break at the specified parametersabstract PageBreakRecord
copy()
PageBreakRecord.Break
getBreak(int main)
Retrieves the region at the row/column indicatedint[]
getBreaks()
java.util.Iterator<PageBreakRecord.Break>
getBreaksIterator()
java.util.Spliterator<PageBreakRecord.Break>
getBreaksSpliterator()
java.util.Map<java.lang.String,java.util.function.Supplier<?>>
getGenericProperties()
int
getNumBreaks()
boolean
isEmpty()
void
removeBreak(int main)
Removes the break indicated by the parametervoid
serialize(LittleEndianOutput out)
-
Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serialize
-
Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, getGenericRecordType, getSid, serialize, toString
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord
getGenericChildren
-
-
-
-
Method Detail
-
isEmpty
public boolean isEmpty()
-
serialize
public final void serialize(LittleEndianOutput out)
-
getNumBreaks
public int getNumBreaks()
-
getBreaksIterator
public final java.util.Iterator<PageBreakRecord.Break> getBreaksIterator()
-
getBreaksSpliterator
public final java.util.Spliterator<PageBreakRecord.Break> getBreaksSpliterator()
- Since:
- POI 5.2.0
-
addBreak
public void addBreak(int main, int subFrom, int 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 minimum, 0)subTo
- No user-interface to set
-
removeBreak
public final void removeBreak(int main)
Removes the break indicated by the parameter- Parameters:
main
- (zero-based)
-
getBreak
public final PageBreakRecord.Break getBreak(int 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.
-
getBreaks
public final int[] getBreaks()
-
copy
public abstract PageBreakRecord copy()
- Specified by:
copy
in interfaceorg.apache.poi.common.Duplicatable
- Specified by:
copy
in classStandardRecord
-
getGenericProperties
public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()
-
-