Top Description Inners Fields Constructors Methods
org.apache.poi.hssf.record

public abstract Class PageBreakRecord

extends StandardRecord
Class Inheritance
Known Direct Subclasses
org.apache.poi.hssf.record.VerticalPageBreakRecord, org.apache.poi.hssf.record.HorizontalPageBreakRecord
Imports
java.util.ArrayList, .HashMap, .Iterator, .Map, .Spliterator, java.util.function.Supplier, org.apache.poi.common.usermodel.GenericRecord, org.apache.poi.util.GenericRecordUtil, .LittleEndianOutput
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 and Inner Type Summary

Modifier and TypeClass and Description
public static class
PageBreakRecord.Break

Since both records store 2byte integers (short), no point in differentiating it in the records.

Field Summary

Modifier and TypeField and Description
private final Map<Integer, PageBreakRecord.Break>
_breakMap

private final ArrayList<PageBreakRecord.Break>
_breaks

private static final int[]
EMPTY_INT_ARRAY

Constructor Summary

AccessConstructor and Description
protected
PageBreakRecord()

protected
PageBreakRecord(PageBreakRecord other)

protected
PageBreakRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public void
addBreak(int
Depending on sid, will determine row or column to put page break (zero-based)
main, int
No user-interface to set (defaults to minimum, 0)
subFrom, int
No user-interface to set
subTo)

Adds the page break at the specified parameters

public abstract PageBreakRecord
copy()

Redeclares org.apache.poi.common.Duplicatable.copy.

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

public final PageBreakRecord.Break

Returns:

The Break or null if no break exists at the row/col specified.
getBreak(int
FIXME: Document this!
main)

Retrieves the region at the row/column indicated

public final int[]
getBreaks()

public final Iterator<PageBreakRecord.Break>
getBreaksIterator()

public final Spliterator<PageBreakRecord.Break>
getBreaksSpliterator()

protected int
getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

public Map<String, Supplier<?>>
getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public int
getNumBreaks()

private void
initMap()

public boolean
isEmpty()

public final void
removeBreak(int
(zero-based)
main)

Removes the break indicated by the parameter

public final void
serialize(LittleEndianOutput
the output object
out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record.

Inherited from org.apache.poi.hssf.record.StandardRecord:
getRecordSizeserialize

Field Detail

_breakMapback to summary
private final Map<Integer, PageBreakRecord.Break> _breakMap
_breaksback to summary
private final ArrayList<PageBreakRecord.Break> _breaks
EMPTY_INT_ARRAYback to summary
private static final int[] EMPTY_INT_ARRAY

Constructor Detail

PageBreakRecordback to summary
protected PageBreakRecord()
PageBreakRecordback to summary
protected PageBreakRecord(PageBreakRecord other)
PageBreakRecordback to summary
protected PageBreakRecord(RecordInputStream in)

Method Detail

addBreakback to summary
public void addBreak(int main, int subFrom, int subTo)

Adds the page break at the specified parameters

Parameters
main:int

Depending on sid, will determine row or column to put page break (zero-based)

subFrom:int

No user-interface to set (defaults to minimum, 0)

subTo:int

No user-interface to set

copyback to summary
public abstract PageBreakRecord copy()

Redeclares org.apache.poi.common.Duplicatable.copy.

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Returns:PageBreakRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations
@Override
getBreakback to summary
public final PageBreakRecord.Break getBreak(int main)

Retrieves the region at the row/column indicated

Parameters
main:int

FIXME: Document this!

Returns:PageBreakRecord.Break

The Break or null if no break exists at the row/col specified.

getBreaksback to summary
public final int[] getBreaks()
getBreaksIteratorback to summary
public final Iterator<PageBreakRecord.Break> getBreaksIterator()
getBreaksSpliteratorback to summary
public final Spliterator<PageBreakRecord.Break> getBreaksSpliterator()
Since
POI 5.2.0
getDataSizeback to summary
protected int getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getNumBreaksback to summary
public int getNumBreaks()
initMapback to summary
private void initMap()
isEmptyback to summary
public boolean isEmpty()
removeBreakback to summary
public final void removeBreak(int main)

Removes the break indicated by the parameter

Parameters
main:int

(zero-based)

serializeback to summary
public final void serialize(LittleEndianOutput out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Doc from org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.

The number of bytes written must equal the record size reported by org.apache.poi.hssf.record.Record#getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Parameters
out:LittleEndianOutput

the output object

org.apache.poi.hssf.record back to summary

public final Class PageBreakRecord.Break

extends Object
implements GenericRecord
Class Inheritance
All Implemented Interfaces
org.apache.poi.common.usermodel.GenericRecord
Since both records store 2byte integers (short), no point in differentiating it in the records.

The subs (rows or columns, don't seem to be able to set but excel sets them automatically)

Field Summary

Modifier and TypeField and Description
public static final int
ENCODED_SIZE

private int
main

private int
subFrom

private int
subTo

Constructor Summary

AccessConstructor and Description
public
Break(PageBreakRecord.Break other)

public
Break(int main, int subFrom, int subTo)

public
Break(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public Map<String, Supplier<?>>
getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public int
getMain()

public int
getSubFrom()

public int
getSubTo()

public void
serialize(LittleEndianOutput out)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

ENCODED_SIZEback to summary
public static final int ENCODED_SIZE
mainback to summary
private int main
subFromback to summary
private int subFrom
subToback to summary
private int subTo

Constructor Detail

Breakback to summary
public Break(PageBreakRecord.Break other)
Breakback to summary
public Break(int main, int subFrom, int subTo)
Breakback to summary
public Break(RecordInputStream in)

Method Detail

getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getMainback to summary
public int getMain()
getSubFromback to summary
public int getSubFrom()
getSubToback to summary
public int getSubTo()
serializeback to summary
public void serialize(LittleEndianOutput out)