com.goldencode.p2j.ui

Class EditorWidget

java.lang.Object

com.goldencode.p2j.util.HandleResource

com.goldencode.p2j.util.HandleChain

com.goldencode.p2j.ui.GenericWidget<T>

com.goldencode.p2j.ui.BaseEntity<T>

com.goldencode.p2j.ui.ControlEntity<T>

com.goldencode.p2j.ui.ControlTextWidget<EditorConfig>

com.goldencode.p2j.ui.EditorWidget

All Implemented Interfaces:

AutoResizableWidget, BoxInterface, Checkable, CommonWidget, ConfigOwner<EditorConfig>, CustomFont, DisableRedraw, Droppable, EditorInterface, Hoverable, ImageSupport, ImageWidgetSupport, IndexedInterface, InnerLines, Labels, MaxCharsElement, ReplaceInterface, ScrollbarHorizontalElement, ScrollbarVerticalElement, SelectableText, WidgetTree, WriteProtectable, CommonField, CommonHandle, CommonHandleChain, Coordinates, DatabaseInfo, Deletable, DynamicResource, HasVisible, InstantiatingProcedure, Nameable, Sensitive, Sizeable, WrappedResource, Printable

public class EditorWidget
extends ControlTextWidget<EditorConfig>
implements EditorInterface, ReplaceInterface, MaxCharsElement, BoxInterface, ScrollbarVerticalElement, ScrollbarHorizontalElement, InnerLines, SelectableText, Hoverable, Labels

Server side implementation of the EDITOR widget.

Nested Class Summary

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

BaseEntity.CharsPixels

Field Summary

Fields

Modifier and Type	Field and Description
static int	FIND_CASE_SENSITIVE Find & replace flags: the search is performed in case sensitive.
static int	FIND_GLOBAL Find & replace flags.
static int	FIND_NEXT_OCCURRENCE Find & replace flags: find next occurrence from the cursor.
static int	FIND_PREV_OCCURRENCE Find & replace flags: find previous occurrence from the cursor.
static int	FIND_SELECT Find & replace flags: the occurrence is selected, otherwise the cursor is moved at its beginning.
static int	FIND_WRAP_AROUND Find & replace flags: search loops from the beginning if the pattern is not found from the current cursor position up to the end of the text.

Fields inherited from class com.goldencode.p2j.ui.ControlEntity

ALIGN_COLON, ALIGN_LEFT, ALIGN_RIGHT

Fields inherited from class com.goldencode.p2j.ui.BaseEntity

group

Fields inherited from class com.goldencode.p2j.ui.GenericWidget

config, deleted, frame, internalScreenValueUsage, realizeOnAttributeAccess

Fields inherited from class com.goldencode.p2j.util.HandleChain

name, nextSibling, prevSibling, wa

Fields inherited from class com.goldencode.p2j.util.HandleResource

instProc, pm

Constructor Summary

Constructors

Constructor and Description
EditorWidget() Default constructor.
EditorWidget(boolean dynamic) Default constructor.

Method Summary

