com.goldencode.p2j.ui.client

Class Editor<O extends OutputManager<?>>

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<O>

All Implemented Interfaces:

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

Direct Known Subclasses:

EditorGuiImpl, EditorImpl

public abstract class Editor<O extends OutputManager<?>>
extends LabeledDataContainer<O,EditorConfig>
implements TextSelection

Implementation of Progress EDITOR component.

Besides what was known from Progress manuals, the following facts describe some peculiarities in the redirected output found experimentally:

• If the number of lines the editor holds is less than or equal to the height of the widget, the output will consist of the text and some empty lines so that the height of the widget equals the number of output lines.
• If the number of lines the editor holds is greater than the height of the widget, all lines will be output, not just the visible portion.
• No matter how many lines of text the editor holds, the visible lines is what is counted when placing the frame on the current page.
• Unlike other widgets, editors can split the output into multiple pages. The page overflow condition is checked after every line of the editor's output. If the current page spills, the form feed character is inserted as well as frame headers, if any. Page headers appear on the page as soon as the editor's output terminates, but no form feed character is printed with the page headers in this case.
• If the editor is long enough, multiple page breaks and frame headers will be created.
• Iterations of the down frames containing editors may have editors of various sizes.
• Every iteration of the down frames containing editors can cause page break as described.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Editor.Line Internal text representation element.
protected class	Editor.LocalFocusListener Some actions on focus hanging.

Field Summary

Fields

Modifier and Type	Field and Description
protected static char	CR Carrage return character.
protected boolean	forceRedraw Flag indicating if the processed event forced a re-draw.
protected boolean	insert Insert mode.
protected static char	LF line feed character
protected java.lang.StringBuilder	lineBuilder The internal work buffer to do string manipulations.
private static int	MAX_SIZE Maximum capacity of the editor.
protected static java.util.Map<java.lang.Integer,java.lang.Integer>	maxSizes Max data size in widget.
protected java.util.List<Editor.Line>	parsedText Editor content parsed into separate string.
private static java.util.regex.Pattern	RTRIM trailing spaces
private java.lang.String	savedContent Saved content of the current screen value.
protected static java.lang.String	SPACE single space string
protected static java.lang.String	SPACE_LF space & lf
protected boolean	widgetFocused Widget in focus flag.

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
Editor(WidgetId id, EditorConfig cfg) Special constructor used to restore component using given configuration.

Method Summary

