Chr.Cmd (Randolf's Java library)

Object
- ca.randolf.fx.textmode.Chr.Cmd

Enclosing class:

Chr
```
public static class Chr.Cmd
extends Object
```
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.
This static class is included as a subordinate to the Chr class as a convenience for developers to make it easier to find in the documentation.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BG_ARGB` Specifies the background as an ARGB colour, which also includes the alpha channel blending value that specifies the level of opacity.
`static int`	`BG_ARGB_INT` Specifies the background as an ARGB colour integer, which also includes the alpha channel blending value that specifies the level of opacity.
`static int`	`BG_BGRA` Specifies the background as an BGRA colour, which also includes the alpha channel blending value that specifies the level of opacity.
`static int`	`BG_BGRA_INT` Specifies the background as an BGRA colour integer, which also includes the alpha channel blending value that specifies the level of opacity.
`static int`	`BG_RGB` Specifies the background as an RGB colour.
`static int`	`BG_RGB_INT` Specifies the background as an RGB colour integer.
`static int`	`BG_VGA` Specifies the background colour by its VGA text mode colour index number, which must be within the range of 0 through 15 (additional bits will be ignored).
`static int`	`BLACK` The colour BLACK. Also VGA text mode colour index 0.
`static int`	`BLINK_CLEAR` Clear the BLINK attribute setting.
`static int`	`BLINK_OFF` Disable the BLINK attribute.
`static int`	`BLINK_ON` Enable the BLINK attribute.
`static int`	`BLUE` The colour BLUE. Also VGA text mode colour index 1.
`static int`	`BRIGHT_BLUE` The colour BRIGHT_BLUE. Also VGA text mode colour index 9.
`static int`	`BRIGHT_CYAN` The colour BRIGHT_CYAN. Also VGA text mode colour index 11.
`static int`	`BRIGHT_GREEN` An alias for LIME.
`static int`	`BRIGHT_RED` The colour BRIGHT_RED. Also VGA text mode colour index 12.
`static int`	`BRIGHT_WHITE` The colour WHITE. Also VGA text mode colour index 15.
`static int`	`BROWN` The colour BROWN. Also VGA text mode colour index 6.
`static int`	`CYAN` The colour CYAN. Also VGA text mode colour index 3.
`static int`	`FG_ARGB` Specifies the foreground as an ARGB colour, which also includes the alpha channel blending value that specifies the level of opacity.
`static int`	`FG_ARGB_INT` Specifies the foreground as an ARGB colour integer, which also includes the alpha channel blending value that specifies the level of opacity.
`static int`	`FG_BGRA` Specifies the foreground as an BGRA colour, which also includes the alpha channel blending value that specifies the level of opacity.
`static int`	`FG_BGRA_INT` Specifies the foreground as an BGRA colour integer, which also includes the alpha channel blending value that specifies the level of opacity.
`static int`	`FG_RGB` Specifies the foreground as an RGB colour.
`static int`	`FG_RGB_INT` Specifies the foreground as an RGB colour integer.
`static int`	`FG_VGA` Specifies the foreground colour by its VGA text mode colour index number, which must be within the range of 0 through 15 (additional bits will be ignored).
`static int`	`GRAY` An alias for GREY.
`static int`	`GREEN` The colour GREEN. Also VGA text mode colour index 2.
`static int`	`GREY` The colour GREY. Also VGA text mode colour index 8.
`static int`	`HIDDEN_CLEAR` Clear the HIDDEN attribute.
`static int`	`HIDDEN_OFF` Disable the HIDDEN attribute.
`static int`	`HIDDEN_ON` Enable the HIDDEN attribute.
`static int`	`LIME` The colour LIME. Also VGA text mode colour index 10.
`static int`	`PINK` The colour PINK. Also VGA text mode colour index 13.
`static int`	`PURPLE` The colour PURPLE. Also VGA text mode colour index 5.
`static int`	`RED` The colour RED. Also VGA text mode colour index 4.
`static int`	`REVERSE_CLEAR` Clear the REVERSE attribute.
`static int`	`REVERSE_OFF` Disable the REVERSE attribute.
`static int`	`REVERSE_ON` Enable the REVERSE attribute.
`static int`	`STRIKE_CLEAR` Clear the STRIKE attribute.
`static int`	`STRIKE_OFF` Disable the STRIKE attribute.
`static int`	`STRIKE_ON` Enable the STRIKE attribute.
`static int`	`TRANSPARENT_CLEAR` Clear the TRANSPARENT attribute.
`static int`	`TRANSPARENT_OFF` Disable the TRANSPARENT attribute.
`static int`	`TRANSPARENT_ON` Enable the TRANSPARENT attribute.
`static int`	`UNDERLINE_CLEAR` Clear the UNDERLINE attribute.
`static int`	`UNDERLINE_OFF` Disable the UNDERLINE attribute.
`static int`	`UNDERLINE_ON` Enable the UNDERLINE attribute.
`static int`	`WHITE` The colour WHITE. Also VGA text mode colour index 7.
`static int`	`YELLOW` The colour YELLOW. Also VGA text mode colour index 14.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`colorToARGB(javafx.scene.paint.Color c)` Converts a javafx.scene.paint.Color object to an ARGB-formatted integer.
`static int`	`colorToBGRA(javafx.scene.paint.Color c)` Converts a javafx.scene.paint.Color object to a BGRA-formatted integer.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BG_ARGB
```
public static final int BG_ARGB
```
    Specifies the background as an ARGB colour, which also includes the alpha channel blending value that specifies the level of opacity.
    Arguments:
    1. Alpha channel value (0 through 255)
    2. Red colour value (0 through 255)
    3. Green colour value (0 through 255)
    4. Blue colour value (0 through 255)
    See Also:
    
    FG_VGA, Constant Field Values
  - BG_ARGB_INT
```
public static final int BG_ARGB_INT
```
    Specifies the background as an ARGB colour integer, which also includes the alpha channel blending value that specifies the level of opacity.
    Arguments:
    1. ARGB colour number as a single integer
    See Also:
    
    BG_VGA, Constant Field Values
  - BG_BGRA
```
public static final int BG_BGRA
```
    Specifies the background as an BGRA colour, which also includes the alpha channel blending value that specifies the level of opacity.
    Arguments:
    1. Blue colour value (0 through 255)
    2. Green colour value (0 through 255)
    3. Red colour value (0 through 255)
    4. Alpha channel value (0 through 255)
    See Also:
    
    BG_VGA, Constant Field Values
  - BG_BGRA_INT
```
public static final int BG_BGRA_INT
```
    Specifies the background as an BGRA colour integer, which also includes the alpha channel blending value that specifies the level of opacity.
    Arguments:
    1. BGRA colour number as a single integer
    See Also:
    
    BG_VGA, Constant Field Values
  - BG_RGB
```
public static final int BG_RGB
```
    Specifies the background as an RGB colour.
    Arguments:
    1. Red colour value (0 through 255)
    2. Green colour value (0 through 255)
    3. Blue colour value (0 through 255)
    See Also:
    
    BG_VGA, Constant Field Values
  - BG_RGB_INT
```
public static final int BG_RGB_INT
```
    Specifies the background as an RGB colour integer.
    Arguments:
    1. RGB colour number as a single integer
    See Also:
    
    BG_VGA, Constant Field Values
  - BG_VGA
```
public static final int BG_VGA
```
    Specifies the background colour by its VGA text mode colour index number, which must be within the range of 0 through 15 (additional bits will be ignored).
    These are the standard 16 basic colours, which are also provided by name as constant ("static final") values, and should suffice for remaining historically consistent with actual text-mode application colours.
    Arguments:
    1. VGA text mode colour index (0 through 15)
    See Also:
    
    Constant Field Values
  - BLACK
```
public static final int BLACK
```
    The colour BLACK. Also VGA text mode colour index 0.
    
    See Also:
    
    Constant Field Values
  - BLINK_CLEAR
```
public static final int BLINK_CLEAR
```
    Clear the BLINK attribute setting.
    Arguments: None
    
    See Also:
    
    Constant Field Values
  - BLINK_OFF
```
public static final int BLINK_OFF
```
    Disable the BLINK attribute.
    Arguments: None
    
    See Also:
    
    Constant Field Values
  - BLINK_ON
```
public static final int BLINK_ON
```
    Enable the BLINK attribute.
    Arguments: None
    
    See Also:
    
    Constant Field Values
  - BLUE
```
public static final int BLUE
```
    The colour BLUE. Also VGA text mode colour index 1.
    
    See Also:
    
    Constant Field Values
  - BRIGHT_BLUE
```
public static final int BRIGHT_BLUE
```
    The colour BRIGHT_BLUE. Also VGA text mode colour index 9.
    
    See Also:
    
    Constant Field Values
  - BRIGHT_CYAN
```
public static final int BRIGHT_CYAN
```
    The colour BRIGHT_CYAN. Also VGA text mode colour index 11.
    
    See Also:
    
    Constant Field Values
  - BRIGHT_GREEN
```
public static final int BRIGHT_GREEN
```
    An alias for LIME.
    
    See Also:
    
    Constant Field Values
  - BRIGHT_RED
```
public static final int BRIGHT_RED
```
    The colour BRIGHT_RED. Also VGA text mode colour index 12.
    
    See Also:
    
    Constant Field Values
  - BRIGHT_WHITE
```
public static final int BRIGHT_WHITE
```
    The colour WHITE. Also VGA text mode colour index 15.
    
    See Also:
    
    Constant Field Values
  - BROWN
```
public static final int BROWN
```
    The colour BROWN. Also VGA text mode colour index 6.
    
    See Also:
    
    Constant Field Values
  - CYAN
```
public static final int CYAN
```
    The colour CYAN. Also VGA text mode colour index 3.
    
    See Also:
    
    Constant Field Values
  - FG_ARGB
```
public static final int FG_ARGB
```
    Specifies the foreground as an ARGB colour, which also includes the alpha channel blending value that specifies the level of opacity.
    Arguments:
    1. Alpha channel value (0 through 255)
    2. Red colour value (0 through 255)
    3. Green colour value (0 through 255)
    4. Blue colour value (0 through 255)
    See Also:
    
    FG_VGA, Constant Field Values
  - FG_ARGB_INT
```
public static final int FG_ARGB_INT
```
    Specifies the foreground as an ARGB colour integer, which also includes the alpha channel blending value that specifies the level of opacity.
    Arguments:
    1. ARGB colour number as a single integer
    See Also:
    
    FG_VGA, Constant Field Values
  - FG_BGRA
```
public static final int FG_BGRA
```
    Specifies the foreground as an BGRA colour, which also includes the alpha channel blending value that specifies the level of opacity.
    Arguments:
    1. Blue colour value (0 through 255)
    2. Green colour value (0 through 255)
    3. Red colour value (0 through 255)
    4. Alpha channel value (0 through 255)
    See Also:
    
    FG_VGA, Constant Field Values
  - FG_BGRA_INT
```
public static final int FG_BGRA_INT
```
    Specifies the foreground as an BGRA colour integer, which also includes the alpha channel blending value that specifies the level of opacity.
    Arguments:
    1. BGRA colour number as a single integer
    See Also:
    
    FG_VGA, Constant Field Values
  - FG_RGB
```
public static final int FG_RGB
```
    Specifies the foreground as an RGB colour.
    Arguments:
    1. Red colour value (0 through 255)
    2. Green colour value (0 through 255)
    3. Blue colour value (0 through 255)
    See Also:
    
    FG_VGA, Constant Field Values
  - FG_RGB_INT
```
public static final int FG_RGB_INT
```
    Specifies the foreground as an RGB colour integer.
    Arguments:
    1. RGB colour number as a single integer
    See Also:
    
    FG_VGA, Constant Field Values
  - FG_VGA
```
public static final int FG_VGA
```
    Specifies the foreground colour by its VGA text mode colour index number, which must be within the range of 0 through 15 (additional bits will be ignored).
    These are the standard 16 basic colours, which are also provided by name as constant ("static final") values, and should suffice for remaining historically consistent with actual text-mode application colours.
    Arguments:
    1. VGA text mode colour index (0 through 15)
    See Also:
    
    Constant Field Values
  - GRAY
```
public static final int GRAY
```
    An alias for GREY.
    
    See Also:
    
    Constant Field Values
  - GREEN
```
public static final int GREEN
```
    The colour GREEN. Also VGA text mode colour index 2.
    
    See Also:
    
    Constant Field Values
  - GREY
```
public static final int GREY
```
    The colour GREY. Also VGA text mode colour index 8.
    
    See Also:
    
    Constant Field Values
  - HIDDEN_CLEAR
```
public static final int HIDDEN_CLEAR
```
    Clear the HIDDEN attribute.
    Arguments: None
    
    See Also:
    
    Constant Field Values
  - HIDDEN_OFF
```
public static final int HIDDEN_OFF
```
    Disable the HIDDEN attribute.
    Arguments: None
    
    See Also:
    
    Constant Field Values
  - HIDDEN_ON
```
public static final int HIDDEN_ON
```
    Enable the HIDDEN attribute.
    Arguments: None
    
    See Also:
    
    Constant Field Values
  - LIME
```
public static final int LIME
```
    The colour LIME. Also VGA text mode colour index 10.
    
    See Also:
    
    Constant Field Values
  - PINK
```
public static final int PINK
```
    The colour PINK. Also VGA text mode colour index 13.
    
    See Also:
    
    Constant Field Values
  - PURPLE
```
public static final int PURPLE
```
    The colour PURPLE. Also VGA text mode colour index 5.
    
    See Also:
    
    Constant Field Values
  - RED
```
public static final int RED
```
    The colour RED. Also VGA text mode colour index 4.
    
    See Also:
    
    Constant Field Values
  - REVERSE_CLEAR
```
public static final int REVERSE_CLEAR
```
    Clear the REVERSE attribute.
    Arguments: None
    
    See Also:
    
    Constant Field Values
  - REVERSE_OFF
```
public static final int REVERSE_OFF
```
    Disable the REVERSE attribute.
    Arguments: None
    
    See Also:
    
    Constant Field Values
  - REVERSE_ON
```
public static final int REVERSE_ON
```
    Enable the REVERSE attribute.
    Arguments: None
    
    See Also:
    
    Constant Field Values
  - STRIKE_CLEAR
```
public static final int STRIKE_CLEAR
```
    Clear the STRIKE attribute.
    Arguments: None
    
    See Also:
    
    Constant Field Values
  - STRIKE_OFF
```
public static final int STRIKE_OFF
```
    Disable the STRIKE attribute.
    Arguments: None
    
    See Also:
    
    Constant Field Values
  - STRIKE_ON
```
public static final int STRIKE_ON
```
    Enable the STRIKE attribute.
    Arguments: None
    
    See Also:
    
    Constant Field Values
  - TRANSPARENT_CLEAR
```
public static final int TRANSPARENT_CLEAR
```
    Clear the TRANSPARENT attribute.
    Arguments: None
    
    See Also:
    
    Constant Field Values
  - TRANSPARENT_OFF
```
public static final int TRANSPARENT_OFF
```
    Disable the TRANSPARENT attribute.
    Arguments: None
    
    See Also:
    
    Constant Field Values
  - TRANSPARENT_ON
```
public static final int TRANSPARENT_ON
```
    Enable the TRANSPARENT attribute.
    Arguments: None
    
    See Also:
    
    Constant Field Values
  - UNDERLINE_CLEAR
```
public static final int UNDERLINE_CLEAR
```
    Clear the UNDERLINE attribute.
    Arguments: None
    
    See Also:
    
    Constant Field Values
  - UNDERLINE_OFF
```
public static final int UNDERLINE_OFF
```
    Disable the UNDERLINE attribute.
    Arguments: None
    
    See Also:
    
    Constant Field Values
  - UNDERLINE_ON
```
public static final int UNDERLINE_ON
```
    Enable the UNDERLINE attribute.
    Arguments: None
    
    See Also:
    
    Constant Field Values
  - WHITE
```
public static final int WHITE
```
    The colour WHITE. Also VGA text mode colour index 7.
    
    See Also:
    
    Constant Field Values
  - YELLOW
```
public static final int YELLOW
```
    The colour YELLOW. Also VGA text mode colour index 14.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - colorToARGB
```
public static int colorToARGB(javafx.scene.paint.Color c)
```
    Converts a javafx.scene.paint.Color object to an ARGB-formatted integer.
    
    Parameters:
    
    c - The colour to convert
    
    Returns:
    
    int Colour converted to an integer in ARGB format
  - colorToBGRA
```
public static int colorToBGRA(javafx.scene.paint.Color c)
```
    Converts a javafx.scene.paint.Color object to a BGRA-formatted integer.
    
    Parameters:
    
    c - The colour to convert
    
    Returns:
    
    int Colour converted to an integer in BGRA format

Class Chr.Cmd

Field Summary

Method Summary

Methods inherited from class Object

Field Detail

BG_ARGB

BG_ARGB_INT

BG_BGRA

BG_BGRA_INT

BG_RGB

BG_RGB_INT

BG_VGA

BLACK

BLINK_CLEAR

BLINK_OFF

BLINK_ON

BLUE

BRIGHT_BLUE

BRIGHT_CYAN

BRIGHT_GREEN

BRIGHT_RED

BRIGHT_WHITE

BROWN

CYAN

FG_ARGB

FG_ARGB_INT

FG_BGRA

FG_BGRA_INT

FG_RGB

FG_RGB_INT

FG_VGA

GRAY

GREEN

GREY

HIDDEN_CLEAR

HIDDEN_OFF

HIDDEN_ON

LIME

PINK

PURPLE

RED

REVERSE_CLEAR

REVERSE_OFF

REVERSE_ON

STRIKE_CLEAR

STRIKE_OFF

STRIKE_ON

TRANSPARENT_CLEAR

TRANSPARENT_OFF

TRANSPARENT_ON

UNDERLINE_CLEAR

UNDERLINE_OFF

UNDERLINE_ON

WHITE

YELLOW

Method Detail

colorToARGB

colorToBGRA