ca.randolf.fx.textmode

Class TextRegion

Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

ca.randolf.fx.textmode.TextRegion

All Implemented Interfaces:

javafx.beans.value.ChangeListener, javafx.css.Styleable, javafx.event.EventTarget

public class TextRegion
extends javafx.scene.layout.Region
implements javafx.beans.value.ChangeListener

The TextRegion class is a high-performance pixel-perfect VGA text mode JavaFX Region that provides threadsafe text manipulation functions (which most JavaFX classes don't normally provide), and behaves, by default, like a real 25-row 80-column text mode screen that was commonly used in Unix and DOS (Disk Operating System) computing environments in the late 1970s, 1980s, and early-to-mid 1990s. The use of AVATAR and ANSI code sequences is supported by the various print() methods, and have been tested with a fairly broad variety of AVATAR and ANSI art that was used by many BBS (Bulletin Board System) operators to enhance the user interface for their end-users (mainly to add colour and occasional animations to what was traditionally a plain, single-colour, text-only communications medium).

While the resulting TextRegion remains true-to-form as closely as possible to the original text mode console popularized by Unix and DOS, additional functionality has been added to make this class even more useful.

Note: To disable automatic DPI scaling for Java applications, add the -Dprism.allowhidpi="false" switch to Java's command line arguments.

Property Summary

Properties inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, heightProperty, insetsProperty, maxHeightProperty, maxWidthProperty, minHeightProperty, minWidthProperty, opaqueInsetsProperty, paddingProperty, prefHeightProperty, prefWidthProperty, scaleShapeProperty, shapeProperty, snapToPixelProperty, widthProperty

Properties inherited from class javafx.scene.Parent

impl_traversalEngineProperty, needsLayoutProperty

Properties inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, cacheHintProperty, cacheProperty, clipProperty, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, focusedProperty, focusTraversableProperty, hoverProperty, idProperty, impl_showMnemonicsProperty, impl_treeVisibleProperty, inputMethodRequestsProperty, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParentTransformProperty, localToSceneTransformProperty, managedProperty, mouseTransparentProperty, nodeOrientationProperty, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, pickOnBoundsProperty, pressedProperty, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, styleProperty, translateXProperty, translateYProperty, translateZProperty, visibleProperty

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	TextRegion.Blink The TextRegion.Blink class is used internally to make characters blink.
static class	TextRegion.Cmd The TextRegion.Cmd class provides the complete set of static constants that are supported by the "randolf.fx.textmode" package.
class	TextRegion.Cursor The TextRegion.Cursor class is used internally to make the cursor flash.

Field Summary

Fields

Modifier and Type	Field and Description
static String	VERSION Version number of this Package (read-only).

Fields inherited from class javafx.scene.layout.Region

USE_COMPUTED_SIZE, USE_PREF_SIZE

Fields inherited from class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Constructors

Constructor and Description
TextRegion(int... cmds) TextRegion constructor, that defaults to a screen size of 25 rows and 80 columns, a black background, and white text.

Method Summary

Modifier and Type	Method and Description
void	changed(javafx.beans.value.ObservableValue o, Object oldValue, Object newValue) This method needs to be provided by an implementation of ChangeListener.
void	changedHeight(javafx.beans.value.ObservableValue o, Object oldValue, Object newValue) This method needs to be provided by an implementation of ChangeListener.
void	changedWidth(javafx.beans.value.ObservableValue o, Object oldValue, Object newValue) This method needs to be provided by an implementation of ChangeListener.
TextRegion	clear() Clear the TextRegion to character 0 without any colour set (so that the default background and foreground colours will be used), and position the cursor to its proper corner.
TextRegion	down() Move the cursor up one row, scrolling if already at the bottom (and the cursor advancement policy is top-to-bottom {default}).
TextRegion	fill(int top, int left, int bottom, int right, int... ch) Fill the specified region with the specified character (without changing the position of the cursor).
TextRegion	fill(int top, int left, int bottom, int right, String s) Fill the specified region with the specified character (without changing the position of the cursor).
TextRegion	fillColour(int top, int left, int bottom, int right, int bg_argb_int, int fg_argb_int) Fill the specified region with the specified background and foreground colours (without changing the position of the cursor) without changing any of the characters.
TextRegion	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}).
TextRegion	lnprint(byte... b) Add binary bytes to TextRegion, preceded by a NewLine sequence, and advance the cursor.
TextRegion	lnprint(String s) Add string to TextRegion, preceded by a NewLine sequence, and advance the cursor.
TextRegion	lnprintRaw(byte... b) Add raw binary bytes to TextRegion, preceded by a NewLine sequence, and advance the cursor.
TextRegion	lnprintRaw(String s) Add raw string to TextRegion, preceded by a NewLine sequence, and advance the cursor.
TextRegion	moveDown() Move the cursor down one row, unless the cursor is already positioned on the bottom-most row.
TextRegion	moveLeft() Move the cursor left one column, unless the cursor is already positioned on the left-most column.
TextRegion	moveRight() Move the cursor right one column, unless the cursor is already positioned on the right-most column.
TextRegion	moveUp() Move the cursor up one row, unless the cursor is already positioned on the top-most row.
TextRegion	newLine() Add NewLine sequence to TextRegion, and advance the cursor.
Chr	peek() Returns the Chr at the current cursor position.
Chr	peek(int r, int c) Returns the Chr at the specified cursor position.
TextRegion	print(byte... b) Add binary bytes to TextRegion, and advance the cursor.
TextRegion	print(String s) Add string to TextRegion, and advance the cursor.
TextRegion	println(byte... b) Add binary bytes to TextRegion, append a NewLine to the string, and advance the cursor.
TextRegion	println(String s) Add string to TextRegion, append a NewLine to the string, and advance the cursor.
TextRegion	printlnRaw(byte... b) Add raw binary bytes to TextRegion, append a NewLine to the string, and advance the cursor.
TextRegion	printlnRaw(String s) Add raw binary bytes to TextRegion, append a NewLine to the string, and advance the cursor.
TextRegion	printRaw(byte... b) Add raw binary bytes to TextRegion, and advance the cursor.
TextRegion	printRaw(String s) Add raw string to TextRegion, and advance the cursor.
TextRegion	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}).
TextRegion	scrollDown(int r) Scroll the entire region down by the specified number of rows (without changing the position of the cursor).
TextRegion	scrollDownArea(int n, int top, int left, int bottom, int right) Scroll the specified region down by the specified number of rows (without changing the position of the cursor).
TextRegion	scrollLeft(int c) Scroll the entire region left by the specified number of columns (without changing the position of the cursor).
TextRegion	scrollRight(int c) Scroll the entire region right by the specified number of columns (without changing the position of the cursor).
TextRegion	scrollUp(int r) Scroll the entire region up by the specified number of rows (without changing the position of the cursor).
TextRegion	scrollUpArea(int n, int top, int left, int bottom, int right) Scroll the specified region up by the specified number of rows (without changing the position of the cursor).
TextRegion	set(int... cmds) Alters the value of any number of parameters (in any order).
TextRegion	strafeDown() Move the cursor down one row, or scroll up one row if the cursor is already positioned on the bottom-most row.
TextRegion	strafeLeft() Move the cursor left one column, or scroll right one column if the cursor is already positioned on the left-most column.
TextRegion	strafeRight() Move the cursor right one column, or scroll left one column if the cursor is already positioned on the right-most column.
TextRegion	strafeUp() Move the cursor up one row, or scroll down one row if the cursor is already positioned on the top-most row.
TextRegion	up() Move the cursor up one row, without scrolling if already at the top (and the cursor advancement policy is top-to-bottom {default}).
void	update() Update the underlying WritableImage (do not call this method directly because it is meant to be called by the secret JavaFX background thread).

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, getBackground, getBorder, getClassCssMetaData, getCssMetaData, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, impl_computeContains, impl_computeGeomBounds, impl_computeLayoutBounds, impl_createPeer, impl_notifyLayoutBoundsChanged, impl_pickNodeLocal, impl_updatePeer, insetsProperty, isCacheShape, isCenterShape, isResizable, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getBaselineOffset, getChildren, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processCSS, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, layoutChildren, lookup, needsLayoutProperty, queryAccessibleAttribute, requestLayout, requestParentLayout, setImpl_traversalEngine, setNeedsLayout, updateBounds

