Package org.refcodes.textual

Interface TextBlockBuilder

All Superinterfaces:

org.refcodes.mixin.ColumnWidthAccessor, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthBuilder<TextBlockBuilder>, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthMutator, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthProperty, HorizAlignTextModeAccessor, HorizAlignTextModeAccessor.HorizAlignTextModeBuilder<TextBlockBuilder>, HorizAlignTextModeAccessor.HorizAlignTextModeMutator, HorizAlignTextModeAccessor.HorizAlignTextModeProperty, Text<TextBlockBuilder>, TextAccessor, TextAccessor.TextBuilder<Text<TextBlockBuilder>>, TextAccessor.TextMutator, TextAccessor.TextProperty, TextAccessor.TextProvider

All Known Implementing Classes:

TextBlockBuilderImpl

public interface TextBlockBuilder
extends org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthBuilder<TextBlockBuilder>, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthProperty, Text<TextBlockBuilder>, HorizAlignTextModeAccessor.HorizAlignTextModeProperty, HorizAlignTextModeAccessor.HorizAlignTextModeBuilder<TextBlockBuilder>

Builds a text block according to the configuration of TextBannerBuilder instances. E.g. the HorizAlignTextMode or the SplitTextMode can be configured as well as the desired column width (as of ColumnWidthAccessor.ColumnWidthMutator.setColumnWidth(int)).

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.ColumnWidthAccessor

org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthBuilder<B extends org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthBuilder<B>>, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthMutator, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthProperty

Nested classes/interfaces inherited from interface org.refcodes.textual.HorizAlignTextModeAccessor

HorizAlignTextModeAccessor.HorizAlignTextModeBuilder<B extends HorizAlignTextModeAccessor.HorizAlignTextModeBuilder<B>>, HorizAlignTextModeAccessor.HorizAlignTextModeMutator, HorizAlignTextModeAccessor.HorizAlignTextModeProperty

Nested classes/interfaces inherited from interface org.refcodes.textual.TextAccessor

TextAccessor.TextBuilder<B extends TextAccessor.TextBuilder<B>>, TextAccessor.TextMutator, TextAccessor.TextProperty, TextAccessor.TextProvider

Method Summary

Modifier and Type	Method	Description
SplitTextMode	getSplitTextMode()	Retrieves the split text mode from the split text mode property.
void	setSplitTextMode(SplitTextMode aSplitTextMode)	Sets the split text mode for the split text mode property.
default TextBlockBuilder	withHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)	Sets the align text mode for the align text mode property.
default TextBlockBuilder	withSplitTextMode(SplitTextMode aSplitTextMode)	Sets the split text mode for the split text mode property.

Methods inherited from interface org.refcodes.mixin.ColumnWidthAccessor

getColumnWidth

Methods inherited from interface org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthBuilder

withColumnWidth

Methods inherited from interface org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthMutator

setColumnWidth

Methods inherited from interface org.refcodes.textual.HorizAlignTextModeAccessor

getHorizAlignTextMode

Methods inherited from interface org.refcodes.textual.HorizAlignTextModeAccessor.HorizAlignTextModeMutator

setHorizAlignTextMode

Methods inherited from interface org.refcodes.textual.Text

toString, toStrings, withText

Methods inherited from interface org.refcodes.textual.TextAccessor

getText

Methods inherited from interface org.refcodes.textual.TextAccessor.TextBuilder

withText

Methods inherited from interface org.refcodes.textual.TextAccessor.TextMutator

setText, setText

Methods inherited from interface org.refcodes.textual.TextAccessor.TextProvider

toString, toStrings

Method Detail

withHorizAlignTextMode

default TextBlockBuilder withHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)

Sets the align text mode for the align text mode property.

Specified by:

withHorizAlignTextMode in interface HorizAlignTextModeAccessor.HorizAlignTextModeBuilder<TextBlockBuilder>

Parameters:

aHorizAlignTextMode - The align text mode to be stored by the align text mode property.

Returns:

The builder for applying multiple build operations.

getSplitTextMode

SplitTextMode getSplitTextMode()

Retrieves the split text mode from the split text mode property.

Returns:

The split text mode stored by the split text mode property.

setSplitTextMode

void setSplitTextMode(SplitTextMode aSplitTextMode)

Sets the split text mode for the split text mode property.

Parameters:

aSplitTextMode - The split text mode to be stored by the align text mode property.

withSplitTextMode

default TextBlockBuilder withSplitTextMode(SplitTextMode aSplitTextMode)

Sets the split text mode for the split text mode property.

Parameters:

aSplitTextMode - The split text mode to be stored by the align text mode property.

Returns:

The builder for applying multiple build operations.