com.goldencode.p2j.ui.client.gui

Class SelectionListGuiImpl

java.lang.Object

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

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

com.goldencode.p2j.ui.client.LabeledPanel<O,SelectionListConfig>

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

com.goldencode.p2j.ui.client.gui.SelectionListGuiImpl

All Implemented Interfaces:

AutoResizable<SelectionListConfig>, ControlSetComponent, DataContainer, FocusListener, LabeledWidget<GuiOutputManager>, MnemonicTrait<GuiOutputManager>, Container<GuiOutputManager>, Widget<GuiOutputManager>, WidgetWithConfig<SelectionListConfig>, ConfigOwner<SelectionListConfig>, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

public class SelectionListGuiImpl
extends SelectionList<GuiOutputManager>
implements AutoResizable<SelectionListConfig>

Specific GUI implementation of SELECTION-LIST widget.

Field Summary

Fields

Modifier and Type	Field and Description
private Border<GuiOutputManager>	border Cached border instance.
private static int	BORDER_SIZE Total size of the selection-list border 1 pixel on each side.
private GuiDriver	gd Screen driver
private GuiFontResolver	gf Font resolver
static int	TEXT_SHIFT Shift in X to draw text inside list.

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

list, scrollpane, sizeAdjusted

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

config

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

listeners, location, mousePtr, nativeInsets, physicalLocation

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
private void	adjustScrollBars() Adjust the scrollbars based on the config attributes (which can be changed until the widget is realized).
protected void	adjustSizeImpl(SelectionListConfig beforeUpdate) Adjust SelectionList size ChUI specific part.
void	afterConfigUpdate(SelectionListConfig beforeUpdate) The method is called after the configuration associated with the implementor changes.
protected MouseHoverAction	createMouseHoverAction() Create handler for processing mouse hover events
void	draw() Draw all the components in this container.
void	initialize(WidgetId id, SelectionListConfig cfg) Replacement API for the logic which should exist in the widget's c'tor, but the logic can't be executed as it depends on the widget being registered into the official registry.
boolean	isAutoResize() Get the AUTO-RESIZE status
boolean	isDroppable() Checks if the given widget is able to be the target of the drop operation.
void	mouseClicked(java.awt.event.MouseEvent e) Check for a left double click and execute SelectionList.fireDefaultAction().
void	mouseDragged(java.awt.event.MouseEvent e) Notification of a mouse dragged event occurred for 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.
void	mouseWheelMoved(java.awt.event.MouseWheelEvent e) Notification of a mouse wheel moved event occurred for this widget.
boolean	processMnemonic(int key) Process the given key, if this widget's mnemonic matches the key.
void	setVisible(boolean visible) Shows or hides the selection list and its label.
boolean	supportsCustomMousePointer() Check if the widget supports LOAD-MOUSE-POINTER() method
void	updateSize(SelectionListConfig beforeUpdate) Update widget's size after config update
protected void	validateLayout(SelectionListConfig beforeUpdate) Validate its own layout.

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

adjustSize, canMovetoTop, currentFocus, defaultFocus, deleteItem, fireDefaultAction, focusTraversable, getFrame, getFrameBottomBorderHeight, getFrameTopBorderHeight, getLegacyWidget, getName, getScreenValue, getSelection, getText, getType, getValue, hasFocus, isModified, manageSystemActions, onFocusGained, onFocusLost, refreshItems, scrollToItem, setEnabled, setSelectionMode, setValue

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

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

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

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

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

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

Methods inherited from class java.lang.Object

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

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

getChangedValue

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

acceptsEscAsAnyKey, acceptTrigger, addFocusListener, addKeyListener, ancestor, ancestorId, bounds, clearWidget, completeTrigger, defaultMousePtr, dimension, displayPhysicalLocation, drawCaret, enclosingFrame, enforceDefaultMousePtr, findMouseSource, forceCursorOnFocus, forceVisibility, getActualBounds, getCustomMousePointer, getEffectiveMousePointer, getId, getIdForTrigger, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getSelectedText, getState, getTriggerWidget, getTriggerWidget, getVisiblePart, getZOrderClass, hasFocus, hasTooltip, height, 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, minimumSize, moveToBottom, moveToTop, name, navigable, oleDrag, parent, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalBounds, physicalDimension, physicalLocation, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, processEvent, processFocusEvent, processKeyEvent, processKeyListeners, raiseLegacyMouseEvents, refreshWidget, registerWidgetListener, repaint, repaint, repaint, requestFocus, 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, width, window

Methods inherited from interface java.awt.event.MouseListener