Modifier and Type	Method and Description
logical	clearSelection() Clears text selection.
logical	deleteLine() Implements the DELETE-LINE() method which deletes the line of text in which the cursor is positioned.
logical	editCopy() Copy the currently selected text into system Clipboard.
logical	editCut() Copy the currently selected text into system Clipboard and remove the currently selected text.
logical	editPaste() Paste the system Clipboard content into current cursor position.
logical	editUndo() Undo the last changes in text editable widget if possible.
integer	getCursorChar() Get the value of the CURSOR-CHAR attribute which is the current cursor position as a 1-based index on the current line.
integer	getCursorLine() Get the value of the CURSOR-LINE attribute which is the current cursor position as a 1-based line number.
integer	getCursorOffset() Obtains the index position of the cursor in a text editing widget.
integer	getInnerChars() Gets the value of the INNER-CHARS attribute which defines the number of character columns in the widget.
integer	getInnerLines() Gets the value of the INNER-LINES attribute which defines the number of text lines in the widget.
integer	getLength() Get the value of the LENGTH attribute
integer	getMaxChars() Get value of the MAX-CHARS attribute.
java.lang.String	getMousePointerImpl() Get the MOUSE-POINTER attribute
integer	getNumLines() Get the value of the NUM-LINES attribute which is the number of lines of text in the editor.
(package private) character	getScreenValue(boolean initialized, BaseDataType bdt, java.lang.String fmt, boolean ignoreFormat) Internal worker for getting the SCREEN-VALUE on a per-widget basis.
integer	getSelectionEnd() Get SELECTION-END attribute.
integer	getSelectionStart() Get SELECTION-START attribute.
character	getSelectionText() Get SELECTION-TEXT attribute.
handle	getSideLabelHandle() Obtains the text widget that is used as the side label for this widget.
boolean	hasFormat() Checks if the given widget has valid format string or even has the format attribute.
logical	insertFile(character file) Attempts to insert the content of a text file at the current position of the caret.
logical	insertFile(java.lang.String file) Attempts to insert the content of a text file at the current position of the caret.
logical	insertString(character txt) Implements the INSERT-STRING() method which inserts the given text into the editor at the location at which the cursor is positioned.
logical	insertString(java.lang.String txt) Implements the INSERT-STRING() method which inserts the given text into the editor at the location at which the cursor is positioned.
private void	invalidPosition(java.lang.String attr, int value) Report invalid cursor positioning attribute
logical	isAutoIndent() Get the value of the AUTO-INDENT attribute.
logical	isBox() Get the value of the BOX attribute
logical	isEditCanPaste() Checks if the Clipboard has data to paste from.
logical	isEditCanUndo() Checks if the widget can handle text undo request.
logical	isLabels() Gets the LABELS attribute.
logical	isLarge() Get the EDITOR's LARGE attribute.
logical	isReturnInserted() Get the value of the RETURN-INSERTED attribute
logical	isScrollbarHorizontal() Get the value of the SCROLLBAR-HORIZONTAL attribute which controls whether the widget must draw the horizontal scroll-bar if the inner width is more than the visible width.
logical	isScrollbarVertical() Get value of the SCROLLBAR-VERTICAL attribute.
logical	isTextSelected() Get TEXT-SELECTED attribute.
logical	isWordWrap() Get the value of the WORD-WRAP attribute
logical	moveCaretToEof() Moves the caret position at the end of the current text
logical	readFile(character name) Implements the READ-FILE() method which replaces the editor's contents with those read from the specified file.
logical	readFile(java.lang.String name) Implements the READ-FILE() method which replaces the editor's contents with those read from the specified file.
logical	removeSelection() Removes the currently selected text.
logical	replace(character newLabel, BaseDataType newValue, character oldItem) REPLACE(character, BaseDataType, character) method and its variations not applicable to the EDITOR widget
logical	replace(character newLabel, BaseDataType newValue, int listIndex) REPLACE (new-label, new-value, list-index) method for COMBO-BOX/SELECTION-LIST
logical	replace(character newLabel, BaseDataType newValue, integer listIndex) REPLACE (new-label, new-value, list-index) method for COMBO-BOX/SELECTION-LIST
logical	replace(character newLabel, BaseDataType newValue, java.lang.String oldItem) REPLACE(character, BaseDataType, character) method and its variations not applicable to the EDITOR widget
logical	replace(character from, character to) Implements the REPLACE() method with default FIND-NEXT-OCCURRENCE mode.
logical	replace(character from, character to, int flag) Implements the REPLACE() method.
logical	replace(character from, character to, integer flag) Implements the REPLACE() method.
logical	replace(character newItemList, int listIndex) REPLACE(character, integer) method and its variations not applicable to the EDITOR widget
logical	replace(character newItemList, integer listIndex) REPLACE(character, integer) method and its variations not applicable to the EDITOR widget
logical	replace(character from, java.lang.String to) Implements the REPLACE() method with default FIND-NEXT-OCCURRENCE mode.
logical	replace(character newLabel, java.lang.String newValue, character oldItem) REPLACE(character, BaseDataType, character) method and its variations not applicable to the EDITOR widget
logical	replace(character from, java.lang.String to, int flag) Implements the REPLACE() method.
logical	replace(character from, java.lang.String to, integer flag) Implements the REPLACE() method.
logical	replace(character newLabel, java.lang.String newValue, java.lang.String oldItem) REPLACE(character, BaseDataType, character) method and its variations not applicable to the EDITOR widget
logical	replace(java.lang.String newLabel, BaseDataType newValue, character oldItem) REPLACE(character, BaseDataType, character) method and its variations not applicable to the EDITOR widget
logical	replace(java.lang.String newLabel, BaseDataType newValue, int listIndex) REPLACE (new-label, new-value, list-index) method for COMBO-BOX/SELECTION-LIST
logical	replace(java.lang.String newLabel, BaseDataType newValue, integer listIndex) REPLACE (new-label, new-value, list-index) method for COMBO-BOX/SELECTION-LIST
logical	replace(java.lang.String newLabel, BaseDataType newValue, java.lang.String oldItem) REPLACE(character, BaseDataType, character) method and its variations not applicable to the EDITOR widget
logical	replace(java.lang.String from, character to) Implements the REPLACE() method with default FIND-NEXT-OCCURRENCE mode.
logical	replace(java.lang.String from, character to, int flag) Implements the REPLACE() method.
logical	replace(java.lang.String from, character to, integer flag) Implements the REPLACE() method.
logical	replace(java.lang.String newItemList, int listIndex) REPLACE(character, integer) method and its variations not applicable to the EDITOR widget
logical	replace(java.lang.String newItemList, integer listIndex) REPLACE(character, integer) method and its variations not applicable to the EDITOR widget
logical	replace(java.lang.String from, java.lang.String to) Implements the REPLACE() method with default FIND-NEXT-OCCURRENCE mode.
logical	replace(java.lang.String newLabel, java.lang.String newValue, character oldItem) REPLACE(character, BaseDataType, character) method and its variations not applicable to the EDITOR widget
logical	replace(java.lang.String from, java.lang.String to, int flag) Implements the REPLACE() method.
logical	replace(java.lang.String from, java.lang.String to, integer flag) Implements the REPLACE() method.
logical	replace(java.lang.String newLabel, java.lang.String newValue, java.lang.String oldItem) REPLACE(character, BaseDataType, character) method and its variations not applicable to the EDITOR widget
logical	replaceSelectionText(character txt) Implements the REPLACE-SELECTION-TEXT() method which replaces the editor's currently selected text with the given text.
logical	replaceSelectionText(java.lang.String txt) Implements the REPLACE-SELECTION-TEXT() method which replaces the editor's currently selected text with the given text.
logical	saveFile(character name) Implements the SAVE-FILE() method which write the editor's contents to the specified file.
logical	saveFile(java.lang.String name) Implements the SAVE-FILE() method which write the editor's contents to the specified file.
logical	search(character pattern, int64 mode) Searches for a specified string starting from the current text caret position.
logical	search(character pattern, long mode) Searches for a specified string starting from the current text caret position.
logical	search(java.lang.String pattern, int64 mode) Searches for a specified string starting from the current text caret position.
logical	search(java.lang.String pattern, long mode) Searches for a specified string starting from the current text caret position.
void	setAutoIndent(boolean autoIndent) Set the value of the AUTO-INDENT attribute.
void	setAutoIndent(logical autoIndent) Set the value of the AUTO-INDENT attribute.
void	setBox(boolean value) Set the value of the BOX attribute
void	setBox(logical value) Set the value of the BOX attribute
void	setBufferChars(int chars) Set value of the BUFFER-CHARS attribute.
void	setBufferChars(NumberType chars) Set value of the BUFFER-CHARS attribute.
void	setBufferLines(int lines) Set value of the BUFFER-LINES attribute.
void	setBufferLines(NumberType lines) Set value of the BUFFER-LINES attribute.
void	setCursorChar(double idx) Set the value of the CURSOR-CHAR attribute which moves the cursor position to the specified 1-based index on the current line.
void	setCursorChar(NumberType idx) Set the value of the CURSOR-CHAR attribute which moves the cursor position to the specified 1-based index on the current line.
void	setCursorLine(double line) Set the value of the CURSOR-LINE attribute which moves the cursor position to the specified 1-based line number.
void	setCursorLine(NumberType line) Set the value of the CURSOR-LINE attribute which moves the cursor position to the specified 1-based line number.
void	setCursorOffset(double offset) Sets the index position of the cursor in a text editing widget.
void	setCursorOffset(NumberType offset) Sets the index position of the cursor in a text editing widget.
void	setDataType(character dataType) Sets new value of DATA-TYPE attribute.
void	setDataType(java.lang.String dataType) Sets new value of DATA-TYPE attribute.
void	setInitialInnerLines(double lines) Sets the value of the INNER-LINES attribute which defines the number of text lines in the widget.
void	setInnerChars(double chars) Sets the value of the INNER-CHARS attribute which defines the number of character columns in the widget.
void	setInnerChars(NumberType chars) Sets the value of the INNER-CHARS attribute which defines the number of character columns in the widget.
void	setInnerLines(double lines) Sets the value of the INNER-LINES attribute which defines the number of text lines in the widget.
void	setInnerLines(NumberType lines) Sets the value of the INNER-LINES attribute which defines the number of text lines in the widget.
void	setLarge(boolean large) Mark this EDITOR widget as EDITOR LARGE, which can be used to display a value of type LONGCHAR.
void	setLarge(logical large) Mark this EDITOR widget as EDITOR LARGE, which can be used to display a value of type LONGCHAR.
void	setMaxChars(double chars) Set value of the MAX-CHARS attribute.
void	setMaxChars(NumberType chars) Set value of the MAX-CHARS attribute.
void	setMousePointerName(java.lang.String name) Set the MOUSE-POINTER attribute
void	setNoBox(boolean box) Set value of the BOX attribute as opposite to passed value.
void	setNoBox(logical box) Set value of the BOX attribute as opposite to passed value.
void	setNoWordWrap(boolean wordwrap) Set value of the WORD-WRAP attribute as opposite to passed value.
void	setNoWordWrap(logical wordwrap) Set value of the WORD-WRAP attribute as opposite to passed value.
void	setReturnInserted(boolean value) Set the value of the RETURN-INSERTED attribute
void	setReturnInserted(logical value) Set the value of the RETURN-INSERTED attribute
(package private) boolean	setScreenValue(ScreenBuffer frameBuf, java.lang.Object value, boolean inUIStmt) Internal worker for setting the SCREEN-VALUE on a per-widget basis.
void	setScrollbarHorizontal(boolean horiz) Set the value of the SCROLLBAR-HORIZONTAL attribute which controls whether the widget must draw the horizontal scroll-bar if the inner width is more than the visible width.
void	setScrollbarHorizontal(logical horiz) Set the value of the SCROLLBAR-HORIZONTAL attribute which controls whether the widget must draw the horizontal scroll-bar if the inner width is more than the visible width.
void	setScrollbarVertical(boolean vertical) Set value of the SCROLLBAR-VERTICAL attribute.
void	setScrollbarVertical(logical vertical) Set value of the SCROLLBAR-VERTICAL attribute.
logical	setSelection(int64 start, int end) Selects text in a widget between start and end points.
logical	setSelection(int64 start, int64 end) Selects text in a widget between start and end points.
logical	setSelection(int start, int end) Selects text in a widget between start and end points.
logical	setSelection(int start, int64 end) Selects text in a widget between start and end points.
void	setSideLabelHandle(handle label) Sets the text widget that is used as the side label for this widget.
void	setWordWrap(boolean value) Set the value of the WORD-WRAP attribute
void	setWordWrap(logical value) Set the value of the WORD-WRAP attribute

