org.daisy.dotify.api.formatter

Class PageAreaProperties.Builder

java.lang.Object

org.daisy.dotify.api.formatter.PageAreaProperties.Builder

Enclosing class:

PageAreaProperties

public static class PageAreaProperties.Builder
extends java.lang.Object

Creates a new page area properties builder

Constructor Summary

Constructors

Constructor and Description
Builder(java.lang.String collectionId, int maxHeight) Creates a new instance with the specified parameters

Method Summary

Modifier and Type	Method and Description
PageAreaProperties.Builder	addFallback(FallbackRule rule) Adds a fallback rule.
PageAreaProperties.Builder	align(PageAreaProperties.Alignment value) Sets the alignment of the page area on the page.
PageAreaProperties	build() Creates a new page area properties object

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder(java.lang.String collectionId,
               int maxHeight)

Creates a new instance with the specified parameters

Parameters:

collectionId - an identifier of the collection used for this page area

maxHeight - the maximum height of this page area

Method Detail

align

public PageAreaProperties.Builder align(PageAreaProperties.Alignment value)

Sets the alignment of the page area on the page.

Parameters:

value - the alignment

Returns:

returns this builder

addFallback

public PageAreaProperties.Builder addFallback(FallbackRule rule)

Adds a fallback rule.

Parameters:

rule - the rule

Returns:

returns this builder

build

public PageAreaProperties build()

Creates a new page area properties object

Returns:

returns a new page area properties instance