com.goldencode.p2j.ui.chui

Class EditorImpl

java.lang.Object

com.goldencode.p2j.ui.client.widget.AbstractWidget<O>

com.goldencode.p2j.ui.client.widget.AbstractContainer<O>

com.goldencode.p2j.ui.client.FixedSizeContainer<O>

com.goldencode.p2j.ui.client.LabeledDataContainer<O,EditorConfig>

com.goldencode.p2j.ui.client.Editor<ChuiOutputManager>

com.goldencode.p2j.ui.chui.EditorImpl

All Implemented Interfaces:

DataContainer, LabeledWidget<ChuiOutputManager>, MnemonicTrait<ChuiOutputManager>, TextSelection, Container<ChuiOutputManager>, Widget<ChuiOutputManager>, WidgetWithConfig<EditorConfig>, ConfigOwner<EditorConfig>, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

public class EditorImpl
extends Editor<ChuiOutputManager>

CHUI-specific portion of EDITOR component.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	EditorImpl.LocalChuiFocusListener Some actions on focus hanging.

Nested classes/interfaces inherited from class com.goldencode.p2j.ui.client.Editor

Editor.Line, Editor.LocalFocusListener

Field Summary

Fields

Modifier and Type	Field and Description
private static int	EDITOR_TAB_SIZE Editor widget TAB size in spaces.
private boolean	fakeInsert If true then the editor is into read-only mode and INSERT key hasn't been pressed.

Fields inherited from class com.goldencode.p2j.ui.client.Editor

CR, forceRedraw, insert, LF, lineBuilder, maxSizes, parsedText, SPACE, SPACE_LF, widgetFocused

Fields inherited from class com.goldencode.p2j.ui.client.LabeledDataContainer

config

Fields inherited from class com.goldencode.p2j.ui.client.widget.AbstractWidget

listeners, location, mousePtr, nativeInsets, physicalLocation

Constructor Summary

Constructors

Constructor and Description
EditorImpl(WidgetId id, EditorConfig cfg) Special constructor used to restore component using given configuration.

Method Summary

Modifier and Type	Method and Description
protected int	absoluteX() Get absolute horizontal position in text.
void	afterConfigUpdate(EditorConfig beforeUpdate) The method is called after the configuration associated with the implementor changes.
private void	appendLine() Handle APPEND-LINE event.
protected double	calcHpos(double size) Calculate horizontal position of the scroll-bar thumb.
protected double	calcVpos(double size) Calculate vertical position of the scroll-bar thumb.
protected void	cursorEndOfLine() Move cursor to the end of line.
protected void	cursorLeft() Move cursor one char left, if possible.
protected void	cursorPos(int pos) Split absolute horizontal cursor position into two components - position of the first visible character and relative cursor position in the visible region.
protected void	cursorRight() Move cursor one char right.
private boolean	deleteLineWorker() Delete the line of text in which the cursor currently resides.
private void	deleteWord() Delete word.
void	draw(Color color) Actual drawing routine.
void	drawCaretUnconditionally() Sets position of terminal's cursor unconditionally (even if this editor is not in focus).
private void	editorBackTab() Handle EDITOR-BACKTAB event.
private void	editorTab() Handle EDITOR-TAB event.
protected FocusListener	getFocusListener() Get the focus listener instance.
private boolean	getInsertMode() Returns the insert mode state.
protected int	getNextSplitPosition(java.lang.String line, int splitAfter) Get the next split position of this line, so that it fits the editor.
private int	getNextWordSize() Get length of the first word in the next row.
protected boolean	goToNewLine(java.lang.String subtext, boolean placeChar) Check if the given text needs to output on a new line.
protected boolean	insertBlankLineOnLF() Determine if a blank line needs to be inserted when RETURN key is pressed on a empty line.
protected void	mergeLines(int row) Merge line with subsequent one(s) if possible
private void	openLineAbove() Insert empty line above current line.
protected void	placeLF() Place new line character at current cursor position.
private java.lang.String	prepareTextRow(boolean uninit, int width, java.lang.String space, int line) Prepare text for display.
protected java.lang.String	processEOLChars(java.lang.String src) Processing for unusual EOL characters in ChUI mode.
void	processKeyEvent(KeyInput ke) Process KeyEvents for this widget.
boolean	setCursorChar(int pos, boolean redraw) Sets the cursor position in the current line
protected void	setCursorX(int pos) Calculate and set the cursor X position.
protected void	setInsertMode(boolean mode) Changes the insert mode state in the window.
void	setLabelInstance(Label<ChuiOutputManager> label) Assign new instance of Label to the fill-in widget.
protected <C extends WidgetConfig> void	updateSizeWorker(C beforeUpdate) Instructs the widget that its size may have changed.
private void	wordLeft() Move cursor one word left.
private void	wordRight() Move cursor one word right.

