com.goldencode.p2j.ui.client

Class SelectionList<O extends OutputManager<?>>

java.lang.Object

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

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

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

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

Type Parameters:

O - the output manager type

All Implemented Interfaces:

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

Direct Known Subclasses:

SelectionListGuiImpl, SelectionListImpl

public abstract class SelectionList<O extends OutputManager<?>>
extends LabeledPanel<O,SelectionListConfig>
implements DataContainer, FocusListener, ControlSetComponent

This class provides necessary scrolling for the SelectionListBody class which implements remaining functionality. Another purpose of this class is to maintain its size and adjust size of scroll pane and selection list.

Version:

1.0

Author:

SIY

Field Summary

Fields

Modifier and Type	Field and Description
protected SelectionListBody<O>	list Component attribute container.
protected ScrollPane<O>	scrollpane ScrollPane which wraps the list of items and make scrolling.
protected boolean	sizeAdjusted adjustSize() was called

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

Method Summary

Modifier and Type	Method and Description
void	adjustSize(SelectionListConfig beforeUpdate) Adjust SelectionList size.
protected abstract void	adjustSizeImpl(SelectionListConfig beforeUpdate) Adjust SelectionList size UI specific part.
void	afterConfigUpdate(SelectionListConfig beforeUpdate) The method is called after the configuration associated with the implementor changes.
boolean	canMovetoTop() Flag indicating if this widget can be moved to top by a DISPLAY statement when WINDOW:KEEP-FRAME-Z-ORDER flag is set.
Widget<O>	currentFocus() Returns the focused direct child Component.
Widget<O>	defaultFocus() Returns the focused direct child Component.
boolean	deleteItem(int idx) Delete item from SelectionList
abstract void	draw() Draw all the components in this container.
void	fireDefaultAction() Fires the DefaultAction event.
boolean	focusTraversable() Check if the widget is focus traversable
protected Frame<O>	getFrame() Gets its parent frame.
double	getFrameBottomBorderHeight() Gets the char height of its parent bottom border.
double	getFrameTopBorderHeight() Gets the char height of its parent top border.
Widget<O>	getLegacyWidget() The method returns the legacy widget representing this possibly virtual widget.
java.lang.String	getName() Returns its name as a string if it is given by its configuration.
BaseDataType	getScreenValue() Get screen value.
int[]	getSelection() Request indexes of selected items.
java.lang.String	getText() Get text representation of the currently selected value.
java.lang.String	getType() Returns its constant type as a string.
BaseDataType	getValue() Getting the currently selected item.
boolean	hasFocus(boolean recurse) Check if widget has focus.
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	isModified() Getting the modification state of the widget.
boolean	manageSystemActions() Check if the current widget can manage non-global system actions on its own, and not via the enclosing event loop.
void	onFocusGained(FocusEvent focusEvent) This is called when the selection-list takes the input focus.
void	onFocusLost(FocusEvent focusEvent) This is called when the selection-list looses the input focus.
void	refreshItems() This method is called when component items are changed in some way (added, removed, sorted, etc).
boolean	scrollToItem(int index) Implements SCROLL-TO-ITEM() method for selection-list widget.
void	setEnabled(boolean flag_) Set the enabled flag for this selection list.
boolean	setSelectionMode(int mode) Forward call to list container.
void	setValue(BaseDataType value) Sets the BaseDataType instance representing the current value.
void	setVisible(boolean visible) Shows or hides the selection list and its label.
protected abstract void	validateLayout(SelectionListConfig beforeUpdate) Validate its own layout.

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, createMouseHoverAction, 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, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved, moveToBottom, moveToTop, name, navigable, oleDoDrop, oleDrag, oleDragging, oleStartDragging, onOleDragging, onOleDropEnd, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalBounds, physicalDimension, physicalLocation, prepParentLocation, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, processEvent, processFocusEvent, processKeyEventForSelectableWidget, processKeyListeners, processMnemonic, processMnemonicImpl, processSystemKey, raiseLegacyMouseEvents, reflectSizeChanged, refresh, registerWidgetListener, repaint, repaint, requestSync, resetBitmap, resizeTo, resolveFont, resolvePopupMenuId, resolveTitleFont, screen, screenDimension, screenHeight, screenLocation, screenPhysicalLocation, screenWidth, setBitmap, setCachedScreenLocation, setCachedScreenPhysicalLocation, setDirectManipulationActive, setHighlighted, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, setSensitiveForUIB, setState, setWindow, show, showPopupMenu, supportsCustomMousePointer, sync, topLevelWindow, toString, translate, triggerLocationChanged, unregisterWidgetListener, updateSystemParent, widgetRealized, window

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.goldencode.p2j.ui.client.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, isDroppable, isEnabled, isFocusable, isHeader, isInitialValueLayout, isLegacyFocus, isProcessProgressEvent, isRealized, isRepaintDisabled, isRMBEntrySupported, isTabStop, isThreeD, isTotallyObscured, isVisible, isVisible, location, maySwitchFocus, minimumSize, moveToBottom, moveToTop, name, navigable, oleDrag, parent, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalBounds, physicalDimension, physicalLocation, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, processEvent, processFocusEvent, processKeyEvent, processKeyListeners, processMnemonic, 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, supportsCustomMousePointer, systemFocusGrabbed, topLevelWindow, unrealize, unregisterWidgetListener, validateDisplayValue, widgetStateChanged, width, window

