com.goldencode.p2j.ui.client

Class ScrollableList<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.ScrollableList<O>

Type Parameters:

O - the output manager type

All Implemented Interfaces:

ScrollableWidget<O>, ScrollPublisher, Widget<O>, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

Direct Known Subclasses:

ScrollableListImpl, ScrollableSelectionListGuiImpl

public abstract class ScrollableList<O extends OutputManager<?>>
extends DefaultList<java.lang.String,O>

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

This class does not provide scrolling capability. Instances must be inserted into a ScrollPane to provide scrolling.

This class is intended to only be used as the container of the actual "contents" inside the drop-down portion of a ComboBox. For the general purpose selection list please use the SelectionList class.

Field Summary

Fields

Modifier and Type	Field and Description
protected ComboBox<O>	box ComboBox instance which this instance services.

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
ScrollableList(ComboBox<O> box, ListModel<java.lang.String> model) Create component using given configuration and data model.

Method Summary

Modifier and Type	Method and Description
abstract void	draw() Draws this component.
abstract void	drawCaret() Sets position of terminal's cursor to the first char of the combo-box.
ComboBox<O>	getBox() Get the combo-box instance to which this drop-down list is attached to.
int	getCurrentRow() Get current cursor row.
static int	getFirstCharSelection(KeyInput ki, ListModel<java.lang.String> model, int currIndx) Gets item index for the given model according to the first item char and key code from the key event.
protected java.lang.String	getItemText(int i) Get item text at specified index.
static int	getStartStringSelection(java.lang.String text, ListModel<java.lang.String> model) Gets item index for the given model according to the item list name and given substring considering it at the beginning of the item name.
Widget	getTriggerWidget(int evtCode, boolean isKey) Complex legacy widgets are usually assembled from multiple individual widget classes.
boolean	isScrollPopupSupported() Check if this widget that supports scrolling also supports scroll popup.
Dimension	minimumSize() Get widget minimum size.
void	processKeyEvent(KeyInput kvt) Intercept key events and handle some special cases which are not handled by base class.
protected abstract void	setTopRow(int index) Set item number to be displayed on the top of the drop-down list.

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

addScrollListener, addSelectionListener, calculateScrollYPosition, currentRow, deselect, dimension, ensureRowVisible, ensureRowVisible, first, getColumns, getScrollDimension, getScrollStep, getVisibleDimension, height, isSingleSelectionMode, model, postScrollEvent, processKey, resetView, scroll, 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, config, copyColors, copyState, createMouseHoverAction, deactivateDirectManipulation, debug, destroy, disable, disableTooltip, displayPhysicalLocation, enable, enableTooltip, enclosingFrame, findMouseSource, focusTraversable, 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, 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, manageSystemActions, 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, 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, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalDimensionInt, setPhysicalLocation, 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.widget.Widget

acceptsEscAsAnyKey, acceptTrigger, addFocusListener, addKeyListener, ancestor, ancestorId, bounds, canMovetoTop, clearWidget, completeTrigger, config, defaultMousePtr, destroy, displayPhysicalLocation, enclosingFrame, enforceDefaultMousePtr, findMouseSource, focusTraversable, forceCursorOnFocus, forceVisibility, getActualBounds, getCustomMousePointer, getEffectiveMousePointer, getId, getIdForTrigger, getLegacyWidget, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getSelectedText, getState, 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, location, maySwitchFocus, moveToBottom, moveToTop, name, navigable, oleDrag, parent, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalBounds, physicalDimension, physicalLocation, postprocessConfig, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, processEvent, processFocusEvent, processKeyListeners, processMnemonic, raiseLegacyMouseEvents, refreshWidget, registerWidgetListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestSync, resizeTo, resolvePopupMenuId, screen, screenLocation, screenPhysicalLocation, setDirectManipulationActive, setEnabled, setHidden, setHighlighted, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, 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

box

protected ComboBox<O extends OutputManager<?>> box

ComboBox instance which this instance services.

Constructor Detail

ScrollableList

public ScrollableList(ComboBox<O> box,
                      ListModel<java.lang.String> model)

Create component using given configuration and data model.

Parameters:

box - The instance with which this object must be associated.

model - The data model that represents the contents of the list.

Method Detail

minimumSize

public Dimension minimumSize()

Get widget minimum size.

Specified by:

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

Overrides:

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

Returns:

widget minimum size.

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

drawCaret

public abstract void drawCaret()

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

Specified by:

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

Overrides:

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

setTopRow

protected abstract void setTopRow(int index)

Set item number to be displayed on the top of the drop-down list.

Parameters:

index - The index of the top item.

getItemText

protected java.lang.String getItemText(int i)

Get item text at specified index.

Parameters:

i - The item index.

Returns:

The item text.

processKeyEvent

public void processKeyEvent(KeyInput kvt)

Intercept key events and handle some special cases which are not handled by base class.

Specified by:

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

Overrides:

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

Parameters:

kvt - Key event to process.

getFirstCharSelection

public static int getFirstCharSelection(KeyInput ki,
                                        ListModel<java.lang.String> model,
                                        int currIndx)

Gets item index for the given model according to the first item char and key code from the key event. If the new item is the same as the curently selected in the given model -1 will be returned.

Parameters:

ki - The event to be tested.

model - The list model to search the new item.

currIndx - The currently selected item for the mode to search in.

Returns:

The new index if the pressed key match the first char of the item or -1 if there is no match or new item is the same as the currently selected one.

getStartStringSelection

public static int getStartStringSelection(java.lang.String text,
                                          ListModel<java.lang.String> model)

Gets item index for the given model according to the item list name and given substring considering it at the beginning of the item name. If the new item is the same as the curently selected it is up to caller to make proper action further.

Parameters:

text - The text to be tested for beginning part.

model - The list model to search the new item.

Returns:

The new index if the given text match the first part of the item or -1 if there is no match.

getCurrentRow

public int getCurrentRow()

Get current cursor row.

Returns:

The current cursor row.

getBox

public ComboBox<O> getBox()

Get the combo-box instance to which this drop-down list is attached to.

Returns:

the ComboBox instance to which this drop-down list is attached to.

isScrollPopupSupported

public boolean isScrollPopupSupported()

Check if this widget that supports scrolling also supports scroll popup.

Specified by:

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

Overrides:

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

Returns:

true if this widget supports scroll popup.

getTriggerWidget

public Widget getTriggerWidget(int evtCode,
                               boolean isKey)

Complex legacy widgets are usually assembled from multiple individual widget classes. Events may be handled by any of the individual widget class which itself may be a virtual widget with no representation in the legacy code. An example is a COMBO-BOX widget, where the scroll panel is a virtual widget with its own event handling. The virtual widget may or may not invoke a legacy trigger as a result of an input event.

This method solves the cases where multiple widget classes make up a legacy widget and one of the widget class causes a trigger to be invoked. This method returns the widget that should server as the source of the triggered event. This widget must always be a non-virtual widget. The method may also return null which prevents triggering of the legacy event.

Parameters:

evtCode - The event being triggered.

isKey - Whether the event being triggered is a real key.

Returns:

see above.