Module org.refcodes.textual

Package org.refcodes.textual

Interface ColumnSetupMetrics

All Superinterfaces:

ColumnFormatMetrics, org.refcodes.mixin.ColumnWidthAccessor, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthBuilder<ColumnWidthMetrics>, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthMutator, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthProperty, ColumnWidthMetrics, HorizAlignTextModeAccessor.HorizAlignTextModeBuilder<ColumnFormatMetrics>, HorizAlignTextModeAccessor.HorizAlignTextModeMutator, MoreTextModeAccessor.MoreTextModeBuilder<ColumnFormatMetrics>, MoreTextModeAccessor.MoreTextModeMutator, org.refcodes.mixin.NameAccessor, org.refcodes.mixin.NameAccessor.NameBuilder<ColumnSetupMetrics>, org.refcodes.mixin.NameAccessor.NameMutator, org.refcodes.mixin.NameAccessor.NameProperty, SplitTextModeAccessor.SplitTextModeBuilder<ColumnFormatMetrics>, SplitTextModeAccessor.SplitTextModeMutator, TextFormatModeAccessor.TextFormatModeBuilder<ColumnFormatMetrics>, TextFormatModeAccessor.TextFormatModeMutator, org.refcodes.graphical.VisibleAccessor, org.refcodes.graphical.VisibleAccessor.VisibleBuilder<ColumnSetupMetrics>, org.refcodes.graphical.VisibleAccessor.VisibleMutator, org.refcodes.graphical.VisibleAccessor.VisibleProperty

All Known Implementing Classes:

ColumnSetupMetricsImpl

public interface ColumnSetupMetrics
extends ColumnFormatMetrics, org.refcodes.graphical.VisibleAccessor.VisibleProperty, org.refcodes.graphical.VisibleAccessor.VisibleBuilder<ColumnSetupMetrics>, org.refcodes.mixin.NameAccessor.NameProperty, org.refcodes.mixin.NameAccessor.NameBuilder<ColumnSetupMetrics>

The Interface ColumnSetupMetrics.

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.mixin.NameAccessor

org.refcodes.mixin.NameAccessor.NameBuilder<B extends org.refcodes.mixin.NameAccessor.NameBuilder<B>>, org.refcodes.mixin.NameAccessor.NameMutator, org.refcodes.mixin.NameAccessor.NameProperty

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

org.refcodes.graphical.VisibleAccessor.VisibleBuilder<B extends org.refcodes.graphical.VisibleAccessor.VisibleBuilder<B>>, org.refcodes.graphical.VisibleAccessor.VisibleMutator, org.refcodes.graphical.VisibleAccessor.VisibleProperty

Method Summary

