ColumnFormatMetrics (org.refcodes:refcodes-textual 1.1.9 API)

All Superinterfaces:

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, SplitTextModeAccessor.SplitTextModeBuilder<ColumnFormatMetrics>, SplitTextModeAccessor.SplitTextModeMutator, TextFormatModeAccessor.TextFormatModeBuilder<ColumnFormatMetrics>, TextFormatModeAccessor.TextFormatModeMutator

All Known Subinterfaces:

ColumnSetupMetrics

All Known Implementing Classes:

ColumnFormatMetricsImpl, ColumnSetupMetricsImpl
```
public interface ColumnFormatMetrics
extends ColumnWidthMetrics, SplitTextModeAccessor.SplitTextModeMutator, SplitTextModeAccessor.SplitTextModeBuilder<ColumnFormatMetrics>, TextFormatModeAccessor.TextFormatModeMutator, TextFormatModeAccessor.TextFormatModeBuilder<ColumnFormatMetrics>, HorizAlignTextModeAccessor.HorizAlignTextModeMutator, HorizAlignTextModeAccessor.HorizAlignTextModeBuilder<ColumnFormatMetrics>, MoreTextModeAccessor.MoreTextModeMutator, MoreTextModeAccessor.MoreTextModeBuilder<ColumnFormatMetrics>
```
The Interface ColumnFormatMetrics.

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

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default void`	`fromColumnFormatMetrics(ColumnFormatMetrics aColumnFormatMetrics)` From column format metrics.
`String`	`getHeaderEscapeCode()` Returns the ANSI Escape-Code for the header.
`EscapeCodeFactory`	`getHeaderEscapeCodeFactory()` Gets the ANSI Escape-Code factory for the header.
`HorizAlignTextMode`	`getHeaderHorizAlignTextMode()` Gets the alignment mode for the header.
`MoreTextMode`	`getHeaderMoreTextMode()` Gets the alignment mode for the header.
`SplitTextMode`	`getHeaderSplitTextMode()` Returns the `SplitTextMode` for the header.
`TextFormatMode`	`getHeaderTextFormatMode()` Returns the `TextFormatMode` for the header.
`String`	`getRowEscapeCode()` Returns the ANSI Escape-Code for the rows and returns this `ColumnFormatMetrics` instance as of the Builder-Pattern.
`EscapeCodeFactory`	`getRowEscapeCodeFactory()` Gets the ANSI Escape-Code factory for the row.
`HorizAlignTextMode`	`getRowHorizAlignTextMode()` Gets the alignment mode for the row.
`MoreTextMode`	`getRowMoreTextMode()` Gets the alignment mode for the row.
`SplitTextMode`	`getRowSplitTextMode()` Returns the `SplitTextMode` for the row.
`TextFormatMode`	`getRowTextFormatMode()` Returns the `TextFormatMode` for the row.
`default void`	`setEscapeCode(String aEscapeCode)` Sets an ANSI Escape-Code for the header and the rows.
`default void`	`setEscapeCodeFactory(EscapeCodeFactory aEscapeCodeFactory)` Sets an ANSI Escape-Code factory for the header and the rows.
`void`	`setHeaderEscapeCode(String aEscapeCode)` Sets an ANSI Escape-Code for the header.
`void`	`setHeaderEscapeCodeFactory(EscapeCodeFactory aEscapeCodeFactory)` Sets an ANSI Escape-Code factory for the header.
`void`	`setHeaderHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)` Sets an alignment mode for the header.
`void`	`setHeaderMoreTextMode(MoreTextMode aMoreTextMode)` Sets a more-text mode for the header.
`void`	`setHeaderSplitTextMode(SplitTextMode aSplitTextMode)` Sets the `SplitTextMode` for the header.
`void`	`setHeaderTextFormatMode(TextFormatMode aTextFormatMode)` Sets the `TextFormatMode` for the header.
`default void`	`setHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)` Sets the horizontal align text mode for the horizontal align text mode property.
`default void`	`setMoreTextMode(MoreTextMode aMoreTextMode)` Sets the more-text mode for the more-text mode property.
`void`	`setRowEscapeCode(String aEscapeCode)` Sets an ANSI Escape-Code for the rows and returns this `ColumnFormatMetrics` instance as of the Builder-Pattern.
`void`	`setRowEscapeCodeFactory(EscapeCodeFactory aEscapeCodeFactory)` Sets an ANSI Escape-Code factory for the row.
`void`	`setRowHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)` Sets an alignment mode for the row.
`void`	`setRowMoreTextMode(MoreTextMode aMoreTextMode)` Sets a more-text mode for the row.
`void`	`setRowSplitTextMode(SplitTextMode aSplitTextMode)` Sets the `SplitTextMode` for the row.
`void`	`setRowTextFormatMode(TextFormatMode aTextFormatMode)` Sets the `TextFormatMode` for the row.
`default void`	`setSplitTextMode(SplitTextMode aSplitTextMode)` Sets the split-text mode for the split-text mode property.
`default void`	`setTextFormatMode(TextFormatMode aTextFormatMode)` Sets the text-format mode for the text-format mode property.
`String`	`toHeaderEscapeCode(Object aIdentifier)` Determines the ANSI Escape-Code by evaluating the provided ID: If an `EscapeCodeFactory` has been set via `setEscapeCodeFactory(EscapeCodeFactory)` and the factory returns a value different to null, then this value is returned.
`String`	`toRowEscapeCode(Object aIdentifier)` Determines the ANSI Escape-Code by evaluating the provided ID: If an `EscapeCodeFactory` has been set via `setEscapeCodeFactory(EscapeCodeFactory)` and the factory returns a value different to null, then this value is returned.
`default ColumnFormatMetrics`	`withColumnWidth(int aColumnWidth)`
`default ColumnFormatMetrics`	`withColumnWidthType(ColumnWidthType aColumnWidthType)` With column width type.
`default ColumnFormatMetrics`	`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 ColumnFormatMetrics`	`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 ColumnFormatMetrics`	`withHeaderEscapeCode(String aEscapeCode)` Sets an ANSI Escape-Code for the header and returns this `ColumnFormatMetrics` instance as of the Builder-Pattern.
`default ColumnFormatMetrics`	`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 ColumnFormatMetrics`	`withHeaderHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)` Sets an alignment mode for the header and returns this `ColumnFormatMetrics` instance as of the Builder-Pattern.
`default ColumnFormatMetrics`	`withHeaderMoreTextMode(MoreTextMode aMoreTextMode)` Sets a more-text mode for the header and returns this `ColumnFormatMetrics` instance as of the Builder-Pattern.
`default ColumnFormatMetrics`	`withHeaderSplitTextMode(SplitTextMode aSplitTextMode)` Sets the `SplitTextMode` for the header and returns this `ColumnFormatMetrics` instance as of the Builder-Pattern.
`default ColumnFormatMetrics`	`withHeaderTextFormatMode(TextFormatMode aTextFormatMode)` Sets the `TextFormatMode` for the header and returns this `ColumnFormatMetrics` instance as of the Builder-Pattern.
`default ColumnFormatMetrics`	`withHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)` Sets the horizontal align text mode for the horizontal align text mode property.
`default ColumnFormatMetrics`	`withMoreTextMode(MoreTextMode aMoreTextMode)` Sets the more-text mode for the more-text mode property.
`default ColumnFormatMetrics`	`withRowEscapeCode(String aEscapeCode)` Sets an ANSI Escape-Code for the rows and returns this `ColumnFormatMetrics` instance as of the Builder-Pattern.
`default ColumnFormatMetrics`	`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 ColumnFormatMetrics`	`withRowHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)` Sets an alignment mode for the row and returns this `ColumnFormatMetrics` instance as of the Builder-Pattern.
`default ColumnFormatMetrics`	`withRowMoreTextMode(MoreTextMode aMoreTextMode)` Sets a more-text mode for the row and returns this `ColumnFormatMetrics` instance as of the Builder-Pattern.
`default ColumnFormatMetrics`	`withRowSplitTextMode(SplitTextMode aSplitTextMode)` Sets the `SplitTextMode` for the row and returns this `ColumnFormatMetrics` instance as of the Builder-Pattern.
`default ColumnFormatMetrics`	`withRowTextFormatMode(TextFormatMode aTextFormatMode)` Sets the `TextFormatMode` for the row and returns this `ColumnFormatMetrics` instance as of the Builder-Pattern.
`default ColumnFormatMetrics`	`withSplitTextMode(SplitTextMode aSplitTextMode)` Sets the split-text mode for the split-text mode property.
`default ColumnFormatMetrics`	`withTextFormatMode(TextFormatMode aTextFormatMode)` Sets the text-format mode for the text-format mode property.

Methods inherited from interface org.refcodes.textual.ColumnWidthMetrics
fromColumnWidthMetrics, getColumnWidthType, setColumnWidthType

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

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

- Method Detail
  - withEscapeCode
```
default ColumnFormatMetrics 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.
    
    Parameters:
    
    aEscapeCode - The String to be used for ANSI escaping.
    
    Returns:
    
    This ColumnFormatMetrics instance to continue configuration.
  - withEscapeCodeFactory
