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

Class RowImpl

java.lang.Object

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

All Implemented Interfaces:

Row

public final class RowImpl
extends Object
implements Row

Provides a single row of text. RowImpls are immutable.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RowImpl.Builder	TODO: Write java doc.

Constructor Summary

Constructors

Constructor	Description
RowImpl()	Create a new empty Row.
RowImpl(String chars)	Create a new Row.
RowImpl(String chars, MarginProperties leftMargin, MarginProperties rightMargin)

Method Summary

Modifier and Type	Method	Description
boolean	allowsBreakAfter()
boolean	equals(Object obj)
FormattingTypes.Alignment	getAlignment()	Gets the alignment value for the row.
List<String>	getAnchors()	Get all anchors on this Row.
String	getChars()	Get the characters on this row.
Object	getExternalReference()	Get the current external reference information tagged for this row.
List<String>	getIdentifiers()	Get all identifiers on this Row.
int	getLeaderSpace()
MarginProperties	getLeftMargin()	Get the left margin value for the Row, in characters.
List<Marker>	getMarkers()	Get all markers on this Row.
MarginProperties	getRightMargin()
Float	getRowSpacing()	Gets the row spacing, in rows.
int	getWidth()
int	hashCode()
boolean	hasMarkerWithName(String name)
boolean	isInvisible()
boolean	shouldAdjustForMargin()

Methods inherited from class java.lang.Object

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

Constructor Detail

RowImpl

public RowImpl(String chars)

Create a new Row.

Parameters:

chars - the characters on this row

RowImpl

public RowImpl(String chars,
               MarginProperties leftMargin,
               MarginProperties rightMargin)

RowImpl

public RowImpl()

Create a new empty Row.

Method Detail

getChars

public String getChars()

Get the characters on this row.

Specified by:

getChars in interface Row

Returns:

returns the characters on the row

getLeaderSpace

public int getLeaderSpace()

getWidth

public int getWidth()

getMarkers

public List<Marker> getMarkers()

Get all markers on this Row.

Returns:

returns the markers

hasMarkerWithName

public boolean hasMarkerWithName(String name)

getAnchors

public List<String> getAnchors()

Get all anchors on this Row.

Returns:

returns an ArrayList of anchors

getIdentifiers

public List<String> getIdentifiers()

Get all identifiers on this Row.

Returns:

returns an ArrayList of identifiers

getLeftMargin

public MarginProperties getLeftMargin()

Get the left margin value for the Row, in characters.

Returns:

returns the left margin

getRightMargin

public MarginProperties getRightMargin()

getAlignment

public FormattingTypes.Alignment getAlignment()

Gets the alignment value for the row.

Returns:

returns the alignment

getRowSpacing

public Float getRowSpacing()

Description copied from interface: Row

Gets the row spacing, in rows.

Specified by:

getRowSpacing in interface Row

Returns:

the row spacing, or null if not set

shouldAdjustForMargin

public boolean shouldAdjustForMargin()

allowsBreakAfter

public boolean allowsBreakAfter()

isInvisible

public boolean isInvisible()

getExternalReference

public Object getExternalReference()

Get the current external reference information tagged for this row.

Specified by:

getExternalReference in interface Row

Returns:

Object of the external reference.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object