Methods inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getContentBias, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_cssGetCursorInitialValue, impl_cssGetFocusTraversableInitialValue, impl_findStyles, impl_geomChanged, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class Object

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

Field Detail

VERSION

public static final String VERSION

Version number of this Package (read-only).

See Also:

Constant Field Values

Constructor Detail

TextRegion

public TextRegion(int... cmds)

TextRegion constructor, that defaults to a screen size of 25 rows and 80 columns, a black background, and white text.

Parameters:

cmds - Commands (and their required parameters)

See Also:

TextRegion.Cmd, TextRegion.Cmd.BLACK, TextRegion.Cmd.WHITE

Method Detail

changed

public void changed(javafx.beans.value.ObservableValue o,
                    Object oldValue,
                    Object newValue)

This method needs to be provided by an implementation of ChangeListener.

Specified by:

changed in interface javafx.beans.value.ChangeListener

changedHeight

public void changedHeight(javafx.beans.value.ObservableValue o,
                          Object oldValue,
                          Object newValue)

This method needs to be provided by an implementation of ChangeListener.

changedWidth

public void changedWidth(javafx.beans.value.ObservableValue o,
                         Object oldValue,
                         Object newValue)

This method needs to be provided by an implementation of ChangeListener.

clear

public TextRegion clear()