Methods inherited from class com.goldencode.p2j.ui.ControlTextWidget

isExpandLabel, isReadOnly, setAt, setAtFormatLength, setForceLabel, setHeader, setReadOnly, setStatic

Methods inherited from class com.goldencode.p2j.ui.ControlEntity

changeFontWorker, delete, firstChild, getColon, getDataClass, getDataType, getIndex, getNextTabItem, getPreviousTabItem, getPrevSibling, getSideLabelHandleWorker, getSizeAttrs, getTitle, hasSideLabelHandle, isAutoResize, isDropTarget, isModified, lastChild, processSideLabel, resetAutoResize, setAttrSpace, setAutoResize, setAutoResize, setColumnLabel, setColumnLabel, setDropTarget, setForceLabel, setHeightCharsWorker, setHeightPixelsWorker, setIndex, setIndex, setModified, setModified, setNoAttrSpace, setNoLabels, setSideLabelHandleWorker, setTitle, setTitle, setTo, setTo, setWidthCharsWorker, setWidthPixelsWorker, validateFields

Methods inherited from class com.goldencode.p2j.ui.BaseEntity

_getHeightChars, _getHeightPixels, _getWidthChars, _getWidthPixels, canSetPixelPositionInChui, emit4084Warning, emitUnableToAssignUnknownAttributeWarning, getBgColor, getBgColorRgb, getColumn, getDColor, getFgColor, getFgColorRgb, getFont, getFontInfo, getFontName, getFontSize, getFrameColumn, getFrameRow, getFrameX, getFrameY, getHeightChars, getHeightPixels, getNextSibling, getParent, getParent, getPfColor, getRow, getTooltip, getValidParentTypes, getWidthChars, getWidthPixels, getX, getY, isFontBold, isFontItalic, isFontUnderline, isMovable, isResizable, isSelected, isTabStop, prepareSizeChars, prepareSizePixels, pushLocAttrs, pushSizeAttrs, setAlign, setBgColor, setBgColor, setBgColor, setBgColorRgb, setBgColorRgb, setColon, setColon, setColumn, setColumn, setColumnOrRow, setColumnOrRowWorker, setDColor, setDColor, setDColor, setFgColor, setFgColor, setFgColor, setFgColorRgb, setFgColorRgb, setFont, setFontBold, setFontItalic, setFontName, setFontSize, setFontUnderline, setGroup, setHeightChars, setHeightChars, setHeightImpl, setHeightPixels, setHeightPixels, setMaxHeightCharsWorker, setMaxHeightPixelsWorker, setMaxWidthCharsWorker, setMaxWidthPixelsWorker, setMinHeightCharsWorker, setMinHeightPixelsWorker, setMinWidthCharsWorker, setMinWidthPixelsWorker, setMovable, setMovable, setParent, setPfColor, setPfColor, setPfColor, setResizable, setResizable, setRow, setRow, setSelected, setSelected, setSizeChars, setSizePixels, setSystemParent, setTabStop, setTabStop, setTooltip, setTooltip, setVirtHeightCharsWorker, setVirtHeightPixelsWorker, setVirtWidthCharsWorker, setVirtWidthPixelsWorker, setWidthChars, setWidthChars, setWidthImpl, setWidthPixels, setWidthPixels, setX, setX, setXorY, setXOrYWorker, setY, setY, useHandleChainSiblings, validateParent, validateSize, validColumnOrRow

Methods inherited from class com.goldencode.p2j.ui.GenericWidget

_dynamic, _getDbName, _getFormat, _getTable, _isEntered, _isHidden, _isNotEntered, _isRealized, _isVisible, _name, _setDynamic, _setVisible, afterConfigUpdate, apply, apply, apply, apply, asWidgetHandle, canAccess, canDelete, canPushWidgetAttr, cleanup, colorDisplay, colorPrompt, config, deselectRows, detachMenu, disable, dynamic, enable, finishConfigProcessing, finishSetup, flushWidgetAttrs, genAssignUnknownWarning, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getColumnFont, getColumnLabel, getContextHelpId, getConvert3D, getDbName, getFormat, getFrame, getFrameHandle, getFrameName, getHeight, getHelp, getHWND, getId, getImage, getLabel, getLabelFont, getLabelStr, getLogicalTerminal, getMaxHeightChars, getMaxWidthChars, getMenuKey, getMenuMouse, getMousePointer, getMousePosition, getNumColumns, getNumSelectedRows, getParentHandle, getPopupMenu, getQuery, getRetainShape, getScreenValue, getStretchToFit, getTable, getTabPosition, getTitleFont, getTransparent, getValidationExpression, getValidationMessage, getVirtHeight, getVirtHeightPixels, getVirtWidth, getVirtWidthPixels, getWidgetId, getWidth, getWindow, getZOrderClass, hasNameReadOnly, hasParent, hide, hide, implicitDeletion, inputValue, isAutoCompletion, isAutoReturn, isChained, isChecked, isDisableRedraw, isEntered, isFocusedRowSelected, isHidden, isKeepFrameZOrder, isManualHighlight, isMultiple, isNotEntered, isScrollable, isSelectable, isSelected, isSelected, isSensitive, isTabWidget, isThreeD, isValidatable, isVisible, labelSizeCheck, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadMousePointer, loadMousePointer, moveAfterTabItem, moveAfterTabItem, moveBeforeTabItem, moveBeforeTabItem, moveToBottom, moveToTop, moveToWorker, name, notQueryable, notQueryable, notSettable, notSettable, notWorker, openPopup, preRealizeCheck, pushScreenDefinition, pushWidgetAttr, pushWidgetAttr, readOnlyError, readOnlyError, realize, refresh, resourceDelete, restoreSharedState, saveSharedState, selectAll, selectFocusedRow, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttrs, setAutoCompletion, setAutoCompletion, setAutoReturn, setAutoReturn, setBlank, setChecked, setChecked, setColumnFont, setColumnFont, setContextHelpId, setContextHelpId, setConvert3D, setConvert3D, setDbname, setDeblank, setDisableAutoZap, setDisableRedraw, setFont, setFormat, setFormat, setFrame, setFrame, setFrame, setFrameHandle, setFrameHandle, setFrameHandle, setFromOCX, setHeight, setHelp, setHelp, setHelpDefault, setHelpStatic, setHidden, setHidden, setId, setKeepFrameZOrder, setKeepFrameZOrder, setLabel, setLabel, setLabel, setLabelFont, setLabelFont, setLabelInt, setManualHighlight, setManualHighlight, setMaxHeightChars, setMaxWidthChars, setMenuKey, setMenuKey, setMenuMouse, setMenuMouse, setMultiple, setMultiple, setNextTabItem, setNoAutoValidate, setNumSelectedRows, setParentHandle, setParentHandle, setPopupMenu, setPopupMenu, setQuery, setRetainShape, setRetainShape, setScreenLock, setScreenValue, setScreenValue, setScreenValue, setScreenValueInt, setScreenValueNoErrorHandling, setScrollable, setScrollable, setSelectable, setSelectable, setSensitive, setSensitive, setSensitive, setSensitive, setStretchToFit, setStretchToFit, setTable, setThreeD, setThreeD, setTitleFont, setTitleFont, setTransparent, setTransparent, setValidation, setValidation, setVertical, setVirtHeight, setVirtHeightPixels, setVirtWidth, setVirtWidthPixels, setVisible, setVisible, setWidgetId, setWidgetId, setWidth, truncatePixelSize, type, underline, underline, valid, validate, validateFields, validateFields, validateFields, validateLabelAssignment, view, warningAlreadyRealized, widgetName

