com.goldencode.p2j.ui.client

Class SelectionListBody<O extends OutputManager<?>>

java.lang.Object

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

com.goldencode.p2j.ui.client.widget.DefaultList<java.lang.String,O>

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

Type Parameters:

O - the type of output manager

All Implemented Interfaces:

DataContainer, FocusListener, SelectionListener, ScrollableWidget<O>, ScrollPublisher, Widget<O>, WidgetWithConfig<SelectionListConfig>, ConfigOwner<SelectionListConfig>, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

Direct Known Subclasses:

SelectionListBodyGuiImpl, SelectionListBodyImpl

public abstract class SelectionListBody<O extends OutputManager<?>>
extends DefaultList<java.lang.String,O>
implements WidgetWithConfig<SelectionListConfig>, FocusListener, SelectionListener, DataContainer

A component that allows the user to select one or more objects from a list.

This class does not provide scrolling capability. Instances of this class are normally inserted into a ScrollPane to provide scrolling.

Field Summary

Fields

Modifier and Type	Field and Description
protected SelectionListConfig	config Component attribute container.
protected boolean	cursorVisible Cursor visibility before this widget gained focus
private BaseDataType	initValue Default initial value.
protected ControlSetItem[]	items Current items' list
protected int	rowTop The current top row in the list to draw.
private boolean	selected Track user interaction with widget.
protected boolean	widgetFocused Widget in focus flag

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

currentRow, listModel, selectionModel, selectionStart

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

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	afterConfigUpdate(SelectionListConfig beforeUpdate) The method is called after the configuration associated with the implementor changes.
protected int	calculateScrollYPosition() Calculate the scroll Y position based on the current state.
void	changed() The implementation of the ListSelectionListener interface.
SelectionListConfig	config() Provide access to the attributes stored in the widget.
boolean	deleteItem(int idx) Delete item from SelectionList
abstract void	draw() Draws this component.
java.lang.String	entry(int index) Returns the character value of the entry with specified index from the SelectionListBody.
int	getDefaultEvent(KeyInput key, boolean inEditingBlock) Get the default event associated for this widget and the given key.
protected java.lang.String	getItemText(int i) Get item text at specified index.
BaseDataType	getScreenValue() Get widget screen value (suitable for assigning back to any associated variable or field).
java.lang.String	getText() Get the text representation of the currently selected value.
BaseDataType	getValue() Getting the currently selected item.
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	isHorizontalScrollBar() Get state of the HORIZONTAL-SCROLL-BAR attribute.
boolean	isModified() Getting the modification state of the widget.
boolean	isSelected(int index) Checks the selection state of the entry with specified index in SelectionListBody.
boolean	isVerticalScrollBar() Get state of the VERTICAL-SCROLL-BAR attribute.
Point	location() Get widget location relative to container.
boolean	manageSystemActions() Check if the current widget can manage non-global system actions on its own, and not via the enclosing event loop.
protected boolean	needValueChanged() Checks if we need to post VALUE-CHANGED event.
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.
protected int	pageSize() Pagination is based on number of visible rows given the widget height.
NativePoint	physicalLocation() Get widget physical location relative to container, expressed in units native to UI type.
void	processKeyEvent(KeyInput keyEvent) Key events handler for the SelectionListBody widget.
protected void	refreshItems() Update list of items from configuration.
void	requestFocus() Requesting the focus to the SelectionListBody.
protected void	resetView() Reset view: set top row to zero, clear selection etc.
void	scroll(java.lang.Integer newXPosition, java.lang.Integer newYPosition) Directs the widget to scroll to the specified X and Y positions.
boolean	scrollToItem(int index) Scrolls the list to have the specified item at the top of the list.
boolean	scrollToItem(java.lang.String item) Scrolls the list to have the specified item at the top of the list.
protected boolean	scrollWorker(java.lang.Integer newXPosition, java.lang.Integer newYPosition) Directs the widget to scroll to the specified X and Y positions.
void	setLocation(double x, double y) Set widget relative location.
void	setPhysicalLocation(int x, int y) Set widget relative physical location.
private boolean	setSingleValue(BaseDataType value) Set single value in the list as selected.
void	setValue(BaseDataType value) Sets the BaseDataType instance representing the current value.
protected boolean	shiftByCursorKeys(int key) If the argument is one of cursor keys (UP, DOWN, PAGE_UP, PAGE_DOWN, HOME, END), then adjust current row.
protected boolean	shiftSelectCurrentRow(int delta, boolean doNotSelect) Shift current row by provided delta, scroll if necessary.
protected void	toggleCurrentRowSelection() Toggle selection of the current item.

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

