org.daisy.dotify.api.formatter

Class MarkerReferenceField

java.lang.Object

org.daisy.dotify.api.formatter.MarkerReferenceField

All Implemented Interfaces:

Field

public class MarkerReferenceField
extends java.lang.Object
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

Modifier and Type	Class and Description
static class	MarkerReferenceField.MarkerSearchDirection Defines marker search directions.
static class	MarkerReferenceField.MarkerSearchScope Defines marker search scopes.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Gets the name of this marker reference field
int	getOffset() Gets the page offset where to start the search
MarkerReferenceField.MarkerSearchDirection	getSearchDirection() Gets the direction of the search
MarkerReferenceField.MarkerSearchScope	getSearchScope() Gets the scope of the search
java.lang.String	getTextStyle() The text style of the field, or null if no special style is used.

Methods inherited from class java.lang.Object

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

Constructor Detail

MarkerReferenceField

public MarkerReferenceField(java.lang.String markerName,
                            MarkerReferenceField.MarkerSearchDirection dir,
                            MarkerReferenceField.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(java.lang.String markerName,
                            MarkerReferenceField.MarkerSearchDirection dir,
                            MarkerReferenceField.MarkerSearchScope scope,
                            java.lang.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(java.lang.String markerName,
                            MarkerReferenceField.MarkerSearchDirection dir,
                            MarkerReferenceField.MarkerSearchScope scope,
                            java.lang.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

getName

public java.lang.String getName()

Gets the name of this marker reference field

Returns:

returns the name

getSearchDirection

public MarkerReferenceField.MarkerSearchDirection getSearchDirection()

Gets the direction of the search

Returns:

returns the search direction

getSearchScope

public MarkerReferenceField.MarkerSearchScope getSearchScope()

Gets the scope of the search

Returns:

returns the search scope

getTextStyle

public java.lang.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

getOffset

public int getOffset()

Gets the page offset where to start the search

Returns:

the page offset