Methods inherited from class com.goldencode.p2j.util.HandleChain

firstResource, firstResource, getHead, getNextSibling, getPrevSibling, getPrivateData, getTail, hasName, hasNameConstraints, hasNextSibling, hasPrevSibling, hasPrivateData, interlink, lastResource, lastResource, moveInChain, name, name, resolveChainType, setHead, setNextSibling, setNextSibling, setPrevSibling, setPrevSibling, setPrivateData, setPrivateData, setPrivateData, validateName

Methods inherited from class com.goldencode.p2j.util.HandleResource

_instantiatingProcedure, addToPool, doDelete, equals, hashCode, id, id, incrementTrigger, instantiatingProcedure, invalidAttribute, processResource, registerResource, resourceType, setInstantiatingProcedure, toString, unableToAssignUnknown, unknown

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.goldencode.p2j.ui.ReplaceInterface

replace, replace, replace, replace, replace, replace, replace, replace

Methods inherited from interface com.goldencode.p2j.ui.SelectableText

focusAndSelect

Methods inherited from interface com.goldencode.p2j.ui.Labels

setLabels, setLabels

Methods inherited from interface com.goldencode.p2j.ui.WriteProtectable

setReadOnly

Methods inherited from interface com.goldencode.p2j.ui.Droppable

endFileDrop, getDroppedFile, getDroppedFile, getNumDroppedFiles, setDropTarget

Methods inherited from interface com.goldencode.p2j.ui.CommonWidget

getIdEx, getListItems, setListItems, setListItems, setScreenValue

Methods inherited from interface com.goldencode.p2j.util.CommonHandleChain

getPrivateData, setPrivateData, setPrivateData

Methods inherited from interface com.goldencode.p2j.util.CommonHandle

resourceType

Methods inherited from interface com.goldencode.p2j.util.WrappedResource

id, id, unknown

Methods inherited from interface com.goldencode.p2j.util.Nameable

name, name

Methods inherited from interface com.goldencode.p2j.ui.DisableRedraw

setDisableRedraw

Methods inherited from interface com.goldencode.util.Printable

asString, print

Methods inherited from interface com.goldencode.p2j.util.Deletable

allowDelete

Field Detail

FIND_NEXT_OCCURRENCE

public static final int FIND_NEXT_OCCURRENCE

Find & replace flags: find next occurrence from the cursor.

See Also:

Constant Field Values

FIND_PREV_OCCURRENCE

public static final int FIND_PREV_OCCURRENCE

Find & replace flags: find previous occurrence from the cursor.

See Also:

Constant Field Values

FIND_CASE_SENSITIVE

public static final int FIND_CASE_SENSITIVE

Find & replace flags: the search is performed in case sensitive.

See Also:

Constant Field Values

FIND_GLOBAL

public static final int FIND_GLOBAL

Find & replace flags.

See Also:

Constant Field Values

FIND_WRAP_AROUND

public static final int FIND_WRAP_AROUND

Find & replace flags: search loops from the beginning if the pattern is not found from the current cursor position up to the end of the text.

See Also:

Constant Field Values

FIND_SELECT

public static final int FIND_SELECT

Find & replace flags: the occurrence is selected, otherwise the cursor is moved at its beginning.

See Also:

Constant Field Values

Constructor Detail

EditorWidget

public EditorWidget()

Default constructor.

EditorWidget

public EditorWidget(boolean dynamic)

Default constructor.

Parameters:

dynamic - Flag indicating if this is a static or dynamic resource.

Method Detail

setDataType

public void setDataType(character dataType)

Sets new value of DATA-TYPE attribute.

Specified by:

setDataType in interface CommonField

Overrides:

setDataType in class ControlEntity<EditorConfig>

Parameters:

dataType - new value of DATA-TYPE attribute

setDataType

public void setDataType(java.lang.String dataType)

Sets new value of DATA-TYPE attribute.

Specified by:

setDataType in interface CommonField

Overrides:

setDataType in class ControlEntity<EditorConfig>

Parameters:

dataType - new value of DATA-TYPE attribute

setLarge

public void setLarge(boolean large)

Mark this EDITOR widget as EDITOR LARGE, which can be used to display a value of type LONGCHAR.

In FWD, there is no special requirements to handle a longchar value at the widget level, on client-side. So, we are just tracking the attribute's value on server-side.

Specified by:

setLarge in interface EditorInterface

Parameters:

large - When true, this is a EDITOR LARGE widget.

setLarge

public void setLarge(logical large)

Mark this EDITOR widget as EDITOR LARGE, which can be used to display a value of type LONGCHAR.

Specified by:

setLarge in interface EditorInterface

Parameters:

large - When true, this is a EDITOR LARGE widget.

isLarge

public logical isLarge()

Get the EDITOR's LARGE attribute.

Specified by:

isLarge in interface EditorInterface

Returns:

When true, this is a EDITOR LARGE widget.

isAutoIndent

public logical isAutoIndent()

Get the value of the AUTO-INDENT attribute. When true a new line in the editor will be indented to the same column as the previous line.

Specified by:

isAutoIndent in interface EditorInterface

Returns:

The value of the attribute.

setAutoIndent

public void setAutoIndent(logical autoIndent)

Set the value of the AUTO-INDENT attribute.

Specified by:

setAutoIndent in interface EditorInterface

Parameters:

autoIndent - When true a new line in the editor will be indented to the same column as the previous line.

setAutoIndent

public void setAutoIndent(boolean autoIndent)

Set the value of the AUTO-INDENT attribute.

Specified by:

setAutoIndent in interface EditorInterface

Parameters:

autoIndent - When true a new line in the editor will be indented to the same column as the previous line.

isLabels

public logical isLabels()

Gets the LABELS attribute.

Specified by:

isLabels in interface Labels

Returns:

the current value of the LABELS attribute.

getInnerLines

public integer getInnerLines()

Gets the value of the INNER-LINES attribute which defines the number of text lines in the widget.

Specified by:

getInnerLines in interface InnerLines

Returns:

The number of lines of text.

setInitialInnerLines

public void setInitialInnerLines(double lines)

Sets the value of the INNER-LINES attribute which defines the number of text lines in the widget. For the INNER-LINES clause in the VIEW-AS phrase

Specified by:

setInitialInnerLines in interface InnerLines

Parameters:

lines - The new number of lines.

setInnerLines

public void setInnerLines(double lines)

Sets the value of the INNER-LINES attribute which defines the number of text lines in the widget.

Specified by:

setInnerLines in interface InnerLines

Parameters:

lines - The new number of lines.

setInnerLines

public void setInnerLines(NumberType lines)

Sets the value of the INNER-LINES attribute which defines the number of text lines in the widget.

Specified by:

setInnerLines in interface InnerLines

Parameters:

lines - The new number of lines.

getInnerChars

public integer getInnerChars()

Gets the value of the INNER-CHARS attribute which defines the number of character columns in the widget.

Specified by:

getInnerChars in interface ScrollbarHorizontalElement

Returns:

The number of character columns.

setInnerChars

public void setInnerChars(double chars)

Sets the value of the INNER-CHARS attribute which defines the number of character columns in the widget.

Specified by:

setInnerChars in interface ScrollbarHorizontalElement

Parameters:

chars - The new value for the attribute.

setInnerChars

public void setInnerChars(NumberType chars)

Sets the value of the INNER-CHARS attribute which defines the number of character columns in the widget.

Specified by:

setInnerChars in interface ScrollbarHorizontalElement

Parameters:

chars - The new value for the attribute.

setMaxChars

public void setMaxChars(double chars)

Set value of the MAX-CHARS attribute.

Specified by:

setMaxChars in interface MaxCharsElement

Parameters:

chars - The new value for the attribute.

setMaxChars

public void setMaxChars(NumberType chars)

Set value of the MAX-CHARS attribute.

Specified by:

setMaxChars in interface MaxCharsElement

Parameters:

chars - The new value for the attribute.

getMaxChars

public integer getMaxChars()

Get value of the MAX-CHARS attribute.

Specified by:

getMaxChars in interface MaxCharsElement

Returns:

value of the attribute.

setBufferChars

public void setBufferChars(int chars)

Set value of the BUFFER-CHARS attribute.

Parameters:

chars - The new value for the attribute.

setBufferChars

public void setBufferChars(NumberType chars)

Set value of the BUFFER-CHARS attribute.

Parameters:

chars - The new value for the attribute.

setBufferLines

public void setBufferLines(int lines)

Set value of the BUFFER-LINES attribute.

Parameters:

lines - The new value for the attribute.

setBufferLines

public void setBufferLines(NumberType lines)

Set value of the BUFFER-LINES attribute.

Parameters:

lines - The new value for the attribute.

setNoBox

public void setNoBox(boolean box)

Set value of the BOX attribute as opposite to passed value.

Parameters:

box - The new value for the attribute.

setNoBox

public void setNoBox(logical box)

Set value of the BOX attribute as opposite to passed value.

Parameters:

box - The new value for the attribute.

setNoWordWrap

public void setNoWordWrap(boolean wordwrap)

Set value of the WORD-WRAP attribute as opposite to passed value.

Parameters:

wordwrap - The new value for the attribute.

setNoWordWrap

public void setNoWordWrap(logical wordwrap)

Set value of the WORD-WRAP attribute as opposite to passed value.

Parameters:

wordwrap - The new value for the attribute.

setScrollbarVertical

public void setScrollbarVertical(boolean vertical)

Set value of the SCROLLBAR-VERTICAL attribute.

Specified by:

setScrollbarVertical in interface ScrollbarVerticalElement

Parameters:

vertical - The new value for the attribute.

setScrollbarVertical

public void setScrollbarVertical(logical vertical)

Set value of the SCROLLBAR-VERTICAL attribute.

Specified by:

setScrollbarVertical in interface ScrollbarVerticalElement

Parameters:

vertical - The new value for the attribute.

isScrollbarVertical

public logical isScrollbarVertical()

Get value of the SCROLLBAR-VERTICAL attribute.

Specified by:

isScrollbarVertical in interface ScrollbarVerticalElement

Returns:

value of the attribute.

isScrollbarHorizontal

public logical isScrollbarHorizontal()

Get the value of the SCROLLBAR-HORIZONTAL attribute which controls whether the widget must draw the horizontal scroll-bar if the inner width is more than the visible width.

Specified by:

isScrollbarHorizontal in interface ScrollbarHorizontalElement

Returns:

The value of the SCROLLBAR-HORIZONTAL attribute.

setScrollbarHorizontal

public void setScrollbarHorizontal(logical horiz)

Set the value of the SCROLLBAR-HORIZONTAL attribute which controls whether the widget must draw the horizontal scroll-bar if the inner width is more than the visible width.

Specified by:

setScrollbarHorizontal in interface ScrollbarHorizontalElement

Parameters:

horiz - The new value for the attribute.

setScrollbarHorizontal

public void setScrollbarHorizontal(boolean horiz)

Set the value of the SCROLLBAR-HORIZONTAL attribute which controls whether the widget must draw the horizontal scroll-bar if the inner width is more than the visible width.

Specified by:

setScrollbarHorizontal in interface ScrollbarHorizontalElement

Parameters:

horiz - The new value for the attribute.

setSelection

public logical setSelection(int64 start,
                            int64 end)

Selects text in a widget between start and end points.

Specified by:

setSelection in interface SelectableText

Parameters:

start - Starting offset.

end - Ending offset.

Returns:

true if the operation succeeded.

setSelection

public logical setSelection(int64 start,
                            int end)

Selects text in a widget between start and end points.

Specified by:

setSelection in interface SelectableText

Parameters:

start - Starting offset.

end - Ending offset.

Returns:

true if the operation succeeded.

setSelection

public logical setSelection(int start,
                            int64 end)

Selects text in a widget between start and end points.

Specified by:

setSelection in interface SelectableText

Parameters:

start - Starting offset.

end - Ending offset.

Returns:

true if the operation succeeded.

setSelection

public logical setSelection(int start,
                            int end)

Selects text in a widget between start and end points.

Specified by:

setSelection in interface SelectableText

Parameters:

start - Starting offset.

end - Ending offset.

Returns:

true if the operation succeeded.

clearSelection

public logical clearSelection()

Clears text selection. TODO: not working, EditorGuiImpl is not able to 'see' the [selectionActive] altered

Specified by:

clearSelection in interface SelectableText

removeSelection

public logical removeSelection()

Removes the currently selected text.

Specified by:

removeSelection in interface SelectableText

Returns:

always yes.

editCopy

public logical editCopy()

Copy the currently selected text into system Clipboard.

Specified by:

editCopy in interface SelectableText

Returns:

true if operation success, false otherwise.

editCut

public logical editCut()

Copy the currently selected text into system Clipboard and remove the currently selected text.

Specified by:

editCut in interface SelectableText

Returns:

true if operation success, false otherwise.

editPaste

public logical editPaste()

Paste the system Clipboard content into current cursor position.

Specified by:

editPaste in interface SelectableText

Returns:

true if operation success, false otherwise.

isEditCanPaste

public logical isEditCanPaste()

Checks if the Clipboard has data to paste from.

Specified by:

isEditCanPaste in interface SelectableText

Returns:

true if operation success, false otherwise.

isEditCanUndo

public logical isEditCanUndo()

Checks if the widget can handle text undo request.

Specified by:

isEditCanUndo in interface CommonWidget

Returns:

true if operation success, false otherwise.

editUndo

public logical editUndo()

Undo the last changes in text editable widget if possible.

Specified by:

editUndo in interface CommonWidget

Overrides:

editUndo in class GenericWidget<EditorConfig>

Returns:

true if operation success, false otherwise.

deleteLine

public logical deleteLine()

Implements the DELETE-LINE() method which deletes the line of text in which the cursor is positioned.

Specified by:

deleteLine in interface EditorInterface

Returns:

true if the line was deleted.

insertString

public logical insertString(character txt)

Implements the INSERT-STRING() method which inserts the given text into the editor at the location at which the cursor is positioned.

Specified by:

insertString in interface EditorInterface

Parameters:

txt - The text to be inserted.

Returns:

true if the text was inserted.

insertString

