com.goldencode.p2j.ui.client.gui

Class ComboBoxGuiImpl

java.lang.Object

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

com.goldencode.p2j.ui.client.ComboBox<GuiOutputManager>

com.goldencode.p2j.ui.client.gui.ComboBoxGuiImpl

All Implemented Interfaces:

AutoResizable<ComboBoxConfig>, ControlSetComponent, DataContainer, FocusListener, ItemListener, SelectionListener, LabeledWidget<GuiOutputManager>, MnemonicTrait<GuiOutputManager>, TextSelection, Widget<GuiOutputManager>, WidgetWithConfig<ComboBoxConfig>, ConfigOwner<ComboBoxConfig>, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

public class ComboBoxGuiImpl
extends ComboBox<GuiOutputManager>
implements AutoResizable<ComboBoxConfig>

Specific GUI implementation of COMBO-BOX widget.

Field Summary

Fields

Modifier and Type	Field and Description
private CoordinatesConversion	cc Coordinate converter
private static int	ENTRY_TO_HEIGHT_Y_DIFF The space difference between item row height and full combo-box height.
private EntryFieldGuiImpl	entryField Editable entry field for SIMPLE and DROP-DOWN modes.
private GuiColorResolver	gc Color resolver
private GuiDriver	gd Screen driver
private GuiFontResolver	gf Font resolver
private KeyInput	keyToDefer The key event that must be posted after drop-down exit.
private boolean	pressed Pressed button state flag.
private GuiOutputManager	screen Output manager
private ScrollableSelectionListGuiImpl	simpleList The list for SIMPLE combo-box mode.
private ScrollPaneGuiImpl	simpleListPane The list for SIMPLE combo-box mode.
static int	TEXT_SHIFT Shift in X to draw text inside entry.

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

browseColumn, config, deferredProgressTrigger, dropDown, endConditionRaised, initValue, limit, selected, valueChanged

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

