com.goldencode.p2j.ui

Class ComboBoxWidget

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.ControlSetEntity<ComboBoxConfig>

com.goldencode.p2j.ui.ComboBoxWidget

All Implemented Interfaces:

AutoResizableWidget, AutoZapElement, Checkable, CommonListWidget<ComboBoxConfig>, CommonWidget, ConfigOwner<ComboBoxConfig>, CustomFont, DisableRedraw, Droppable, Hoverable, ImageSupport, ImageWidgetSupport, IndexedInterface, InnerLines, Labels, MaxCharsElement, ReplaceInterface, SelectableText, SortedElement, WidgetTree, WriteProtectable, CommonField, CommonHandle, CommonHandleChain, Coordinates, DatabaseInfo, Deletable, DynamicResource, HasVisible, InstantiatingProcedure, Nameable, NumItems, Sensitive, Sizeable, SubTypeAttribute, WrappedResource, Printable

public class ComboBoxWidget
extends ControlSetEntity<ComboBoxConfig>
implements AutoZapElement, MaxCharsElement, NumItems, SortedElement, InnerLines, SelectableText, SubTypeAttribute, Labels

Server side combo box widget implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	ComboBoxWidget.ListItemPairsConfig Class which stores the configuration of LIST-ITEM-PAIRS for this combo-box.

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

ControlSetEntity.BiPredicate<T,U>

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

BaseEntity.CharsPixels

Field Summary

Fields

Modifier and Type	Field and Description
protected ComboBoxWidget.ListItemPairsConfig	listItemPairsConfig The configuration used for LIST-ITEM-PAIRS by this combo-box.

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

COMPARE_LABEL, COMPARE_LABEL_IGNORE_CASE, COMPARE_VALUE_IGNORE_CASE, LTRIM, RTRIM

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
ComboBoxWidget() Default constructor.
ComboBoxWidget(boolean dynamic) Constructor.

Method Summary

