dev.jeka.core.api.text

Class Jk2ColumnsText

java.lang.Object

dev.jeka.core.api.text.Jk2ColumnsText

public class Jk2ColumnsText
extends java.lang.Object

Utility class that allows formatting text into two columns. Each column consists of a left and right section separated by a delimiter.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<dev.jeka.core.api.text.Jk2ColumnsText.Row>	rows

Method Summary

Modifier and Type	Method and Description
Jk2ColumnsText	add(java.lang.String left, java.lang.Object right) Adds a new row with the given left and right values.
static Jk2ColumnsText	of(int leftSize, int maxSize) Creates a new instance of Jk2ColumnsText with the given left size and maximum size.
static Jk2ColumnsText	of(int leftSize, int maxSize, java.lang.String delimiter) Creates a new instance of Jk2ColumnsText with the given parameters.
Jk2ColumnsText	setAdjustLeft(boolean adjustLeft) Sets the adjustLeft flag.
Jk2ColumnsText	setMarginLeft(java.lang.String marginLeft) Sets the left margin for displaying the whole result;
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

rows

public final java.util.List<dev.jeka.core.api.text.Jk2ColumnsText.Row> rows

Method Detail

of

public static Jk2ColumnsText of(int leftSize,
                                int maxSize,
                                java.lang.String delimiter)

Creates a new instance of Jk2ColumnsText with the given parameters.

Parameters:

leftSize - the size of the left column

maxSize - the maximum overall size of each row in the text

delimiter - the delimiter used to separate the columns

of

public static Jk2ColumnsText of(int leftSize,
                                int maxSize)

Creates a new instance of Jk2ColumnsText with the given left size and maximum size. Uses the delimiter " : ".

See Also:

of(int, int, String)

add

public Jk2ColumnsText add(java.lang.String left,
                          java.lang.Object right)

Adds a new row with the given left and right values.

setAdjustLeft

public Jk2ColumnsText setAdjustLeft(boolean adjustLeft)

Sets the adjustLeft flag. When set to true, the left column will adjust its size to accommodate longer left values. When set to false, the left column will be truncated to the specified size.

Initial value is true

setMarginLeft

public Jk2ColumnsText setMarginLeft(java.lang.String marginLeft)

Sets the left margin for displaying the whole result;

Parameters:

marginLeft - the left margin to set

Returns:

the modified Jk2ColumnsText object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object