org.refcodes.textual.impls

Class VertAlignTextBuilderImpl

java.lang.Object

org.refcodes.textual.impls.VertAlignTextBuilderImpl

All Implemented Interfaces:

org.refcodes.mixin.RowHeightAccessor, org.refcodes.mixin.RowHeightAccessor.RowHeightBuilder<VertAlignTextBuilder>, org.refcodes.mixin.RowHeightAccessor.RowHeightMutator, org.refcodes.mixin.RowHeightAccessor.RowHeightProperty, Text<VertAlignTextBuilder>, TextAccessor, TextAccessor.TextBuilder<Text<VertAlignTextBuilder>>, TextAccessor.TextMutator, TextAccessor.TextProperty, VertAlignTextBuilder, VertAlignTextModeAccessor, VertAlignTextModeAccessor.VertAlignTextModeBuilder<VertAlignTextBuilder>, VertAlignTextModeAccessor.VertAlignTextModeMutator, VertAlignTextModeAccessor.VertAlignTextModeProperty

public class VertAlignTextBuilderImpl
extends Object
implements VertAlignTextBuilder

Author:

steiner

Nested Class Summary

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

org.refcodes.mixin.RowHeightAccessor.RowHeightBuilder<B extends org.refcodes.mixin.RowHeightAccessor.RowHeightBuilder<B>>, org.refcodes.mixin.RowHeightAccessor.RowHeightMutator, org.refcodes.mixin.RowHeightAccessor.RowHeightProperty

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

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

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

VertAlignTextModeAccessor.VertAlignTextModeBuilder<B extends VertAlignTextModeAccessor.VertAlignTextModeBuilder<B>>, VertAlignTextModeAccessor.VertAlignTextModeMutator, VertAlignTextModeAccessor.VertAlignTextModeProperty

Constructor Summary

Constructors

Constructor and Description
VertAlignTextBuilderImpl()

Method Summary

Modifier and Type	Method and Description
char	getFillChar() Retrieves the fill char from the fill char property.
int	getRowHeight()
String[]	getText() Retrieves the text from the text property.
VertAlignTextMode	getVertAlignTextMode() Retrieves the vertical align text mode from the vertical align text mode property.
void	setFillChar(char aFillChar) Sets the fill char for the fill char property.
void	setRowHeight(int aRowHeight)
void	setText(String... aText) Sets the text for the text property.
void	setVertAlignTextMode(VertAlignTextMode aVertAlignTextMode) Sets the vertical align text mode for the vertical align text mode property.
String	toString() The String being build by the builder upon the settings of the attributes.
String	toString(String... aText) Race condition safe shortcut for using Text.withText(String...)
String[]	toStrings() The Strings being build by the builder upon the settings of the attributes.
String[]	toStrings(String... aText) Race condition safe shortcut for using Text.withText(String...)
protected static String[]	toTextBlock(String[] aTextBlock, int aHeight, char aFillChar, VertAlignTextMode aVertAlignTextMode) Fills up or truncates a given text block to the provided height; filling up or truncating depends on the VertAlignTextMode specified, the default is VertAlignTextMode.TOP.
VertAlignTextBuilder	withRowHeight(int aRowHeight)
B	withText(Collection<String> aText) Sets the text for the text property.
B	withText(String... aText) Sets the text for the text property.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.textual.VertAlignTextBuilder

withFillChar, withVertAlignTextMode

Methods inherited from interface org.refcodes.textual.Text

toString, toString, withText

Methods inherited from interface org.refcodes.textual.TextAccessor

getText

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

setText, setText

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

withText

Constructor Detail

VertAlignTextBuilderImpl

public VertAlignTextBuilderImpl()

Method Detail

withRowHeight

public VertAlignTextBuilder withRowHeight(int aRowHeight)

Specified by:

withRowHeight in interface org.refcodes.mixin.RowHeightAccessor.RowHeightBuilder<VertAlignTextBuilder>

setRowHeight

public void setRowHeight(int aRowHeight)

Specified by:

setRowHeight in interface org.refcodes.mixin.RowHeightAccessor.RowHeightMutator

getRowHeight

public int getRowHeight()

Specified by:

getRowHeight in interface org.refcodes.mixin.RowHeightAccessor

setVertAlignTextMode

public void setVertAlignTextMode(VertAlignTextMode aVertAlignTextMode)

Description copied from interface: VertAlignTextModeAccessor.VertAlignTextModeMutator

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