mouseEntered, mouseExited

Methods inherited from interface java.awt.event.MouseMotionListener

mouseMoved

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

createMnemonic, getMnemonicCharacter, getMnemonicKeyCode, getMnemonicLabel, isMnemonicSupported, updateMnemonic

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

widgetsAsList

Field Detail

TEXT_SHIFT

public static final int TEXT_SHIFT

Shift in X to draw text inside list.

See Also:

Constant Field Values

BORDER_SIZE

private static final int BORDER_SIZE

Total size of the selection-list border 1 pixel on each side.

See Also:

Constant Field Values

gd

private GuiDriver gd

Screen driver

gf

private GuiFontResolver gf

Font resolver

border

private Border<GuiOutputManager> border

Cached border instance.

Constructor Detail

SelectionListGuiImpl

public SelectionListGuiImpl(WidgetId id,
                            SelectionListConfig 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,
                       SelectionListConfig cfg)

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

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

Specified by:

initialize in interface WidgetWithConfig<SelectionListConfig>

Overrides:

initialize in class SelectionList<GuiOutputManager>

Parameters:

id - The widget's ID.

cfg - The config used to initialize this widget.

draw

public void draw()

Draw all the components in this container.

Specified by:

draw in interface Widget<GuiOutputManager>

Specified by:

draw in class SelectionList<GuiOutputManager>

mousePressed

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

Notification of a mouse pressed event occurred for this widget.

Specified by:

mousePressed in interface java.awt.event.MouseListener

Overrides:

mousePressed in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mouseClicked

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

Check for a left double click and execute SelectionList.fireDefaultAction().

Specified by:

mouseClicked in interface java.awt.event.MouseListener

Overrides:

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

Specified by:

mouseReleased in interface java.awt.event.MouseListener

Overrides:

mouseReleased in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mouseDragged

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

Notification of a mouse dragged event occurred for this widget.

Specified by:

mouseDragged in interface java.awt.event.MouseMotionListener

Overrides:

mouseDragged in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mouseWheelMoved

public void mouseWheelMoved(java.awt.event.MouseWheelEvent e)

Notification of a mouse wheel moved event occurred for this widget.

Specified by:

mouseWheelMoved in interface java.awt.event.MouseWheelListener

Overrides:

mouseWheelMoved in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

updateSize

public void updateSize(SelectionListConfig beforeUpdate)

Update widget's size after config update

Specified by:

updateSize in interface AutoResizable<SelectionListConfig>

Parameters:

beforeUpdate - previous value of the widget's config

isAutoResize

public boolean isAutoResize()

Get the AUTO-RESIZE status

Specified by:

isAutoResize in interface AutoResizable<SelectionListConfig>

Returns:

true is AUTO-RESIZE is enabled

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

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.

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.

afterConfigUpdate

public void afterConfigUpdate(SelectionListConfig beforeUpdate)

The method is called after the configuration associated with the implementor changes. If

selectable

property changed then update

scrollpane

widget and activate/deactivate direct manipulation.

Specified by:

afterConfigUpdate in interface ConfigOwner<SelectionListConfig>

Overrides:

afterConfigUpdate in class SelectionList<GuiOutputManager>

Parameters:

beforeUpdate - Configuration before update

setVisible

public void setVisible(boolean visible)

Shows or hides the selection list and its label.

If the SELECTION-LIST is realized via a mouse event, then the body will not be highlighted via the dotted line.

Specified by:

setVisible in interface Widget<GuiOutputManager>

Overrides:

setVisible in class SelectionList<GuiOutputManager>

Parameters:

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

createMouseHoverAction

protected MouseHoverAction createMouseHoverAction()

Create handler for processing mouse hover events

Overrides:

createMouseHoverAction in class AbstractWidget<GuiOutputManager>

Returns:

handler for processing mouse hover events

adjustSizeImpl

protected void adjustSizeImpl(SelectionListConfig beforeUpdate)

Adjust SelectionList size ChUI specific part.

Specified by:

adjustSizeImpl in class SelectionList<GuiOutputManager>

Parameters:

beforeUpdate - The previous configuration changes. If this is null, this method won't ensure that inner-lines/inner-chars are in sync with widthChars/heightChars.

validateLayout

protected void validateLayout(SelectionListConfig beforeUpdate)

Validate its own layout.

Specified by:

validateLayout in class SelectionList<GuiOutputManager>

Parameters:

beforeUpdate - The previous configuration values

adjustScrollBars

private void adjustScrollBars()

Adjust the scrollbars based on the config attributes (which can be changed until the widget is realized).