TextRegion.Cmd (Randolf's Java library)

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

Enclosing class:

TextRegion
```
public static class TextRegion.Cmd
extends Object
```
The TextRegion.Cmd class provides the complete set of static constants that are supported by the "randolf.fx.textmode" package.
This static class is included as a subordinate to the TextRegion 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`	`BOTTOM` Move the cursor to the bottom row.
`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`	`CENTRE` Move the cursor to the centre of the screen. Where an even number of rows or columns is in effect, the centre is decided by rounding off the result after dividing by the total number of rows and columns each by two.
`static int`	`CLEAR` Clear the screen and move the cursor to the top-left corner.
`static int`	`COL` An alias for X.
`static int`	`COLUMN` An alias for X.
`static int`	`CYAN` The colour CYAN. Also VGA text mode colour index 3.
`static int`	`DOWN` Move the cursor down one row, scrolling if already at the bottom (and the cursor advancement policy is top-to-bottom {default}).
`static int`	`END` Move the cursor to the right-most column.
`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`	`FILL` Fill the specified region with the specified character (without changing the position of the cursor) using the current foreground and background colours.
`static int`	`FILL_COLOUR` Fill the specified region with the specified background and foreground colours (without changing the position of the cursor) without changing any of the characters.
`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`	`HOME` Move the cursor to the left-most column.
`static int`	`LEFT` Move the cursor left one column, wrapping around the edge to the previous row as needed and without scrolling (and the cursor advancement policy is top-to-bottom {default}).
`static int`	`LIME` The colour LIME. Also VGA text mode colour index 10.
`static int`	`MOVE_DOWN` Move the cursor down one row, unless the cursor is already positioned on the bottom-most row.
`static int`	`MOVE_LEFT` Move the cursor left one column, unless the cursor is already positioned on the left-most column.
`static int`	`MOVE_RIGHT` Move the cursor right one column, unless the cursor is already positioned on the right-most column.
`static int`	`MOVE_UP` Move the cursor up one row, unless the cursor is already positioned on the top-most row.
`static int`	`NEWLINE` Advance the cursor to the beginning of the next row. If the cursor is already on the bottom row, then the entire TextRegion will be scrolled up by 1 row (the cursor will still be advanced to the first column).
`static int`	`PINK` The colour PINK. Also VGA text mode colour index 13.
`static int`	`PRINT` Add multiple characters to the TextRegion, and advance the cursor position accordingly.
`static int`	`PRINT_RAW` Add multiple characters to the TextRegion, and advance the cursor position accordingly.
`static int`	`PRINTCH` Add a single character to the TextRegion, and advance the cursor position accordingly.
`static int`	`PRINTCH_RAW` Add a single character to the TextRegion, and advance the cursor position accordingly.
`static int`	`PRINTLN` Add multiple characters to the TextRegion, and advance the cursor position accordingly, with NewLine added.
`static int`	`PRINTLN_RAW` Add multiple characters to the TextRegion, and advance the cursor position accordingly, with NewLine added.
`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`	`RESIZE_X` Specify a new size for the TextRegion by number of columns. Existing text will be retained if the new size is larger, or cropped if the new size is smaller. The cursor position will also be updated as needed in order to remain properly within the bounds of the TextRegion.
`static int`	`RESIZE_XY` Specify a new size for the TextRegion by number of columns and rows. Existing text will be retained if the new size is larger, or cropped if the new size is smaller. The cursor position will also be updated as needed in order to remain properly within the bounds of the TextRegion.
`static int`	`RESIZE_Y` Specify a new size for the TextRegion by number of rows. Existing text will be retained if the new size is larger, or cropped if the new size is smaller. The cursor position will also be updated as needed in order to remain properly within the bounds of the TextRegion.
`static int`	`RESIZE_YX` Specify a new size for the TextRegion by number of rows and columns. Existing text will be retained if the new size is larger, or cropped if the new size is smaller. The cursor position will also be updated as needed in order to remain properly within the bounds of the TextRegion.
`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`	`RIGHT` Move the cursor right one column, wrapping around the edge to the next row as needed and with scrolling also as needed (and the cursor advancement policy is top-to-bottom {default}).
`static int`	`ROW` An alias for Y.
`static int`	`SCROLL_DOWN` Scroll the entire region down by the specified number of rows (without changing the position of the cursor).
`static int`	`SCROLL_DOWN_AREA` Scroll the specified region down by the specified number of rows (without changing the position of the cursor).
`static int`	`SCROLL_LEFT` Scroll the entire region left by the specified number of columns (without changing the position of the cursor).
`static int`	`SCROLL_RIGHT` Scroll the entire region right by the specified number of columns (without changing the position of the cursor).
`static int`	`SCROLL_UP` Scroll the entire region up by the specified number of rows (without changing the position of the cursor).
`static int`	`SCROLL_UP_AREA` Scroll the specified region up by the specified number of rows (without changing the position of the cursor).
`static int`	`STRAFE_DOWN` Move the cursor down one row, or scroll up one row if the cursor is already positioned on the bottom-most row.
`static int`	`STRAFE_LEFT` Move the cursor left one column, or scroll right one column if the cursor is already positioned on the left-most column.
`static int`	`STRAFE_RIGHT` Move the cursor right one column, or scroll left one column if the cursor is already positioned on the right-most column.
`static int`	`STRAFE_UP` Move the cursor up one row, or scroll down one row if the cursor is already positioned on the top-most row.
`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`	`TOP` Move the cursor to the top row.
`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`	`UP` Move the cursor up one row, without scrolling if already at the top (and the cursor advancement policy is top-to-bottom {default}).
`static int`	`WHITE` The colour WHITE. Also VGA text mode colour index 7.
`static int`	`X` Specifies the column, or "X" coordinate, of the cursor.
`static int`	`XY` Next two arguments specify the current X and Y coordinates of the cursor, where X comes before Y.
`static int`	`Y` Specifies the row, or "Y" coordinate, of the cursor.
`static int`	`YELLOW` The colour YELLOW. Also VGA text mode colour index 14.
`static int`	`YX` Next two arguments specify the current Y and X coordinates of the cursor, where Y comes before X.

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
  - BOTTOM
```
public static final int BOTTOM
```
    Move the cursor to the bottom row.
    Arguments: None
    
    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
  - CENTRE
```
public static final int CENTRE
```
    Move the cursor to the centre of the screen. Where an even number of rows or columns is in effect, the centre is decided by rounding off the result after dividing by the total number of rows and columns each by two.
    Arguments: None
    
    See Also:
    
    Constant Field Values
  - CLEAR
```
public static final int CLEAR
```
    Clear the screen and move the cursor to the top-left corner.
    Arguments: None
    
    See Also:
    
    Constant Field Values
  - COL
```
public static final int COL
```
    An alias for X.
    
    See Also:
    
    X, Constant Field Values
  - COLUMN
```
public static final int COLUMN
```
    An alias for X.
    
    See Also:
    
    X, Constant Field Values
  - CYAN
```
public static final int CYAN
```
    The colour CYAN. Also VGA text mode colour index 3.
    
    See Also:
    
    Constant Field Values
  - DOWN
```
public static final int DOWN
```
    Move the cursor down one row, scrolling if already at the bottom (and the cursor advancement policy is top-to-bottom {default}).
    Arguments: None
    
    See Also:
    
    Constant Field Values
  - END
```
public static final int END
```
    Move the cursor to the right-most column.
    Arguments: None
    
    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
  - FILL
```
public static final int FILL
```
    Fill the specified region with the specified character (without changing the position of the cursor) using the current foreground and background colours.
    Arguments:
    1. Top row of area
    2. Left column of area
    3. Bottom row of area
    4. Right column of area
    5. Number of fill characters (0 or a positive integer)
    6. ...n Integer character values (0 through 255 with the default font)
    Note: Where the area exceeds the TextRegion, the area will be truncated accordingly. If the area specifies 0, no scrolling occurs, but negative row and/or column numbers are calculated as counting in reverse from the bottom or right edges respectively (with -1 indicating the final row or column, -2 indicating the penultimate row or column, etc.).
    Note: Fill character(s) will be cycled through repeatedly until the area is filled with them. If no characters are specified, then 0 will be used by default.
    See Also:
    
    Constant Field Values
  - FILL_COLOUR
```
public static final int FILL_COLOUR
```
    Fill the specified region with the specified background and foreground colours (without changing the position of the cursor) without changing any of the characters.
    Arguments:
    1. Top row of area
    2. Left column of area
    3. Bottom row of area
    4. Right column of area
    5. ARGB background colour number as a single integer
    6. ARGB foreground colour number as a single integer
    Note: Where the area exceeds the TextRegion, the area will be truncated accordingly. If the area specifies 0, no scrolling occurs, but negative row and/or column numbers are calculated as counting in reverse from the bottom or right edges respectively (with -1 indicating the final row or column, -2 indicating the penultimate row or column, etc.).
    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
  - HOME
```
public static final int HOME
```
    Move the cursor to the left-most column.
    Arguments: None
    
    See Also:
    
    Constant Field Values
  - LEFT
```
public static final int LEFT
```
    Move the cursor left one column, wrapping around the edge to the previous row as needed and without scrolling (and the cursor advancement policy is top-to-bottom {default}).
    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
  - MOVE_DOWN
```
public static final int MOVE_DOWN
```
    Move the cursor down one row, unless the cursor is already positioned on the bottom-most row.
    Arguments: None
    
    See Also:
    
    Constant Field Values
  - MOVE_LEFT
```
public static final int MOVE_LEFT
```
    Move the cursor left one column, unless the cursor is already positioned on the left-most column.
    Arguments: None
    
    See Also:
    
    Constant Field Values
  - MOVE_RIGHT
```
public static final int MOVE_RIGHT
```
    Move the cursor right one column, unless the cursor is already positioned on the right-most column.
    Arguments: None
    
    See Also:
    
    Constant Field Values
  - MOVE_UP
```
public static final int MOVE_UP
```
    Move the cursor up one row, unless the cursor is already positioned on the top-most row.
    Arguments: None
    
    See Also:
    
    Constant Field Values
  - NEWLINE
```
public static final int NEWLINE
```
    Advance the cursor to the beginning of the next row. If the cursor is already on the bottom row, then the entire TextRegion will be scrolled up by 1 row (the cursor will still be advanced to the first column).
    Arguments: None
    
    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
  - PRINT
```
public static final int PRINT
```
    Add multiple characters to the TextRegion, and advance the cursor position accordingly.
    Functional control characters will work as expected.
    Arguments:
    1. Number of characters
    2. ...n Integer character values (0 through 255 with the default font)
    See Also:
    
    Constant Field Values
  - PRINT_RAW
```
public static final int PRINT_RAW
```
    Add multiple characters to the TextRegion, and advance the cursor position accordingly.
    Functional control characters will not function, and will be displayed instead of working as expected.
    Arguments:
    1. Number of characters
    2. ...n Integer character values (0 through 255 with the default font)
    See Also:
    
    Constant Field Values
  - PRINTCH
```
public static final int PRINTCH
```
    Add a single character to the TextRegion, and advance the cursor position accordingly.
    Functional control characters will work as expected.
    Arguments:
    1. Character's integer value (0 through 255 with the default font)
    See Also:
    
    Constant Field Values
  - PRINTCH_RAW
```
public static final int PRINTCH_RAW
```
    Add a single character to the TextRegion, and advance the cursor position accordingly.
    Functional control characters will not function, and will be displayed instead of working as expected.
    Arguments:
    1. Character's integer value (0 through 255 with the default font)
    See Also:
    
    Constant Field Values
  - PRINTLN
```
public static final int PRINTLN
```
    Add multiple characters to the TextRegion, and advance the cursor position accordingly, with NewLine added.
    Functional control characters will work as expected.
    Arguments:
    1. Number of characters
    2. ...n Integer character values (0 through 255 with the default font)
    See Also:
    
    Constant Field Values
  - PRINTLN_RAW
```
public static final int PRINTLN_RAW
```
    Add multiple characters to the TextRegion, and advance the cursor position accordingly, with NewLine added.
    Functional control characters will not function, and will be displayed instead of working as expected.
    Arguments:
    1. Number of characters
    2. ...n Integer character values (0 through 255 with the default font)
    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
  - RESIZE_X
```
public static final int RESIZE_X
```
    Specify a new size for the TextRegion by number of columns. Existing text will be retained if the new size is larger, or cropped if the new size is smaller. The cursor position will also be updated as needed in order to remain properly within the bounds of the TextRegion.
    Arguments:
    1. Number of columns (must be greater than 0)
    See Also:
    
    RESIZE_Y, Constant Field Values
  - RESIZE_XY
```
public static final int RESIZE_XY
```
    Specify a new size for the TextRegion by number of columns and rows. Existing text will be retained if the new size is larger, or cropped if the new size is smaller. The cursor position will also be updated as needed in order to remain properly within the bounds of the TextRegion.
    Arguments:
    1. Number of columns (must be greater than 0)
    2. Number of rows (must be greater than 0)
    See Also:
    
    RESIZE_YX, Constant Field Values
  - RESIZE_Y
```
public static final int RESIZE_Y
```
    Specify a new size for the TextRegion by number of rows. Existing text will be retained if the new size is larger, or cropped if the new size is smaller. The cursor position will also be updated as needed in order to remain properly within the bounds of the TextRegion.
    Arguments:
    1. Number of rows (must be greater than 0)
    See Also:
    
    RESIZE_X, Constant Field Values
  - RESIZE_YX
```
public static final int RESIZE_YX
```
    Specify a new size for the TextRegion by number of rows and columns. Existing text will be retained if the new size is larger, or cropped if the new size is smaller. The cursor position will also be updated as needed in order to remain properly within the bounds of the TextRegion.
    Arguments:
    1. Number of rows (must be greater than 0)
    2. Number of columns (must be greater than 0)
    See Also:
    
    RESIZE_XY, 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
  - RIGHT
```
public static final int RIGHT
```
    Move the cursor right one column, wrapping around the edge to the next row as needed and with scrolling also as needed (and the cursor advancement policy is top-to-bottom {default}).
    Arguments: None
    
    See Also:
    
    Constant Field Values
  - ROW
```
public static final int ROW
```
    An alias for Y.
    
    See Also:
    
    Y, Constant Field Values
  - SCROLL_DOWN
```
public static final int SCROLL_DOWN
```
    Scroll the entire region down by the specified number of rows (without changing the position of the cursor).
    Arguments:
    1. Number of rows (should be greater than 0)
    Note: If the number of rows exceeds that of the TextRegion, then the clear() method will simply be called instead.
    Note: If the number of rows is 0 or less, then no scrolling occurs.
    See Also:
    
    SCROLL_UP, Constant Field Values
  - SCROLL_DOWN_AREA
```
public static final int SCROLL_DOWN_AREA
```
    Scroll the specified region down by the specified number of rows (without changing the position of the cursor).
    Arguments:
    1. Number of rows (should be greater than 0)
    2. Top row of area
    3. Left column of area
    4. Bottom row of area
    5. Right column of area
    Note: Where the area exceeds the TextRegion, the area will be truncated accordingly. If the area specifies 0, no scrolling occurs, but negative row and/or column numbers are calculated as counting in reverse from the bottom or right edges respectively (with -1 indicating the final row or column, -2 indicating the penultimate row or column, etc.).
    Note: If the number of rows is 0, no scrolling occurs. If the number or rows is negative, then scrolling occurs in the reverse direction instead.
    See Also:
    
    SCROLL_UP_AREA, Constant Field Values
  - SCROLL_LEFT
```
public static final int SCROLL_LEFT
```
    Scroll the entire region left by the specified number of columns (without changing the position of the cursor).
    Arguments:
    1. Number of columns (should be greater than 0)
    Note: If the number of columns exceeds that of the TextRegion, then the clear() method will simply be called instead.
    Note: If the number of columns is 0 or less, then no scrolling occurs.
    See Also:
    
    SCROLL_RIGHT, Constant Field Values
  - SCROLL_RIGHT
```
public static final int SCROLL_RIGHT
```
    Scroll the entire region right by the specified number of columns (without changing the position of the cursor).
    Arguments:
    1. Number of columns (should be greater than 0)
    Note: If the number of columns exceeds that of the TextRegion, then the clear() method will simply be called instead.
    Note: If the number of columns is 0 or less, then no scrolling occurs.
    See Also:
    
    SCROLL_LEFT, Constant Field Values
  - SCROLL_UP
```
public static final int SCROLL_UP
```
    Scroll the entire region up by the specified number of rows (without changing the position of the cursor).
    Arguments:
    1. Number of rows (should be greater than 0)
    Note: If the number of rows exceeds that of the TextRegion, then the clear() method will simply be called instead.
    Note: If the number of rows is 0 or less, then no scrolling occurs.
    See Also:
    
    SCROLL_DOWN, Constant Field Values
  - SCROLL_UP_AREA
```
public static final int SCROLL_UP_AREA
```
    Scroll the specified region up by the specified number of rows (without changing the position of the cursor).
    Arguments:
    1. Number of rows (should be greater than 0)
    2. Top row of area
    3. Left column of area
    4. Bottom row of area
    5. Right column of area
    Note: Where the area exceeds the TextRegion, the area will be truncated accordingly. If the area specifies 0, no scrolling occurs, but negative row and/or column numbers are calculated as counting in reverse from the bottom or right edges respectively (with -1 indicating the final row or column, -2 indicating the penultimate row or column, etc.).
    Note: If the number of rows is 0, no scrolling occurs. If the number or rows is negative, then scrolling occurs in the reverse direction instead.
    See Also:
    
    SCROLL_DOWN_AREA, Constant Field Values
  - STRAFE_DOWN
```
public static final int STRAFE_DOWN
```
    Move the cursor down one row, or scroll up one row if the cursor is already positioned on the bottom-most row.
    Arguments: None
    
    See Also:
    
    Constant Field Values
  - STRAFE_LEFT
```
public static final int STRAFE_LEFT
```
    Move the cursor left one column, or scroll right one column if the cursor is already positioned on the left-most column.
    Arguments: None
    
    See Also:
    
    Constant Field Values
  - STRAFE_RIGHT
```
public static final int STRAFE_RIGHT
```
    Move the cursor right one column, or scroll left one column if the cursor is already positioned on the right-most column.
    Arguments: None
    
    See Also:
    
    Constant Field Values
  - STRAFE_UP
```
public static final int STRAFE_UP
```
    Move the cursor up one row, or scroll down one row if the cursor is already positioned on the top-most row.
    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
  - TOP
```
public static final int TOP
```
    Move the cursor to the top row.
    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
  - UP
```
public static final int UP
```
    Move the cursor up one row, without scrolling if already at the top (and the cursor advancement policy is top-to-bottom {default}).
    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
  - X
```
public static final int X
```
    Specifies the column, or "X" coordinate, of the cursor.
    Arguments:
    1. Column number (starting from 0)
    As a convenience, a negative column number will be counted starting from the right, so a -1 will translate into the last column, -2 will translate into the penultimate column, and so on.
    Note: Any position that exceeds the range will be truncated to fit.
    See Also:
    
    XY, YX, Constant Field Values
  - XY
```
public static final int XY
```
    Next two arguments specify the current X and Y coordinates of the cursor, where X comes before Y.
    Arguments:
    1. Column number (starting from 0)
    2. Row number (starting from 0)
    As a convenience, negative row and column numbers will be counted starting from the bottom and right respectively, so a -1 will translate into the bottom row or column, -2 will translate into the penultimate row or column, and so on.
    Note: Any position that exceeds the range will be truncated to fit.
    See Also:
    
    X, Y, YX, Constant Field Values
  - Y
```
public static final int Y
```
    Specifies the row, or "Y" coordinate, of the cursor.
    Arguments:
    1. Row number (starting from 0)
    As a convenience, a negative row number will be counted starting from the bottom, so a -1 will translate into the bottom row, -2 will translate into the penultimate row, and so on.
    Note: Any position that exceeds the range will be truncated to fit.
    See Also:
    
    XY, YX, Constant Field Values
  - YELLOW
```
public static final int YELLOW
```
    The colour YELLOW. Also VGA text mode colour index 14.
    
    See Also:
    
    Constant Field Values
  - YX
```
public static final int YX
```
    Next two arguments specify the current Y and X coordinates of the cursor, where Y comes before X.
    Arguments:
    1. Row number (starting from 0)
    2. Column number (starting from 0)
    As a convenience, negative row and column numbers will be counted starting from the bottom and right respectively, so a -1 will translate into the bottom row or column, -2 will translate into the penultimate row or column, and so on.
    Note: Any position that exceeds the range will be truncated to fit.
    See Also:
    
    X, Y, XY, 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 TextRegion.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

BOTTOM

BRIGHT_BLUE

BRIGHT_CYAN

BRIGHT_GREEN

BRIGHT_RED

BRIGHT_WHITE

BROWN

CENTRE

CLEAR

COL

COLUMN

CYAN

DOWN

END

FG_ARGB

FG_ARGB_INT

FG_BGRA

FG_BGRA_INT

FG_RGB

FG_RGB_INT

FG_VGA

FILL

FILL_COLOUR

GRAY

GREEN

GREY

HIDDEN_CLEAR

HIDDEN_OFF

HIDDEN_ON

HOME

LEFT

LIME

MOVE_DOWN

MOVE_LEFT

MOVE_RIGHT

MOVE_UP

NEWLINE

PINK

PRINT

PRINT_RAW

PRINTCH

PRINTCH_RAW

PRINTLN

PRINTLN_RAW

PURPLE

RED

RESIZE_X

RESIZE_XY

RESIZE_Y

RESIZE_YX

REVERSE_CLEAR

REVERSE_OFF

REVERSE_ON

RIGHT

ROW

SCROLL_DOWN

SCROLL_DOWN_AREA

SCROLL_LEFT

SCROLL_RIGHT

SCROLL_UP

SCROLL_UP_AREA

STRAFE_DOWN

STRAFE_LEFT