Methods inherited from interface java.awt.event.MouseListener

mouseClicked, mouseEntered, mouseExited, mousePressed, mouseReleased

Methods inherited from interface java.awt.event.MouseMotionListener

mouseDragged, mouseMoved

Methods inherited from interface java.awt.event.MouseWheelListener

mouseWheelMoved

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

createMnemonic, getMnemonicCharacter, getMnemonicKeyCode, getMnemonicLabel, isMnemonicSupported, updateMnemonic

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

widgetsAsList

Field Detail

scrollpane

protected ScrollPane<O extends OutputManager<?>> scrollpane

ScrollPane which wraps the list of items and make scrolling.

list

protected SelectionListBody<O extends OutputManager<?>> list

Component attribute container.

sizeAdjusted

protected boolean sizeAdjusted

adjustSize() was called

Constructor Detail

SelectionList

public SelectionList(WidgetId id,
                     SelectionListConfig cfg)

Special constructor used to restore component using given configuration.

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

Parameters:

id - The widget's ID.

cfg - Configuration data.

Method Detail

canMovetoTop

public boolean canMovetoTop()

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

Specified by:

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

Returns:

Always true.

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>

Parameters:

id - The widget's ID.

cfg - The config used to initialize this widget.

currentFocus

public Widget<O> currentFocus()

Returns the focused direct child Component.

Specified by:

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

Overrides:

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

Returns:

The focused direct child Component.

defaultFocus

public Widget<O> defaultFocus()

Returns the focused direct child Component.

Specified by:

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

Overrides:

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

Returns:

The focused direct child Component.

onFocusGained

public void onFocusGained(FocusEvent focusEvent)

This is called when the selection-list takes the input focus. When the help string is defined for the selection-list it should be displayed at the window status line.

Specified by:

onFocusGained in interface FocusListener

Parameters:

focusEvent - The focus event to be processed.

onFocusLost

public void onFocusLost(FocusEvent focusEvent)

This is called when the selection-list looses the input focus.

Specified by:

onFocusLost in interface FocusListener

Parameters:

focusEvent - The focus event to be processed.

refreshItems

public void refreshItems()

This method is called when component items are changed in some way (added, removed, sorted, etc).

Specified by:

refreshItems in interface ControlSetComponent

getSelection

public int[] getSelection()

Request indexes of selected items.

Specified by:

getSelection in interface ControlSetComponent

Returns:

array of 0-based indexes of selected items.

deleteItem

public boolean deleteItem(int idx)

Delete item from SelectionList

Parameters:

idx - index of the item

Returns:

true if successful

setSelectionMode

public boolean setSelectionMode(int mode)

Forward call to list container.

Parameters:

mode - New selection mode.

Returns:

true if selection mode was changed by this call

adjustSize

public void adjustSize(SelectionListConfig beforeUpdate)

Adjust SelectionList size.