public logical insertString(java.lang.String txt)

Implements the INSERT-STRING() method which inserts the given text into the editor at the location at which the cursor is positioned.

Specified by:

insertString in interface EditorInterface

Parameters:

txt - The text to be inserted.

Returns:

true if the text was inserted.

readFile

public logical readFile(character name)

Implements the READ-FILE() method which replaces the editor's contents with those read from the specified file.

Specified by:

readFile in interface EditorInterface

Parameters:

name - The relative or absolute file name.

Returns:

true if the file was successfully read.

readFile

public logical readFile(java.lang.String name)

Implements the READ-FILE() method which replaces the editor's contents with those read from the specified file.

Specified by:

readFile in interface EditorInterface

Parameters:

name - The relative or absolute file name.

Returns:

true if the file was successfully read.

replaceSelectionText

public logical replaceSelectionText(character txt)

Implements the REPLACE-SELECTION-TEXT() method which replaces the editor's currently selected text with the given text.

Specified by:

replaceSelectionText in interface EditorInterface

Parameters:

txt - The replacement text.

Returns:

true if the text was successfully replaced.

replaceSelectionText

public logical replaceSelectionText(java.lang.String txt)

Implements the REPLACE-SELECTION-TEXT() method which replaces the editor's currently selected text with the given text.

Specified by:

replaceSelectionText in interface EditorInterface

Parameters:

txt - The replacement text.

Returns:

true if the text was successfully replaced.

saveFile

public logical saveFile(java.lang.String name)

Implements the SAVE-FILE() method which write the editor's contents to the specified file.

Specified by:

saveFile in interface EditorInterface

Parameters:

name - The relative or absolute file name.

Returns:

true if the file was successfully written.

saveFile

public logical saveFile(character name)

Implements the SAVE-FILE() method which write the editor's contents to the specified file.

Specified by:

saveFile in interface EditorInterface

Parameters:

name - The relative or absolute file name.

Returns:

true if the file was successfully written.

getCursorChar

public integer getCursorChar()

Get the value of the CURSOR-CHAR attribute which is the current cursor position as a 1-based index on the current line.

Specified by:

getCursorChar in interface EditorInterface

Returns:

The current position of the cursor on the current line.

setCursorChar

public void setCursorChar(double idx)

Set the value of the CURSOR-CHAR attribute which moves the cursor position to the specified 1-based index on the current line.

Specified by:

setCursorChar in interface EditorInterface

Parameters:

idx - The 1-based position to which to move.

setCursorChar

public void setCursorChar(NumberType idx)

Set the value of the CURSOR-CHAR attribute which moves the cursor position to the specified 1-based index on the current line.

Specified by:

setCursorChar in interface EditorInterface

Parameters:

idx - The 1-based position to which to move.

getCursorLine

public integer getCursorLine()

Get the value of the CURSOR-LINE attribute which is the current cursor position as a 1-based line number.

Specified by:

getCursorLine in interface EditorInterface

Returns:

The current position of the cursor on the current line.

setCursorLine

public void setCursorLine(double line)

Set the value of the CURSOR-LINE attribute which moves the cursor position to the specified 1-based line number.

Specified by:

setCursorLine in interface EditorInterface

Parameters:

line - The line to which to move.

setCursorLine

public void setCursorLine(NumberType line)

Set the value of the CURSOR-LINE attribute which moves the cursor position to the specified 1-based line number.

Specified by:

setCursorLine in interface EditorInterface

Parameters:

line - The line to which to move.

getCursorOffset

public integer getCursorOffset()

Obtains the index position of the cursor in a text editing widget. This corresponds to the CURSOR-OFFSET attribute in the EDITOR widget.

Specified by:

getCursorOffset in interface CommonWidget

Overrides:

getCursorOffset in class GenericWidget<EditorConfig>

Returns:

The character index at which the cursor is placed.

setCursorOffset

public void setCursorOffset(double offset)

Sets the index position of the cursor in a text editing widget. This corresponds to the CURSOR-OFFSET attribute in the EDITOR widget.

Specified by:

setCursorOffset in interface CommonWidget

Overrides:

setCursorOffset in class GenericWidget<EditorConfig>

Parameters:

offset - The character index at which the cursor is to be placed.

setCursorOffset

public void setCursorOffset(NumberType offset)

Sets the index position of the cursor in a text editing widget. This corresponds to the CURSOR-OFFSET attribute in the EDITOR widget.

Specified by:

setCursorOffset in interface CommonWidget

Overrides:

setCursorOffset in class GenericWidget<EditorConfig>

Parameters:

offset - The character index at which the cursor is to be placed.

getNumLines

public integer getNumLines()

Get the value of the NUM-LINES attribute which is the number of lines of text in the editor.

Specified by:

getNumLines in interface EditorInterface

Returns:

The number of lines in the editor.

isReturnInserted

public logical isReturnInserted()

Get the value of the RETURN-INSERTED attribute

Specified by:

isReturnInserted in interface EditorInterface

Returns:

the value of the attribute

setReturnInserted

public void setReturnInserted(logical value)

Set the value of the RETURN-INSERTED attribute

Specified by:

setReturnInserted in interface EditorInterface

Parameters:

value - the new value of the attribute

setReturnInserted

public void setReturnInserted(boolean value)

Set the value of the RETURN-INSERTED attribute

Specified by:

setReturnInserted in interface EditorInterface

Parameters:

value - the new value of the attribute

isWordWrap

public logical isWordWrap()

Get the value of the WORD-WRAP attribute

Specified by:

isWordWrap in interface EditorInterface

Returns:

the value of the attribute

setWordWrap

public void setWordWrap(logical value)

Set the value of the WORD-WRAP attribute

Specified by:

setWordWrap in interface EditorInterface

Parameters:

value - the new value of the attribute

setWordWrap

public void setWordWrap(boolean value)

Set the value of the WORD-WRAP attribute

Specified by:

setWordWrap in interface EditorInterface

Parameters:

value - the new value of the attribute

isBox

public logical isBox()

Get the value of the BOX attribute

Specified by:

isBox in interface BoxInterface

Returns:

the value of the attribute

setBox

public void setBox(logical value)

Set the value of the BOX attribute

Specified by:

setBox in interface BoxInterface

Parameters:

value - the new value of the attribute

setBox

public void setBox(boolean value)

Set the value of the BOX attribute

Specified by:

setBox in interface BoxInterface

Parameters:

value - the new value of the attribute

getLength

public integer getLength()

Get the value of the LENGTH attribute

Specified by:

getLength in interface EditorInterface

Returns:

the value of the attribute

getSelectionText

public character getSelectionText()

Get SELECTION-TEXT attribute.

Specified by:

getSelectionText in interface SelectableText

Returns:

SELECTION-TEXT value

getSelectionEnd

public integer getSelectionEnd()

Get SELECTION-END attribute.

Specified by:

getSelectionEnd in interface SelectableText

Returns:

SELECTION-END value

getSelectionStart

public integer getSelectionStart()

Get SELECTION-START attribute.

Specified by:

getSelectionStart in interface SelectableText

Returns:

SELECTION-START value

isTextSelected

public logical isTextSelected()

Get TEXT-SELECTED attribute.

Specified by:

isTextSelected in interface SelectableText

Overrides:

isTextSelected in class GenericWidget<EditorConfig>

Returns:

TEXT-SELECTED value

replace

public logical replace(character from,
                       character to,
                       integer flag)

Implements the REPLACE() method.

Specified by:

replace in interface ReplaceInterface

Parameters:

from - The source text.

to - The replacement text.