insets, listeners, location, LOG, mousePtr, nativeInsets, physicalLocation

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	addUISpecificEvents(EventList listToChange) Adding mouse clicks as exit events.
void	afterConfigUpdate(ComboBoxConfig beforeUpdate) The method is called after the configuration associated with the implementor changes.
void	changed() This method is invoked when selection is changed.
private void	createEntryField() Clean up the main registry pool from drop-down widgets when it is closing, if the widget is a container, make recursive call.
MnemonicInfo	createMnemonic() Creates new MnemonicInfo instance.
private void	createSimpleList() Creates the list for SIMPLE mode of the combo-box.
void	deferKeyEvent(KeyInput ki) Saves the key event to be posted into event queue after drop-down is gone.
void	destroy() Destroy this widget.
boolean	doAutoCompletion(char currentChar, boolean listOpened) Handles entry field changes when AUTO-COMPLETION attribute is on.
void	draw() Draw the combo-box.
void	drawCaret() Sets position of terminal's cursor to the first char of the combo-box.
protected void	dropDownRequestFocus() Requesting focus to opened drop-down.
void	entryFieldChanged(java.lang.String newValue) Posts value changed event to the queue.
void	exitDropDown() Exit the drop-down (the "selection" mode of the combo-box).
protected java.lang.String	formatValue(java.lang.String selectedItem, DisplayFormat format, int width, boolean right) Format source string using current settings and make it suitable for GUI display.
java.util.Optional<MousePtrWrapper>	getCustomMousePointer() Get the current custom mouse pointer if it is set
int	getDropDownScrollBarWidth() Gets the width of the scrollbar used for drop-down.
EntryFieldGuiImpl	getEntryField() Gets instance of entry field attached in SIMPLE or DROP-DOWN modes.
(package private) int	getEntryFieldHeight() Returns entry field height.
int	getFormatLength() Returns the format length of the data type the combo-box represents.
java.lang.String	getInitialScreenText(BaseDataType initVal) Gets the initially setted screen value.
private int	getInnerLines() Returns the inner lines value for combo-box.
private int	getItemMaximalWidth(int font) Calculates the maximal item width in the pixel units for the given font number.
java.lang.Object	getList() Returns the list for SIMPLE combo-box mode.
int	getRowHeight() Gets the current row height depending on choosen font.
BaseDataType	getScreenValue() Get widget screen value.
int	getSimpleListVisibleHeight() Returns simple list height without (upper and lower) border.
BaseDataType	getValue() Gets the currently selected item.
BaseDataType	getValue(boolean initial) Gets the currently selected item.
boolean	hasFocus() Check if widget has focus.
double	height() Get widget height.
protected java.util.Set<java.lang.String>	initEventsSet() Initializes the event set to return.
void	initialize(WidgetId id, ComboBoxConfig wcfg) Replacement API for the logic which should exist in the widget's c'tor, but the logic can't be executed as it depends on the widget being registered into the official registry.
void	invalidateSelection() Invalidate the editor's selection.
boolean	isAutoResize() Get the AUTO-RESIZE status
boolean	isDroppable() Checks if the given widget is able to be the target of the drop operation.
boolean	isSelectionValid() Check if currently there is some selected text.
private void	layoutSimpleList() Layout simple list.
protected int[]	mouseActions() Determine the mouse actions processed by this widget.
void	mousePressed(java.awt.event.MouseEvent e) Notification of a mouse pressed event occurred for this widget.
void	mouseReleased(java.awt.event.MouseEvent e) Notification of a mouse released event occurred for this widget.
boolean	moveToBottom() Moves this widget to the bottom of other widgets in the z-ordering.
boolean	moveToTop() Moves this widget to the top of other widgets in the z-ordering.
void	onFocusGained(FocusEvent event) This is called when the combo-box gains the input focus.
void	onFocusLost(FocusEvent focusEvent) This is called when the combo-box loses the input focus.
private void	positionEntryField(Theme theme, NativePoint p) Method that sets the location of the entry field, based on the combo-box's location and the theme in use.
protected void	postprocessDropDown() Sometimes it is required to do several action the was deferred during drop-down life cycle.
void	processFocusMoveKey(KeyInput keyEvent) Process the action associated with the given focus movement key in an independent drawing bracket.
void	processKeyEvent(KeyInput keyEvent) Process key events that have been generated by this component.
boolean	processMnemonic(int key) Process the given key, if this widget's mnemonic matches the key.
void	processSystemKey(KeyInput keyEvent) Process the action associated with the given key in an independent drawing bracket.
void	refreshItems() Refresh items in the combo-box after assignment.
protected void	registerDropDownFrame() Registers drop-down frame in current window system.
void	removeSelectedText() Removes selected text.
void	setEnabled(boolean enabled) Enable/disable widget.
void	setHidden(boolean hidden) Tracks the hidden state of the combo-box and its entry field or simple-list pane.
private void	setNewSelection(int indexNew) Changes the selected value without opening drop-down.
boolean	setSelection(int start, int end) Creates a new selection, eventually dropping the already existing one.
void	setValue(BaseDataType value) Sets the instance representing the current value.
void	setVisible(boolean visible_) Shows or hides the combo-box and its label.
boolean	supportsCustomMousePointer() Check if the widget supports LOAD-MOUSE-POINTER() method
void	updateSize(ComboBoxConfig beforeUpdate) Update widget's size after config update
void	valueChangedCommon() Posts value changed event to the queue.
double	width() Get widget width.

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

activate, addItemListener, calcLimit, canMovetoTop, config, deactivateCode, deleteItem, dimension, fireValueChanged, getBrowse, getColon, getColumnLabelText, getColumnMnemonic, getDColor, getDropDownList, getItemText, getLabelInstance, getLabelText, getMaxLabelLen, getMnemonic, getScrollPaneId, getSelection, getText, getTo, getTriggerWidget, isDropDownActive, isForceLabel, isFormatHonored, isLinkedToBrowse, isModified, isNoLabels, isRightAligned, isSelected, isSimpleMode, lookup, manageSystemActions, minimumSize, model, onSelect, postprocessConfig, processEvent, removeItemListener, requestFocus, setBrowseColumn, setColumnMnemonic, setLabelInstance, setMnemonic, setNoLabels, setWasVisible, valueChangedImpl, wasVisible, widgetRealized

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

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

Methods inherited from class java.lang.Object

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

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

getChangedValue

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

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

Methods inherited from interface java.awt.event.MouseListener

mouseClicked, mouseEntered, mouseExited

Methods inherited from interface java.awt.event.MouseMotionListener

mouseDragged, mouseMoved

Methods inherited from interface java.awt.event.MouseWheelListener

mouseWheelMoved

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