Specified by:

setVertAlignTextMode in interface VertAlignTextModeAccessor.VertAlignTextModeMutator

Parameters:

aVertAlignTextMode - The vertical align text mode to be stored by the font style property.

getVertAlignTextMode

public VertAlignTextMode getVertAlignTextMode()

Description copied from interface: VertAlignTextModeAccessor

Retrieves the vertical align text mode from the vertical align text mode property.

Specified by:

getVertAlignTextMode in interface VertAlignTextModeAccessor

Returns:

The vertical align text mode stored by the vertical align text mode property.

getFillChar

public char getFillChar()

Description copied from interface: VertAlignTextBuilder

Retrieves the fill char from the fill char property.

Specified by:

getFillChar in interface VertAlignTextBuilder

Returns:

The fill char stored by the fill char property.

setFillChar

public void setFillChar(char aFillChar)

Description copied from interface: VertAlignTextBuilder

Sets the fill char for the fill char property.

Specified by:

setFillChar in interface VertAlignTextBuilder

Parameters:

aFillChar - The fill char to be stored by the align text mode property.

toStrings

public String[] toStrings()

Description copied from interface: Text

The Strings being build by the builder upon the settings of the attributes.

Specified by:

toStrings in interface Text<VertAlignTextBuilder>

Returns:

The according resulting String array

toStrings

public String[] toStrings(String... aText)

Description copied from interface: Text

Race condition safe shortcut for using Text.withText(String...) followed by Text.toStrings(). Implementation requirements: This method must not(!) be implemented by calling Text.withText(String...) followed by Text.toStrings() (do not change the text property) as this would not be thread safe!

Specified by:

toStrings in interface Text<VertAlignTextBuilder>

Parameters:

aText - The text to be processed.

Returns:

The according resulting String array

toTextBlock

protected static String[] toTextBlock(String[] aTextBlock,
                                      int aHeight,
                                      char aFillChar,
                                      VertAlignTextMode aVertAlignTextMode)

Fills up or truncates a given text block to the provided height; filling up or truncating depends on the VertAlignTextMode specified, the default is VertAlignTextMode.TOP. When filling up a line, a String filled with space (" ") characters the length of the first element in the array is used.

Parameters:

aTextBlock - The text block to be filled up / truncated.

aHeight - The height of the resulting text block.

aVertAlignTextMode - The mode on how to fill up the text block. The mode can be VertAlignTextMode.BOTTOM, VertAlignTextMode.CENTER or VertAlignTextMode.TOP

Returns:

The text block filled up / truncated to the required height.

getText

public String[] getText()

Description copied from interface: TextAccessor

Retrieves the text from the text property.

Specified by:

getText in interface TextAccessor

Returns:

The text stored by the text property.

setText

public void setText(String... aText)

Description copied from interface: TextAccessor.TextMutator

Sets the text for the text property.

Specified by:

setText in interface TextAccessor.TextMutator

Parameters:

aText - The text to be stored by the text property.

withText

public B withText(String... aText)

Description copied from interface: TextAccessor.TextBuilder

Sets the text for the text property.

Specified by:

withText in interface Text<B extends Text<B>>

Specified by:

withText in interface TextAccessor.TextBuilder<Text<B extends Text<B>>>

Parameters:

aText - The text to be stored by the text property.

Returns:

The builder for applying multiple build operations.

withText

public B withText(Collection<String> aText)

Description copied from interface: TextAccessor.TextBuilder

Sets the text for the text property.

Specified by:

withText in interface TextAccessor.TextBuilder<Text<B extends Text<B>>>

Parameters:

aText - The text to be stored by the text property.

Returns:

The builder for applying multiple build operations.

toString

public String toString()

The String being build by the builder upon the settings of the attributes. The string array is returned as a single String with the operating system's end of line marker (CR on on Windows and CR LF on *nix operating systems) as determined by SystemUtility.getLineBreak()

Specified by:

toString in interface Text<B extends Text<B>>

Overrides:

toString in class Object

Returns:

The according resulting String

toString

public String toString(String... aText)

Description copied from interface: Text

Race condition safe shortcut for using Text.withText(String...) followed by Text.toString(). Implementation requirements: This method must not(!) be implemented by calling Text.withText(String...) followed by Text.toString() (do not change the text property) as this would not be thread safe!

Specified by:

toString in interface Text<B extends Text<B>>

Parameters:

aText - The text to be processed.

Returns:

The according resulting String