addScrollListener, addSelectionListener, currentRow, deselect, dimension, ensureRowVisible, ensureRowVisible, first, getColumns, getScrollDimension, getScrollStep, getVisibleDimension, height, isScrollPopupSupported, isSingleSelectionMode, minimumSize, model, postScrollEvent, processKey, select, selectCurrentRow, selected, selection, selectionClear, selectionMode, selectionSize, set, setColumns, setCurrentRow, setSelectionMode, setVisibleRows, shiftCurrentRow, value, visibleRows, 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, copyState, createMouseHoverAction, deactivateDirectManipulation, debug, destroy, disable, disableTooltip, displayPhysicalLocation, drawCaret, enable, enableTooltip, enclosingFrame, findMouseSource, focusTraversable, forceCursorOnFocus, forceVisibility, getActualBounds, getAndResetBitmap, getAndSetBitmap, getBitmapCopy, getCachedScreenLocation, getCachedScreenPhysicalLocation, getCustomMousePointer, 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, 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, postprocessConfig, prepParentLocation, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, processEvent, processFocusEvent, processKeyEventForSelectableWidget, processKeyListeners, processMnemonic, processMnemonicImpl, processSystemKey, 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, setEnabled, setHidden, setHighlighted, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalDimensionInt, setSensitiveForUIB, setState, setVisible, setWindow, show, showPopupMenu, supportsCustomMousePointer, sync, topLevelWindow, toString, translate, triggerLocationChanged, unrealize, unregisterWidgetListener, updateSizeWorker, updateSystemParent, widgetRealized, 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, canMovetoTop, clearWidget, completeTrigger, defaultMousePtr, destroy, displayPhysicalLocation, drawCaret, enclosingFrame, enforceDefaultMousePtr, findMouseSource, focusTraversable, forceCursorOnFocus, forceVisibility, getActualBounds, getCustomMousePointer, getEffectiveMousePointer, getId, getIdForTrigger, getLegacyWidget, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getSelectedText, getState, getTriggerWidget, getTriggerWidget, getVisiblePart, getZOrderClass, hasFocus, hasFocus, hasTooltip, 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, maySwitchFocus, moveToBottom, moveToTop, name, navigable, oleDrag, parent, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalBounds, physicalDimension, postprocessConfig, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, processEvent, processFocusEvent, processKeyListeners, processMnemonic, raiseLegacyMouseEvents, refreshWidget, registerWidgetListener, repaint, repaint, repaint, requestFocus, requestFocus, requestSync, resizeTo, resolvePopupMenuId, screen, screenLocation, screenPhysicalLocation, setDirectManipulationActive, setEnabled, setHidden, setHighlighted, setLocation, setMousePointer, setMousePointer, setParent, setSensitiveForUIB, setState, setVisible, setWindow, show, startTrigger, supportsCustomMousePointer, systemFocusGrabbed, topLevelWindow, unrealize, unregisterWidgetListener, validateDisplayValue, widgetStateChanged, 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

Field Detail

config

protected SelectionListConfig config

Component attribute container.

cursorVisible

protected boolean cursorVisible

Cursor visibility before this widget gained focus

items

protected ControlSetItem[] items

Current items' list

rowTop

protected int rowTop

The current top row in the list to draw.

widgetFocused

protected boolean widgetFocused

Widget in focus flag

initValue

private BaseDataType initValue

Default initial value.

selected

private boolean selected

