org.daisy.dotify.api.formatter

Class Leader.Builder

java.lang.Object

org.daisy.dotify.api.formatter.Leader.Builder

Enclosing class:

Leader

public static class Leader.Builder
extends Object

The Builder is used when creating a Leader instance

Constructor Summary

Constructors

Constructor and Description
Builder() Create a new Builder

Method Summary

Modifier and Type	Method and Description
Leader.Builder	align(Leader.Alignment align) Set the Alignment for Leader instances created using this builder.
Leader	build() Build Leader using the current state of the Builder
Leader.Builder	pattern(String pattern) Set the pattern for Leader instances created using this builder.
Leader.Builder	position(Position pos) Set the Position for Leader instances created using this builder.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Create a new Builder

Method Detail

position

public Leader.Builder position(Position pos)

Set the Position for Leader instances created using this builder. For example, position "0" is at the beginning of a row and "100%" is at the very end of a row.

Parameters:

pos - the Position for the leader

Returns:

returns the Builder

align

public Leader.Builder align(Leader.Alignment align)

Set the Alignment for Leader instances created using this builder. The alignment effects the placement of the text following the leader

Parameters:

align - the Alignment for the leader

Returns:

returns the Builder

pattern

public Leader.Builder pattern(String pattern)

Set the pattern for Leader instances created using this builder. The pattern is used to fill up the space between the text preceding the leader and the text following it.

Parameters:

pattern - the pattern for the leader

Returns:

returns the Builder

build

public Leader build()

Build Leader using the current state of the Builder

Returns:

returns a new Leader instance