```
default ColumnFormatMetrics 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.
    
    Parameters:
    
    aEscapeCodeFactory - The EscapeCodeFactory to be used for determining ANSI escaping.
    
    Returns:
    
    This ColumnFormatMetrics instance to continue configuration.
  - setEscapeCodeFactory
```
default void setEscapeCodeFactory(EscapeCodeFactory aEscapeCodeFactory)
```
    Sets an ANSI Escape-Code factory for the header and the rows. 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.
    
    Parameters:
    
    aEscapeCodeFactory - The EscapeCodeFactory to be used for determining ANSI escaping.
  - withHeaderEscapeCodeFactory
```
default ColumnFormatMetrics 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.
    
    Parameters:
    
    aEscapeCodeFactory - The EscapeCodeFactory to be used for determining ANSI escaping.
    
    Returns:
    
    the column format metrics
  - setHeaderEscapeCodeFactory
```
void setHeaderEscapeCodeFactory(EscapeCodeFactory aEscapeCodeFactory)
```
    Sets an ANSI Escape-Code factory for the header. 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.
    
    Parameters:
    
    aEscapeCodeFactory - The EscapeCodeFactory to be used for determining ANSI escaping.
  - getHeaderEscapeCodeFactory
```
EscapeCodeFactory getHeaderEscapeCodeFactory()
```
    Gets the ANSI Escape-Code factory for the header. 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.
    
    Returns:
    
    The EscapeCodeFactory to be used for determining ANSI escaping.
  - toHeaderEscapeCode