Track user interaction with widget.

Constructor Detail

SelectionListBody

public SelectionListBody(WidgetId id,
                         SelectionListConfig cfg)

Special constructor used to restore component using given configuration.

Parameters:

id - The widget's ID.

cfg - Configuration data.

Method Detail

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>

Parameters:

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

changed

public void changed()

The implementation of the ListSelectionListener interface. Marks the widget as modified.

Specified by:

changed in interface SelectionListener

config

public SelectionListConfig config()

Provide access to the attributes stored in the widget.

Specified by:

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

Specified by:

config in interface ConfigOwner<SelectionListConfig>

Overrides:

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

Returns:

Reference to attribute container.

draw

public abstract void draw()

Draws this component. Overrides draw() in JList.

Specified by:

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

Specified by:

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

entry

public java.lang.String entry(int index)

Returns the character value of the entry with specified index from the SelectionListBody.

Parameters:

index - The index of the entry which value should be returned.

Returns:

The string value of the entry with given index.

getDefaultEvent

public int getDefaultEvent(KeyInput key,
                           boolean inEditingBlock)

Get the default event associated for this widget and the given key.

Overrides:

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

Parameters:

key - The current key.

inEditingBlock - true if EDITING mode is active.

Returns:

The action code for the widget's default event, Keyboard.SE_CHOOSE.

getScreenValue

public BaseDataType getScreenValue()

Get widget screen value (suitable for assigning back to any associated variable or field). This will be rendered as the values (which are the same as the labels in LIST-ITEMS mode, but are different from the labels in LIST-ITEM-PAIRS mode).

This will be a single text value if this is a single-select list and will be a delimited list if this is multiple-select.

Returns:

Current widget screen value.

getText

public java.lang.String getText()

Get the text representation of the currently selected value. This will be rendered as the labels that are displayed (which are the same as the value in LIST-ITEMS mode, but are different from the value in LIST-ITEM-PAIRS mode).

This will be a single text value if this is a single-select list and will be a delimited list if this is multiple-select.

Specified by:

getText in interface DataContainer

Returns:

The screen representation of the value or empty string if there is no selection.

getValue

public BaseDataType getValue()

Getting the currently selected item. Since the list is made of {label, value} pairs, this method returns the value.

Specified by:

getValue in interface DataContainer

Returns:

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

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.

isHorizontalScrollBar

public boolean isHorizontalScrollBar()

Get state of the HORIZONTAL-SCROLL-BAR attribute.

Returns:

true if scroll bar is enabled.

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.

isSelected

public boolean isSelected(int index)

Checks the selection state of the entry with specified index in SelectionListBody.

Parameters:

index - The index of the entry to be checked inside the list.

Returns:

true if operation was successful and false otherwise.

isVerticalScrollBar

public boolean isVerticalScrollBar()

Get state of the VERTICAL-SCROLL-BAR attribute.

Returns:

true if scroll bar is enabled.

location

public Point location()

Get widget location relative to container.

Specified by:

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

Overrides:

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

Returns:

relative widget location.

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.

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.

physicalLocation

public NativePoint physicalLocation()

Get widget physical location relative to container, expressed in units native to UI type.

Specified by:

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

Overrides:

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

Returns:

relative widget location.

processKeyEvent

public final void processKeyEvent(KeyInput keyEvent)

Key events handler for the SelectionListBody widget. The special processing for SelectionListBody is the SPACE key is the same as ENTER key. Also by moving the list cursor the user changes selected item for single selection mode list.

Specified by:

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

Overrides:

processKeyEvent in class DefaultList<java.lang.String,O extends OutputManager<?>>

Parameters:

keyEvent - The key event to be handled.

requestFocus

public void requestFocus()

Requesting the focus to the SelectionListBody.

Specified by:

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

scroll

public void scroll(java.lang.Integer newXPosition,
                   java.lang.Integer newYPosition)

Directs the widget to scroll to the specified X and Y positions. It is the widget's responsibility to update its visuals accordingly. Note that the position values are in the same units as the returned dimensions from DefaultList.getScrollDimension(), DefaultList.getVisibleDimension() and DefaultList.getScrollStep().