Modifier and Type	Method and Description
private void	checkItems(ControlSetItem[] items, boolean append) Verify which items needs to be set as SCREEN-VALUE.
logical	clearSelection() Clears text selection
protected ControlSetItem	controlSetItem(character label, BaseDataType value) Create new ControlSetItem
logical	delete(character itemList) Implements the DELETE() widget method, which removes the list item or items specified.
logical	delete(long idx) Implements the DELETE() widget method, which removes the list item at the given index.
logical	delete(java.lang.String itemList) Implements the DELETE() widget method, which removes the list item or items specified.
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.
character	entry(long index) Implements the ENTRY() widget method.
void	finishSetup() Finish initialization of the combo box widget.
integer	getCursorOffset() Obtains the index position of the cursor in a text editing widget.
decimal	getHeightChars() Gets the HEIGHT-CHARS writable attribute.
integer	getInnerLines() Gets the value of the INNER-LINES attribute which defines the number of text lines in the widget.
character	getItemValue(character value) Retrieves the corresponding control set item of the COMBO-BOX for the given value.
integer	getMaxChars() Get value of the MAX-CHARS attribute.
integer	getNumItems() Get the NUM-ITEMS attribute.
character	getScreenValue() Obtain the current value in the screen buffer of the backing data for this widget and return it as a character type.
(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.
character	getSubType() Obtain the subtype of the handle.
protected boolean	ignore(BaseDataType value) Checks if a value should be ignored (UNKNOWN for COMBO-BOX).
protected boolean	ignore(java.lang.String value) Checks if a value should be ignored ("?" for COMBO-BOX).
BaseDataType	inputValue() Reads the INPUT-VALUE attribute (value of the widget currently in the screen-buffer).
protected boolean	invalid(character label, BaseDataType value) Checks if a (label,value) pair is not acceptable for this widget.
logical	isAutoCompletion() Get AUTO-COMPLETION attribute value.
logical	isAutoZap() Get value of the AUTO-ZAP attribute.
logical	isDisableAutoZap() Get value of the DISABLE-AUTO-ZAP 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	isTextSelected() Get TEXT-SELECTED attribute.
protected boolean	isValidScreenValue(character value) Check if the tested value is in the control-set values.
logical	removeSelection() Removes selected text.
protected java.lang.String	resolveFormat() Resolve the format for this widget, used to generate the labels.
void	setAutoCompletion(boolean autoCompletion) Set AUTO-COMPLETION attribute value.
void	setAutoCompletion(logical autoCompletion) Set AUTO-COMPLETION attribute value.
void	setAutoZap(boolean value) Set AUTO-ZAP attribute.
void	setAutoZap(logical value) Set AUTO-ZAP attribute.
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(java.lang.String dataType) Set the widget's DATA-TYPE.
void	setDisableAutoZap(boolean disableAutoZap) Sets the DISABLE-AUTO-ZAP option.
void	setDisableAutoZap(logical disableAutoZap) Sets the DISABLE-AUTO-ZAP option.
void	setFormat(java.lang.String format) Sets the format specification.
void	setFrame(FrameWidget frame) Sets the containing frame instance.
void	setHeightChars(double height) Sets the HEIGHT-CHARS writable attribute.
void	setHeightChars(NumberType height) Sets the HEIGHT-CHARS writable attribute.
void	setHeightPixels(int heightPixels) Sets new value of HEIGHT-PIXELS attribute.
void	setHeightPixels(NumberType heightPixels) Sets new value of HEIGHT-PIXELS attribute.
void	setInitialInnerLines(double lines) Sets the value of the INNER-LINES attribute which defines the number of text lines 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.
protected void	setItems(ControlSetItem[] items, java.lang.Boolean pairs, boolean checkItems, java.util.List<ControlSetItem> newAddedItems, boolean append) Store array of items into config.
void	setListItemPairs(character list) Common implementation list item pair attributes (LIST-ITEM-PAIRS and RADIO-BUTTONS) attribute.
void	setMaxChars(double maxChars) Set value of the MAX-CHARS attribute.
void	setMaxChars(NumberType maxChars) Set value of the MAX-CHARS attribute.
void	setModeDropDown(boolean b) Set DROP-DOWN mode for the widget.
void	setModeDropDownList(boolean b) Set DROP-DOWN-LIST mode for the widget.
void	setModeSimple(boolean b) Set SIMPLE mode for the widget.
protected void	setScreenValueInt(character value) Set the current value in the screen buffer of the backing data for this widget.
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	setSubType(character value) Sets the the subtype of the combobox.
void	setSubType(java.lang.String value) Sets the the subtype of the combobox.
protected BaseDataType	truncateValue(BaseDataType value) Remove trailing whitespaces if applicable
protected java.lang.String	truncateValue(java.lang.String value) Remove trailing spaces.
protected ControlSetItem[]	truncateValues(ControlSetItem[] items) Truncate values of the provided items and remove invalid ones.
(package private) boolean	validateScreenValue(character value, character unparsedValue) Validate the value(s) for SCREEN-VALUE attribute.

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

add, add, addFirst, addFirst, addFirst, addFirst, addFirst, addFirst, addFirst, addFirst, addFirst, addLast, addLast, addLast, addLast, addLast, addLast, checkIfNotPairs, checkValue, delete, delete, delete, delete, delete, entry, getDelimiter, getItemIndex, getListItemPairs, getListItems, getMousePointerImpl, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, isExpandLabel, isSort, isValidScreenValue, itemIndex, lookup, lookup, pairs, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, setDelimiter, setDelimiter, setHonorFormat, setItems, setListItemPairs, setListItemPairsWorker, setListItems, setListItems, setMousePointerName, setScreenValue, setSort, setSort, useListItemPairs, useListItems

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, setDataType, setDropTarget, setForceLabel, 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, 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, setHeightImpl, 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, 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, getStretchToFit, getTable, getTabPosition, getTitleFont, getTransparent, getValidationExpression, getValidationMessage, getVirtHeight, getVirtHeightPixels, getVirtWidth, getVirtWidthPixels, getWidgetId, getWidth, getWindow, getZOrderClass, hasFormat, hasNameReadOnly, hasParent, hide, hide, implicitDeletion, isAutoReturn, isChained, isChecked, isDisableRedraw, isEntered, isFocusedRowSelected, isHidden, isKeepFrameZOrder, isManualHighlight, isMultiple, isNotEntered, isReadOnly, 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, setAtFormatLength, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttrs, setAutoReturn, setAutoReturn, setBlank, setChecked, setChecked, setColumnFont, setColumnFont, setContextHelpId, setContextHelpId, setConvert3D, setConvert3D, setDbname, setDeblank, setDisableRedraw, setFont, setFormat, setFrame, setFrame, setFrameHandle, setFrameHandle, setFrameHandle, setFromOCX, setHeader, 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, setReadOnly, setRetainShape, setRetainShape, setScreenLock, setScreenValue, setScreenValue, setScreenValue, 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.SortedElement

isSort, setSort, setSort

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

setItems

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

apply, apply, apply, apply, asWidgetHandle, colorDisplay, colorPrompt, deselectRows, disable, enable, getBgColor, getBgColorRgb, getColumnFont, getContextHelpId, getDColor, getFgColor, getFgColorRgb, getFont, getFrame, getFrameColumn, getFrameHandle, getFrameName, getFrameRow, getFrameX, getFrameY, getHWND, getId, getIdEx, getImage, getLabelFont, getLabelStr, getMaxHeightChars, getMaxWidthChars, getMenuKey, getMenuMouse, getMousePointer, getMousePosition, getNextTabItem, getNumColumns, getNumSelectedRows, getParent, getParentHandle, getPfColor, getPopupMenu, getPreviousTabItem, getQuery, getTabPosition, getTitle, getTitleFont, getTooltip, getVirtHeight, getVirtHeightPixels, getVirtWidth, getVirtWidthPixels, getWidgetId, getWindow, hide, hide, isAutoResize, isEntered, isFocusedRowSelected, isHidden, isKeepFrameZOrder, isManualHighlight, isModified, isMovable, isMultiple, isNotEntered, isResizable, isScrollable, isSelectable, isSelected, isSelected, isSelected, isTabStop, isThreeD, isValidatable, loadMousePointer, loadMousePointer, moveAfterTabItem, moveAfterTabItem, moveBeforeTabItem, moveBeforeTabItem, moveToBottom, moveToTop, openPopup, preRealizeCheck, realize, refresh, selectAll, selectFocusedRow, setAtFormatLength, setAutoResize, setAutoResize, setBgColor, setBgColorRgb, setBlank, setColumnFont, setColumnFont, setContextHelpId, setContextHelpId, setDColor, setDColor, setDeblank, setFgColor, setFgColorRgb, setFont, setFont, setFrame, setFrame, setFrameHandle, setFrameHandle, setFrameHandle, setGroup, setHeader, setHidden, setHidden, setId, setKeepFrameZOrder, setKeepFrameZOrder, setLabelFont, setLabelFont, setManualHighlight, setManualHighlight, setMaxHeightChars, setMaxWidthChars, setMenuKey, setMenuKey, setMenuMouse, setMenuMouse, setModified, setModified, setMovable, setMovable, setMultiple, setMultiple, setNextTabItem, setNumSelectedRows, setParent, setParentHandle, setParentHandle, setPfColor, setPfColor, setPopupMenu, setPopupMenu, setQuery, setResizable, setResizable, setScreenValue, setScreenValue, setScrollable, setScrollable, setSelectable, setSelectable, setSelected, setSelected, setSensitive, setTabStop, setTabStop, setThreeD, setThreeD, setTitle, setTitle, setTitleFont, setTitleFont, setTooltip, setTooltip, setValidation, setValidation, setVertical, setVirtHeight, setVirtHeightPixels, setVirtWidth, setVirtWidthPixels, setWidgetId, setWidgetId, underline, underline, valid, validateFields, validateFields, validateFields, view

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

getNextSibling, getPrevSibling, getPrivateData, setPrivateData, setPrivateData

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

readOnlyError, readOnlyError, resourceType

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

id, id, unknown

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

name, name, name

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

getColumnLabel, getDataType, getFormat, getHelp, getLabel, setColumnLabel, setColumnLabel, setDataType, setFormat, setHelp, setHelp, setLabel, setLabel, setLabel

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

getDbName, getTable

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

isDisableRedraw, setDisableRedraw, setDisableRedraw

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

isVisible, setVisible, setVisible

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

getHeight, getHeightPixels, getWidth, getWidthChars, getWidthPixels, setHeight, setWidth, setWidthChars, setWidthChars, setWidthPixels, setWidthPixels

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

getColumn, getRow, getX, getY, setColumn, setColumn, setRow, setRow, setX, setX, setY, setY

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

getRetainShape, getStretchToFit, getTransparent, setRetainShape, setRetainShape, setStretchToFit, setStretchToFit, setTransparent, setTransparent

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

getConvert3D, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, setConvert3D, setConvert3D

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

isReadOnly, setReadOnly, setReadOnly

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

endFileDrop, getDroppedFile, getDroppedFile, getNumDroppedFiles, setDropTarget

Methods inherited from interface com.goldencode.util.Printable

asString, print

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

allowDelete

Field Detail

listItemPairsConfig

protected ComboBoxWidget.ListItemPairsConfig listItemPairsConfig

The configuration used for LIST-ITEM-PAIRS by this combo-box.

Constructor Detail

ComboBoxWidget

public ComboBoxWidget()

Default constructor.

ComboBoxWidget

public ComboBoxWidget(boolean dynamic)

Constructor.

Parameters:

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

Method Detail

setDataType

public void setDataType(java.lang.String dataType)

Set the widget's DATA-TYPE. This resets its items and also sets the FORMAT and SCREEN-VALUE accordingly.

Specified by:

setDataType in interface CommonField

Overrides:

setDataType in class ControlEntity<ComboBoxConfig>

Parameters:

dataType - New data type name.

setFormat

public void setFormat(java.lang.String format)

Sets the format specification.

Specified by:

setFormat in interface CommonWidget

Specified by:

setFormat in interface CommonField

Overrides:

setFormat in class GenericWidget<ComboBoxConfig>

Parameters:

format - The format specification.

setModeDropDownList

public void setModeDropDownList(boolean b)

Set DROP-DOWN-LIST mode for the widget. Has no effect in character mode interface.

Parameters:

b - true enables mode, false is ignored.

setModeDropDown

public void setModeDropDown(boolean b)

Set DROP-DOWN mode for the widget. Has no effect in character mode interface.

Parameters:

b - true enables mode, false is ignored.

setModeSimple

public void setModeSimple(boolean b)

Set SIMPLE mode for the widget. Has no effect in character mode interface.

Parameters:

b - true enables mode, false is ignored.

getNumItems

public integer getNumItems()

Get the NUM-ITEMS attribute.

Specified by:

getNumItems in interface NumItems

Returns:

The numebr of items in the list.

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.

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

isLabels

public logical isLabels()

Gets the LABELS attribute.

Specified by:

isLabels in interface Labels

Returns:

the current value of the LABELS attribute.

isTextSelected

public logical isTextSelected()

Get TEXT-SELECTED attribute.

Specified by:

isTextSelected in interface SelectableText

Overrides:

isTextSelected in class GenericWidget<ComboBoxConfig>

Returns:

TEXT-SELECTED value

clearSelection

public logical clearSelection()

Clears text selection

Specified by:

clearSelection in interface SelectableText

removeSelection

public logical removeSelection()

Removes selected text.

Specified by:

removeSelection in interface SelectableText

Returns:

always yes/true

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

Returns:

true if operation success, false otherwise.

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.

getHeightChars

public decimal getHeightChars()

Gets the HEIGHT-CHARS writable attribute.

Specified by:

getHeightChars in interface Sizeable

Overrides:

getHeightChars in class BaseEntity<ComboBoxConfig>

Returns:

The current value of the HEIGHT-CHARS attribute.

setDisableAutoZap

public void setDisableAutoZap(logical disableAutoZap)

Sets the DISABLE-AUTO-ZAP option.

Specified by:

setDisableAutoZap in interface AutoZapElement

Parameters:

disableAutoZap - true if the option is set to ON.

setDisableAutoZap

public void setDisableAutoZap(boolean disableAutoZap)

Sets the DISABLE-AUTO-ZAP option.

Specified by:

setDisableAutoZap in interface AutoZapElement

Specified by:

setDisableAutoZap in interface CommonWidget

Overrides:

setDisableAutoZap in class GenericWidget<ComboBoxConfig>

Parameters:

disableAutoZap - true if the option is set to ON.

isDisableAutoZap

public logical isDisableAutoZap()

Get value of the DISABLE-AUTO-ZAP attribute.

Specified by:

isDisableAutoZap in interface AutoZapElement

Returns:

value of the attribute.

setAutoZap

public void setAutoZap(logical value)

Set AUTO-ZAP attribute.

Specified by:

setAutoZap in interface AutoZapElement

Parameters:

value - New value for the attribute.

setAutoZap

public void setAutoZap(boolean value)

Set AUTO-ZAP attribute.

Specified by:

setAutoZap in interface AutoZapElement

Parameters:

value - New value for the attribute.

isAutoZap

public logical isAutoZap()

Get value of the AUTO-ZAP attribute.

Specified by:

isAutoZap in interface AutoZapElement

Returns:

value of the attribute.

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

Specified by:

setCursorOffset in interface CommonWidget

Overrides:

setCursorOffset in class GenericWidget<ComboBoxConfig>

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

Specified by:

setCursorOffset in interface CommonWidget

Overrides:

setCursorOffset in class GenericWidget<ComboBoxConfig>

Parameters:

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

getCursorOffset

public integer getCursorOffset()

Obtains the index position of the cursor in a text editing widget. This corresponds to the CURSOR-OFFSET attribute in BROWSE columns (only when the cell is FILL-IN or COMBO-BOX), COMBO-BOX, EDITOR or FILL-IN widgets.

Specified by:

getCursorOffset in interface CommonWidget

Overrides:

getCursorOffset in class GenericWidget<ComboBoxConfig>

Returns:

The character index at which the cursor is placed.

setHeightChars

public void setHeightChars(NumberType height)

Sets the HEIGHT-CHARS writable attribute.

Specified by:

setHeightChars in interface Sizeable

Overrides:

setHeightChars in class BaseEntity<ComboBoxConfig>

Parameters:

height - The new value for the HEIGHT-CHARS attribute.

setHeightChars

public void setHeightChars(double height)

Sets the HEIGHT-CHARS writable attribute.

Specified by:

setHeightChars in interface Sizeable

Overrides:

setHeightChars in class BaseEntity<ComboBoxConfig>

Parameters:

height - The new value for the HEIGHT-CHARS attribute.

setHeightPixels

public void setHeightPixels(NumberType heightPixels)

Sets new value of HEIGHT-PIXELS attribute.

Specified by:

setHeightPixels in interface Sizeable

Overrides:

setHeightPixels in class BaseEntity<ComboBoxConfig>

Parameters:

heightPixels - new value of HEIGHT-PIXELS attribute

setHeightPixels

public void setHeightPixels(int heightPixels)

Sets new value of HEIGHT-PIXELS attribute.

Specified by:

setHeightPixels in interface Sizeable

Overrides:

setHeightPixels in class BaseEntity<ComboBoxConfig>

Parameters:

heightPixels - new value of HEIGHT-PIXELS attribute

setMaxChars

public void setMaxChars(double maxChars)

Set value of the MAX-CHARS attribute.

Specified by:

setMaxChars in interface MaxCharsElement

Parameters:

maxChars - Value of the attribute.

setMaxChars

public void setMaxChars(NumberType maxChars)

Set value of the MAX-CHARS attribute.

Specified by:

setMaxChars in interface MaxCharsElement

Parameters:

maxChars - Value of the attribute.

getMaxChars

public integer getMaxChars()

Get value of the MAX-CHARS attribute.

Specified by:

getMaxChars in interface MaxCharsElement

Returns:

value of the attribute.

setAutoCompletion

public void setAutoCompletion(logical autoCompletion)

Set AUTO-COMPLETION attribute value.

Specified by:

setAutoCompletion in interface CommonWidget

Overrides:

setAutoCompletion in class GenericWidget<ComboBoxConfig>

Parameters:

autoCompletion - New value for the attribute.

setAutoCompletion

public void setAutoCompletion(boolean autoCompletion)

Set AUTO-COMPLETION attribute value.

Specified by:

setAutoCompletion in interface CommonWidget

Overrides:

setAutoCompletion in class GenericWidget<ComboBoxConfig>

Parameters:

autoCompletion - New value for the attribute.

isAutoCompletion

public logical isAutoCompletion()

Get AUTO-COMPLETION attribute value.

Specified by:

isAutoCompletion in interface CommonWidget

Overrides:

isAutoCompletion in class GenericWidget<ComboBoxConfig>

Returns:

The value of the attribute.

delete

public logical delete(character itemList)

Implements the DELETE() widget method, which removes the list item or items specified.

Specified by:

delete in interface CommonListWidget<ComboBoxConfig>

Parameters:

itemList - The item or items to delete.

Returns:

true if the method succeeds.

delete

public logical delete(long idx)

Implements the DELETE() widget method, which removes the list item at the given index.

Specified by:

delete in interface CommonListWidget<ComboBoxConfig>

Overrides:

delete in class ControlSetEntity<ComboBoxConfig>

Parameters:

idx - The 1-based index of the item to delete.

Returns:

true if the method succeeds.

finishSetup

public void finishSetup()

Finish initialization of the combo box widget.

Overrides:

finishSetup in class GenericWidget<ComboBoxConfig>

delete

public logical delete(java.lang.String itemList)

Implements the DELETE() widget method, which removes the list item or items specified.

Specified by:

delete in interface CommonListWidget<ComboBoxConfig>

Parameters:

itemList - The item or items to delete.

Returns:

true if the method succeeds.

setFrame

public void setFrame(FrameWidget frame)

Sets the containing frame instance.

Specified by:

setFrame in interface CommonWidget

Overrides:

setFrame in class GenericWidget<ComboBoxConfig>

Parameters:

frame - GenericFrame instance that contains this widget

entry

public character entry(long index)

Implements the ENTRY() widget method. This method returns items from the set by 1-based index.

Specified by:

entry in interface CommonListWidget<ComboBoxConfig>

Overrides:

entry in class ControlSetEntity<ComboBoxConfig>

Parameters:

index - The index of an item.

Returns:

The list item indexed or unknown value.

getScreenValue

public character getScreenValue()

Obtain the current value in the screen buffer of the backing data for this widget and return it as a character type. If there is no value in the screen buffer (if it is null which is the representation for an uninitialized value), then return the empty string.

Specified by:

getScreenValue in interface CommonWidget

Overrides:

getScreenValue in class GenericWidget<ComboBoxConfig>

Returns:

The value as a character type or the empty string if the screen buffer value is uninitialized.

inputValue

public BaseDataType inputValue()

Reads the INPUT-VALUE attribute (value of the widget currently in the screen-buffer).

Specified by:

inputValue in interface CommonWidget

Overrides:

inputValue in class GenericWidget<ComboBoxConfig>

Returns:

The input value of the widget of the same data type as the field or variable associated with the widget or empty string if unknown.

getSubType

public character getSubType()

Obtain the subtype of the handle.

Specified by:

getSubType in interface SubTypeAttribute

Returns:

the subtype of this combobox.

setSubType

public void setSubType(character value)

Sets the the subtype of the combobox.

Specified by:

setSubType in interface SubTypeAttribute

Parameters:

value - The new value of the subtype object attribute. Valid values are: SIMPLE, DROP-DOWN, and DROP-DOWN-LIST. The last value is the default.

setSubType

public void setSubType(java.lang.String value)

Sets the the subtype of the combobox.

Specified by:

setSubType in interface SubTypeAttribute

Parameters:

value - The new value of the subtype object attribute. Valid values are: SIMPLE, DROP-DOWN, and DROP-DOWN-LIST. The last value is the default.

setListItemPairs

public void setListItemPairs(character list)

Common implementation list item pair attributes (LIST-ITEM-PAIRS and RADIO-BUTTONS) attribute. The parameter contains string representation of all labels and values separated by a delimiter (comma is the default delimiter).

Example: Label1,value1,Label2,value2,...,LabelN,valueN

Specified by:

setListItemPairs in interface CommonListWidget<ComboBoxConfig>

Overrides:

setListItemPairs in class ControlSetEntity<ComboBoxConfig>

Parameters:

list - A list of delimited items using the configured delimiter for this widget (a comma by default) to split the items. These items will be set as the full list of items in this widget.

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

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

Returns:

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

getItemValue

public character getItemValue(character value)

Retrieves the corresponding control set item of the COMBO-BOX for the given value.

Parameters:

value - The to be validated as SCREEN-VALUE attribute. Note that this value has already been parsed, unless it is made of whitespaces.

Returns:

The associated control set item if found, null otherwise.

resolveFormat

protected java.lang.String resolveFormat()

Resolve the format for this widget, used to generate the labels.

Overrides:

resolveFormat in class ControlSetEntity<ComboBoxConfig>

Returns:

If the mode is DROP-DOWN-LIST, then format. Otherwise, x(255).

setItems

protected void setItems(ControlSetItem[] items,
                        java.lang.Boolean pairs,
                        boolean checkItems,
                        java.util.List<ControlSetItem> newAddedItems,
                        boolean append)

Store array of items into config.

Overrides:

setItems in class ControlSetEntity<ComboBoxConfig>

Parameters:

items - Array of new items.

pairs - true if LIST_ITEM_PAIRS, RADIO_BUTTONS is set false if LIST_ITEMs is set.

checkItems - If this value is true, then items are checked and truncated.

newAddedItems - The list of new added items

append - true if the items have been set through ADD, INSERT or other append-type methods, false if they have been set all at once.

setScreenValueInt

protected void setScreenValueInt(character value)

Set the current value in the screen buffer of the backing data for this widget. If the given value is null then this widget will be set to the uninitialized value. This method is overridden in order to mimic a 4GL quirk: if for GUI clients, when setting the SCREEN-VALUE to empty string (or formed by spaces - which are equal in 4GL), the actual value the attribute gets is the unknown value (?). If this combo-box is initialized using item-pairs instead of items, the quirk doesn't take effect.

Overrides:

setScreenValueInt in class GenericWidget<ComboBoxConfig>

Parameters:

value - The new value for the widget, use null to set the value as uninitialized.

truncateValue

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

Remove trailing spaces.

Overrides:

truncateValue in class ControlSetEntity<ComboBoxConfig>

Parameters:

value - the string to be truncated.

Returns:

the truncated argument

truncateValue

protected BaseDataType truncateValue(BaseDataType value)

Remove trailing whitespaces if applicable

Overrides:

truncateValue in class ControlSetEntity<ComboBoxConfig>

Parameters:

value - the BaseDataType to be truncated

Returns:

the truncated argument if the argument is of type character (nothing is required for non-character types)

controlSetItem

protected ControlSetItem controlSetItem(character label,
                                        BaseDataType value)

Create new ControlSetItem

Overrides:

controlSetItem in class ControlSetEntity<ComboBoxConfig>

Parameters:

label - item' label

value - item's value

Returns:

new instance of the ControlSetItem

ignore

protected boolean ignore(BaseDataType value)

Checks if a value should be ignored (UNKNOWN for COMBO-BOX).

Overrides:

ignore in class ControlSetEntity<ComboBoxConfig>

Parameters:

value - The value to be checked.

Returns:

true if the value should be ignored.

ignore

protected boolean ignore(java.lang.String value)

Checks if a value should be ignored ("?" for COMBO-BOX).

Overrides:

ignore in class ControlSetEntity<ComboBoxConfig>

Parameters:

value - The value to be checked.

Returns:

true if the value should be ignored.

invalid

protected boolean invalid(character label,
                          BaseDataType value)

Checks if a (label,value) pair is not acceptable for this widget. The value ? is not acceptable.

Overrides:

invalid in class ControlSetEntity<ComboBoxConfig>

Parameters:

label - label to be checked

value - value to be checked

Returns:

true if the value should be ignored

truncateValues

protected ControlSetItem[] truncateValues(ControlSetItem[] items)

Truncate values of the provided items and remove invalid ones.

Overrides:

truncateValues in class ControlSetEntity<ComboBoxConfig>

Parameters:

items - The items to be processed.

Returns:

Valid items with truncated values.

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

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

isValidScreenValue

protected boolean isValidScreenValue(character value)

Check if the tested value is in the control-set values.

Overrides:

isValidScreenValue in class ControlSetEntity<ComboBoxConfig>

Parameters:

value - The tested value

Returns:

True if the tested value is in the control-set values, otherwise false.

checkItems

private void checkItems(ControlSetItem[] items,
                        boolean append)

Verify which items needs to be set as SCREEN-VALUE.

Parameters:

items - The items to be set.

append - true if the items have been set through ADD, INSERT or other append-type methods, false if they have been set all at once.

validateScreenValue

boolean validateScreenValue(character value,
                            character unparsedValue)

Validate the value(s) for SCREEN-VALUE attribute. If valid, the passed in value will be updated to reflect the resulting value. - empty string will set the value to unknown, unless a valid item value. - for unknown the result can be empty string if a valid item value. - first item found that match the value is used (case insensitive)

Overrides:

validateScreenValue in class ControlSetEntity<ComboBoxConfig>

Parameters:

value - The to be validated as SCREEN-VALUE attribute. Note that this value has already been parsed.

unparsedValue - The value to be validated via SCREEN-VALUE attribute, before suffering parse changes.

Returns:

true if the value is a valid screen-value.