```
String toHeaderEscapeCode(Object aIdentifier)
```
    Determines the ANSI Escape-Code by evaluating the provided ID: If an EscapeCodeFactory has been set via setEscapeCodeFactory(EscapeCodeFactory) and the factory returns a value different to null, then this value is returned. Else the value returned by getHeaderEscapeCode() is returned as fallback.
    
    Parameters:
    
    aIdentifier - The ID for which to lookup an Escape-Code.
    
    Returns:
    
    The identified Escape-Code or null if none was identifiable.
  - withRowEscapeCodeFactory
```
default ColumnFormatMetrics 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.
    
    Parameters:
    
    aEscapeCodeFactory - The EscapeCodeFactory to be used for determining ANSI escaping.
    
    Returns:
    
    the column format metrics
  - setRowEscapeCodeFactory
```
void setRowEscapeCodeFactory(EscapeCodeFactory aEscapeCodeFactory)
```
    Sets an ANSI Escape-Code factory for the row. 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.
    
    Parameters:
    
    aEscapeCodeFactory - The EscapeCodeFactory to be used for determining ANSI escaping. configuration.
  - getRowEscapeCodeFactory
```
EscapeCodeFactory getRowEscapeCodeFactory()
```
    Gets the ANSI Escape-Code factory for the row. 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.
    
    Returns:
    
    The EscapeCodeFactory to be used for determining ANSI escaping.
  - toRowEscapeCode
```
String toRowEscapeCode(Object aIdentifier)
```
    Determines the ANSI Escape-Code by evaluating the provided ID: If an EscapeCodeFactory has been set via setEscapeCodeFactory(EscapeCodeFactory) and the factory returns a value different to null, then this value is returned. Else the value returned by getRowEscapeCode() is returned as fallback.
    
    Parameters:
    
    aIdentifier - The ID for which to lookup an Escape-Code.
    
    Returns:
    
    The identified Escape-Code or null if none was identifiable.
  - setEscapeCode
```
default void setEscapeCode(String aEscapeCode)
```
    Sets an ANSI Escape-Code for the header and the rows. 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.
    
    Parameters:
    
    aEscapeCode - The String to be used for ANSI escaping.
  - withHeaderEscapeCode
```
default ColumnFormatMetrics 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.
    
    Parameters:
    
    aEscapeCode - The String to be used for ANSI escaping.
    
    Returns:
    
    This ColumnFormatMetrics instance to continue configuration.
  - setHeaderEscapeCode
