ca.randolf.fx.textmode

Class Chr

Object

ca.randolf.fx.textmode.Chr

public class Chr
extends Object

The Chr class encapsulates a single character (intended for display within a TextRegion) and all its attributes (the on-screen position is not included because it is managed independently by the TextRegion class).

The usual event listeners can also be tracked on a per-character basis with this class, and will gracefully disappear once removed from the TextRegion (and there is an event that can be listened to for that as well).

The name "Chr" was chosen to prevent confusion with Java's "char" primitive and the "java.lang.Character" class, and also embraces the obvious nature of this class by duplicating the functionally similar "Chr" keyword used in some well-known software technologies (e.g., Perl, BASIC, PostgreSQL, etc.) that first became popular in the pre-GUI computing era.

Nested Class Summary

Nested Classes

Modifier and Type

Class and Description

static class

Chr.Cmd The Chr.Cmd class provides a subset of the TextRegion.Cmd class's static constants that are supported by the "randolf.fx.textmode.Chr" class. While the constants hold the same values as those by the same names in the TextRegion.Cmd class, it's important to note that the Chr class is specific in its scope that focuses only on static attributes such as the foreground and background colours, effects (e.g., underline, bold, etc.), and so on.

Constructor Summary

Constructors

Constructor and Description
Chr(byte chr, int... cmds) Basic "Chr" constructor, starting with the character only. Attributes are optional, but if defined will override TextRegion defaults.
Chr(char chr, int... cmds) Basic "Chr" constructor, starting with the character only. Attributes are optional, but if defined will override TextRegion defaults.
Chr(int chr, int... cmds) Basic "Chr" constructor, starting with the character only. Attributes are optional, but if defined will override TextRegion defaults.
Chr(int chr, int bg_argb_int, int fg_argb_int, boolean underline, boolean strike, boolean blink, boolean transparent, boolean reverse, boolean hidden, int... cmds) Advanced "Chr" constructor, starting with the character, its colours, and all attributes, which will override TextRegion defaults. Additional attributes are optional.
Chr(int chr, TextRegion tr, int... cmds) Autonomic "Chr" constructor, starting with the character, and a TextRegion object upon which to base its attribute defaults. Additional attributes are optional.
Chr(String chr, int... cmds) Basic "Chr" constructor, starting with the character only. Attributes are optional, but if defined will override TextRegion defaults.

Method Summary

Modifier and Type	Method and Description
Chr	clone() Instantiate a new Chr object that is a duplicate of this one.
int	getBackground() Returns the current BACKGROUND colour attribute. If the attribute was not set, then the default of BLACK will be returned.
int	getForeground() Returns the current FOREGROUND colour attribute. If the attribute was not set, then the default of WHITE will be returned.
boolean	isBackgroundDefined() Indicates whether the BACKGROUND colour attribute is set.
boolean	isBlink() Indicates the current status of the BLINK attribute. If the BLINK attribute was not set, then FALSE will be returned.
boolean	isBlinkDefined() Indicates whether the BLINK attribute was set.
boolean	isChanged() Indicates whether this character needs to be re-drawn (this setting is normally only managed by the owning TextRegion object).
boolean	isForegroundDefined() Indicates whether the FOREGROUND colour attribute is set.
boolean	isHidden() Indicates the current status of the HIDDEN attribute. If the attribute was not set, then FALSE will be returned.
boolean	isHiddenDefined() Indicates whether the HIDDEN attribute was set.
boolean	isReverse() Indicates the current status of the REVERSE attribute. If the attribute was not set, then FALSE will be returned.
boolean	isReverseDefined() Indicates whether the REVERSE attribute was set.
boolean	isStrike() Indicates the current status of the STRIKE attribute. If the attribute was not set, then FALSE will be returned.
boolean	isStrikeDefined() Indicates whether the STRIKE attribute was set.
boolean	isTransparent() Indicates the current status of the TRANSPARENT attribute. If the attribute was not set, then FALSE will be returned.
boolean	isTransparentDefined() Indicates whether the TRANSPARENT attribute was set.
boolean	isUnderline() Indicates the current status of the UNDERLINE attribute. If the attribute was not set, then FALSE will be returned.
boolean	isUnderlineDefined() Indicates whether the UNDERLINE attribute was set.
Chr	set(int... cmds) Alters the value of any number of parameters (in any order).
Chr	setChanged(boolean changed) Sets the internal "changed" flag (this setting is normally only managed by the owning TextRegion object).
Chr	setColours(int bg_argb_int, int fg_argb_int) Specify both the background and foreground colours (formatted as ARGB integers).
char	toChar() Returns the current character as a native "char" type.
int	toInteger() Returns the current character's ASCII (or other) value as an integer.
static Chr	zero(int bg_argb_int, int fg_argb_int) Instantiate a new Chr object that is character 0 using the specified background and foreground colours (formatted as ARGB integers).
static Chr	zero(int bg_argb_int, int fg_argb_int, boolean underline, boolean strike, boolean blink, boolean transparent, boolean reverse, boolean hidden) Instantiate a new Chr object that is character 0 using the specified background and foreground colours (formatted as ARGB integers), and various other attributes (which should normally all be "FALSE" by default).
static Chr	zero(TextRegion tr) Instantiate a new Chr object that is character 0 using the specified background and foreground colours (formatted as ARGB integers).

