TextCharacter (Lanterna 3.0.4 API)

java.lang.Object
- com.googlecode.lanterna.TextCharacter

```
public class TextCharacter
extends Object
```
Represents a single character with additional metadata such as colors and modifiers. This class is immutable and cannot be modified after creation.

Author:

Martin

Field Summary

Fields
Modifier and Type Field Description

static TextCharacter DEFAULT_CHARACTER

Fields
Modifier and Type	Field	Description
`static TextCharacter`	`DEFAULT_CHARACTER`

Constructor Summary

Constructors
Constructor	Description
`TextCharacter(char character)`	Creates a `ScreenCharacter` based on a supplied character, with default colors and no extra modifiers.
`TextCharacter(char character, TextColor foregroundColor, TextColor backgroundColor, SGR... styles)`	Creates a new `ScreenCharacter` based on a physical character, color information and optional modifiers.
`TextCharacter(char character, TextColor foregroundColor, TextColor backgroundColor, EnumSet<SGR> modifiers)`	Creates a new `ScreenCharacter` based on a physical character, color information and a set of modifiers.
`TextCharacter(TextCharacter character)`	Copies another `ScreenCharacter`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object obj)`
`TextColor`	`getBackgroundColor()`	Background color specified for this TextCharacter
`char`	`getCharacter()`	The actual character this TextCharacter represents
`TextColor`	`getForegroundColor()`	Foreground color specified for this TextCharacter
`EnumSet<SGR>`	`getModifiers()`	Returns a set of all active modifiers on this TextCharacter
`int`	`hashCode()`
`boolean`	`isBlinking()`	Returns true if this TextCharacter has the blink modifier active
`boolean`	`isBold()`	Returns true if this TextCharacter has the bold modifier active
`boolean`	`isBordered()`	Returns true if this TextCharacter has the bordered modifier active
`boolean`	`isCrossedOut()`	Returns true if this TextCharacter has the crossed-out modifier active
`boolean`	`isDoubleWidth()`
`boolean`	`isItalic()`	Returns true if this TextCharacter has the italic modifier active
`boolean`	`isReversed()`	Returns true if this TextCharacter has the reverse modifier active
`boolean`	`isUnderlined()`	Returns true if this TextCharacter has the underline modifier active
`String`	`toString()`
`TextCharacter`	`withBackgroundColor(TextColor backgroundColor)`	Returns a copy of this TextCharacter with a specified background color
`TextCharacter`	`withCharacter(char character)`	Returns a new TextCharacter with the same colors and modifiers but a different underlying character
`TextCharacter`	`withForegroundColor(TextColor foregroundColor)`	Returns a copy of this TextCharacter with a specified foreground color
`TextCharacter`	`withModifier(SGR modifier)`	Returns a copy of this TextCharacter with an additional SGR modifier.
`TextCharacter`	`withModifiers(Collection<SGR> modifiers)`	Returns a copy of this TextCharacter with specified list of SGR modifiers.
`TextCharacter`	`withoutModifier(SGR modifier)`	Returns a copy of this TextCharacter with an SGR modifier removed.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_CHARACTER
```
public static final TextCharacter DEFAULT_CHARACTER
```
- Constructor Detail
  - TextCharacter
```
public TextCharacter(char character)
```
    Creates a ScreenCharacter based on a supplied character, with default colors and no extra modifiers.
    
    Parameters:
    
    character - Physical character to use
  - TextCharacter
```
public TextCharacter(TextCharacter character)
```
    Copies another ScreenCharacter
    
    Parameters:
    
    character - screenCharacter to copy from
  - TextCharacter
```
public TextCharacter(char character,
                     TextColor foregroundColor,
                     TextColor backgroundColor,
                     SGR... styles)
```
    Creates a new ScreenCharacter based on a physical character, color information and optional modifiers.
    
    Parameters:
    
    character - Physical character to refer to
    
    foregroundColor - Foreground color the character has
    
    backgroundColor - Background color the character has
    
    styles - Optional list of modifiers to apply when drawing the character
  - TextCharacter
```
public TextCharacter(char character,
                     TextColor foregroundColor,
                     TextColor backgroundColor,
                     EnumSet<SGR> modifiers)
