Package org.daisy.dotify.api.formatter

Class MarkerReferenceField

java.lang.Object

org.daisy.dotify.api.formatter.MarkerReference

org.daisy.dotify.api.formatter.MarkerReferenceField

All Implemented Interfaces:

Field

public class MarkerReferenceField
extends MarkerReference
implements Field

A MarkerReferenceField is a place holder for a marker's value. Its value is resolved by the LayoutPerformer when its location in the flow is known.

Nested Class Summary

Nested classes/interfaces inherited from class org.daisy.dotify.api.formatter.MarkerReference

MarkerReference.MarkerSearchDirection, MarkerReference.MarkerSearchScope

Constructor Summary

Constructors

Constructor	Description
MarkerReferenceField(String markerName, MarkerReference.MarkerSearchDirection dir, MarkerReference.MarkerSearchScope scope)	Creates a new instance with the specified parameters.
MarkerReferenceField(String markerName, MarkerReference.MarkerSearchDirection dir, MarkerReference.MarkerSearchScope scope, String textStyle)	Creates a new instance with the specified parameters.
MarkerReferenceField(String markerName, MarkerReference.MarkerSearchDirection dir, MarkerReference.MarkerSearchScope scope, String textStyle, int offset)	Creates a new instance with the specified parameters.

Method Summary

Modifier and Type	Method	Description
String	getTextStyle()	The text style of the field, or null if no special style is used.

Methods inherited from class org.daisy.dotify.api.formatter.MarkerReference

equals, getName, getOffset, getSearchDirection, getSearchScope, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

MarkerReferenceField

public MarkerReferenceField(String markerName,
                            MarkerReference.MarkerSearchDirection dir,
                            MarkerReference.MarkerSearchScope scope)

Creates a new instance with the specified parameters.

Parameters:

markerName - the name of the marker

dir - the direction

scope - the scope

MarkerReferenceField

public MarkerReferenceField(String markerName,
                            MarkerReference.MarkerSearchDirection dir,
                            MarkerReference.MarkerSearchScope scope,
                            String textStyle)

Creates a new instance with the specified parameters.

Parameters:

markerName - the name of the marker

dir - the direction

scope - the scope

textStyle - a text style name

MarkerReferenceField

public MarkerReferenceField(String markerName,
                            MarkerReference.MarkerSearchDirection dir,
                            MarkerReference.MarkerSearchScope scope,
                            String textStyle,
                            int offset)

Creates a new instance with the specified parameters.

Parameters:

markerName - the name of the marker

dir - the direction

scope - the scope

textStyle - a text style name

offset - offsets the search by the specified amount, in pages

Method Detail

getTextStyle

public String getTextStyle()

Description copied from interface: Field

The text style of the field, or null if no special style is used.

Specified by:

getTextStyle in interface Field

Returns:

the text style