```
void setHeaderEscapeCode(String aEscapeCode)
```
    Sets an ANSI Escape-Code for the header. 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.
    
    Parameters:
    
    aEscapeCode - The String to be used for ANSI escaping.
  - getHeaderEscapeCode
```
String getHeaderEscapeCode()
```
    Returns the ANSI Escape-Code for the header. 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.
    
    Returns:
    
    The String to be used for ANSI escaping.
  - withRowEscapeCode
```
default ColumnFormatMetrics 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.
    
    Parameters:
    
    aEscapeCode - The String to be used for ANSI escaping.
    
    Returns:
    
    This ColumnFormatMetrics instance to continue configuration.
  - setRowEscapeCode
```
void setRowEscapeCode(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.
    
    Parameters:
    
    aEscapeCode - The String to be used for ANSI escaping.
  - getRowEscapeCode
```
String getRowEscapeCode()
```
    Returns the ANSI Escape-Code for the rows and returns this ColumnFormatMetrics instance as of the Builder-Pattern. The latest ANSI Escape-Code being set wins.
    
    Returns:
    
    The String to be used for ANSI escaping.
  - withColumnWidth
```
default ColumnFormatMetrics withColumnWidth(int aColumnWidth)
```
    Specified by:
    
    withColumnWidth in interface org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthBuilder<ColumnWidthMetrics>
  - withColumnWidthType
```
default ColumnFormatMetrics withColumnWidthType(ColumnWidthType aColumnWidthType)
```
    With column width type.
    
    Specified by:
    
    withColumnWidthType in interface ColumnWidthMetrics
    
    Parameters:
    
    aColumnWidthType - the a column width type
    
    Returns:
    
    the column width metrics
  - withHorizAlignTextMode
```
default ColumnFormatMetrics withHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)
```
    Sets the horizontal align text mode for the horizontal align text mode property.
    
    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.
  - setHorizAlignTextMode
```
default void setHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)
```
    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.
  - withHeaderHorizAlignTextMode
```
default ColumnFormatMetrics withHeaderHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)
```
    Sets an alignment mode for the header and returns this ColumnFormatMetrics instance as of the Builder-Pattern.
    
    Parameters:
    
    aHorizAlignTextMode - The HorizAlignTextMode to be used for aligning the text.
    
    Returns:
    
    This TableBuilder instance to continue configuration.
  - setHeaderHorizAlignTextMode
```
void setHeaderHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)
```
    Sets an alignment mode for the header.
    
    Parameters:
    
    aHorizAlignTextMode - The HorizAlignTextMode to be used for aligning the text.
  - getHeaderHorizAlignTextMode
```
HorizAlignTextMode getHeaderHorizAlignTextMode()
```
    Gets the alignment mode for the header.
    
    Returns:
    
    The HorizAlignTextMode to be used for aligning the text.
  - withRowHorizAlignTextMode
```
default ColumnFormatMetrics withRowHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)
```
    Sets an alignment mode for the row and returns this ColumnFormatMetrics instance as of the Builder-Pattern.
    
    Parameters:
    
    aHorizAlignTextMode - The HorizAlignTextMode to be used for aligning the text.
    
    Returns:
    
    This TableBuilder instance to continue configuration.
  - setRowHorizAlignTextMode
```
void setRowHorizAlignTextMode(HorizAlignTextMode aHorizAlignTextMode)
```
    Sets an alignment mode for the row.
    
    Parameters:
    
    aHorizAlignTextMode - The HorizAlignTextMode to be used for aligning the text.
  - getRowHorizAlignTextMode
```
HorizAlignTextMode getRowHorizAlignTextMode()
```
    Gets the alignment mode for the row.
    
    Returns:
    
    The HorizAlignTextMode to be used for aligning the text.
  - withMoreTextMode
```
default ColumnFormatMetrics withMoreTextMode(MoreTextMode aMoreTextMode)
```
    Sets the more-text mode for the more-text mode property.
    
    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.
  - setMoreTextMode
```
default void setMoreTextMode(MoreTextMode aMoreTextMode)
```
    Sets the more-text mode for the more-text mode property.
    
    Specified by:
    
    setMoreTextMode in interface MoreTextModeAccessor.MoreTextModeMutator
    
    Parameters:
    
    aMoreTextMode - The more-text mode to be stored by the more-text mode property.
  - withHeaderMoreTextMode
```
default ColumnFormatMetrics withHeaderMoreTextMode(MoreTextMode aMoreTextMode)
```
    Sets a more-text mode for the header and returns this ColumnFormatMetrics instance as of the Builder-Pattern.
    
    Parameters:
    
    aMoreTextMode - The MoreTextMode to be used for truncating the text.
    
    Returns:
    
    This TableBuilder instance to continue configuration.
  - setHeaderMoreTextMode
```
void setHeaderMoreTextMode(MoreTextMode aMoreTextMode)
```
    Sets a more-text mode for the header.
    
    Parameters:
    
    aMoreTextMode - The MoreTextMode to be used for truncating the text.
  - getHeaderMoreTextMode
```
MoreTextMode getHeaderMoreTextMode()
```
    Gets the alignment mode for the header.
    
    Returns:
    
    The MoreTextMode to be used for truncating the text.
  - withRowMoreTextMode
```
default ColumnFormatMetrics withRowMoreTextMode(MoreTextMode aMoreTextMode)
```
    Sets a more-text mode for the row and returns this ColumnFormatMetrics instance as of the Builder-Pattern.
    
    Parameters:
    
    aMoreTextMode - The MoreTextMode to be used for truncating the text.
    
    Returns:
    
    This TableBuilder instance to continue configuration.
  - setRowMoreTextMode
```
void setRowMoreTextMode(MoreTextMode aMoreTextMode)
```
    Sets a more-text mode for the row.
    
    Parameters:
    
    aMoreTextMode - The MoreTextMode to be used for truncating the text.
  - getRowMoreTextMode
```
MoreTextMode getRowMoreTextMode()
```
    Gets the alignment mode for the row.
    
    Returns:
    
    The MoreTextMode to be used for truncating the text.
  - withTextFormatMode
```
default ColumnFormatMetrics withTextFormatMode(TextFormatMode aTextFormatMode)
```
    Sets the text-format mode for the text-format mode property.
    
    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.
  - setTextFormatMode
```
default void setTextFormatMode(TextFormatMode aTextFormatMode)
```
    Sets the text-format mode for the text-format mode property.
    
    Specified by:
    
    setTextFormatMode in interface TextFormatModeAccessor.TextFormatModeMutator
    
    Parameters:
    
    aTextFormatMode - The text-format mode to be stored by the text-format mode property.
  - withSplitTextMode
```
default ColumnFormatMetrics withSplitTextMode(SplitTextMode aSplitTextMode)
```
    Sets the split-text mode for the split-text mode property.
    
    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.
  - setSplitTextMode
```
default void setSplitTextMode(SplitTextMode aSplitTextMode)
```
    Description copied from interface: SplitTextModeAccessor.SplitTextModeMutator
    
    Sets the split-text mode for the split-text mode property.
    
    Specified by:
    
    setSplitTextMode in interface SplitTextModeAccessor.SplitTextModeMutator
    
    Parameters:
    
    aSplitTextMode - The split-text mode to be stored by the split-text mode property.
  - setHeaderSplitTextMode
```
void setHeaderSplitTextMode(SplitTextMode aSplitTextMode)
```
    Sets the SplitTextMode for the header.
    
    Parameters:
    
    aSplitTextMode - The SplitTextMode to be set for the header;
  - getHeaderSplitTextMode
```
SplitTextMode getHeaderSplitTextMode()
```
    Returns the SplitTextMode for the header.
    
    Returns:
    
    The SplitTextMode to be set for the header;
  - withHeaderSplitTextMode
```
default ColumnFormatMetrics withHeaderSplitTextMode(SplitTextMode aSplitTextMode)
```
    Sets the SplitTextMode for the header and returns this ColumnFormatMetrics instance as of the Builder-Pattern.
    
    Parameters:
    
    aSplitTextMode - The SplitTextMode to be set for the header;
    
    Returns:
    
    This TableBuilder instance to continue configuration.
  - setRowSplitTextMode
```
void setRowSplitTextMode(SplitTextMode aSplitTextMode)
```
    Sets the SplitTextMode for the row.
    
    Parameters:
    
    aSplitTextMode - The SplitTextMode to be set for the row;
  - getRowSplitTextMode
```
SplitTextMode getRowSplitTextMode()
```
    Returns the SplitTextMode for the row.
    
    Returns:
    
    The SplitTextMode to be set for the row;
  - withRowSplitTextMode
```
default ColumnFormatMetrics withRowSplitTextMode(SplitTextMode aSplitTextMode)
```
    Sets the SplitTextMode for the row and returns this ColumnFormatMetrics instance as of the Builder-Pattern.
    
    Parameters:
    
    aSplitTextMode - The SplitTextMode to be set for the row;
    
    Returns:
    
    This TableBuilder instance to continue configuration.
  - setHeaderTextFormatMode
```
void setHeaderTextFormatMode(TextFormatMode aTextFormatMode)
```
    Sets the TextFormatMode for the header.
    
    Parameters:
    
    aTextFormatMode - The TextFormatMode to be set for the header;
  - getHeaderTextFormatMode
```
TextFormatMode getHeaderTextFormatMode()
```
    Returns the TextFormatMode for the header.
    
    Returns:
    
    The TextFormatMode to be set for the header;
  - withHeaderTextFormatMode
```
default ColumnFormatMetrics withHeaderTextFormatMode(TextFormatMode aTextFormatMode)
```
    Sets the TextFormatMode for the header and returns this ColumnFormatMetrics instance as of the Builder-Pattern.
    
    Parameters:
    
    aTextFormatMode - The TextFormatMode to be set for the header;
    
    Returns:
    
    This TableBuilder instance to continue configuration.
  - setRowTextFormatMode
```
void setRowTextFormatMode(TextFormatMode aTextFormatMode)
```
    Sets the TextFormatMode for the row.
    
    Parameters:
    
    aTextFormatMode - The TextFormatMode to be set for the row;
  - getRowTextFormatMode
```
TextFormatMode getRowTextFormatMode()
```
    Returns the TextFormatMode for the row.
    
    Returns:
    
    The TextFormatMode to be set for the row;
  - withRowTextFormatMode
```
default ColumnFormatMetrics withRowTextFormatMode(TextFormatMode aTextFormatMode)
```
    Sets the TextFormatMode for the row and returns this ColumnFormatMetrics instance as of the Builder-Pattern.
    
    Parameters:
    
    aTextFormatMode - The TextFormatMode to be set for the row;
    
    Returns:
    
    This TableBuilder instance to continue configuration.
  - fromColumnFormatMetrics
```
default void fromColumnFormatMetrics(ColumnFormatMetrics aColumnFormatMetrics)
```
    From column format metrics.
    
    Parameters:
    
    aColumnFormatMetrics - the a column format metrics

Interface ColumnFormatMetrics

Nested Class Summary

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

Method Summary

Methods inherited from interface org.refcodes.textual.ColumnWidthMetrics

Methods inherited from interface org.refcodes.mixin.ColumnWidthAccessor

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

Method Detail

withEscapeCode

withEscapeCodeFactory

setEscapeCodeFactory

withHeaderEscapeCodeFactory

setHeaderEscapeCodeFactory

getHeaderEscapeCodeFactory

toHeaderEscapeCode

withRowEscapeCodeFactory

setRowEscapeCodeFactory

getRowEscapeCodeFactory

toRowEscapeCode

setEscapeCode

withHeaderEscapeCode

setHeaderEscapeCode

getHeaderEscapeCode

withRowEscapeCode

setRowEscapeCode

getRowEscapeCode

withColumnWidth

withColumnWidthType

withHorizAlignTextMode

setHorizAlignTextMode

withHeaderHorizAlignTextMode

setHeaderHorizAlignTextMode

getHeaderHorizAlignTextMode

withRowHorizAlignTextMode

setRowHorizAlignTextMode

getRowHorizAlignTextMode

withMoreTextMode

setMoreTextMode

withHeaderMoreTextMode

setHeaderMoreTextMode

getHeaderMoreTextMode

withRowMoreTextMode

setRowMoreTextMode

getRowMoreTextMode

withTextFormatMode

setTextFormatMode

withSplitTextMode

setSplitTextMode

setHeaderSplitTextMode

getHeaderSplitTextMode

withHeaderSplitTextMode

setRowSplitTextMode

getRowSplitTextMode

withRowSplitTextMode

setHeaderTextFormatMode

getHeaderTextFormatMode

withHeaderTextFormatMode

setRowTextFormatMode

getRowTextFormatMode

withRowTextFormatMode

fromColumnFormatMetrics