Methods inherited from class com.goldencode.p2j.ui.client.Editor

absoluteY, addIndent, backspace, bell, canMovetoTop, canPlaceChar, clear, contentLength, currentFocus, cursorBeginOfLine, cursorDown, cursorEndOfPrevLine, cursorHome, cursorRightTo, cursorUp, defaultFocus, deleteCharacter, deleteCharacterKey, deleteLine, deleteToEndOfLine, draw, drawCaret, editorReadFile, editorSaveFile, fireValueChanged, focusTraversable, fullHeight, getChangedValue, getCursorChar, getCursorLine, getCursorOffset, getIndentSize, getLength, getLine, getLineCount, getLineText, getMaxSize, getText, getValue, initialize, insertFile, insertString, lastRow, manageSystemActions, parseContent, parseContentImpl, placeChar, placeChar, refresh, replaceSelectionText, replaceString, requestFocus, resolveContent, rtrim, search, setCursorChar, setCursorLine, setCursorLineAndChar, setCursorOffset, setCursorOffset, setSelection, setValue, splitLine, updateOffset

Methods inherited from class com.goldencode.p2j.ui.client.LabeledDataContainer

config, copyState, defaultMousePtr, destroy, getColon, getColumnLabelText, getColumnMnemonic, getLabelInstance, getLabelText, getMnemonic, getTo, isForceLabel, isModified, isNoLabels, isRightAligned, postprocessConfig, setColumnMnemonic, setHidden, setMnemonic, setNoLabels, setVisible, setWasVisible, wasVisible

Methods inherited from class com.goldencode.p2j.ui.client.FixedSizeContainer

minimumSize, requestFocus

Methods inherited from class com.goldencode.p2j.ui.client.widget.AbstractContainer

add, add, add, addContainerStateListener, addDirectly, belongsTo, checkWidget, childrenLocation, clipping, clipRectangle, currentFocus, cycleFocus, deregisterSelectedWidget, detach, dimension, doLayout, dumpCurrentWidgets, dumpWidgets, endSizeChange, findMouseSource, firstFocus, focus, focusWorker, formatDump, get, getAllSelectedWidgets, getClipRect, getEffectiveScrollableSize, getFocusInt, getIgnoreFocus, getLayout, getScrollableSize, getTabItemList, hasFocusable, height, insets, lastFocus, moveAfterTabItem, moveBeforeTabItem, moveToBottom, moveToBottomInClass, moveToTop, moveToTopInClass, moveToZpos, nextFocus, normalizeZOrder, onWidgetAdded, onWidgetRemoved, paintOnTop, parentOf, prepareWidgets, prevFocus, reflectAncestorChange, reflectLocationChanged, registerSelectedWidget, remove, removeContainerStateListener, repaint, replace, requestFocus, setFocus, setFocusInt, setHeight, setIgnoreFocus, setInsets, setLayout, setPhysicalDimensionInt, setSize, setSize, setTabItemList, setWidth, startSizeChange, swap, triggerContainerStateRedrawEnabled, unrealize, widgets, widgetsAsList, widgetStateChanged, width

Methods inherited from class com.goldencode.p2j.ui.client.widget.AbstractWidget