getMnemonicCharacter, getMnemonicKeyCode, getMnemonicLabel, isMnemonicSupported, updateMnemonic

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

editPaste, isEditCanUndo

Field Detail

TEXT_SHIFT

public static final int TEXT_SHIFT

Shift in X to draw text inside entry.

See Also:

Constant Field Values

ENTRY_TO_HEIGHT_Y_DIFF

private static final int ENTRY_TO_HEIGHT_Y_DIFF

The space difference between item row height and full combo-box height.

See Also:

Constant Field Values

gd

private GuiDriver gd

Screen driver

screen

private GuiOutputManager screen

Output manager

cc

private CoordinatesConversion cc

Coordinate converter

gc

private GuiColorResolver gc

Color resolver

gf

private GuiFontResolver gf

Font resolver

pressed

private boolean pressed

Pressed button state flag.

entryField

private EntryFieldGuiImpl entryField

Editable entry field for SIMPLE and DROP-DOWN modes.

simpleList

private ScrollableSelectionListGuiImpl simpleList

The list for SIMPLE combo-box mode.

simpleListPane

private ScrollPaneGuiImpl simpleListPane

The list for SIMPLE combo-box mode.

keyToDefer

private KeyInput keyToDefer

The key event that must be posted after drop-down exit.

Constructor Detail

ComboBoxGuiImpl

public ComboBoxGuiImpl(WidgetId id,
                       WidgetConfig cfg)

Special constructor used to restore component using given configuration.

Parameters:

id - The widget's ID.

cfg - Configuration data.

Method Detail

initialize

public void initialize(WidgetId id,
                       ComboBoxConfig wcfg)

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

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

Specified by:

initialize in interface WidgetWithConfig<ComboBoxConfig>

Overrides:

initialize in class ComboBox<GuiOutputManager>

Parameters:

id - The widget's ID.

wcfg - The config used to initialize this widget.

afterConfigUpdate

public void afterConfigUpdate(ComboBoxConfig beforeUpdate)

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

Specified by:

afterConfigUpdate in interface ConfigOwner<ComboBoxConfig>

Overrides:

afterConfigUpdate in class ComboBox<GuiOutputManager>

Parameters:

beforeUpdate - Config reference capturing the config state before the owner's config was modified.

draw

public void draw()

Draw the combo-box. Called by this ComboBox's parent container.

Specified by:

draw in interface Widget<GuiOutputManager>

Specified by:

draw in class ComboBox<GuiOutputManager>

drawCaret

public void drawCaret()

Sets position of terminal's cursor to the first char of the combo-box.

Specified by:

drawCaret in interface Widget<GuiOutputManager>

Specified by:

drawCaret in class ComboBox<GuiOutputManager>

formatValue

protected java.lang.String formatValue(java.lang.String selectedItem,
                                       DisplayFormat format,
                                       int width,
                                       boolean right)

Format source string using current settings and make it suitable for GUI display. If the honor format flag is true then the widget is in "item list" mode and the super class handles it. Otherwise the string is used unchanged.

Overrides:

formatValue in class ComboBox<GuiOutputManager>

Parameters:

selectedItem - The source string to format.

format - The instance of DisplayFormat

width - The char width

right - True for right-aligned values

Returns:

The formatted value suitable for display.

onFocusGained

public void onFocusGained(FocusEvent event)

This is called when the combo-box gains the input focus. In addition to regular action when simple mode is active we need to move input focus to the entry field.

Specified by:

onFocusGained in interface FocusListener

Overrides:

onFocusGained in class ComboBox<GuiOutputManager>

Parameters:

event - The focus event to be processed.

mousePressed

public void mousePressed(java.awt.event.MouseEvent e)

Notification of a mouse pressed event occurred for this widget. Redraw combo-box in pressed state and request focus.

Specified by:

mousePressed in interface java.awt.event.MouseListener

Overrides:

mousePressed in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent e)

Notification of a mouse released event occurred for this widget. Redraw combo-box in released state.

Specified by:

mouseReleased in interface java.awt.event.MouseListener

Overrides:

mouseReleased in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

processMnemonic

public boolean processMnemonic(int key)

Process the given key, if this widget's mnemonic matches the key.

Specified by:

processMnemonic in interface Widget<GuiOutputManager>

Overrides:

processMnemonic in class AbstractWidget<GuiOutputManager>

Parameters:

key - The pressed mnemonic key code.

Returns:

true if this widget accepted this mnemonic key. Not enabled or not visible widget will not accept it.

createMnemonic

public MnemonicInfo createMnemonic()

Creates new MnemonicInfo instance.

Specified by:

createMnemonic in interface MnemonicTrait<GuiOutputManager>

Returns:

MnemonicInfo or its descendant.

processKeyEvent

public void processKeyEvent(KeyInput keyEvent)

Process key events that have been generated by this component.

Specified by:

processKeyEvent in interface Widget<GuiOutputManager>

Overrides:

processKeyEvent in class ComboBox<GuiOutputManager>

Parameters:

keyEvent - The key event to be handled.

processSystemKey

public void processSystemKey(KeyInput keyEvent)

Process the action associated with the given key in an independent drawing bracket. In GUI combo-box the precessing is highly dependend on the current mode.

This must be called only in the context of widget-level event processing.

Overrides:

processSystemKey in class ComboBox<GuiOutputManager>

Parameters:

keyEvent - The key to be processed.

processFocusMoveKey

public void processFocusMoveKey(KeyInput keyEvent)

Process the action associated with the given focus movement key in an independent drawing bracket. Currently it is TAB or BACK_TAB.

This must be called only in SIMPLE or DROP-DOWN mode either from entry field or from attached selection list.

Parameters:

keyEvent - The key to be processed, TAB or BACK_TAB.

getValue

public BaseDataType getValue()

Gets the currently selected item.

Specified by:

getValue in interface DataContainer

Overrides:

getValue in class ComboBox<GuiOutputManager>

Returns:

The character representing the current value of the combo-box.

getValue

public BaseDataType getValue(boolean initial)

Gets the currently selected item.

Parameters:

initial - true to get the initial value for the entry field.

Returns:

The character representing the current value of the combo-box.

getScreenValue

public BaseDataType getScreenValue()

Get widget screen value. It is an item value, not item description. For DROP-DOWN and SIMPLE modes, if entry field value doesn't match a value form the list, the entry field value is returned.

Overrides:

getScreenValue in class ComboBox<GuiOutputManager>

Returns:

Current widget screen value.

invalidateSelection

public void invalidateSelection()

Invalidate the editor's selection. Delegates the operation to entry field if the combobox has editing capability.

Specified by:

invalidateSelection in interface TextSelection

isSelectionValid

public boolean isSelectionValid()

Check if currently there is some selected text. Delegates the operation to entry field if the combobox has editing capability.

Specified by:

isSelectionValid in interface TextSelection

Returns:

true if text is selected.

removeSelectedText

public void removeSelectedText()

Removes selected text. If the combobox cannot edit current value or if no text is selected in editor, nothing is executed.

Specified by:

removeSelectedText in interface TextSelection

setSelection

public boolean setSelection(int start,
                            int end)

Creates a new selection, eventually dropping the already existing one. Delegates the operation to entry field if the combobox has editing capability.

Specified by:

setSelection in interface TextSelection

Parameters:

start - The offset of the start of the new selection.

end - The offset of the end of the new selection.

Returns:

true is operation is successful.

moveToTop

public boolean moveToTop()

Moves this widget to the top of other widgets in the z-ordering.

The entryField is always on top of the combo-box.

Specified by:

moveToTop in interface Widget<GuiOutputManager>

Overrides:

moveToTop in class AbstractWidget<GuiOutputManager>

Returns:

true if operation was successful and false otherwise.

moveToBottom

public boolean moveToBottom()

Moves this widget to the bottom of other widgets in the z-ordering.

Specified by:

moveToBottom in interface Widget<GuiOutputManager>

Overrides:

moveToBottom in class AbstractWidget<GuiOutputManager>

Returns:

true if operation was successful and false otherwise.

setVisible

public void setVisible(boolean visible_)

Shows or hides the combo-box and its label.

Specified by:

setVisible in interface Widget<GuiOutputManager>

Overrides:

setVisible in class ComboBox<GuiOutputManager>

Parameters:

visible_ - true to make the widget visible, false to hide the widget.

setHidden

public void setHidden(boolean hidden)

Tracks the hidden state of the combo-box and its entry field or simple-list pane.

Specified by:

setHidden in interface Widget<GuiOutputManager>

Overrides:

setHidden in class ComboBox<GuiOutputManager>

Parameters:

hidden - New hidden state.

height

public double height()

Description copied from class: AbstractWidget

Get widget height.

Specified by:

height in interface Widget<GuiOutputManager>

Overrides:

height in class ComboBox<GuiOutputManager>

Returns:

widget height.

See Also:

Widget.height()

width

public double width()

Description copied from class: AbstractWidget

Get widget width.

Specified by:

width in interface Widget<GuiOutputManager>

Overrides:

width in class ComboBox<GuiOutputManager>

Returns:

widget width.

See Also:

Widget.width()

setValue

public void setValue(BaseDataType value)

Sets the instance representing the current value.

Specified by:

setValue in interface DataContainer

Overrides:

setValue in class ComboBox<GuiOutputManager>

Parameters:

value - The value representing the current widget value.

changed

public void changed()

This method is invoked when selection is changed.

Specified by:

changed in interface SelectionListener

Overrides:

changed in class ComboBox<GuiOutputManager>

setEnabled

public void setEnabled(boolean enabled)

Enable/disable widget.

Specified by:

setEnabled in interface Widget<GuiOutputManager>

Overrides:

setEnabled in class AbstractWidget<GuiOutputManager>

Parameters:

enabled - TRUE to make the widget enabled, FALSE to disable the widget.

hasFocus

public boolean hasFocus()

Check if widget has focus.

Specified by:

hasFocus in interface Widget<GuiOutputManager>

Returns:

true if widget has focus.

getRowHeight

public int getRowHeight()

Gets the current row height depending on choosen font.

Returns:

The row height value in pixels.

getDropDownScrollBarWidth

public int getDropDownScrollBarWidth()

Gets the width of the scrollbar used for drop-down. If the drop-down is not active or has no vertical scroll-bar - returns 0 width.

Returns:

The width value in pixels for scrollbar.

destroy

public void destroy()

Destroy this widget. Cleans up all including widgets before destruction.

Specified by:

destroy in interface Widget<GuiOutputManager>

Overrides:

destroy in class ComboBox<GuiOutputManager>

entryFieldChanged

public void entryFieldChanged(java.lang.String newValue)

Posts value changed event to the queue. This should be done in GUI mode after any changes in entry field for SIMLPLE and DROP_DOWN combo-box modes.

Parameters:

newValue - The new value for combo-box.

deferKeyEvent

public void deferKeyEvent(KeyInput ki)

Saves the key event to be posted into event queue after drop-down is gone.

Parameters:

ki - The key event to be posted after drop-down become closed.

postprocessDropDown

protected void postprocessDropDown()

Sometimes it is required to do several action the was deferred during drop-down life cycle.

Overrides:

postprocessDropDown in class ComboBox<GuiOutputManager>

exitDropDown

public void exitDropDown()

Exit the drop-down (the "selection" mode of the combo-box). GUI specific cleanup.

Overrides:

exitDropDown in class ComboBox<GuiOutputManager>

updateSize

public void updateSize(ComboBoxConfig beforeUpdate)

Update widget's size after config update

Specified by:

updateSize in interface AutoResizable<ComboBoxConfig>

Parameters:

beforeUpdate - previous value of the widget's config

isAutoResize

public boolean isAutoResize()

Get the AUTO-RESIZE status

Specified by:

isAutoResize in interface AutoResizable<ComboBoxConfig>

Returns:

true is AUTO-RESIZE is enabled

onFocusLost

public void onFocusLost(FocusEvent focusEvent)

This is called when the combo-box loses the input focus.

Specified by:

onFocusLost in interface FocusListener

Overrides:

onFocusLost in class ComboBox<GuiOutputManager>

Parameters:

focusEvent - The focus event to be processed.

getList

public java.lang.Object getList()

Returns the list for SIMPLE combo-box mode.

Returns:

The list instance.

refreshItems

public void refreshItems()

Refresh items in the combo-box after assignment.

Specified by:

refreshItems in interface ControlSetComponent

Overrides:

refreshItems in class ComboBox<GuiOutputManager>

getSimpleListVisibleHeight

public int getSimpleListVisibleHeight()

Returns simple list height without (upper and lower) border. Note: SIMPLE list are drawn 2 more pixel shorter than actually declared.

Returns:

see above

isDroppable

public boolean isDroppable()

Checks if the given widget is able to be the target of the drop operation.

Specified by:

isDroppable in interface Widget<GuiOutputManager>

Returns:

TRUE if this widget can be droppable at this time, FALSE otherwise.

doAutoCompletion

public boolean doAutoCompletion(char currentChar,
                                boolean listOpened)

Handles entry field changes when AUTO-COMPLETION attribute is on.

Parameters:

currentChar - The current char from key event causung this call, not yet in entry field screen buffer.

listOpened - The flag indicating if the DROP-DOWN list is opened.

Returns:

TRUE if changes happen in current combo-box status, FALSE otherwise.

getEntryField

public EntryFieldGuiImpl getEntryField()

Gets instance of entry field attached in SIMPLE or DROP-DOWN modes.

Returns:

Entry field object.

registerDropDownFrame

protected void registerDropDownFrame()

Registers drop-down frame in current window system. GUI specific version.

Specified by:

registerDropDownFrame in class ComboBox<GuiOutputManager>

dropDownRequestFocus

protected void dropDownRequestFocus()

Requesting focus to opened drop-down.

Specified by:

dropDownRequestFocus in class ComboBox<GuiOutputManager>

supportsCustomMousePointer

public boolean supportsCustomMousePointer()

Check if the widget supports LOAD-MOUSE-POINTER() method

Specified by:

supportsCustomMousePointer in interface Widget<GuiOutputManager>

Overrides:

supportsCustomMousePointer in class AbstractWidget<GuiOutputManager>

Returns:

true if the widget supports LOAD-MOUSE-POINTER() method

getCustomMousePointer

public java.util.Optional<MousePtrWrapper> getCustomMousePointer()

Get the current custom mouse pointer if it is set

Specified by:

getCustomMousePointer in interface Widget<GuiOutputManager>

Overrides:

getCustomMousePointer in class AbstractWidget<GuiOutputManager>

Returns:

the current custom mouse pointer if it is set

mouseActions

protected int[] mouseActions()

Determine the mouse actions processed by this widget.

Overrides:

mouseActions in class AbstractWidget<GuiOutputManager>

Returns:

See above.

valueChangedCommon

public void valueChangedCommon()

Posts value changed event to the queue. This should be done in ChUI and GUI mode after closing drop-down or in GUI mode after pressing UP/DOWN keys with focused combo-box.

Overrides:

valueChangedCommon in class ComboBox<GuiOutputManager>

initEventsSet

protected java.util.Set<java.lang.String> initEventsSet()

Initializes the event set to return. GUI specifics,

Overrides:

initEventsSet in class ComboBox<GuiOutputManager>

Returns:

The keyboard event to be used to exit drop-down.

addUISpecificEvents

protected void addUISpecificEvents(EventList listToChange)

Adding mouse clicks as exit events. GUI specifics.

Overrides:

addUISpecificEvents in class ComboBox<GuiOutputManager>

Parameters:

listToChange - The event list to modify.

createEntryField

private void createEntryField()

Clean up the main registry pool from drop-down widgets when it is closing, if the widget is a container, make recursive call.

positionEntryField

private void positionEntryField(Theme theme,
                                NativePoint p)

Method that sets the location of the entry field, based on the combo-box's location and the theme in use.

Parameters:

theme - The theme in use.

p - The combo-box location.

createSimpleList

private void createSimpleList()

Creates the list for SIMPLE mode of the combo-box. This part will permanently exist for the combo-box life time.

getEntryFieldHeight

int getEntryFieldHeight()

Returns entry field height.

layoutSimpleList

private void layoutSimpleList()

Layout simple list.

setNewSelection

private void setNewSelection(int indexNew)

Changes the selected value without opening drop-down.

Parameters:

indexNew - The index of the new item to select.

getInitialScreenText

public java.lang.String getInitialScreenText(BaseDataType initVal)

Gets the initially setted screen value.

Parameters:

initVal - The number of the list items pair or entry for the list item.

Returns:

The string representation of the initial value.

getFormatLength

public int getFormatLength()

Returns the format length of the data type the combo-box represents.

Returns:

Format length.

getItemMaximalWidth

private int getItemMaximalWidth(int font)

Calculates the maximal item width in the pixel units for the given font number.

Parameters:

font - The provided font.

Returns:

The maximal item width.

getInnerLines

private int getInnerLines()

Returns the inner lines value for combo-box. Used in closed state.

Returns:

Inner lines value.