Package org.refcodes.textual

Interface TextBorderBuilder

All Superinterfaces:

org.refcodes.graphical.BoxBorderModeAccessor, org.refcodes.graphical.BoxBorderModeAccessor.BoxBorderModeBuilder<TextBorderBuilder>, org.refcodes.graphical.BoxBorderModeAccessor.BoxBorderModeMutator, org.refcodes.graphical.BoxBorderModeAccessor.BoxBorderModeProperty, Text<TextBorderBuilder>, TextAccessor, TextAccessor.TextBuilder<TextBorderBuilder>, TextAccessor.TextMutator, TextAccessor.TextProperty, TextAccessor.TextProvider, TextBoxGridAccessor, TextBoxGridAccessor.TextBoxGridBuilder<TextBorderBuilder>, TextBoxGridAccessor.TextBoxGridMutator, TextBoxGridAccessor.TextBoxGridProperty

All Known Implementing Classes:

TextBorderBuilderImpl

public interface TextBorderBuilder
extends Text<TextBorderBuilder>, org.refcodes.graphical.BoxBorderModeAccessor.BoxBorderModeProperty, org.refcodes.graphical.BoxBorderModeAccessor.BoxBorderModeBuilder<TextBorderBuilder>, TextBoxGridAccessor.TextBoxGridProperty, TextBoxGridAccessor.TextBoxGridBuilder<TextBorderBuilder>

"Draws" an ASCII_HEADER_ASCII_BODY characters border around a text. The text border can be provided by adjusting properties such as the TableStyle or the BoxBorderMode. When providing a TableStyle, then the TableStyle.getBody() characters are used to draw the border.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.graphical.BoxBorderModeAccessor

org.refcodes.graphical.BoxBorderModeAccessor.BoxBorderModeBuilder<B extends org.refcodes.graphical.BoxBorderModeAccessor.BoxBorderModeBuilder<B>>, org.refcodes.graphical.BoxBorderModeAccessor.BoxBorderModeMutator, org.refcodes.graphical.BoxBorderModeAccessor.BoxBorderModeProperty

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

TextBoxGridAccessor.TextBoxGridBuilder<B extends TextBoxGridAccessor.TextBoxGridBuilder<?>>, TextBoxGridAccessor.TextBoxGridMutator, TextBoxGridAccessor.TextBoxGridProperty

Method Summary

Modifier and Type	Method	Description
static TextBorderBuilder	build()	This is a convenience method for easily instantiating the according builder.
char	getBorderChar()	Retrieves the border char from the border char property.
int	getBorderWidth()	Retrieves the border width from the border width property.
void	setBorderChar(char aBorderChar)	Sets the border char for the border char property.
void	setBorderWidth(int aBorderWidth)	Sets the border width for the border width property.
String[]	toStrings()	The Strings being build by the builder upon the settings of the attributes.
default TextBorderBuilder	withBorderChar(char aBorderChar)	Sets the border char for the border char property.
default TextBorderBuilder	withBorderWidth(int aBorderWidth)	Sets the border width for the border width property.

Methods inherited from interface org.refcodes.graphical.BoxBorderModeAccessor

getBoxBorderMode

Methods inherited from interface org.refcodes.graphical.BoxBorderModeAccessor.BoxBorderModeBuilder

withBoxBorderMode

Methods inherited from interface org.refcodes.graphical.BoxBorderModeAccessor.BoxBorderModeMutator

setBoxBorderMode

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

Methods inherited from interface org.refcodes.textual.TextBoxGridAccessor

getTextBoxGrid

Methods inherited from interface org.refcodes.textual.TextBoxGridAccessor.TextBoxGridBuilder

withTextBoxGrid

Methods inherited from interface org.refcodes.textual.TextBoxGridAccessor.TextBoxGridMutator

setTextBoxGrid

Method Detail

getBorderChar

char getBorderChar()

Retrieves the border char from the border char property.

Returns:

The border char stored by the border char property.

setBorderChar

void setBorderChar(char aBorderChar)

Sets the border char for the border char property.

Parameters:

aBorderChar - The border char to be stored by the text align mode property.

withBorderChar

default TextBorderBuilder withBorderChar(char aBorderChar)

Sets the border char for the border char property.

Parameters:

aBorderChar - The border char to be stored by the text align mode property.

Returns:

The builder for applying multiple build operations.

getBorderWidth

int getBorderWidth()

Retrieves the border width from the border width property.

Returns:

The border width stored by the border width property.

setBorderWidth

void setBorderWidth(int aBorderWidth)

Sets the border width for the border width property.

Parameters:

aBorderWidth - The border width to be stored by the text align mode property.

withBorderWidth

default TextBorderBuilder withBorderWidth(int aBorderWidth)

Sets the border width for the border width property.

Parameters:

aBorderWidth - The border width to be stored by the text align mode property.

Returns:

The builder for applying multiple build operations.

toStrings

String[] toStrings()

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

build

static TextBorderBuilder build()

This is a convenience method for easily instantiating the according builder.

Returns:

an instance (using a default implementation) of this builder