_setHidden, _setVisible, activateDirectManipulation, addFocusListener, addKeyListener, afterConfigUpdateBase, ancestor, ancestorId, autoResize, bounds, clear, clearWidget, clipRectangle, clipRectangle, clipWith, copyColors, createMouseHoverAction, deactivateDirectManipulation, debug, disable, disableTooltip, displayPhysicalLocation, enable, enableTooltip, enclosingFrame, forceCursorOnFocus, forceVisibility, getActualBounds, getAndResetBitmap, getAndSetBitmap, getBitmapCopy, getCachedScreenLocation, getCachedScreenPhysicalLocation, getCustomMousePointer, getDefaultEvent, getEffectiveMousePointer, getId, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getPortableMouseEventCoordinates, getSelectedText, getState, getTextHeight, getTextHeightNative, getTextHeightNative, getTextWidth, getTextWidth, getTextWidthNative, getTextWidthNative, getVisiblePart, getZOrderClass, hasFocus, hasTooltip, hidden, hide, highlighted, ignoreAction, initialHeight, initialWidth, isCurrent, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDirectManipulationCapable, isDirectManipulationRequired, isDisplayed, isEnabled, isFocusable, isHeader, isMouseDrag, isRealized, isRepaintDisabled, isRMBEntrySupported, isScreenLocationCached, isTabStop, isThreeD, isTotallyObscured, isVisible, isVisible, location, mouseActions, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved, moveToBottom, moveToTop, name, navigable, oleDoDrop, oleDrag, oleDragging, oleStartDragging, onOleDragging, onOleDropEnd, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalBounds, physicalDimension, physicalLocation, prepParentLocation, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, processEvent, processFocusEvent, processKeyEventForSelectableWidget, processKeyListeners, processMnemonic, processMnemonicImpl, processSystemKey, raiseLegacyMouseEvents, reflectSizeChanged, refresh, registerWidgetListener, repaint, repaint, requestSync, resetBitmap, resizeTo, resolveFont, resolvePopupMenuId, resolveTitleFont, screen, screenDimension, screenHeight, screenLocation, screenPhysicalLocation, screenWidth, setBitmap, setCachedScreenLocation, setCachedScreenPhysicalLocation, setDirectManipulationActive, setEnabled, setHighlighted, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, setSensitiveForUIB, setState, setWindow, show, showPopupMenu, supportsCustomMousePointer, sync, topLevelWindow, toString, translate, triggerLocationChanged, unregisterWidgetListener, updateSystemParent, widgetRealized, window

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.goldencode.p2j.ui.client.TextSelection

editPaste, invalidateSelection, isEditCanUndo, isSelectionValid, removeSelectedText

Methods inherited from interface com.goldencode.p2j.ui.client.widget.Widget

acceptsEscAsAnyKey, acceptTrigger, addFocusListener, addKeyListener, ancestor, ancestorId, bounds, clearWidget, completeTrigger, dimension, displayPhysicalLocation, enclosingFrame, enforceDefaultMousePtr, findMouseSource, forceCursorOnFocus, forceVisibility, getActualBounds, getCustomMousePointer, getEffectiveMousePointer, getId, getIdForTrigger, getLegacyWidget, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getSelectedText, getState, getTriggerWidget, getTriggerWidget, getVisiblePart, getZOrderClass, hasFocus, hasFocus, hasTooltip, height, hidden, hide, highlighted, ignoreEnable, initialHeight, initialWidth, insets, isCurrent, isCurrent, isDirectManipulable, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDisplayed, isDroppable, isEnabled, isFocusable, isHeader, isInitialValueLayout, isLegacyFocus, isProcessProgressEvent, isRealized, isRepaintDisabled, isRMBEntrySupported, isTabStop, isThreeD, isTotallyObscured, isVisible, isVisible, location, maySwitchFocus, minimumSize, moveToBottom, moveToTop, name, navigable, oleDrag, parent, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalBounds, physicalDimension, physicalLocation, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, processEvent, processFocusEvent, processKeyListeners, processMnemonic, raiseLegacyMouseEvents, refreshWidget, registerWidgetListener, repaint, repaint, repaint, requestFocus, requestFocus, requestSync, resizeTo, resolvePopupMenuId, screen, screenLocation, screenPhysicalLocation, setDirectManipulationActive, setEnabled, setHighlighted, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, setSensitiveForUIB, setState, setWindow, show, startTrigger, supportsCustomMousePointer, systemFocusGrabbed, topLevelWindow, unrealize, unregisterWidgetListener, validateDisplayValue, widgetStateChanged, width, window

Methods inherited from interface java.awt.event.MouseListener

mouseClicked, mouseEntered, mouseExited, mousePressed, mouseReleased

Methods inherited from interface java.awt.event.MouseMotionListener

mouseDragged, mouseMoved

