net.morimekta.console.chr

Class CharUtil

java.lang.Object

net.morimekta.console.chr.CharUtil

public class CharUtil
extends Object

Common character and console utilities. It can contain both standard unicode characters and unix console control sequences. Here also resides lots of helper methods related to calculating visible string length, that takes into account control sequences, non-width characters and double width characters.

Field Summary

Fields

Modifier and Type	Field and Description
static int	TAB_WIDTH

Method Summary

Modifier and Type	Method and Description
static String	clipWidth(String string, int width) Remove all printable characters after 'width' characters have been filled.
static String	expandTabs(String string) Expand tabs in string.
static String	expandTabs(String string, int tabWidth) Expand tabs in string.
static String	expandTabs(String string, int tabWidth, int offset) Expand tabs in string.
static String	leftJust(String string, int width)
static int	printableWidth(String string) How many single-characters worth of console real-estate will be taken up by this string if printed.
static String	rightJust(String string, int width)
static String	stripNonPrintable(String string) Strip string of all non-printable characters.

Methods inherited from class java.lang.Object

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

Field Detail

TAB_WIDTH

public static final int TAB_WIDTH

See Also:

Constant Field Values

Method Detail

printableWidth

public static int printableWidth(String string)

How many single-characters worth of console real-estate will be taken up by this string if printed. Control characters will be ignored, and double-width characters (CJK) will count as 2 width each. Strings containing carriage movement, CR, LF, unexpanded tabs etc are not allowed, and will cause an IllegalArgumentException.

Parameters:

string - The string to measure.

Returns:

The printed width.

expandTabs

public static String expandTabs(String string)

Expand tabs in string.

Parameters:

string - The string to expand.

Returns:

The expanded string.

expandTabs

public static String expandTabs(String string,
                                int tabWidth)

Expand tabs in string.

Parameters:

string - The string to expand.

tabWidth - The tab width.

Returns:

The expanded string.

expandTabs

public static String expandTabs(String string,
                                int tabWidth,
                                int offset)

Expand tabs in string.

Parameters:

string - The string to expand.

tabWidth - The tab width.

offset - The initial offset.

Returns:

The expanded string.

stripNonPrintable

public static String stripNonPrintable(String string)

Strip string of all non-printable characters.

Parameters:

string - The source string.

Returns:

The result without non-printable chars.

clipWidth

public static String clipWidth(String string,
                               int width)

Remove all printable characters after 'width' characters have been filled. All control chars will be left in place.

Parameters:

string - The base string.

width - The printed width.

Returns:

The clipped string.

leftJust

public static String leftJust(String string,
                              int width)

rightJust

public static String rightJust(String string,
                               int width)