Package org.daisy.dotify.api.formatter

Class LayoutMasterProperties

java.lang.Object

org.daisy.dotify.api.formatter.LayoutMasterProperties

public class LayoutMasterProperties
extends Object

Provides properties for a LayoutMaster.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LayoutMasterProperties.Builder	Configuration class for a ConfigurableLayoutMaster.

Method Summary

Modifier and Type	Method	Description
boolean	duplex()	Gets the duplex value.
TextBorderStyle	getBorder()	Gets the page border to use.
int	getFlowWidth()	Gets the width available for the text body.
int	getInnerMargin()	Gets the width of the inner margin, in characters.
int	getOuterMargin()	Gets the width of the outer margin, in characters.
int	getPageHeight()	Gets the page height, in characters.
int	getPageWidth()	Gets the page width, in characters.
float	getRowSpacing()	Gets the row spacing, in character heights.

Methods inherited from class java.lang.Object

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

Method Detail

getPageWidth

public int getPageWidth()

Gets the page width, in characters.

Returns:

returns the page width

getPageHeight

public int getPageHeight()

Gets the page height, in characters.

Returns:

returns the page height

getFlowWidth

public int getFlowWidth()

Gets the width available for the text body.

Returns:

returns the width, in characters

getInnerMargin

public int getInnerMargin()

Gets the width of the inner margin, in characters. The inner margin is the margin closes to the binding.

Returns:

returns the width of the inner margin

getOuterMargin

public int getOuterMargin()

Gets the width of the outer margin, in characters. The outer margin is the margin farthest from the binding.

Returns:

returns the width of the outer margin

getRowSpacing

public float getRowSpacing()

Gets the row spacing, in character heights. A value of 1 indicates regular single line spacing. 2 indicates double line spacing.

Returns:

the row spacing

duplex

public boolean duplex()

Gets the duplex value. If true, both sides of a sheet should be used. If false, only one side of a sheet should be used.

Returns:

returns true if both sides of a sheet should be used, false otherwise

getBorder

public TextBorderStyle getBorder()

Gets the page border to use.

Returns:

returns the page border