Methods inherited from interface java.awt.event.MouseWheelListener

mouseWheelMoved

Methods inherited from interface com.goldencode.p2j.ui.client.MnemonicTrait

createMnemonic, getMnemonicCharacter, getMnemonicKeyCode, getMnemonicLabel, isMnemonicSupported, updateMnemonic

Methods inherited from interface com.goldencode.p2j.ui.client.widget.Container

widgetsAsList

Field Detail

EDITOR_TAB_SIZE

private static final int EDITOR_TAB_SIZE

Editor widget TAB size in spaces.

See Also:

Constant Field Values

fakeInsert

private boolean fakeInsert

If true then the editor is into read-only mode and INSERT key hasn't been pressed. In this case we should display OFF state while actual insert state may be either ON or OFF.

Constructor Detail

EditorImpl

public EditorImpl(WidgetId id,
                  EditorConfig cfg)

Special constructor used to restore component using given configuration.

Parameters:

id - The widget's ID.

cfg - Configuration data.

Method Detail

processKeyEvent

public void processKeyEvent(KeyInput ke)

Process KeyEvents for this widget.

Specified by:

processKeyEvent in interface Widget<ChuiOutputManager>

Overrides:

processKeyEvent in class Editor<ChuiOutputManager>

Parameters:

ke - Key event structure.

afterConfigUpdate

public void afterConfigUpdate(EditorConfig beforeUpdate)

The method is called after the configuration associated with the implementor changes. The parameter points to a reference representing the original configuration state. This reference can be used to detect what configuration fields changed and so optimize any processing related to the configuration change.

Specified by:

afterConfigUpdate in interface ConfigOwner<EditorConfig>

Overrides:

afterConfigUpdate in class LabeledDataContainer<ChuiOutputManager,EditorConfig>

Parameters:

beforeUpdate - The previous configuration.

setLabelInstance

public void setLabelInstance(Label<ChuiOutputManager> label)

Assign new instance of Label to the fill-in widget.

Specified by:

setLabelInstance in interface LabeledWidget<ChuiOutputManager>

Overrides:

setLabelInstance in class LabeledDataContainer<ChuiOutputManager,EditorConfig>

Parameters:

label - Reference to new Label instance.

drawCaretUnconditionally

public void drawCaretUnconditionally()

Sets position of terminal's cursor unconditionally (even if this editor is not in focus).

Specified by:

drawCaretUnconditionally in class Editor<ChuiOutputManager>

draw

public void draw(Color color)

Actual drawing routine.

Specified by:

draw in class Editor<ChuiOutputManager>

Parameters:

color - Color for drawing.

setCursorChar

public boolean setCursorChar(int pos,
                             boolean redraw)

Sets the cursor position in the current line

Overrides:

setCursorChar in class Editor<ChuiOutputManager>

Parameters:

pos - the new cursor position value, 0-based

redraw - request redraw/sync

Returns:

true if the cursor position is valid and set

calcHpos

protected double calcHpos(double size)

Calculate horizontal position of the scroll-bar thumb.

Parameters:

size - The width of the scroll-bar.

Returns:

The horizontal position of the scroll-bar thumb.

calcVpos

protected double calcVpos(double size)

Calculate vertical position of the scroll-bar thumb.

Parameters:

size - The height of the scroll-bar.

Returns:

The vertical position of the scroll-bar thumb.

absoluteX

protected int absoluteX()

Get absolute horizontal position in text.

Specified by:

absoluteX in class Editor<ChuiOutputManager>

Returns:

The horizontal position in the text.

goToNewLine

protected boolean goToNewLine(java.lang.String subtext,
                              boolean placeChar)

Check if the given text needs to output on a new line.

Specified by:

goToNewLine in class Editor<ChuiOutputManager>

Parameters:

subtext - The text.

placeChar - flag indicating if this call is from Editor.placeChar(char).

Returns:

true if the text will output on a new line.

mergeLines

protected void mergeLines(int row)

Merge line with subsequent one(s) if possible

Specified by:

mergeLines in class Editor<ChuiOutputManager>

Parameters:

row - line's row

setInsertMode

protected void setInsertMode(boolean mode)

Changes the insert mode state in the window.

Parameters:

mode - New state.

• false- overwrite mode,
• true- insert mode.

