Package org.daisy.dotify.formatter.impl.row

Class RowImpl.Builder

java.lang.Object

org.daisy.dotify.formatter.impl.row.RowImpl.Builder

Enclosing class:

RowImpl

public static class RowImpl.Builder
extends Object

TODO: Write java doc.

Constructor Summary

Constructors

Constructor	Description
Builder(String chars)
Builder(RowImpl template)

Method Summary

Modifier and Type	Method	Description
void	addAnchors(int index, List<String> refs)
RowImpl.Builder	addAnchors(List<String> refs)
RowImpl.Builder	addExternalReference(Object externalReference)	Add an external reference object that will flow though the framework to the PEF file.
void	addIdentifiers(int index, List<String> list)	Add a collection of identifiers to the Row.
RowImpl.Builder	addIdentifiers(List<String> refs)	Add a collection of identifiers to the Row.
void	addMarkers(int index, List<Marker> list)	Add a collection of markers to the Row.
RowImpl.Builder	addMarkers(List<Marker> list)	Add a collection of markers to the Row.
RowImpl.Builder	adjustedForMargin(boolean value)
RowImpl.Builder	alignment(FormattingTypes.Alignment value)
RowImpl.Builder	allowsBreakAfter(boolean value)
RowImpl	build()
int	getLeaderSpace()
RowImpl.Builder	invisible(boolean b)
void	leaderSpace(int value)
RowImpl.Builder	leftMargin(MarginProperties value)
RowImpl.Builder	rightMargin(MarginProperties value)
RowImpl.Builder	rowSpacing(Float value)
RowImpl.Builder	text(String value)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(String chars)

Builder

public Builder(RowImpl template)

Method Detail

text

public RowImpl.Builder text(String value)

leftMargin

public RowImpl.Builder leftMargin(MarginProperties value)

rightMargin

public RowImpl.Builder rightMargin(MarginProperties value)

alignment

public RowImpl.Builder alignment(FormattingTypes.Alignment value)

rowSpacing

public RowImpl.Builder rowSpacing(Float value)

adjustedForMargin

public RowImpl.Builder adjustedForMargin(boolean value)

allowsBreakAfter

public RowImpl.Builder allowsBreakAfter(boolean value)

addAnchors

public RowImpl.Builder addAnchors(List<String> refs)

addAnchors

public void addAnchors(int index,
                       List<String> refs)

leaderSpace

public void leaderSpace(int value)

getLeaderSpace

public int getLeaderSpace()

addMarkers

public RowImpl.Builder addMarkers(List<Marker> list)

Add a collection of markers to the Row.

Parameters:

list - the list of markers

Returns:

returns this builder

addMarkers

public void addMarkers(int index,
                       List<Marker> list)

Add a collection of markers to the Row.

Parameters:

index - the position in the marker list to insert the markers

list - the list of markers

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index > getMarkers().size())

addIdentifiers

public RowImpl.Builder addIdentifiers(List<String> refs)

Add a collection of identifiers to the Row.

Parameters:

refs - a list of identifiers

Returns:

returns this builder

addExternalReference

public RowImpl.Builder addExternalReference(Object externalReference)

Add an external reference object that will flow though the framework to the PEF file.

Parameters:

externalReference - External reference object

Returns:

returns this builder

addIdentifiers

public void addIdentifiers(int index,
                           List<String> list)

Add a collection of identifiers to the Row.

Parameters:

index - the position in the identifier list to insert the identifiers

list - the list of identifiers

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index > getIdentifiers().size())

invisible

public RowImpl.Builder invisible(boolean b)

build

public RowImpl build()