Specified by:

scroll in interface ScrollableWidget<O extends OutputManager<?>>

Overrides:

scroll in class DefaultList<java.lang.String,O extends OutputManager<?>>

Parameters:

newXPosition - New X scroll position.

newYPosition - New Y scroll position.

scrollToItem

public boolean scrollToItem(int index)

Scrolls the list to have the specified item at the top of the list.

Parameters:

index - The index of the entry which must be visible after scrolling the list.

Returns:

true if operation was successful and false otherwise.

scrollToItem

public boolean scrollToItem(java.lang.String item)

Scrolls the list to have the specified item at the top of the list.

Parameters:

item - The string entry which must be visible after scrolling the list.

Returns:

true if operation was successful and false otherwise.

setLocation

public void setLocation(double x,
                        double y)

Set widget relative location. The x value corresponds to COLUMN while y value corresponds to ROW 4GL attribute. Note however that the values are expected to be 0-based.

Specified by:

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

Overrides:

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

Parameters:

x - Widget X.

y - Widget Y.

setPhysicalLocation

public void setPhysicalLocation(int x,
                                int y)

Set widget relative physical location.

Specified by:

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

Overrides:

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

Parameters:

x - Widget physical X.

y - Widget physical Y.

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.

deleteItem

public boolean deleteItem(int idx)

Delete item from SelectionList

Parameters:

idx - 1-based index of the item

Returns:

true if successful

refreshItems

protected void refreshItems()

Update list of items from configuration. Preserve current selection.

calculateScrollYPosition

protected int calculateScrollYPosition()

Calculate the scroll Y position based on the current state.

Overrides:

calculateScrollYPosition in class DefaultList<java.lang.String,O extends OutputManager<?>>

Returns:

the new scroll Y position

getItemText

protected java.lang.String getItemText(int i)

Get item text at specified index.

Parameters:

i - The item index.

Returns:

The item text.

needValueChanged

protected boolean needValueChanged()

Checks if we need to post VALUE-CHANGED event. UI specific part.

Returns:

TRUE if single selection mode and changed value, FALSE otherwise.

pageSize

protected int pageSize()

Pagination is based on number of visible rows given the widget height. If less than one row is visible pagination is disabled.

Returns:

the number of rows to skip when paginating

resetView

protected void resetView()

Reset view: set top row to zero, clear selection etc.

Overrides:

resetView in class DefaultList<java.lang.String,O extends OutputManager<?>>

scrollWorker

protected boolean scrollWorker(java.lang.Integer newXPosition,
                               java.lang.Integer newYPosition)

Directs the widget to scroll to the specified X and Y positions. It is the widget's responsibility to update its visuals accordingly. Note that the position values are in the same units as the returned dimensions from DefaultList.getScrollDimension(), DefaultList.getVisibleDimension() and DefaultList.getScrollStep().

Parameters:

newXPosition - New X scroll position.

newYPosition - New Y scroll position.

Returns:

true to indicate that the scroll operation actually invalidated this list.

shiftByCursorKeys

protected final boolean shiftByCursorKeys(int key)

If the argument is one of cursor keys (UP, DOWN, PAGE_UP, PAGE_DOWN, HOME, END), then adjust current row. Otherwise do nothing.

Parameters:

key - the key

Returns:

true if the current row was changed by this call

shiftSelectCurrentRow

protected final boolean shiftSelectCurrentRow(int delta,
                                              boolean doNotSelect)

Shift current row by provided delta, scroll if necessary.

Parameters:

delta - offset to next row, may be 0

doNotSelect - if true, then do not select current item

Returns:

true if the widget needs repaint

toggleCurrentRowSelection

protected final void toggleCurrentRowSelection()

Toggle selection of the current item.

setSingleValue

private boolean setSingleValue(BaseDataType value)

Set single value in the list as selected.

Parameters:

value - Value to set.

Returns:

true if value is set and repaint is required.