Module org.refcodes.textual
Package org.refcodes.textual

Interface ColumnWidthMetrics

All Superinterfaces:
org.refcodes.mixin.ColumnWidthAccessor, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthBuilder<ColumnWidthMetrics>, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthMutator, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthProperty
All Known Subinterfaces:
ColumnFormatMetrics, ColumnSetupMetrics
All Known Implementing Classes:
ColumnFormatMetricsImpl, ColumnSetupMetricsImpl, ColumnWidthMetricsImpl
public interface ColumnWidthMetrics extends org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthProperty, org.refcodes.mixin.ColumnWidthAccessor.ColumnWidthBuilder<ColumnWidthMetrics>
This interface specifies means to define a width either as percentage or absolute, e.g. in the number of chars.

  • 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

    Modifier and Type
    Method
    Description
    default void
    fromColumnWidthMetrics(ColumnWidthMetrics aColumnWidthMetrics)
    From column width metrics.
    ColumnWidthType
    getColumnWidthType()
    The type of the width being provided, either percent (%) or number of chars.
    void
    setColumnWidthType(ColumnWidthType aColumnWidthType)
    Sets the column width type.
    default ColumnWidthMetrics
    withColumnWidthType(ColumnWidthType aColumnWidthType)
    With column width type.

    Methods inherited from interface org.refcodes.mixin.ColumnWidthAccessor

    getColumnWidth

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

    withColumnWidth

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

    setColumnWidth

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

    letColumnWidth

  • Method Details

    • getColumnWidthType

      ColumnWidthType getColumnWidthType()
      The type of the width being provided, either percent (%) or number of chars.
      Returns:
      The column's width type, either percent (%) or number of chars.

    • setColumnWidthType

      void setColumnWidthType(ColumnWidthType aColumnWidthType)
      Sets the column width type.
      Parameters:
      aColumnWidthType - the new column width type

    • withColumnWidthType

      default ColumnWidthMetrics withColumnWidthType(ColumnWidthType aColumnWidthType)
      With column width type.
      Parameters:
      aColumnWidthType - the column width type
      Returns:
      the column width metrics

    • fromColumnWidthMetrics

      default void fromColumnWidthMetrics(ColumnWidthMetrics aColumnWidthMetrics)
      From column width metrics.
      Parameters:
      aColumnWidthMetrics - the column width metrics