SequenceProperties (dotify.library 1.0.5 API)

java.lang.Object
- org.daisy.dotify.api.formatter.SequenceProperties

Direct Known Subclasses:

TocProperties
```
public class SequenceProperties
extends Object
```
SequenceProperties stores properties that are specific for a sequence of blocks

The constructor is private, use SequenceProperties.Builder to create new instances.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`SequenceProperties.Builder`	The Builder is used when creating a SequenceProperites instance.
`static class`	`SequenceProperties.SequenceBreakBefore`	Provides types of "break before" rules for sequences.

Constructor Summary

Constructors
Modifier Constructor Description

protected SequenceProperties(SequenceProperties.Builder builder)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SequenceProperties.SequenceBreakBefore`	`getBreakBeforeType()`	Get break before type.
`Integer`	`getInitialPageNumber()`	Get the initial page number, i.e.
`String`	`getMasterName()`	Get the name for the LayoutMaster.
`Optional<String>`	`getPageCounterName()`	Gets the page counter name.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SequenceProperties
```
protected SequenceProperties(SequenceProperties.Builder builder)
```
- Method Detail
  - getMasterName
```
public String getMasterName()
```
    Get the name for the LayoutMaster.
    
    Returns:
    
    returns the name of the LayoutMaster
  - 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
  - getBreakBeforeType
```
public SequenceProperties.SequenceBreakBefore getBreakBeforeType()
```
    Get break before type.
    
    Returns:
    
    returns the break before type
  - getPageCounterName
```
public Optional<String> getPageCounterName()
```
    Gets the page counter name. If a value is present, page numbers within this sequence should be counted separately (in other words, not using the default page counter). Instead, pages are counted together with other sequences having the same page counter name.
    
    Returns:
    
    returns the page counter name