```
    Creates a new ScreenCharacter based on a physical character, color information and a set of modifiers.
    
    Parameters:
    
    character - Physical character to refer to
    
    foregroundColor - Foreground color the character has
    
    backgroundColor - Background color the character has
    
    modifiers - Set of modifiers to apply when drawing the character
- Method Detail
  - getCharacter
```
public char getCharacter()
```
    The actual character this TextCharacter represents
    
    Returns:
    
    character of the TextCharacter
  - getForegroundColor
```
public TextColor getForegroundColor()
```
    Foreground color specified for this TextCharacter
    
    Returns:
    
    Foreground color of this TextCharacter
  - getBackgroundColor
```
public TextColor getBackgroundColor()
```
    Background color specified for this TextCharacter
    
    Returns:
    
    Background color of this TextCharacter
  - getModifiers
```
public EnumSet<SGR> getModifiers()
```
    Returns a set of all active modifiers on this TextCharacter
    
    Returns:
    
    Set of active SGR codes
  - isBold
```
public boolean isBold()
```
    Returns true if this TextCharacter has the bold modifier active
    
    Returns:
    
    true if this TextCharacter has the bold modifier active
  - isReversed
```
public boolean isReversed()
```
    Returns true if this TextCharacter has the reverse modifier active
    
    Returns:
    
    true if this TextCharacter has the reverse modifier active
  - isUnderlined
```
public boolean isUnderlined()
```
    Returns true if this TextCharacter has the underline modifier active
    
    Returns:
    
    true if this TextCharacter has the underline modifier active
  - isBlinking
```
public boolean isBlinking()
```
    Returns true if this TextCharacter has the blink modifier active
    
    Returns:
    
    true if this TextCharacter has the blink modifier active
  - isBordered
```
public boolean isBordered()
```
    Returns true if this TextCharacter has the bordered modifier active
    
    Returns:
    
    true if this TextCharacter has the bordered modifier active
  - isCrossedOut
```
public boolean isCrossedOut()
```
    Returns true if this TextCharacter has the crossed-out modifier active
    
    Returns:
    
    true if this TextCharacter has the crossed-out modifier active
  - isItalic
```
public boolean isItalic()
```
    Returns true if this TextCharacter has the italic modifier active
    
    Returns:
    
    true if this TextCharacter has the italic modifier active
  - withCharacter
```
public TextCharacter withCharacter(char character)
```
    Returns a new TextCharacter with the same colors and modifiers but a different underlying character
    
    Parameters:
    
    character - Character the copy should have
    
    Returns:
    
    Copy of this TextCharacter with different underlying character
  - withForegroundColor
```
public TextCharacter withForegroundColor(TextColor foregroundColor)
```
    Returns a copy of this TextCharacter with a specified foreground color
    
    Parameters:
    
    foregroundColor - Foreground color the copy should have
    
    Returns:
    
    Copy of the TextCharacter with a different foreground color
  - withBackgroundColor
```
public TextCharacter withBackgroundColor(TextColor backgroundColor)
```
    Returns a copy of this TextCharacter with a specified background color
    
    Parameters:
    
    backgroundColor - Background color the copy should have
    
    Returns:
    
    Copy of the TextCharacter with a different background color
  - withModifiers
```
public TextCharacter withModifiers(Collection<SGR> modifiers)
```
    Returns a copy of this TextCharacter with specified list of SGR modifiers. None of the currently active SGR codes will be carried over to the copy, only those in the passed in value.
    
    Parameters:
    
    modifiers - SGR modifiers the copy should have
    
    Returns:
    
    Copy of the TextCharacter with a different set of SGR modifiers
  - withModifier
```
public TextCharacter withModifier(SGR modifier)
```
    Returns a copy of this TextCharacter with an additional SGR modifier. All of the currently active SGR codes will be carried over to the copy, in addition to the one specified.
    
    Parameters:
    
    modifier - SGR modifiers the copy should have in additional to all currently present
    
    Returns:
    
    Copy of the TextCharacter with a new SGR modifier
  - withoutModifier
```
public TextCharacter withoutModifier(SGR modifier)
```
    Returns a copy of this TextCharacter with an SGR modifier removed. All of the currently active SGR codes will be carried over to the copy, except for the one specified. If the current TextCharacter doesn't have the SGR specified, it will return itself.
    
    Parameters:
    
    modifier - SGR modifiers the copy should not have
    
    Returns:
    
    Copy of the TextCharacter without the SGR modifier
  - isDoubleWidth
```
public boolean isDoubleWidth()
```
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class TextCharacter

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_CHARACTER

Constructor Detail

TextCharacter

TextCharacter

TextCharacter

TextCharacter

Method Detail

getCharacter

getForegroundColor

getBackgroundColor

getModifiers

isBold

isReversed

isUnderlined

isBlinking

isBordered

isCrossedOut

isItalic

withCharacter

withForegroundColor

withBackgroundColor

withModifiers

withModifier

withoutModifier

isDoubleWidth

equals

hashCode

toString