Clear the TextRegion to character 0 without any colour set (so that the default background and foreground colours will be used), and position the cursor to its proper corner.

down

public TextRegion down()

Move the cursor up one row, scrolling if already at the bottom (and the cursor advancement policy is top-to-bottom {default}).

Returns:

This object, as a convenience

fill

public TextRegion fill(int top,
                       int left,
                       int bottom,
                       int right,
                       int... ch)

Fill the specified region with the specified character (without changing the position of the cursor).

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.

Parameters:

top - First row of area

left - Left column of area

bottom - Bottom row of area

right - Right column of area

ch - Fill character(s) to use (optional)

fill

public TextRegion fill(int top,
                       int left,
                       int bottom,
                       int right,
                       String s)

Fill the specified region with the specified character (without changing the position of the cursor).

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 String's characters will be cycled through repeatedly until the area is filled with them. If the String is NULL or empty, then character 0 will be used by default.

Parameters:

top - First row of area

left - Left column of area

bottom - Bottom row of area

right - Right column of area

s - Fill string to use

fillColour

public TextRegion fillColour(int top,
                             int left,
                             int bottom,
                             int right,
                             int bg_argb_int,
                             int fg_argb_int)

Fill the specified region with the specified background and foreground colours (without changing the position of the cursor) without changing any of the characters.

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.).

Parameters:

top - First row of area

left - Left column of area

bottom - Bottom row of area

right - Right column of area

bg_argb_int - Background colour

fg_argb_int - Foreground colour

left

public TextRegion 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}).

Returns:

This object, as a convenience

lnprint

public TextRegion lnprint(byte... b)

Add binary bytes to TextRegion, preceded by a NewLine sequence, and advance the cursor.

Parameters:

b - byte[] array to add

Returns:

This object, as a convenience

lnprint

public TextRegion lnprint(String s)

Add string to TextRegion, preceded by a NewLine sequence, and advance the cursor.

Parameters:

s - String to add

Returns:

This object, as a convenience

lnprintRaw

public TextRegion lnprintRaw(byte... b)

Add raw binary bytes to TextRegion, preceded by a NewLine sequence, and advance the cursor.

Parameters:

b - byte[] array to add

Returns:

This object, as a convenience

lnprintRaw

public TextRegion lnprintRaw(String s)

Add raw string to TextRegion, preceded by a NewLine sequence, and advance the cursor.

Parameters:

s - String to add

Returns:

This object, as a convenience

moveDown

public TextRegion moveDown()

Move the cursor down one row, unless the cursor is already positioned on the bottom-most row.

Returns:

This object, as a convenience

moveLeft

public TextRegion moveLeft()

Move the cursor left one column, unless the cursor is already positioned on the left-most column.

Returns:

This object, as a convenience

moveRight

public TextRegion moveRight()

Move the cursor right one column, unless the cursor is already positioned on the right-most column.

Returns:

This object, as a convenience

moveUp

public TextRegion moveUp()

Move the cursor up one row, unless the cursor is already positioned on the top-most row.

Returns:

This object, as a convenience

newLine

public TextRegion newLine()

Add NewLine sequence to TextRegion, and advance the cursor.

Returns:

This object, as a convenience

peek

public Chr peek()

Returns the Chr at the current cursor position.

Returns:

Chr

peek

public Chr peek(int r,
                int c)

Returns the Chr at the specified cursor position.

Parameters:

r - The row number (row 0 is the first row)

c - The column number (column 0 is the first column)

Returns:

Chr

print

public TextRegion print(byte... b)

Add binary bytes to TextRegion, and advance the cursor.

Parameters:

b - byte[] array to add

Returns:

This object, as a convenience

print

public TextRegion print(String s)

Add string to TextRegion, and advance the cursor.

Parameters:

s - String to add

Returns:

This object, as a convenience

println

public TextRegion println(byte... b)