Modifier and Type	Method	Description
default void	fromColumnSetupMetrics(ColumnSetupMetrics aColumnSetupMetrics)	From column setup metrics.
default ColumnSetupMetrics	withColumnWidth(int aColumnWidth)
default ColumnSetupMetrics	withColumnWidthType(ColumnWidthType aColumnWidthType)	With column width type.
default ColumnSetupMetrics	withEscapeCode(String aEscapeCode)	Sets an ANSI Escape-Code for the header and the rows and returns this ColumnFormatMetrics instance as of the Builder-Pattern.
default ColumnSetupMetrics	withEscapeCodeFactory(EscapeCodeFactory aEscapeCodeFactory)	Sets an ANSI Escape-Code factory for the header and the rows and returns this ColumnFormatMetrics instance as of the Builder-Pattern.
default ColumnSetupMetrics	withHeaderEscapeCode(String aEscapeCode)	Sets an ANSI Escape-Code for the header and returns this ColumnFormatMetrics instance as of the Builder-Pattern.
default ColumnSetupMetrics	withHeaderEscapeCodeFactory(EscapeCodeFactory aEscapeCodeFactory)	Sets an ANSI Escape-Code factory for the header and the rows and returns this ColumnFormatMetrics instance as of the Builder-Pattern.
default ColumnSetupMetrics	withHeaderHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)	Sets an alignment mode for the header and returns this ColumnFormatMetrics instance as of the Builder-Pattern.
default ColumnSetupMetrics	withHeaderMoreTextMode(MoreTextMode aMoreTextMode)	Sets a more-text mode for the header and returns this ColumnFormatMetrics instance as of the Builder-Pattern.
default ColumnSetupMetrics	withHeaderSplitTextMode(SplitTextMode aSplitTextMode)	Sets the SplitTextMode for the header and returns this ColumnFormatMetrics instance as of the Builder-Pattern.
default ColumnSetupMetrics	withHeaderTextFormatMode(TextFormatMode aTextFormatMode)	Sets the TextFormatMode for the header and returns this ColumnFormatMetrics instance as of the Builder-Pattern.
default ColumnSetupMetrics	withHide()
default ColumnSetupMetrics	withHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)	Sets the horizontal align text mode for the horizontal align text mode property.
default ColumnSetupMetrics	withMoreTextMode(MoreTextMode aMoreTextMode)	Sets the more-text mode for the more-text mode property.
default ColumnSetupMetrics	withName(String aName)
default ColumnSetupMetrics	withRowEscapeCode(String aEscapeCode)	Sets an ANSI Escape-Code for the rows and returns this ColumnFormatMetrics instance as of the Builder-Pattern.
default ColumnSetupMetrics	withRowEscapeCodeFactory(EscapeCodeFactory aEscapeCodeFactory)	Sets an ANSI Escape-Code factory for the row and the rows and returns this ColumnFormatMetrics instance as of the Builder-Pattern.
default ColumnSetupMetrics	withRowHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)	Sets an alignment mode for the row and returns this ColumnFormatMetrics instance as of the Builder-Pattern.
default ColumnSetupMetrics	withRowMoreTextMode(MoreTextMode aMoreTextMode)	Sets a more-text mode for the row and returns this ColumnFormatMetrics instance as of the Builder-Pattern.
default ColumnSetupMetrics	withRowSplitTextMode(SplitTextMode aSplitTextMode)	Sets the SplitTextMode for the row and returns this ColumnFormatMetrics instance as of the Builder-Pattern.
default ColumnSetupMetrics	withRowTextFormatMode(TextFormatMode aTextFormatMode)	Sets the TextFormatMode for the row and returns this ColumnFormatMetrics instance as of the Builder-Pattern.
default ColumnSetupMetrics	withShow()
default ColumnSetupMetrics	withSplitTextMode(SplitTextMode aSplitTextMode)	Sets the split-text mode for the split-text mode property.
default ColumnSetupMetrics	withTextFormatMode(TextFormatMode aTextFormatMode)	Sets the text-format mode for the text-format mode property.
default ColumnSetupMetrics	withVisible(boolean isVisible)

Methods inherited from interface org.refcodes.textual.ColumnFormatMetrics

fromColumnFormatMetrics, getHeaderEscapeCode, getHeaderEscapeCodeFactory, getHeaderHorizAlignTextMode, getHeaderMoreTextMode, getHeaderSplitTextMode, getHeaderTextFormatMode, getRowEscapeCode, getRowEscapeCodeFactory, getRowHorizAlignTextMode, getRowMoreTextMode, getRowSplitTextMode, getRowTextFormatMode, setEscapeCode, setEscapeCodeFactory, setHeaderEscapeCode, setHeaderEscapeCodeFactory, setHeaderHorizAlignTextMode, setHeaderMoreTextMode, setHeaderSplitTextMode, setHeaderTextFormatMode, setHorizAlignTextMode, setMoreTextMode, setRowEscapeCode, setRowEscapeCodeFactory, setRowHorizAlignTextMode, setRowMoreTextMode, setRowSplitTextMode, setRowTextFormatMode, setSplitTextMode, setTextFormatMode, toHeaderEscapeCode, toRowEscapeCode