flag - The type of search to be performed..

Returns:

true if the text was successfully replaced.

replace

public logical replace(java.lang.String from,
                       character to,
                       integer flag)

Implements the REPLACE() method.

Specified by:

replace in interface ReplaceInterface

Parameters:

from - The source text.

to - The replacement text.

flag - The type of search to be performed..

Returns:

true if the text was successfully replaced.

replace

public logical replace(character from,
                       java.lang.String to,
                       integer flag)

Implements the REPLACE() method.

Specified by:

replace in interface ReplaceInterface

Parameters:

from - The source text.

to - The replacement text.

flag - The type of search to be performed..

Returns:

true if the text was successfully replaced.

replace

public logical replace(character from,
                       character to,
                       int flag)

Implements the REPLACE() method.

Specified by:

replace in interface ReplaceInterface

Parameters:

from - The source text.

to - The replacement text.

flag - The type of search to be performed..

Returns:

true if the text was successfully replaced.

replace

public logical replace(java.lang.String from,
                       character to,
                       int flag)

Implements the REPLACE() method.

Specified by:

replace in interface ReplaceInterface

Parameters:

from - The source text.

to - The replacement text.

flag - The type of search to be performed..

Returns:

true if the text was successfully replaced.

replace

public logical replace(character from,
                       java.lang.String to,
                       int flag)

Implements the REPLACE() method.

Specified by:

replace in interface ReplaceInterface

Parameters:

from - The source text.

to - The replacement text.

flag - The type of search to be performed..

Returns:

true if the text was successfully replaced.

replace

public logical replace(java.lang.String from,
                       java.lang.String to,
                       integer flag)

Implements the REPLACE() method.

Specified by:

replace in interface ReplaceInterface

Parameters:

from - The source text.

to - The replacement text.

flag - The type of search to be performed..

Returns:

true if the text was successfully replaced.

replace

public logical replace(java.lang.String from,
                       java.lang.String to,
                       int flag)

Implements the REPLACE() method.

Specified by:

replace in interface ReplaceInterface

Parameters:

from - The source text.

to - The replacement text.

flag - The type of search to be performed..

Returns:

true if the text was successfully replaced.

replace

public logical replace(character from,
                       character to)

Implements the REPLACE() method with default FIND-NEXT-OCCURRENCE mode.

Specified by:

replace in interface ReplaceInterface

Parameters:

from - The source text.

to - The replacement text.

Returns:

true if the text was successfully replaced.

replace

public logical replace(character from,
                       java.lang.String to)

Implements the REPLACE() method with default FIND-NEXT-OCCURRENCE mode.

Specified by:

replace in interface ReplaceInterface

Parameters:

from - The source text.

to - The replacement text.

Returns:

true if the text was successfully replaced.

replace

public logical replace(java.lang.String from,
                       character to)

Implements the REPLACE() method with default FIND-NEXT-OCCURRENCE mode.

Specified by:

replace in interface ReplaceInterface

Parameters:

from - The source text.

to - The replacement text.

Returns:

true if the text was successfully replaced.

replace

public logical replace(java.lang.String from,
                       java.lang.String to)

Implements the REPLACE() method with default FIND-NEXT-OCCURRENCE mode.

Specified by:

replace in interface ReplaceInterface

Parameters:

from - The source text.

to - The replacement text.

Returns:

true if the text was successfully replaced.

replace

public logical replace(character newItemList,
                       integer listIndex)

REPLACE(character, integer) method and its variations not applicable to the EDITOR widget

Specified by:

replace in interface ReplaceInterface

Parameters:

newItemList - new item list

listIndex - old item's index

Returns:

true if the operation was successful.

replace

public logical replace(character newItemList,
                       int listIndex)

REPLACE(character, integer) method and its variations not applicable to the EDITOR widget

Specified by:

replace in interface ReplaceInterface

Parameters:

newItemList - new item list

listIndex - old item's index

Returns:

true if the operation was successful.

replace

public logical replace(java.lang.String newItemList,
                       integer listIndex)

REPLACE(character, integer) method and its variations not applicable to the EDITOR widget

Specified by:

replace in interface ReplaceInterface

Parameters:

newItemList - new item list

listIndex - old item's index

Returns:

true if the operation was successful.

replace

public logical replace(java.lang.String newItemList,
                       int listIndex)

REPLACE(character, integer) method and its variations not applicable to the EDITOR widget

Specified by:

replace in interface ReplaceInterface

Parameters:

newItemList - new item list

listIndex - old item's index

Returns:

true if the operation was successful.

replace

public logical replace(character newLabel,
                       BaseDataType newValue,
                       character oldItem)

REPLACE(character, BaseDataType, character) method and its variations not applicable to the EDITOR widget

Specified by:

replace in interface ReplaceInterface

Parameters:

newLabel - new item's label

newValue - new item's value

oldItem - oldItem (old-label for the READIO-SET, and list-item for the COMBO-BOX/SELECTION-LIST)

Returns:

true if the operation was successful.

replace

public logical replace(java.lang.String newLabel,
                       BaseDataType newValue,
                       character oldItem)

REPLACE(character, BaseDataType, character) method and its variations not applicable to the EDITOR widget

Specified by:

replace in interface ReplaceInterface

Parameters:

newLabel - new item's label

newValue - new item's value

oldItem - oldItem (old-label for the READIO-SET, and list-item for the COMBO-BOX/SELECTION-LIST)

Returns:

true if the operation was successful.

replace

public logical replace(character newLabel,
                       java.lang.String newValue,
                       character oldItem)

REPLACE(character, BaseDataType, character) method and its variations not applicable to the EDITOR widget

Specified by:

replace in interface ReplaceInterface

Parameters:

newLabel - new item's label

newValue - new item's value

oldItem - oldItem (old-label for the READIO-SET, and list-item for the COMBO-BOX/SELECTION-LIST)

Returns:

true if the operation was successful.

replace

public logical replace(java.lang.String newLabel,
                       java.lang.String newValue,
                       character oldItem)

REPLACE(character, BaseDataType, character) method and its variations not applicable to the EDITOR widget

Specified by:

replace in interface ReplaceInterface

Parameters:

newLabel - new item's label

newValue - new item's value

oldItem - oldItem (old-label for the READIO-SET, and list-item for the COMBO-BOX/SELECTION-LIST)

Returns:

true if the operation was successful.

replace

public logical replace(character newLabel,
                       BaseDataType newValue,
                       java.lang.String oldItem)

REPLACE(character, BaseDataType, character) method and its variations not applicable to the EDITOR widget

Specified by:

replace in interface ReplaceInterface

Parameters:

newLabel - new item's label

newValue - new item's value

oldItem - oldItem (old-label for the READIO-SET, and list-item for the COMBO-BOX/SELECTION-LIST)

Returns:

true if the operation was successful.

replace

public logical replace(java.lang.String newLabel,
                       BaseDataType newValue,
                       java.lang.String oldItem)

REPLACE(character, BaseDataType, character) method and its variations not applicable to the EDITOR widget

Specified by:

replace in interface ReplaceInterface

Parameters:

newLabel - new item's label

newValue - new item's value

oldItem - oldItem (old-label for the READIO-SET, and list-item for the COMBO-BOX/SELECTION-LIST)

Returns:

true if the operation was successful.

replace

public logical replace(character newLabel,
                       java.lang.String newValue,
                       java.lang.String oldItem)

REPLACE(character, BaseDataType, character) method and its variations not applicable to the EDITOR widget

Specified by:

replace in interface ReplaceInterface

Parameters:

newLabel - new item's label

