org.daisy.dotify.api.formatter

Class BlockProperties

java.lang.Object

org.daisy.dotify.api.formatter.BlockProperties

All Implemented Interfaces:

Cloneable

public class BlockProperties
extends Object
implements Cloneable

BlockProperties defines properties specific for a block of text

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BlockProperties.Builder The Builder is used when creating a BlockProperties instance.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BlockProperties(BlockProperties.Builder builder)

Method Summary

Modifier and Type	Method and Description
Object	clone()
boolean	equals(Object obj)
int	getBlockIndent() Get block indent, in characters
FormattingTypes.BreakBefore	getBreakBeforeType() Get break before type
String	getDefaultListLabel() Gets the default list label for this list
Condition	getDisplayWhen() Gets the expression when a block should be shown.
FormattingTypes.Keep	getKeepType() Get keep type
int	getKeepWithNext() Get the number of rows containing text in the next block that must be on the same page as this block
int	getKeepWithNextSheets() Gets the number of next sheets to keep in the same volume as this block
int	getKeepWithPreviousSheets() Gets the number of previous sheets to keep in the same volume as this block
String	getListItemLabel() Gets the list item label
NumeralStyle	getListNumberFormat() Gets the number format for this list
FormattingTypes.ListStyle	getListType() Get list type
BlockSpacing	getMargin() Gets the margin
int	getOrphans() Gets the minimum number of lines of a paragraph that must be left at the bottom of a page.
BlockSpacing	getPadding() Gets the padding
TextBlockProperties	getTextBlockProperties() Gets the text block properties for this block
TextBorderStyle	getTextBorderStyle() Gets the text border style for this block
String	getUnderlineStyle() Gets the underline pattern for this block
BlockPosition	getVerticalPosition() Gets the vertical position for this block
Integer	getVolumeKeepPriority() Gets volume keep priority
int	getWidows() Gets the minimum number of lines of a paragraph that must be left at the top of a page.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockProperties

protected BlockProperties(BlockProperties.Builder builder)

Method Detail

getMargin

public BlockSpacing getMargin()

Gets the margin

Returns:

returns the margin

getPadding

public BlockSpacing getPadding()

Gets the padding

Returns:

returns the padding

getBlockIndent

public int getBlockIndent()

Get block indent, in characters

Returns:

returns the block indent

getVolumeKeepPriority

public Integer getVolumeKeepPriority()

Gets volume keep priority

Returns:

returns the volume keep priority, or null if not set

getListType

public FormattingTypes.ListStyle getListType()

Get list type

Returns:

returns the list type

getListNumberFormat

public NumeralStyle getListNumberFormat()

Gets the number format for this list

Returns:

returns the number format

getDefaultListLabel

public String getDefaultListLabel()

Gets the default list label for this list

Returns:

returns the default list label, or null if not set.

getListItemLabel

public String getListItemLabel()

Gets the list item label

Returns:

returns the list item label

getBreakBeforeType

public FormattingTypes.BreakBefore getBreakBeforeType()

Get break before type

Returns:

returns the break before type

getKeepType

public FormattingTypes.Keep getKeepType()

Get keep type

Returns:

returns the keep type

getKeepWithNext

public int getKeepWithNext()

Get the number of rows containing text in the next block that must be on the same page as this block

Returns:

returns the number of rows in the next block to keep with this block

getKeepWithPreviousSheets

public int getKeepWithPreviousSheets()

Gets the number of previous sheets to keep in the same volume as this block

Returns:

returns the number of sheets

getKeepWithNextSheets

public int getKeepWithNextSheets()

Gets the number of next sheets to keep in the same volume as this block

Returns:

returns the number of sheets

getVerticalPosition

public BlockPosition getVerticalPosition()

Gets the vertical position for this block

Returns:

returns the vertical position

getTextBorderStyle

public TextBorderStyle getTextBorderStyle()

Gets the text border style for this block

Returns:

returns the text border style

getUnderlineStyle

public String getUnderlineStyle()

Gets the underline pattern for this block

Returns:

returns the underline pattern

getOrphans

public int getOrphans()

Gets the minimum number of lines of a paragraph that must be left at the bottom of a page.

Returns:

returns the orphans

getWidows

public int getWidows()

Gets the minimum number of lines of a paragraph that must be left at the top of a page.

Returns:

returns the widows

getDisplayWhen

public Condition getDisplayWhen()

Gets the expression when a block should be shown.

Returns:

returns the display when expression.

getTextBlockProperties

public TextBlockProperties getTextBlockProperties()

Gets the text block properties for this block

Returns:

returns the text block properties

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object