Package org.daisy.dotify.formatter.impl.page

Class BlockSequence

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.Vector<E>

java.util.Stack<Block>

org.daisy.dotify.formatter.impl.core.FormatterCoreImpl

org.daisy.dotify.formatter.impl.page.BlockSequence

All Implemented Interfaces:

Serializable, Cloneable, Iterable<Block>, Collection<Block>, List<Block>, RandomAccess, BlockBuilder, BlockContentBuilder, FormatterCore, FormatterSequence, BlockGroup

public class BlockSequence
extends FormatterCoreImpl
implements FormatterSequence

Provides an interface for a sequence of block contents.

selectScenario is used to access the blocks, as a list of RowGroupSequences (one RowGroupSequence for each block).

See Also:

Serialized Form

Field Summary

Fields inherited from class org.daisy.dotify.formatter.impl.core.FormatterCoreImpl

fc, propsContext, scenario

Fields inherited from class java.util.Vector

capacityIncrement, elementCount, elementData

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
BlockSequence(FormatterContext fc, SequenceProperties props, LayoutMaster master)

Method Summary

Modifier and Type	Method	Description
Integer	getInitialPageNumber()	Get the initial page number, i.e.
LayoutMaster	getLayoutMaster()	Gets the layout master for this sequence.
SequenceProperties	getSequenceProperties()

Methods inherited from class org.daisy.dotify.formatter.impl.core.FormatterCoreImpl

addChars, beginsTableBody, beginsTableCell, beginsTableHeader, beginsTableRow, endBlock, endSpan, endStyle, endTable, getBlocks, getCurrentBlock, insertAnchor, insertDynamicLayout, insertEvaluate, insertExternalReference, insertLeader, insertMarker, insertMarkerReference, insertPageReference, isGenerated, newBlock, newLine, startBlock, startBlock, startSpan, startStyle, startTable

Methods inherited from class java.util.Stack

empty, peek, pop, push, search

Methods inherited from class java.util.Vector

add, add, addAll, addAll, addElement, capacity, clear, clone, contains, containsAll, copyInto, elementAt, elements, ensureCapacity, equals, firstElement, forEach, get, hashCode, indexOf, indexOf, insertElementAt, isEmpty, iterator, lastElement, lastIndexOf, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeAllElements, removeElement, removeElementAt, removeIf, removeRange, replaceAll, retainAll, set, setElementAt, setSize, size, sort, spliterator, subList, toArray, toArray, toString, trimToSize

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.daisy.dotify.api.formatter.BlockBuilder

endBlock, startBlock, startBlock

Methods inherited from interface org.daisy.dotify.api.formatter.BlockContentBuilder

addChars, endSpan, endStyle, insertAnchor, insertEvaluate, insertExternalReference, insertLeader, insertMarker, insertMarkerReference, insertPageReference, newLine, startSpan, startStyle

Methods inherited from interface java.util.Collection

parallelStream, stream, toArray

Methods inherited from interface org.daisy.dotify.api.formatter.FormatterCore

beginsTableBody, beginsTableCell, beginsTableHeader, beginsTableRow, endTable, insertDynamicLayout, startTable

Constructor Detail

BlockSequence

public BlockSequence(FormatterContext fc,
                     SequenceProperties props,
                     LayoutMaster master)

Method Detail

getLayoutMaster

public LayoutMaster getLayoutMaster()

Gets the layout master for this sequence.

Returns:

returns the layout master for this sequence

getInitialPageNumber

public Integer getInitialPageNumber()

Get the initial page number, i.e. the number that the first page in the sequence should have.

Returns:

returns the initial page number, or null if no initial page number has been specified

getSequenceProperties

public SequenceProperties getSequenceProperties()