Add binary bytes to TextRegion, append a NewLine to the string, and advance the cursor.

Parameters:

b - byte[] array to add

Returns:

This object, as a convenience

println

public TextRegion println(String s)

Add string to TextRegion, append a NewLine to the string, and advance the cursor.

Parameters:

s - String to add

Returns:

This object, as a convenience

printlnRaw

public TextRegion printlnRaw(byte... b)

Add raw binary bytes to TextRegion, append a NewLine to the string, and advance the cursor.

Parameters:

b - byte[] array to add

Returns:

This object, as a convenience

printlnRaw

public TextRegion printlnRaw(String s)

Add raw binary bytes to TextRegion, append a NewLine to the string, and advance the cursor.

Parameters:

s - String to add

Returns:

This object, as a convenience

printRaw

public TextRegion printRaw(byte... b)

Add raw binary bytes to TextRegion, and advance the cursor.

Parameters:

b - byte[] array to add

Returns:

This object, as a convenience

printRaw

public TextRegion printRaw(String s)

Add raw string to TextRegion, and advance the cursor.

Parameters:

s - String to add

Returns:

This object, as a convenience

right

public TextRegion 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}).

Returns:

This object, as a convenience

scrollDown

public TextRegion scrollDown(int r)

Scroll the entire region down by the specified number of rows (without changing the position of the cursor).

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, no scrolling occurs. If the number or rows is negative, then scrolling occurs in the reverse direction instead.

Parameters:

r - Number of rows

Returns:

This object, as a convenience

scrollDownArea

public TextRegion scrollDownArea(int n,
                                 int top,
                                 int left,
                                 int bottom,
                                 int right)

Scroll the specified region down by the specified number of rows (without changing the position of the cursor).

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.

Parameters:

n - Number of rows

top - First row of area

left - Left column of area

bottom - Bottom row of area

right - Right column of area

Returns:

This object, as a convenience

scrollLeft

public TextRegion scrollLeft(int c)

Scroll the entire region left by the specified number of columns (without changing the position of the cursor).

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, no scrolling occurs. If the number or columns is negative, then scrolling occurs in the reverse direction instead.

Parameters:

c - Number of columns

Returns:

This object, as a convenience

scrollRight

public TextRegion scrollRight(int c)

Scroll the entire region right by the specified number of columns (without changing the position of the cursor).

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, no scrolling occurs. If the number or columns is negative, then scrolling occurs in the reverse direction instead.

Parameters:

c - Number of columns

Returns:

This object, as a convenience

scrollUp

public TextRegion scrollUp(int r)

Scroll the entire region up by the specified number of rows (without changing the position of the cursor).

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, no scrolling occurs. If the number or rows is negative, then scrolling occurs in the reverse direction instead.

Parameters:

r - Number of rows

Returns:

This object, as a convenience

scrollUpArea

public TextRegion scrollUpArea(int n,
                               int top,
                               int left,
                               int bottom,
                               int right)

Scroll the specified region up by the specified number of rows (without changing the position of the cursor).

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.

Parameters:

n - Number of rows

top - First row of area

left - Left column of area

bottom - Bottom row of area

right - Right column of area

Returns:

This object, as a convenience

set

public TextRegion set(int... cmds)

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

All the Commands are defined in the TextRegion.Cmd class.

Note: This method is threadsafe because the changes are queued for JavaFX to update in parallel in its background thread. A number of basic syntax checks are performed prior to adding all the commands to the queue as a single transaction.

Parameters:

cmds - Commands (and their required parameters)

Returns:

This object, as a convenience

See Also:

TextRegion.Cmd

strafeDown

public TextRegion strafeDown()

Move the cursor down one row, or scroll up one row if the cursor is already positioned on the bottom-most row.

Returns:

This object, as a convenience

strafeLeft

public TextRegion strafeLeft()

Move the cursor left one column, or scroll right one column if the cursor is already positioned on the left-most column.

Returns:

This object, as a convenience

strafeRight

public TextRegion strafeRight()

Move the cursor right one column, or scroll left one column if the cursor is already positioned on the right-most column.

Returns:

This object, as a convenience

strafeUp

public TextRegion strafeUp()

Move the cursor up one row, or scroll down one row if the cursor is already positioned on the top-most row.

Returns:

This object, as a convenience

up

public TextRegion up()

Move the cursor up one row, without scrolling if already at the top (and the cursor advancement policy is top-to-bottom {default}).

Returns:

This object, as a convenience

update

public void update()

Update the underlying WritableImage (do not call this method directly because it is meant to be called by the secret JavaFX background thread).