org.refcodes.textual.impls

Class TextBlockBuilderImpl

java.lang.Object

org.refcodes.textual.impls.TextBlockBuilderImpl

All Implemented Interfaces:

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, TextBlockBuilder

public class TextBlockBuilderImpl
extends Object
implements TextBlockBuilder

Author:

steiner

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.TextAccessor

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

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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	NO_SINGLE_LINE_CHARS

Constructor Summary

Constructors

Constructor and Description
TextBlockBuilderImpl()

Method Summary

Modifier and Type	Method and Description
int	getColumnWidth()
HorizAlignTextMode	getHorizAlignTextMode() Retrieves the horizontal align text mode from the horizontal align text mode property.
SplitTextMode	getSplitTextMode() Retrieves the split text mode from the split text mode property.
String[]	getText() Retrieves the text from the text property.
void	setColumnWidth(int aColumnWidth)
void	setHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode) Sets the horizontal align text mode for the horizontal align text mode property.
void	setSplitTextMode(SplitTextMode aSplitTextMode) Sets the split text mode for the split text mode property.
void	setText(String... aText) Sets the text for the text property.
protected static String	toNonBreakingLine(String aText) Creates a single line by replacing all new lines, line feeds and tabulators from the given String by full stops or spaces (heuristic) so that it is displayed in one single line.
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 aText, int aLength) Cuts the String into subString instances with the maximum given length.
protected static String[]	toTextBlock(String aText, int aLength, HorizAlignTextMode aHorizAlignTextMode) Cuts the String into subString instances with the maximum given length.
protected static String[]	toTextBlock(String aText, int aLength, HorizAlignTextMode aHorizAlignTextMode, SplitTextMode aLineSplitMode) Cuts the String into subString instances with the maximum given length.
protected static String[]	toTextBlock(String aText, int aLength, SplitTextMode aLineSplitMode) Cuts the String into subString instances with the maximum given length.
TextBlockBuilder	withColumnWidth(int aColumnWidth)
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.TextBlockBuilder

withHorizAlignTextMode, withSplitTextMode

Methods inherited from interface org.refcodes.textual.Text

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

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

toString

Field Detail

NO_SINGLE_LINE_CHARS

protected static final String NO_SINGLE_LINE_CHARS

Constructor Detail

TextBlockBuilderImpl

public TextBlockBuilderImpl()

Method Detail

withColumnWidth

public TextBlockBuilder withColumnWidth(int aColumnWidth)

Specified by:

withColumnWidth in interface org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthBuilder<TextBlockBuilder>

setColumnWidth

public void setColumnWidth(int aColumnWidth)

Specified by:

setColumnWidth in interface org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthMutator

getColumnWidth

public int getColumnWidth()

Specified by:

getColumnWidth in interface org.refcodes.mixin.ColumnWidthAccessor

setHorizAlignTextMode

public void setHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)

Description copied from interface: HorizAlignTextModeAccessor.HorizAlignTextModeMutator

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

Specified by:

setHorizAlignTextMode in interface HorizAlignTextModeAccessor.HorizAlignTextModeMutator

Parameters:

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

getHorizAlignTextMode

public HorizAlignTextMode getHorizAlignTextMode()

Description copied from interface: HorizAlignTextModeAccessor

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

Specified by:

getHorizAlignTextMode in interface HorizAlignTextModeAccessor

Returns:

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

getSplitTextMode

public SplitTextMode getSplitTextMode()

Description copied from interface: TextBlockBuilder

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

Specified by:

getSplitTextMode in interface TextBlockBuilder

Returns:

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

setSplitTextMode

public void setSplitTextMode(SplitTextMode aSplitTextMode)

Description copied from interface: TextBlockBuilder

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

Specified by:

setSplitTextMode in interface TextBlockBuilder

Parameters:

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

toStrings

public String[] toStrings()

Description copied from interface: TextAccessor.TextProvider

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

Specified by:

toStrings in interface TextAccessor.TextProvider

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 TextAccessor.TextProvider.toStrings(). Implementation requirements: This method must not(!) be implemented by calling Text.withText(String...) followed by TextAccessor.TextProvider.toStrings() (do not change the text property) as this would not be thread safe!

Specified by:

toStrings in interface Text<TextBlockBuilder>

Parameters:

aText - The text to be processed.

Returns:

The according resulting String array

toTextBlock

protected static String[] toTextBlock(String aText,
                                      int aLength)

Cuts the String into subString instances with the maximum given length. The array of the resulting String instances is returned.

Parameters:

aText - The String text line to be cut into sub String instances ( String array).

aLength - The maximum length of a line returned in the String array.

Returns:

A String array with the subString instances.

toTextBlock

protected static String[] toTextBlock(String aText,
                                      int aLength,
                                      SplitTextMode aLineSplitMode)

Cuts the String into subString instances with the maximum given length. The array of the resulting String instances is returned.

Parameters:

aText - The String text line to be cut into sub String instances ( String array).

aLength - The maximum length of a line returned in the String array.

aLineSplitMode - Depending on which value is passed, a line is split into subString instances preferably reckoning an end of a line ( SplitTextMode.AT_END_OF_LINE), preferably reckoning the spaces (SplitTextMode.AT_SPACE) or exactly reckoning a given width (SplitTextMode.AT_FIXED_WIDTH).

Returns:

A String array with the subString instances.

toTextBlock

protected static String[] toTextBlock(String aText,
                                      int aLength,
                                      HorizAlignTextMode aHorizAlignTextMode)

Cuts the String into subString instances with the maximum given length. The array of the resulting String instances is returned.

Parameters:

aText - The String text line to be cut into sub String instances ( String array).

aLength - The maximum length of a line returned in the String array.

aHorizAlignTextMode - The HorizAlignTextMode specifies on how a line is to be aligned in the result.

Returns:

A String array with the subString instances.

toTextBlock

protected static String[] toTextBlock(String aText,
                                      int aLength,
                                      HorizAlignTextMode aHorizAlignTextMode,
                                      SplitTextMode aLineSplitMode)

Cuts the String into subString instances with the maximum given length. The array of the resulting String instances is returned.

Parameters:

aText - The String text line to be cut into sub String instances ( String array).

aLength - The maximum length of a line returned in the String array.

aHorizAlignTextMode - The HorizAlignTextMode specifies on how a line is to be aligned in the result.

aLineSplitMode - Depending on which value is passed, a line is split into subString instances preferably reckoning an end of a line ( SplitTextMode.AT_END_OF_LINE), preferably reckoning the spaces (SplitTextMode.AT_SPACE) or exactly reckoning a given width (SplitTextMode.AT_FIXED_WIDTH).

Returns:

A String array with the subString instances.

toNonBreakingLine

protected static String toNonBreakingLine(String aText)

Creates a single line by replacing all new lines, line feeds and tabulators from the given String by full stops or spaces (heuristic) so that it is displayed in one single line.

Parameters:

aText - The String from which to replace all characters responsible for line wrapping and stuff.

Returns:

A String which will render in a single line.

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 TextAccessor.TextProvider

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 TextAccessor.TextProvider.toString(). Implementation requirements: This method must not(!) be implemented by calling Text.withText(String...) followed by TextAccessor.TextProvider.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