newValue - new item's value

oldItem - oldItem (old-label for the READIO-SET, and list-item for the COMBO-BOX/SELECTION-LIST)

Returns:

true if the operation was successful.

replace

public logical replace(java.lang.String newLabel,
                       java.lang.String newValue,
                       java.lang.String oldItem)

REPLACE(character, BaseDataType, character) method and its variations not applicable to the EDITOR widget

Specified by:

replace in interface ReplaceInterface

Parameters:

newLabel - new item's label

newValue - new item's value

oldItem - oldItem (old-label for the READIO-SET, and list-item for the COMBO-BOX/SELECTION-LIST)

Returns:

true if the operation was successful.

replace

public logical replace(character newLabel,
                       BaseDataType newValue,
                       integer listIndex)

REPLACE (new-label, new-value, list-index) method for COMBO-BOX/SELECTION-LIST

Specified by:

replace in interface ReplaceInterface

Parameters:

newLabel - new item's label

newValue - new item's value

listIndex - index of the item to be replaced

Returns:

true if the operation was successful.

replace

public logical replace(java.lang.String newLabel,
                       BaseDataType newValue,
                       integer listIndex)

REPLACE (new-label, new-value, list-index) method for COMBO-BOX/SELECTION-LIST

Specified by:

replace in interface ReplaceInterface

Parameters:

newLabel - new item's label

newValue - new item's value

listIndex - index of the item to be replaced

Returns:

true if the operation was successful.

replace

public logical replace(character newLabel,
                       BaseDataType newValue,
                       int listIndex)

REPLACE (new-label, new-value, list-index) method for COMBO-BOX/SELECTION-LIST

Specified by:

replace in interface ReplaceInterface

Parameters:

newLabel - new item's label

newValue - new item's value

listIndex - index of the item to be replaced

Returns:

true if the operation was successful.

replace

public logical replace(java.lang.String newLabel,
                       BaseDataType newValue,
                       int listIndex)

REPLACE (new-label, new-value, list-index) method for COMBO-BOX/SELECTION-LIST

Specified by:

replace in interface ReplaceInterface

Parameters:

newLabel - new item's label

newValue - new item's value

listIndex - index of the item to be replaced

Returns:

true if the operation was successful.

invalidPosition

private void invalidPosition(java.lang.String attr,
                             int value)

Report invalid cursor positioning attribute

Parameters:

attr - attribute name

value - attribute value

setMousePointerName

public void setMousePointerName(java.lang.String name)

Set the MOUSE-POINTER attribute

Specified by:

setMousePointerName in interface Hoverable

Parameters:

name - the attribute value

getMousePointerImpl

public java.lang.String getMousePointerImpl()

Get the MOUSE-POINTER attribute

Specified by:

getMousePointerImpl in interface Hoverable

Returns:

the attribute value

hasFormat

public boolean hasFormat()

Checks if the given widget has valid format string or even has the format attribute.

Overrides:

hasFormat in class GenericWidget<EditorConfig>

Returns:

FALSE, editor does not have the format option.

setSideLabelHandle

public void setSideLabelHandle(handle label)

Sets the text widget that is used as the side label for this widget. This is the equivalent of the SIDE-LABEL-HANDLE attribute of COMBO-BOX, EDITOR, FILL-IN, RADIO-SET, SELECTION-LIST, SLIDER and TEXT widgets.

Specified by:

setSideLabelHandle in interface CommonWidget

Overrides:

setSideLabelHandle in class GenericWidget<EditorConfig>

Parameters:

label - The handle to the text widget to be used as the side label of this widget.

getSideLabelHandle

public handle getSideLabelHandle()

Obtains the text widget that is used as the side label for this widget. This is the equivalent of the SIDE-LABEL-HANDLE attribute of COMBO-BOX, EDITOR, FILL-IN, RADIO-SET, SELECTION-LIST, SLIDER and TEXT widgets.

Specified by:

getSideLabelHandle in interface CommonWidget

Overrides:

getSideLabelHandle in class GenericWidget<EditorConfig>

Returns:

The handle to the text widget that is the side label of this widget.

getScreenValue

character getScreenValue(boolean initialized,
                         BaseDataType bdt,
                         java.lang.String fmt,
                         boolean ignoreFormat)

Internal worker for getting the SCREEN-VALUE on a per-widget basis.

Overrides:

getScreenValue in class GenericWidget<EditorConfig>

Parameters:

initialized - Flag indicating if the widget is realized or not.

bdt - The current value in the frame's buffer.

fmt - The format to be applied, in case this is a formatted value.

ignoreFormat - Flag indicating if the format needs to be ignored.

Returns:

This widget's screen-value

setScreenValue

boolean setScreenValue(ScreenBuffer frameBuf,
                       java.lang.Object value,
                       boolean inUIStmt)

Internal worker for setting the SCREEN-VALUE on a per-widget basis.

Overrides:

setScreenValue in class GenericWidget<EditorConfig>

Parameters:

frameBuf - The frame buffer where to save the value.

value - The value to be set via SCREEN-VALUE attribute.

inUIStmt - Flag indicating this call originates from a UI statement.

Returns:

true if the caller can proceed, as the screen-value can be set.

insertFile

public logical insertFile(java.lang.String file)

Attempts to insert the content of a text file at the current position of the caret.

Specified by:

insertFile in interface EditorInterface

Parameters:

file - The file whose content should be inserted. Full or relative path may be used. In latter case, the PROPATH is used to find the file.

Returns:

if the text insertion succeeded, the method returns yes.

insertFile

public logical insertFile(character file)

Attempts to insert the content of a text file at the current position of the caret.

Specified by:

insertFile in interface EditorInterface

Parameters:

file - The file whose content should be inserted. Full or relative path may be used. In latter case, the PROPATH is used to find the file.

Returns:

if the text insertion succeeded, the method returns yes.

search

public logical search(java.lang.String pattern,
                      long mode)

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

Specified by:

search in interface EditorInterface

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
FIND-NEXT-OCCURRENCE	1
FIND-PREV-OCCURRENCE	2
FIND-CASE-SENSITIVE	4
FIND-WRAP-AROUND	16
FIND-SELECT	32

Returns:

if the text is found and caret moved, the method returns yes.

search

public logical search(character pattern,
                      long mode)

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

Specified by:

search in interface EditorInterface

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
FIND-NEXT-OCCURRENCE	1
FIND-PREV-OCCURRENCE	2
FIND-CASE-SENSITIVE	4
FIND-WRAP-AROUND	16
FIND-SELECT	32

Returns:

if the text is found and caret moved, the method returns yes.

search

public logical search(java.lang.String pattern,
                      int64 mode)

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

Specified by:

search in interface EditorInterface

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
FIND-NEXT-OCCURRENCE	1
FIND-PREV-OCCURRENCE	2
FIND-CASE-SENSITIVE	4
FIND-WRAP-AROUND	16
FIND-SELECT	32

Returns:

if the text is found and caret moved, the method returns yes.

search

public logical search(character pattern,
                      int64 mode)

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

Specified by:

search in interface EditorInterface

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
FIND-NEXT-OCCURRENCE	1
FIND-PREV-OCCURRENCE	2
FIND-CASE-SENSITIVE	4
FIND-WRAP-AROUND	16
FIND-SELECT	32

Returns:

if the text is found and caret moved, the method returns yes.

moveCaretToEof

public logical moveCaretToEof()

Moves the caret position at the end of the current text

Specified by:

moveCaretToEof in interface EditorInterface

Returns:

if the operation is successful, the method returns yes.