Methods inherited from interface org.refcodes.mixin.ColumnWidthAccessor

getColumnWidth

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

setColumnWidth

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

letColumnWidth

Methods inherited from interface org.refcodes.textual.ColumnWidthMetrics

fromColumnWidthMetrics, getColumnWidthType, setColumnWidthType

Methods inherited from interface org.refcodes.mixin.NameAccessor

getName

Methods inherited from interface org.refcodes.mixin.NameAccessor.NameMutator

setName

Methods inherited from interface org.refcodes.mixin.NameAccessor.NameProperty

letName

Methods inherited from interface org.refcodes.graphical.VisibleAccessor

isVisible

Methods inherited from interface org.refcodes.graphical.VisibleAccessor.VisibleMutator

hide, setVisible, show

Methods inherited from interface org.refcodes.graphical.VisibleAccessor.VisibleProperty

letVisible

Method Details

withVisible

default ColumnSetupMetrics withVisible(boolean isVisible)

Specified by:

withVisible in interface org.refcodes.graphical.VisibleAccessor.VisibleBuilder<ColumnSetupMetrics>

withName

default ColumnSetupMetrics withName(String aName)

Specified by:

withName in interface org.refcodes.mixin.NameAccessor.NameBuilder<ColumnSetupMetrics>

withColumnWidth

default ColumnSetupMetrics withColumnWidth(int aColumnWidth)

Specified by:

withColumnWidth in interface ColumnFormatMetrics

Specified by:

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

withShow

default ColumnSetupMetrics withShow()

Specified by:

withShow in interface org.refcodes.graphical.VisibleAccessor.VisibleBuilder<ColumnSetupMetrics>

withHide

default ColumnSetupMetrics withHide()

Specified by:

withHide in interface org.refcodes.graphical.VisibleAccessor.VisibleBuilder<ColumnSetupMetrics>

withEscapeCode

default ColumnSetupMetrics withEscapeCode(String aEscapeCode)

Sets an ANSI Escape-Code for the header and the rows and returns this ColumnFormatMetrics instance as of the Builder-Pattern. In case an ANSI Escape-Code is set, then the ANSI Escape-Code is prepended and an ANSI Reset-Code is appended to the according text being printed.

Specified by:

withEscapeCode in interface ColumnFormatMetrics

Parameters:

aEscapeCode - The String to be used for ANSI escaping.

Returns:

This ColumnFormatMetrics instance to continue configuration.

withHeaderEscapeCode

default ColumnSetupMetrics withHeaderEscapeCode(String aEscapeCode)

Sets an ANSI Escape-Code for the header and returns this ColumnFormatMetrics instance as of the Builder-Pattern. In case an ANSI Escape-Code is set, then the ANSI Escape-Code is prepended and an ANSI Reset-Code is appended to the according text being printed.

Specified by:

withHeaderEscapeCode in interface ColumnFormatMetrics

Parameters:

aEscapeCode - The String to be used for ANSI escaping.

Returns:

This ColumnFormatMetrics instance to continue configuration.

withRowEscapeCode

default ColumnSetupMetrics withRowEscapeCode(String aEscapeCode)

Sets an ANSI Escape-Code for the rows and returns this ColumnFormatMetrics instance as of the Builder-Pattern. The latest ANSI Escape-Code being set wins.

Specified by:

withRowEscapeCode in interface ColumnFormatMetrics

Parameters:

aEscapeCode - The String to be used for ANSI escaping.

Returns:

This ColumnFormatMetrics instance to continue configuration.

withColumnWidthType

default ColumnSetupMetrics withColumnWidthType(ColumnWidthType aColumnWidthType)

With column width type.

Specified by:

withColumnWidthType in interface ColumnFormatMetrics

Specified by:

withColumnWidthType in interface ColumnWidthMetrics

Parameters:

aColumnWidthType - the column width type