Parameters:

beforeUpdate - The previous configuration values

getValue

public BaseDataType getValue()

Getting the currently selected item.

Specified by:

getValue in interface DataContainer

Returns:

The BaseDataType object representing the current value of the selection-list.

isModified

public boolean isModified()

Getting the modification state of the widget.

Specified by:

isModified in interface DataContainer

Returns:

true if the widget value was modified, false otherwise.

setValue

public void setValue(BaseDataType value)

Sets the BaseDataType instance representing the current value.

Specified by:

setValue in interface DataContainer

Parameters:

value - The value representing the current widget value.

getText

public java.lang.String getText()

Get text representation of the currently selected value.

Specified by:

getText in interface DataContainer

Returns:

The screen representation of the value.

setEnabled

public void setEnabled(boolean flag_)

Set the enabled flag for this selection list.

Specified by:

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

Overrides:

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

Parameters:

flag_ - The enabled status for this selection list.

draw

public abstract void draw()

Draw all the components in this container.

Specified by:

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

Overrides:

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

setVisible

public void setVisible(boolean visible)

Shows or hides the selection list and its label.

Specified by:

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

Overrides:

setVisible in class LabeledPanel<O extends OutputManager<?>,SelectionListConfig>

Parameters:

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

getScreenValue

public BaseDataType getScreenValue()

Get screen value.

Returns:

Current screen value.

manageSystemActions

public boolean manageSystemActions()

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

Overrides:

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

Returns:

true as the widget has its own event management.

afterConfigUpdate

public void afterConfigUpdate(SelectionListConfig 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<SelectionListConfig>

Overrides:

afterConfigUpdate in class LabeledPanel<O extends OutputManager<?>,SelectionListConfig>

Parameters:

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

scrollToItem

public boolean scrollToItem(int index)

Implements SCROLL-TO-ITEM() method for selection-list widget.

Parameters:

index - The 0-based index of an item to scroll.

Returns:

TRUE in success, FALSE otherwise.

focusTraversable

public boolean focusTraversable()

Check if the widget is focus traversable

Specified by:

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

Overrides:

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

Returns:

TRUE if it is focus traversable, FALSE if not.

getType

public final java.lang.String getType()

Returns its constant type as a string.

Returns:

"SELECTION-LIST"

getName

public final java.lang.String getName()

Returns its name as a string if it is given by its configuration.

Returns:

config.name or empty string

getFrameTopBorderHeight

public final double getFrameTopBorderHeight()

Gets the char height of its parent top border.

Returns:

The char height of its parent top border.

getFrameBottomBorderHeight

public final double getFrameBottomBorderHeight()

Gets the char height of its parent bottom border.

Returns:

The char height of its parent bottom border.

getFrame

protected Frame<O> getFrame()

Gets its parent frame.

Returns:

The parent frame that contains this widget or null if its frame id is not set.

adjustSizeImpl

protected abstract void adjustSizeImpl(SelectionListConfig beforeUpdate)

Adjust SelectionList size UI specific part.

Parameters:

beforeUpdate - The previous configuration values

validateLayout

protected abstract void validateLayout(SelectionListConfig beforeUpdate)

Validate its own layout.

Parameters:

beforeUpdate - The previous configuration values

hasFocus

public boolean hasFocus(boolean recurse)

Check if widget has focus.

When true is passed as the argument the method considers this widget focused when all the parent widgets up to the top-level window are current and the widget itself is a leaf node of the widget tree. When false is passed as the argument the method considers this widget focused when all the parent widgets up to the top-level window are current but the widget itself does not have to be a leaf node.

Specified by:

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

Overrides:

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

Parameters:

recurse - see above

Returns:

true if widget has focus.

getLegacyWidget

public Widget<O> getLegacyWidget()

The method returns the legacy widget representing this possibly virtual widget. If this is already a legacy widget it is returned.

The default implementation walks up the widget tree starting at this. The first enumerated widget returning false from WidgetId.virtualWidget(WidgetId) is returned.

Specified by:

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

Returns:

A non-virtual widget reference, or null if none found.

fireDefaultAction

public void fireDefaultAction()

Fires the DefaultAction event.