Methods inherited from class Object

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

Constructor Detail

Chr

public Chr(byte chr,
           int... cmds)

Basic "Chr" constructor, starting with the character only. Attributes are optional, but if defined will override TextRegion defaults.

Parameters:

chr - Character code to use (e.g., by its ASCII value), as a byte (which will be interpreted as an unsigned byte)

cmds - Attribute commands (and their required parameters)

See Also:

set(int...), TextRegion.Cmd

Chr

public Chr(char chr,
           int... cmds)

Basic "Chr" constructor, starting with the character only. Attributes are optional, but if defined will override TextRegion defaults.

Parameters:

chr - The native "char" to use

cmds - Attribute commands (and their required parameters)

See Also:

set(int...), TextRegion.Cmd

Chr

public Chr(int chr,
           int... cmds)

Basic "Chr" constructor, starting with the character only. Attributes are optional, but if defined will override TextRegion defaults.

Parameters:

chr - Character code to use (e.g., by its ASCII value)

cmds - Attribute commands (and their required parameters)

See Also:

set(int...), TextRegion.Cmd

Chr

public Chr(int chr,
           int bg_argb_int,
           int fg_argb_int,
           boolean underline,
           boolean strike,
           boolean blink,
           boolean transparent,
           boolean reverse,
           boolean hidden,
           int... cmds)

Advanced "Chr" constructor, starting with the character, its colours, and all attributes, which will override TextRegion defaults. Additional attributes are optional.

Parameters:

chr - Character code to use (e.g., by its ASCII value)

bg_argb_int - Background colour

fg_argb_int - Foreground colour

underline - underline attribute

strike - strike-through attribute

blink - blink attribute

transparent - transparency attribute

reverse - reverse attribute

hidden - hidden attribute

cmds - Attribute commands (and their required parameters)

See Also:

set(int...), TextRegion.Cmd

Chr

public Chr(int chr,
           TextRegion tr,
           int... cmds)

Autonomic "Chr" constructor, starting with the character, and a TextRegion object upon which to base its attribute defaults. Additional attributes are optional.

Parameters:

chr - Character code to use (e.g., by its ASCII value)

tr - TextRegion object to obtain colour and other attributes from

cmds - Attribute commands (and their required parameters)

See Also:

set(int...), TextRegion.Cmd

Chr

public Chr(String chr,
           int... cmds)

Basic "Chr" constructor, starting with the character only. Attributes are optional, but if defined will override TextRegion defaults.

Parameters:

chr - The String to obtain the first native "char" from (NULL or empty String will be interpreted as character 0)

cmds - Attribute commands (and their required parameters)

See Also:

set(int...), TextRegion.Cmd

Method Detail

clone

public Chr clone()

Instantiate a new Chr object that is a duplicate of this one.

Overrides:

clone in class Object

Returns:

Chr - the new Chr object

getBackground

public int getBackground()

Returns the current BACKGROUND colour attribute. If the attribute was not set, then the default of BLACK will be returned.

Returns:

boolean

See Also:

isBackgroundDefined(), Chr.Cmd.BLACK

getForeground

public int getForeground()

Returns the current FOREGROUND colour attribute. If the attribute was not set, then the default of WHITE will be returned.

Returns:

boolean

See Also:

isForegroundDefined(), Chr.Cmd.WHITE

isBackgroundDefined

public boolean isBackgroundDefined()

Indicates whether the BACKGROUND colour attribute is set.

Returns:

boolean TRUE = set / FALSE = cleared (not defined)

See Also:

getBackground()

isBlink

public boolean isBlink()

Indicates the current status of the BLINK attribute. If the BLINK attribute was not set, then FALSE will be returned.

Returns:

boolean

See Also:

isBlinkDefined()

isBlinkDefined

public boolean isBlinkDefined()

Indicates whether the BLINK attribute was set.

Returns:

boolean TRUE = set / FALSE = cleared (not defined)

See Also:

isBlink()

isChanged

public boolean isChanged()

Indicates whether this character needs to be re-drawn (this setting is normally only managed by the owning TextRegion object).

Returns:

boolean

See Also:

setChanged(boolean)

isForegroundDefined

public boolean isForegroundDefined()

Indicates whether the FOREGROUND colour attribute is set.

Returns:

boolean TRUE = set / FALSE = cleared (not defined)

See Also:

getForeground()

isHidden

public boolean isHidden()

Indicates the current status of the HIDDEN attribute. If the attribute was not set, then FALSE will be returned.

Returns:

boolean

See Also:

isHiddenDefined()

isHiddenDefined

public boolean isHiddenDefined()

Indicates whether the HIDDEN attribute was set.

Returns:

boolean TRUE = set / FALSE = cleared (not defined)

See Also:

isHidden()

isReverse

public boolean isReverse()

Indicates the current status of the REVERSE attribute. If the attribute was not set, then FALSE will be returned.

Returns:

boolean

See Also:

isReverseDefined()

isReverseDefined

public boolean isReverseDefined()

Indicates whether the REVERSE attribute was set.

Returns:

boolean TRUE = set / FALSE = cleared (not defined)

See Also:

isReverse()

isStrike

public boolean isStrike()

Indicates the current status of the STRIKE attribute. If the attribute was not set, then FALSE will be returned.

Returns:

boolean

See Also:

isStrikeDefined()

isStrikeDefined

public boolean isStrikeDefined()

Indicates whether the STRIKE attribute was set.

Returns:

boolean TRUE = set / FALSE = cleared (not defined)

See Also:

isStrike()

isTransparent

public boolean isTransparent()

Indicates the current status of the TRANSPARENT attribute. If the attribute was not set, then FALSE will be returned.

Returns:

boolean

See Also:

isTransparentDefined()

isTransparentDefined

public boolean isTransparentDefined()

Indicates whether the TRANSPARENT attribute was set.

Returns:

boolean TRUE = set / FALSE = cleared (not defined)

See Also:

isTransparent()

isUnderline

public boolean isUnderline()

Indicates the current status of the UNDERLINE attribute. If the attribute was not set, then FALSE will be returned.

Returns:

boolean

See Also:

isUnderlineDefined()

isUnderlineDefined

public boolean isUnderlineDefined()

Indicates whether the UNDERLINE attribute was set.

Returns:

boolean TRUE = set / FALSE = cleared (not defined)

See Also:

isUnderline()

set

public Chr set(int... cmds)

Alters the value of any number of parameters (in any order).

The following Attribute Commands, which are defined in the TextRegion.Cmd class, may be used (all others will be ignored):

• Foreground colour
• Background colour
• Background transparency
• Underline
• Strike-through
• Blink
• Reverse
• Hidden

Parameters:

cmds - Attribute commands (and their required parameters)

Returns:

This object, as a convenience

See Also:

Chr.Cmd

setChanged

public Chr setChanged(boolean changed)

Sets the internal "changed" flag (this setting is normally only managed by the owning TextRegion object).

Parameters:

-

Returns:

This object, as a convenience

See Also:

setChanged(boolean)

setColours

public Chr setColours(int bg_argb_int,
                      int fg_argb_int)

Specify both the background and foreground colours (formatted as ARGB integers).

Parameters:

bg_argb_int - Background colour

fg_argb_int - Foreground colour

Returns:

This object, as a convenience

toChar

public char toChar()

Returns the current character as a native "char" type.

Returns:

char Native "char" equivalent

toInteger

public int toInteger()

Returns the current character's ASCII (or other) value as an integer.

Returns:

int Character's value

zero

public static Chr zero(int bg_argb_int,
                       int fg_argb_int)

Instantiate a new Chr object that is character 0 using the specified background and foreground colours (formatted as ARGB integers).

Parameters:

bg_argb_int - Background colour

fg_argb_int - Foreground colour

Returns:

Chr - the new Chr(0) object

zero

public static Chr zero(int bg_argb_int,
                       int fg_argb_int,
                       boolean underline,
                       boolean strike,
                       boolean blink,
                       boolean transparent,
                       boolean reverse,
                       boolean hidden)

Instantiate a new Chr object that is character 0 using the specified background and foreground colours (formatted as ARGB integers), and various other attributes (which should normally all be "FALSE" by default).

Parameters:

bg_argb_int - Background colour

fg_argb_int - Foreground colour

underline - underline attribute

strike - strike-through attribute

blink - blink attribute

transparent - transparency attribute

reverse - reverse attribute

hidden - hidden attribute

Returns:

Chr - the new Chr(0) object

zero

public static Chr zero(TextRegion tr)

Instantiate a new Chr object that is character 0 using the specified background and foreground colours (formatted as ARGB integers).

Parameters:

tr - TextRegion object to obtain colour and other attributes from

Returns:

Chr - the new Chr(0) object