Returns:

the column width metrics

withHorizAlignTextMode

default ColumnSetupMetrics withHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)

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

Specified by:

withHorizAlignTextMode in interface ColumnFormatMetrics

Specified by:

withHorizAlignTextMode in interface HorizAlignTextModeAccessor.HorizAlignTextModeBuilder<ColumnFormatMetrics>

Parameters:

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

Returns:

The builder for applying multiple build operations.

withHeaderHorizAlignTextMode

default ColumnSetupMetrics withHeaderHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)

Sets an alignment mode for the header and returns this ColumnFormatMetrics instance as of the Builder-Pattern.

Specified by:

withHeaderHorizAlignTextMode in interface ColumnFormatMetrics

Parameters:

aHorizAlignTextMode - The HorizAlignTextMode to be used for aligning the text.

Returns:

This TableBuilder instance to continue configuration.

withRowHorizAlignTextMode

default ColumnSetupMetrics withRowHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)

Sets an alignment mode for the row and returns this ColumnFormatMetrics instance as of the Builder-Pattern.

Specified by:

withRowHorizAlignTextMode in interface ColumnFormatMetrics

Parameters:

aHorizAlignTextMode - The HorizAlignTextMode to be used for aligning the text.

Returns:

This TableBuilder instance to continue configuration.

withMoreTextMode

default ColumnSetupMetrics withMoreTextMode(MoreTextMode aMoreTextMode)

Sets the more-text mode for the more-text mode property.

Specified by:

withMoreTextMode in interface ColumnFormatMetrics

Specified by:

withMoreTextMode in interface MoreTextModeAccessor.MoreTextModeBuilder<ColumnFormatMetrics>

Parameters:

aMoreTextMode - The more-text mode to be stored by the more-text mode property.

Returns:

The builder for applying multiple build operations.

withHeaderMoreTextMode

default ColumnSetupMetrics withHeaderMoreTextMode(MoreTextMode aMoreTextMode)

Sets a more-text mode for the header and returns this ColumnFormatMetrics instance as of the Builder-Pattern.

Specified by:

withHeaderMoreTextMode in interface ColumnFormatMetrics

Parameters:

aMoreTextMode - The MoreTextMode to be used for truncating the text.

Returns:

This TableBuilder instance to continue configuration.

withRowMoreTextMode

default ColumnSetupMetrics withRowMoreTextMode(MoreTextMode aMoreTextMode)

Sets a more-text mode for the row and returns this ColumnFormatMetrics instance as of the Builder-Pattern.

Specified by:

withRowMoreTextMode in interface ColumnFormatMetrics

Parameters:

aMoreTextMode - The MoreTextMode to be used for truncating the text.

Returns:

This TableBuilder instance to continue configuration.

withTextFormatMode

default ColumnSetupMetrics withTextFormatMode(TextFormatMode aTextFormatMode)

Sets the text-format mode for the text-format mode property.

Specified by:

withTextFormatMode in interface ColumnFormatMetrics

Specified by:

withTextFormatMode in interface TextFormatModeAccessor.TextFormatModeBuilder<ColumnFormatMetrics>

Parameters:

aTextFormatMode - The text-format mode to be stored by the text-format mode property.

Returns:

The builder for applying multiple build operations.

withSplitTextMode

default ColumnSetupMetrics withSplitTextMode(SplitTextMode aSplitTextMode)

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

Specified by:

withSplitTextMode in interface ColumnFormatMetrics

Specified by:

withSplitTextMode in interface SplitTextModeAccessor.SplitTextModeBuilder<ColumnFormatMetrics>

Parameters:

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

Returns:

The builder for applying multiple build operations.

withHeaderSplitTextMode

default ColumnSetupMetrics withHeaderSplitTextMode(SplitTextMode aSplitTextMode)

Sets the SplitTextMode for the header and returns this ColumnFormatMetrics instance as of the Builder-Pattern.

Specified by:

withHeaderSplitTextMode in interface ColumnFormatMetrics

Parameters:

aSplitTextMode - The SplitTextMode to be set for the header;

Returns:

This TableBuilder instance to continue configuration.

withRowSplitTextMode

default ColumnSetupMetrics withRowSplitTextMode(SplitTextMode aSplitTextMode)

Sets the SplitTextMode for the row and returns this ColumnFormatMetrics instance as of the Builder-Pattern.

Specified by:

withRowSplitTextMode in interface ColumnFormatMetrics

Parameters:

aSplitTextMode - The SplitTextMode to be set for the row;

Returns:

This TableBuilder instance to continue configuration.

withHeaderTextFormatMode

default ColumnSetupMetrics withHeaderTextFormatMode(TextFormatMode aTextFormatMode)

Sets the TextFormatMode for the header and returns this ColumnFormatMetrics instance as of the Builder-Pattern.

Specified by:

withHeaderTextFormatMode in interface ColumnFormatMetrics

Parameters:

aTextFormatMode - The TextFormatMode to be set for the header;

Returns:

This TableBuilder instance to continue configuration.

withRowTextFormatMode

default ColumnSetupMetrics withRowTextFormatMode(TextFormatMode aTextFormatMode)

Sets the TextFormatMode for the row and returns this ColumnFormatMetrics instance as of the Builder-Pattern.

Specified by:

withRowTextFormatMode in interface ColumnFormatMetrics

Parameters:

aTextFormatMode - The TextFormatMode to be set for the row;

Returns:

This TableBuilder instance to continue configuration.

withEscapeCodeFactory

default ColumnSetupMetrics withEscapeCodeFactory(EscapeCodeFactory aEscapeCodeFactory)

Sets an ANSI Escape-Code factory for the header and the rows and returns this ColumnFormatMetrics instance as of the Builder-Pattern. In case an ANSI Escape-Code has been determined by the EscapeCodeFactory, then the ANSI Escape-Code is prepended and an ANSI Reset-Code is appended to the according text being printed.

Specified by:

withEscapeCodeFactory in interface ColumnFormatMetrics

Parameters:

aEscapeCodeFactory - The EscapeCodeFactory to be used for determining ANSI escaping.

Returns:

This ColumnFormatMetrics instance to continue configuration.

withHeaderEscapeCodeFactory

default ColumnSetupMetrics withHeaderEscapeCodeFactory(EscapeCodeFactory aEscapeCodeFactory)

Sets an ANSI Escape-Code factory for the header and the rows and returns this ColumnFormatMetrics instance as of the Builder-Pattern. In case an ANSI Escape-Code has been determined by the EscapeCodeFactory, then the ANSI Escape-Code is prepended and an ANSI Reset-Code is appended to the according text being printed.

Specified by:

withHeaderEscapeCodeFactory in interface ColumnFormatMetrics

Parameters:

aEscapeCodeFactory - The EscapeCodeFactory to be used for determining ANSI escaping.

Returns:

the column format metrics

withRowEscapeCodeFactory

default ColumnSetupMetrics withRowEscapeCodeFactory(EscapeCodeFactory aEscapeCodeFactory)

Sets an ANSI Escape-Code factory for the row and the rows and returns this ColumnFormatMetrics instance as of the Builder-Pattern. In case an ANSI Escape-Code has been determined by the EscapeCodeFactory, then the ANSI Escape-Code is prepended and an ANSI Reset-Code is appended to the according text being printed.

Specified by:

withRowEscapeCodeFactory in interface ColumnFormatMetrics

Parameters:

aEscapeCodeFactory - The EscapeCodeFactory to be used for determining ANSI escaping.

Returns:

the column format metrics

fromColumnSetupMetrics

default void fromColumnSetupMetrics(ColumnSetupMetrics aColumnSetupMetrics)

From column setup metrics.

Parameters:

aColumnSetupMetrics - the column setup metrics