Modifier and Type	Method and Description
protected abstract int	absoluteX() Get absolute horizontal position in text.
protected int	absoluteY() Get absolute vertical position in text.
protected java.lang.String	addIndent(java.lang.String line, int indentSize) Add indent consisting of spaces to the beginning of the specified line.
protected void	backspace() Handle BACKSPACE key.
protected void	bell() Handle BELL event.
boolean	canMovetoTop() Flag indicating if this widget can be moved to top by a DISPLAY statement when WINDOW:KEEP-FRAME-Z-ORDER flag is set.
protected boolean	canPlaceChar() Determine if a character can be placed in the editor.
void	clear() Clear input variable.
int	contentLength() Gets the actual content length (not the LENGTH attribute).
Widget<O>	currentFocus() Returns this component directly because it is not a container (it has no child components.
protected void	cursorBeginOfLine() Move cursor to beginning of the line.
protected void	cursorDown() Move cursor one row down, if possible.
protected void	cursorEndOfLine() Move cursor to the end of line.
protected void	cursorEndOfPrevLine() Move the cursor to the end of the previous line.
protected void	cursorHome() Move cursor to the start position.
protected void	cursorLeft() Move cursor one char left, if possible.
private void	cursorPageDown() Scroll one page down.
private void	cursorPageUp() Scroll one page up.
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.
protected void	cursorRightTo(int shift) Shift cursor to the right within current line.
protected void	cursorUp() Move cursor one row up, if possible.
Widget<O>	defaultFocus() Returns this component directly because it is not a container (it has no child components.
protected boolean	deleteCharacter() Delete character at current cursor position.
protected void	deleteCharacterKey() Delete character at current cursor position - called by processKeyEvent(com.goldencode.p2j.ui.client.event.KeyInput).
boolean	deleteLine() Delete the line of text in which the cursor currently resides.
private boolean	deleteLineWorker() Delete the line of text in which the cursor currently resides.
protected boolean	deleteToEndOfLine() Delete to end of line.
void	draw() Draws text.
abstract void	draw(Color color) Actual drawing routine.
void	drawCaret() Sets position of terminal's cursor.
abstract void	drawCaretUnconditionally() Sets position of terminal's cursor unconditionally (even if this editor is not in focus).
boolean	editorReadFile(java.lang.String name) Loads the file from the client side filesystem.
boolean	editorSaveFile(java.lang.String name) Save the content in the widgets in the client side filesystem.
private int	findRow(int pos) Find row number for a position
protected void	fireValueChanged() No-op for ChUI.
boolean	focusTraversable() This component will receive an input focus when Tab or Shift-Tab is pressed.
int	fullHeight() Returns the number of lines the editor is holding.
BaseDataType	getChangedValue() Getting the BaseDataType object representing the current value change since last call.
int	getCursorChar() Gets the cursor in the current line
int	getCursorLine() Gets the cursor liner
int	getCursorOffset() Gets the cursor offset
protected FocusListener	getFocusListener() Get the focus listener instance.
protected int	getIndentSize(java.lang.String line) Calculate the size of the line indent, which is the number of leading spaces.
int	getLength() Gets the content length, compatible with the LENGTH attribute.
protected Editor.Line	getLine() Get reference to the line under absolute cursor position.
int	getLineCount() Obtain the number of current lines displayed (parsed) by this editor.
java.lang.String	getLineText(int k) Obtain the text displayed on a specified line.
protected int	getMaxSize() Maximal size of the content in chars.
protected abstract int	getNextSplitPosition(java.lang.String line, int splitAfter) Get the next split position of this line, so that it fits the editor.
java.lang.String	getText() Get screen representation of the data.
BaseDataType	getValue() Getting the BaseDataType object representing the current value.
protected abstract boolean	goToNewLine(java.lang.String subtext, boolean placeChar) Check if the given text needs to output on a new line.
void	initialize(WidgetId id, EditorConfig cfg) Replacement API for the logic which should exist in the widget's c'tor, but the logic can't be executed as it depends on the widget being registered into the official registry.
private int	inSameLime(int start, int end) Check if there are now LFs between positions
protected abstract boolean	insertBlankLineOnLF() Determine if a blank line needs to be inserted when RETURN key is pressed on a empty line.
boolean	insertFile(java.lang.String fileNameToLoad) Inserts content of a file at the current cursor position.
boolean	insertString(java.lang.String txt) Inserts string at the current cursor position.
protected int	lastRow() Maximal value of the absolute Y coordinate.
boolean	manageSystemActions() Check if the current widget can manage non-global system actions on its own, and not via the enclosing event loop.
protected abstract void	mergeLines(int row) Merge line with subsequent one(s) if possible
protected void	parseContent(java.lang.String source, int row, boolean placeChar) Parse content of the editor and prepare array of displayable values.
protected java.util.List<Editor.Line>	parseContentImpl(java.lang.String source, int start, int offset, boolean placeChar) Worker to parse content of the editor and prepare array of displayable values.
protected void	placeChar(char ch) Place character at current cursor position.
protected void	placeChar(char ch, boolean ignoreReadonly) Place character at current cursor position.
protected void	placeLF() Place new line character at current cursor position.
private void	placeStringInt(java.lang.String text) Place string at current cursor position.
private void	placeStringSegment(java.lang.String text) Place string at current cursor position for the current line.
private void	placeStringSegmentWrap(java.lang.String text) Place string at current cursor position for the current line.
protected abstract java.lang.String	processEOLChars(java.lang.String src) Processing for unusual EOL characters in different UI modes.
void	processKeyEvent(KeyInput ke) Process KeyEvents for this widget.
protected void	refresh() Refresh the editor.
private boolean	replaceInterval(int start, int end, java.lang.String txt) Replace subinterval of the editor content
boolean	replaceSelectionText(java.lang.String txt) Replace selection of the editor content with a given string.
boolean	replaceString(java.lang.String from, java.lang.String to, int flag) Replace given substring of the editor content with a given string
void	requestFocus() Requesting the focus to the widget.
protected java.lang.String	resolveContent() Get a string representation of this editor's content.
protected java.lang.String	rtrim(java.lang.String value) Remove trailing whitespaces
java.lang.Boolean	search(java.lang.String pattern, int mode) Searches for a specified string starting from the current text caret position.
boolean	setCursorChar(int pos) Sets the cursor position in the current line
boolean	setCursorChar(int pos, boolean redraw) Sets the cursor position in the current line
boolean	setCursorLine(int line) Sets the cursor line
protected boolean	setCursorLineAndChar(int line, int offset) Sets the cursor line offset
boolean	setCursorOffset(int offset) Sets the cursor offset.
boolean	setCursorOffset(int offset, boolean shouldInvalidateSelection) Sets the cursor offset.
boolean	setSelection(int start, int end) Selects text in a widget between start and end points.
void	setValue(BaseDataType value) Sets the new variable value in the editor.
protected void	splitLine(java.lang.String line, int row, int splitAfter) Replace line, splitting it if necessary
protected void	updateOffset() Update widget content;

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

afterConfigUpdate, config, copyState, defaultMousePtr, destroy, getColon, getColumnLabelText, getColumnMnemonic, getLabelInstance, getLabelText, getMnemonic, getTo, isForceLabel, isModified, isNoLabels, isRightAligned, postprocessConfig, setColumnMnemonic, setHidden, setLabelInstance, 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, updateSizeWorker, 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

LF

protected static final char LF

line feed character

See Also:

Constant Field Values

CR

protected static final char CR

Carrage return character.

See Also:

Constant Field Values

SPACE

protected static final java.lang.String SPACE

single space string

See Also:

Constant Field Values

SPACE_LF

protected static final java.lang.String SPACE_LF

space & lf

See Also:

Constant Field Values

RTRIM

private static final java.util.regex.Pattern RTRIM

trailing spaces

parsedText

protected java.util.List<Editor.Line> parsedText

Editor content parsed into separate string.

widgetFocused

protected boolean widgetFocused

Widget in focus flag.

maxSizes

protected static final java.util.Map<java.lang.Integer,java.lang.Integer> maxSizes

Max data size in widget. Depends on width-chars or inner-chars

insert

protected boolean insert

Insert mode.

forceRedraw

protected boolean forceRedraw

Flag indicating if the processed event forced a re-draw.

lineBuilder

protected java.lang.StringBuilder lineBuilder

The internal work buffer to do string manipulations.

MAX_SIZE

private static int MAX_SIZE

Maximum capacity of the editor.

savedContent

private java.lang.String savedContent

Saved content of the current screen value.

Constructor Detail

Editor

public Editor(WidgetId id,
              EditorConfig cfg)

Special constructor used to restore component using given configuration.

Call initialize(com.goldencode.p2j.ui.WidgetId, com.goldencode.p2j.ui.EditorConfig) to finish the widget initialization.

Parameters:

id - The widget's ID.

cfg - Configuration data.

Method Detail

drawCaretUnconditionally

public abstract void drawCaretUnconditionally()

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

draw

public abstract void draw(Color color)

Actual drawing routine.

Parameters:

color - Color for drawing.

goToNewLine

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

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

Parameters:

subtext - The text.

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

Returns:

true if the text will output on a new line.

insertBlankLineOnLF

protected abstract boolean insertBlankLineOnLF()

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

Returns:

See above.

mergeLines

protected abstract void mergeLines(int row)

Merge line with subsequent one(s) if possible

Parameters:

row - line's row

getNextSplitPosition

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

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

Parameters:

line - The line to be split.

splitAfter - minimal split position.

Returns:

An index where the split ends.

absoluteX

protected abstract int absoluteX()

Get absolute horizontal position in text.

Returns:

The horizontal position in the text.

processEOLChars

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

Processing for unusual EOL characters in different UI modes.

Parameters:

src - the string to be processed.

Returns:

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

canMovetoTop

public boolean canMovetoTop()

Flag indicating if this widget can be moved to top by a DISPLAY statement when WINDOW:KEEP-FRAME-Z-ORDER flag is set.

Specified by:

canMovetoTop in interface Widget<O extends OutputManager<?>>

Returns:

Always true.

editorReadFile

public boolean editorReadFile(java.lang.String name)

Loads the file from the client side filesystem.

Parameters:

name - The file name for the file to be loaded.

Returns:

TRUE if operation successful FALSE otherwise.

editorSaveFile

public boolean editorSaveFile(java.lang.String name)

Save the content in the widgets in the client side filesystem.

Parameters:

name - The file name for the file to be written.

Returns:

TRUE if operation successful FALSE otherwise.

initialize

public void initialize(WidgetId id,
                       EditorConfig cfg)

Replacement API for the logic which should exist in the widget's c'tor, but the logic can't be executed as it depends on the widget being registered into the official registry.

This API is called after the widget is created and added to the registry.

Specified by:

initialize in interface WidgetWithConfig<EditorConfig>

Parameters:

id - The widget's ID.

cfg - The config used to initialize this widget.

getChangedValue

public BaseDataType getChangedValue()

Getting the BaseDataType object representing the current value change since last call.

Specified by:

getChangedValue in interface DataContainer

Returns:

The value representing the current widget value change.

getValue

public BaseDataType getValue()

Getting the BaseDataType object representing the current value.

Specified by:

getValue in interface DataContainer

Returns:

The value representing the current widget value.

requestFocus

public void requestFocus()

Requesting the focus to the widget.

Specified by:

requestFocus in interface Widget<O extends OutputManager<?>>

Overrides:

requestFocus in class FixedSizeContainer<O extends OutputManager<?>>

drawCaret

public void drawCaret()

Sets position of terminal's cursor.

Specified by:

drawCaret in interface Widget<O extends OutputManager<?>>

Overrides:

drawCaret in class AbstractWidget<O extends OutputManager<?>>

draw

public void draw()

Draws text. DisplayFormat.Presentation instance is rendered into screen value. Screen value is left justified or padded to the right bound with spaces. Non first lines are filled with spaces. If widget is focused then after rendering terminal's cursor is set to appropriate position in the widget.

Specified by:

draw in interface Widget<O extends OutputManager<?>>

Overrides:

draw in class AbstractContainer<O extends OutputManager<?>>

refresh

protected void refresh()

Refresh the editor.

getText

public java.lang.String getText()

Get screen representation of the data.

Specified by:

getText in interface DataContainer

Returns:

Text representation of the variable value according to all current settings, flags, format, etc.

clear

public void clear()

Clear input variable.

focusTraversable

public boolean focusTraversable()

This component will receive an input focus when Tab or Shift-Tab is pressed.

Specified by:

focusTraversable in interface Widget<O extends OutputManager<?>>

Overrides:

focusTraversable in class AbstractContainer<O extends OutputManager<?>>

Returns:

true if this component is enabled and visible.

currentFocus

public Widget<O> currentFocus()

Returns this component directly because it is not a container (it has no child components.

Specified by:

currentFocus in interface Container<O extends OutputManager<?>>

Overrides:

currentFocus in class AbstractContainer<O extends OutputManager<?>>

Returns:

focused widget.

See Also:

Container.currentFocus()

defaultFocus

public Widget<O> defaultFocus()

Returns this component directly because it is not a container (it has no child components.

Specified by:

defaultFocus in interface Container<O extends OutputManager<?>>

Overrides:

defaultFocus in class AbstractContainer<O extends OutputManager<?>>

Returns:

default focusable widget.

See Also:

Container.defaultFocus()

setValue

public void setValue(BaseDataType value)

Sets the new variable value in the editor.

Specified by:

setValue in interface DataContainer

Parameters:

value - New value for the screen buffer.

processKeyEvent

public void processKeyEvent(KeyInput ke)

Process KeyEvents for this widget.

Specified by:

processKeyEvent in interface Widget<O extends OutputManager<?>>

Overrides:

processKeyEvent in class AbstractContainer<O extends OutputManager<?>>

Parameters:

ke - Key event structure.

deleteLine

public boolean deleteLine()

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 the line was deleted.

setSelection

public boolean setSelection(int start,
                            int end)

Selects text in a widget between start and end points.

Specified by:

setSelection in interface TextSelection

Parameters:

start - Starting offset.

end - Ending offset.

Returns:

true if the operation succeeded.

setCursorLine

public boolean setCursorLine(int line)

Sets the cursor line

Parameters:

line - the new cursor line value

Returns:

true if the cursor line is valid and set

getCursorLine

public int getCursorLine()

Gets the cursor liner

Returns:

the cursor line

setCursorChar

public boolean setCursorChar(int pos)

Sets the cursor position in the current line

Parameters:

pos - the new cursor position value

Returns:

true if the cursor position is valid and set

setCursorChar

public boolean setCursorChar(int pos,
                             boolean redraw)

Sets the cursor position in the current line

Parameters:

pos - The new cursor position value.

redraw - Request redraw/sync.

Returns:

true if the cursor position is valid and set.

getCursorChar

public int getCursorChar()

Gets the cursor in the current line

Returns:

the cursor position

setCursorOffset

public boolean setCursorOffset(int offset,
                               boolean shouldInvalidateSelection)

Sets the cursor offset.

Specified by:

setCursorOffset in class LabeledDataContainer<O extends OutputManager<?>,EditorConfig>

Parameters:

offset - The new offset value. Use -1 to move the caret at the end (MOVE-TO-EOF).

shouldInvalidateSelection - The flag that shows if we should invalidate selection.

Returns:

true if the cursor offset is valid and set.

setCursorOffset

public boolean setCursorOffset(int offset)

Sets the cursor offset.

Parameters:

offset - The new offset value. Use -1 to move the caret at the end (MOVE-TO-EOF).

Returns:

true if the cursor offset is valid and set.

setCursorLineAndChar

protected boolean setCursorLineAndChar(int line,
                                       int offset)

Sets the cursor line offset

Parameters:

line - the new cursor line value

offset - the new offset value

Returns:

true if the cursor offset is valid and set

getCursorOffset

public int getCursorOffset()

Gets the cursor offset

Returns:

the cursor offset

getLength

public int getLength()

Gets the content length, compatible with the LENGTH attribute.

Returns:

the content length

contentLength

public int contentLength()

Gets the actual content length (not the LENGTH attribute).

Returns:

the content length

getLineCount

public int getLineCount()

Obtain the number of current lines displayed (parsed) by this editor. If no text was parsed 0 is returned.

Returns:

the number of current lines displayed (parsed) by this editor.

getLineText

public java.lang.String getLineText(int k)

Obtain the text displayed on a specified line. If text has not been parsed yet or the requested line is invalid, null is returned.

Parameters:

k - The line whose text is requested.

Returns:

The content of the k line (0-base).

insertString

public boolean insertString(java.lang.String txt)

Inserts string at the current cursor position. // OM: todo: implementation may be too slow from large texts

Parameters:

txt - The string to be inserted.

Returns:

true if the string is inserted.

insertFile

public boolean insertFile(java.lang.String fileNameToLoad)

Inserts content of a file at the current cursor position.

Parameters:

fileNameToLoad - The file to be inserted.

Returns:

true if the file was successfully inserted.

replaceSelectionText

public boolean replaceSelectionText(java.lang.String txt)

Replace selection of the editor content with a given string.

Parameters:

txt - the replacement string

Returns:

true if the selection is replaced

replaceInterval

private boolean replaceInterval(int start,
                                int end,
                                java.lang.String txt)

Replace subinterval of the editor content

Parameters:

start - start of the interval

end - end of the interval

txt - replacement text

Returns:

true if replacement done.

replaceString

public boolean replaceString(java.lang.String from,
                             java.lang.String to,
                             int flag)

Replace given substring of the editor content with a given string

Parameters:

from - the string to be replaced

to - the replacement string

flag - the replacement mode flag as described in 4GL EDITOR:REPLACE documentation

Returns:

true if the replacement was performed

search

public java.lang.Boolean search(java.lang.String pattern,
                                int mode)

Searches for a specified string starting from the current text caret position.

Parameters:

pattern - The string to be search. No wildcard allowed.

mode - a combinations of flags that specifies the type of search to be performed. The following values are accepted:

Type of search	Flag value
EditorWidget.FIND_NEXT_OCCURRENCE	1
EditorWidget.FIND_PREV_OCCURRENCE	2
EditorWidget.FIND_CASE_SENSITIVE	4
EditorWidget.FIND_WRAP_AROUND	16
EditorWidget.FIND_SELECT	32

Returns:

This base class always returns false. Objects that extends it will implement their search and return the result accordingly.

findRow

private int findRow(int pos)

Find row number for a position

Parameters:

pos - position

Returns:

row number or -1 if position is out of range

inSameLime

private int inSameLime(int start,
                       int end)

Check if there are now LFs between positions

Parameters:

start - first position

end - second position

Returns:

number of row for the first position or -1 if provided positions are invalid or are not in the same line.

manageSystemActions

public boolean manageSystemActions()

Check if the current widget can manage non-global system actions on its own, and not via the enclosing event loop.

Overrides:

manageSystemActions in class AbstractWidget<O extends OutputManager<?>>

Returns:

true as the widget has its own event management.

cursorPageUp

private void cursorPageUp()

Scroll one page up.

cursorPageDown

private void cursorPageDown()

Scroll one page down.

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.

lastRow

protected int lastRow()

Maximal value of the absolute Y coordinate.

Returns:

The last row index.

getMaxSize

protected int getMaxSize()

Maximal size of the content in chars.

Returns:

The internal buffer capacity. Always 32k for ChUI.

fullHeight

public int fullHeight()

Returns the number of lines the editor is holding.

Returns:

number of lines of text.

fireValueChanged

protected void fireValueChanged()

No-op for ChUI.

cursorBeginOfLine

protected void cursorBeginOfLine()

Move cursor to beginning of the line.

deleteToEndOfLine

protected boolean deleteToEndOfLine()

Delete to end of line.

Returns:

true if text was deleted.

bell

protected void bell()

Handle BELL event.

backspace

protected void backspace()

Handle BACKSPACE key.

cursorEndOfPrevLine

protected void cursorEndOfPrevLine()

Move the cursor to the end of the previous line.

cursorHome

protected void cursorHome()

Move cursor to the start position.

cursorEndOfLine

protected void cursorEndOfLine()

Move cursor to the end of line.

getLine

protected Editor.Line getLine()

Get reference to the line under absolute cursor position.

Returns:

The instance of the Line at current position.

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.

Parameters:

pos - The new absolute cursor position.

cursorDown

protected void cursorDown()

Move cursor one row down, if possible.

cursorUp

protected void cursorUp()

Move cursor one row up, if possible.

cursorRight

protected void cursorRight()

Move cursor one char right.

cursorRightTo

protected void cursorRightTo(int shift)

Shift cursor to the right within current line.

Parameters:

shift - The value to increment the cursor position..

cursorLeft

protected void cursorLeft()

Move cursor one char left, if possible.

placeLF

protected void placeLF()

Place new line character at current cursor position.

getIndentSize

protected int getIndentSize(java.lang.String line)

Calculate the size of the line indent, which is the number of leading spaces.

Parameters:

line - The line which indent will be calculated.

Returns:

indent size of the given line.

addIndent

protected java.lang.String addIndent(java.lang.String line,
                                     int indentSize)

Add indent consisting of spaces to the beginning of the specified line.

Parameters:

line - The line to which an indent will be added.

indentSize - The size of the indent.

Returns:

specified line with prepended indent.

canPlaceChar

protected boolean canPlaceChar()

Determine if a character can be placed in the editor. Note that this implementation doesn't check for read-only state.

Returns:

true if the editor allows a char to be placed.

placeChar

protected void placeChar(char ch)

Place character at current cursor position. Depending on the current insertion mode character can be either inserted into text or can replace existing character.

Parameters:

ch - Character to place.

placeChar

protected void placeChar(char ch,
                         boolean ignoreReadonly)

Place character at current cursor position. Depending on the current insertion mode character can be either inserted into text or can replace existing character.

Parameters:

ch - Character to place.

ignoreReadonly - If true places the char even when the editor is read-only, otherwise config.readOnly field is honored.

splitLine

protected void splitLine(java.lang.String line,
                         int row,
                         int splitAfter)

Replace line, splitting it if necessary

Parameters:

line - line's content

row - line's row

splitAfter - minimal split position

absoluteY

protected int absoluteY()

Get absolute vertical position in text.

Returns:

The vertical position in the text.

deleteCharacterKey

protected void deleteCharacterKey()

Delete character at current cursor position - called by processKeyEvent(com.goldencode.p2j.ui.client.event.KeyInput).

deleteCharacter

protected final boolean deleteCharacter()

Delete character at current cursor position.

Returns:

true if something was deleted.

parseContent

protected void parseContent(java.lang.String source,
                            int row,
                            boolean placeChar)

Parse content of the editor and prepare array of displayable values.

Parameters:

source - Source string to parse.

row - Row index to start parsing from.

placeChar - Set to true if called from placeChar(char) method in insert mode.

parseContentImpl

protected java.util.List<Editor.Line> parseContentImpl(java.lang.String source,
                                                       int start,
                                                       int offset,
                                                       boolean placeChar)

Worker to parse content of the editor and prepare array of displayable values.

Sub-classes can override this, to i.e. use cached metrics.

Parameters:

source - Source string to parse.

start - Row index to start parsing from.

offset - Text offset to start parsing from.

placeChar - Set to true if called from placeChar(char) method in insert mode.

resolveContent

protected final java.lang.String resolveContent()

Get a string representation of this editor's content.

Returns:

See above.

getFocusListener

protected FocusListener getFocusListener()

Get the focus listener instance.

Returns:

See above.

rtrim

protected java.lang.String rtrim(java.lang.String value)

Remove trailing whitespaces

Parameters:

value - the string to be truncated

Returns:

the truncated argument

updateOffset

protected void updateOffset()

Update widget content;

placeStringInt

private void placeStringInt(java.lang.String text)

Place string at current cursor position. Internal version.

Parameters:

text - String to place.

placeStringSegmentWrap

private void placeStringSegmentWrap(java.lang.String text)

Place string at current cursor position for the current line. Internal version. Possible text wrap should be considered here.

Parameters:

text - String to place.

placeStringSegment

private void placeStringSegment(java.lang.String text)

Place string at current cursor position for the current line. Internal version.

Parameters:

text - String to place.