org.daisy.dotify.api.formatter

Class MarkerIndicatorRegion

java.lang.Object

org.daisy.dotify.api.formatter.MarkerIndicatorRegion

All Implemented Interfaces:

MarginRegion

public class MarkerIndicatorRegion
extends Object
implements MarginRegion

Provides an marker indicator region. This margin region marks occurrences of markers at the height of the occurrence within the flow using the specified indicators. The first matching indicator in the list of indicators at that row will be printed in the margin region.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MarkerIndicatorRegion.Builder Creates a new marker indicator region builder

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<MarkerIndicator>	getIndicators() Gets the list of indicators.
int	getWidth() Gets the width of the region, in columns.
int	hashCode()
static MarkerIndicatorRegion.Builder	ofWidth(int width) Creates a new builder of the specified width.

Methods inherited from class java.lang.Object

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

Method Detail

ofWidth

public static MarkerIndicatorRegion.Builder ofWidth(int width)

Creates a new builder of the specified width.

Parameters:

width - the width of the builder, in characters

Returns:

the builder

getWidth

public int getWidth()

Description copied from interface: MarginRegion

Gets the width of the region, in columns.

Specified by:

getWidth in interface MarginRegion

Returns:

the width of the column

getIndicators

public List<MarkerIndicator> getIndicators()

Gets the list of indicators.

Returns:

the list of indicators

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object