placeLF

protected void placeLF()

Place new line character at current cursor position.

Overrides:

placeLF in class Editor<ChuiOutputManager>

insertBlankLineOnLF

protected boolean insertBlankLineOnLF()

Determine if a blank line needs to be inserted when RETURN key is pressed on a empty line.

Specified by:

insertBlankLineOnLF in class Editor<ChuiOutputManager>

Returns:

In ChUI, always false.

cursorRight

protected void cursorRight()

Move cursor one char right.

Overrides:

cursorRight in class Editor<ChuiOutputManager>

cursorEndOfLine

protected void cursorEndOfLine()

Move cursor to the end of line.

Overrides:

cursorEndOfLine in class Editor<ChuiOutputManager>

cursorLeft

protected void cursorLeft()

Move cursor one char left, if possible.

Overrides:

cursorLeft in class Editor<ChuiOutputManager>

setCursorX

protected void setCursorX(int pos)

Calculate and set the cursor X position. If the position is not near the edge, then the cursor will be positioned about at the middle of the screen.

Parameters:

pos - New cursor position (0-based).

cursorPos

protected void cursorPos(int pos)

Split absolute horizontal cursor position into two components - position of the first visible character and relative cursor position in the visible region.

Overrides:

cursorPos in class Editor<ChuiOutputManager>

Parameters:

pos - The new absolute cursor position.

getFocusListener

protected FocusListener getFocusListener()

Get the focus listener instance.

Overrides:

getFocusListener in class Editor<ChuiOutputManager>

Returns:

See above.

getNextSplitPosition

protected int getNextSplitPosition(java.lang.String line,
                                   int splitAfter)

Get the next split position of this line, so that it fits the editor.

Specified by:

getNextSplitPosition in class Editor<ChuiOutputManager>

Parameters:

line - The line to be split.

splitAfter - minimal split position.

Returns:

An index where the split ends.

updateSizeWorker

protected <C extends WidgetConfig> void updateSizeWorker(C beforeUpdate)

Instructs the widget that its size may have changed. The widget updates its state from the associated config instance. It is the responsibility of the caller to call this method only after the config size is set with the new values.

This implementation ignores the supplied config instance. Instead it relies on AbstractContainer.size and LabeledDataContainer.config() to detect whether size has changed.

Overrides:

updateSizeWorker in class AbstractContainer<ChuiOutputManager>

Type Parameters:

C - Widget config type.

Parameters:

beforeUpdate - BaseConfig reference or null.

processEOLChars

protected java.lang.String processEOLChars(java.lang.String src)

Processing for unusual EOL characters in ChUI mode. Currently removes '\r'.

Specified by:

processEOLChars in class Editor<ChuiOutputManager>

Parameters:

src - the string to be processed.

Returns:

the string with only '\n' characters as line seperator(EOL).

wordLeft

private void wordLeft()

Move cursor one word left.

wordRight

private void wordRight()

Move cursor one word right.

getNextWordSize

private int getNextWordSize()

Get length of the first word in the next row.

Returns:

The length of the first word in the row immediately under the current.

editorBackTab

private void editorBackTab()

Handle EDITOR-BACKTAB event.

editorTab

private void editorTab()

Handle EDITOR-TAB event.

appendLine

private void appendLine()

Handle APPEND-LINE event.

getInsertMode

private boolean getInsertMode()

Returns the insert mode state.

Returns:

The insert mode state.

• false- overwrite mode,
• true- insert mode.

openLineAbove

private void openLineAbove()

Insert empty line above current line.

prepareTextRow

private java.lang.String prepareTextRow(boolean uninit,
                                        int width,
                                        java.lang.String space,
                                        int line)

Prepare text for display.

Parameters:

uninit - true if the widget is uninitialized.

width - Width of the displayed area.

space - Prepared string filled with spaces.

line - Index in the array of parsed strings.

Returns:

Text string ready for displaying.

deleteLineWorker

private boolean deleteLineWorker()

Delete the line of text in which the cursor currently resides. Leave the cursor at the leftmost position of the same line number (which will be the line previously below this one if the cursor is not already on the last line) or at the leftmost position of the last line (if there are no lines below this one).

Returns:

true if anything is deleted.

deleteWord

private void deleteWord()

Delete word.