com.goldencode.p2j.ui.client.gui

Class ScrollableSelectionListGuiImpl

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

com.goldencode.p2j.ui.client.gui.ScrollableSelectionListGuiImpl

All Implemented Interfaces:

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

public class ScrollableSelectionListGuiImpl
extends ScrollableList<GuiOutputManager>

Scrollable selection list GUI implementation. To be used to support combo box and selection list widgets.

Field Summary

Fields

Modifier and Type	Field and Description
private GuiColorResolver	gc Color resolver
private GuiDriver	gd Screen driver
private GuiFontResolver	gf Font resolver
private boolean	highlighted Flag indicating the selected item in the list must be highlighted when drawing.
private java.lang.Runnable	onItemSelectedAction A callback after item selected.
private int	rowsToDisplay The GUI specific visible rows value including possible partial row.
private int	rowTop The current top row in the list to draw.

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

box

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

Method Summary

Modifier and Type	Method and Description
protected int	calculateScrollYPosition() Calculate the scroll Y position based on the current state.
void	draw() Draws this component.
void	drawCaret() Sets position of terminal's cursor to the first char of the combo-box.
boolean	enforceDefaultMousePtr() Check if the default mouse pointer should be used regardless of the parent settings
private int	fixTopRow(int desiredTopRow) Converts the passed in value to a valid row unless the value is already valid.
MousePtrWrapper	getEffectiveMousePointer() Get the current effective custom mouse pointer
java.util.Optional<MousePtrWrapper>	getLoadedMousePointer() Get the Loaded custom mouse pointer if it is set
protected int	getTopRow() Get item number to be displayed on the top of the list.
protected int[]	mouseActions() Determine the mouse actions processed by this widget.
void	mouseClicked(java.awt.event.MouseEvent e) Notification of a mouse clicked event occurred for this widget.
void	mouseMoved(java.awt.event.MouseEvent e) Notification of a mouse moving event occurred for this widget.
void	processKeyEvent(KeyInput kvt) Intercept key events and handle some special cases which are not handled by base class.
void	repaint() The scrollable list's boundary does not keep track of the view size - it posts a repaint event for the entire list, regardless how small a part is visible.
void	scroll(java.lang.Integer newXPosition, java.lang.Integer newYPosition) Directs the widget to scroll to the specified X and Y positions.
protected boolean	select(int from, int to) Add specified range of items to selection.
boolean	set(int index) Set selection to the specified row.
void	setHighlighted(boolean highlighted) Set the mode if the current row is drawing as selected or not.
void	setOnItemSelected(java.lang.Runnable action) Set an action to be called when item is selected.
void	setRowsToDisplay(int dispRows) Sets the number of rows to display including possible partial row.
protected void	setTopRow(int index) Set item number to be displayed on the top of the drop-down list.
protected boolean	shiftCurrentRow(int delta, boolean scroll) Shifts current row by specified delta.
boolean	supportsCustomMousePointer() Check if the widget supports LOAD-MOUSE-POINTER() method

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

getBox, getCurrentRow, getFirstCharSelection, getItemText, getStartStringSelection, getTriggerWidget, isScrollPopupSupported, minimumSize

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

addScrollListener, addSelectionListener, currentRow, deselect, dimension, ensureRowVisible, ensureRowVisible, first, getColumns, getScrollDimension, getScrollStep, getVisibleDimension, height, isSingleSelectionMode, model, postScrollEvent, processKey, resetView, selectCurrentRow, selected, selection, selectionClear, selectionMode, selectionSize, setColumns, setCurrentRow, setSelectionMode, setVisibleRows, 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, getId, 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, mouseDragged, mouseEntered, mouseExited, 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, requestFocus, requestSync, resetBitmap, resizeTo, resolveFont, resolvePopupMenuId, resolveTitleFont, screen, screenDimension, screenHeight, screenLocation, screenPhysicalLocation, screenWidth, setBitmap, setCachedScreenLocation, setCachedScreenPhysicalLocation, setDirectManipulationActive, setEnabled, setHidden, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalDimensionInt, setPhysicalLocation, setSensitiveForUIB, setState, setVisible, setWindow, show, showPopupMenu, 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, findMouseSource, focusTraversable, forceCursorOnFocus, forceVisibility, getActualBounds, getCustomMousePointer, getId, getIdForTrigger, getLegacyWidget, 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, requestFocus, requestFocus, requestFocus, requestSync, resizeTo, resolvePopupMenuId, screen, screenLocation, screenPhysicalLocation, setDirectManipulationActive, setEnabled, setHidden, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, setSensitiveForUIB, setState, setVisible, setWindow, show, startTrigger, systemFocusGrabbed, topLevelWindow, unrealize, unregisterWidgetListener, validateDisplayValue, widgetStateChanged, window

Methods inherited from interface java.awt.event.MouseListener

mouseEntered, mouseExited, mousePressed, mouseReleased

Methods inherited from interface java.awt.event.MouseMotionListener

mouseDragged

Methods inherited from interface java.awt.event.MouseWheelListener

mouseWheelMoved

Field Detail

gd

private GuiDriver gd

Screen driver

gc

private GuiColorResolver gc

Color resolver

gf

private GuiFontResolver gf

Font resolver

rowTop

private int rowTop

The current top row in the list to draw.

rowsToDisplay

private int rowsToDisplay

The GUI specific visible rows value including possible partial row.

onItemSelectedAction

private java.lang.Runnable onItemSelectedAction

A callback after item selected.

highlighted

private boolean highlighted

Flag indicating the selected item in the list must be highlighted when drawing.

Constructor Detail

ScrollableSelectionListGuiImpl

ScrollableSelectionListGuiImpl(ComboBox<GuiOutputManager> 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

draw

public void draw()

Draws this component. Overrides draw() in JList.

Specified by:

draw in interface Widget<GuiOutputManager>

Specified by:

draw in class ScrollableList<GuiOutputManager>

scroll

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

Description copied from class: DefaultList

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

Overrides:

scroll in class DefaultList<java.lang.String,GuiOutputManager>

Parameters:

newXPosition - New X scroll position.

newYPosition - New Y scroll position.

mouseClicked

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

Notification of a mouse clicked event occurred for this widget.

Specified by:

mouseClicked in interface java.awt.event.MouseListener

Overrides:

mouseClicked in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mouseMoved

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

Notification of a mouse moving event occurred for this widget.

Specified by:

mouseMoved in interface java.awt.event.MouseMotionListener

Overrides:

mouseMoved in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

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 ScrollableList<GuiOutputManager>

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

Overrides:

processKeyEvent in class ScrollableList<GuiOutputManager>

Parameters:

kvt - Key event to process.

setRowsToDisplay

public void setRowsToDisplay(int dispRows)

Sets the number of rows to display including possible partial row.

Parameters:

dispRows - New value for rows to display.

mouseActions

protected int[] mouseActions()

Determine the mouse actions processed by this widget.

Overrides:

mouseActions in class AbstractWidget<GuiOutputManager>

Returns:

See above.

setTopRow

protected void setTopRow(int index)

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

Specified by:

setTopRow in class ScrollableList<GuiOutputManager>

Parameters:

index - The index of the top item.

getTopRow

protected int getTopRow()

Get item number to be displayed on the top of the list.

Returns:

See above.

set

public boolean set(int index)

Set selection to the specified row.

Overrides:

set in class DefaultList<java.lang.String,GuiOutputManager>

Parameters:

index - Item index.

Returns:

true if selection was changed by this call

select

protected boolean select(int from,
                         int to)

Add specified range of items to selection.

Overrides:

select in class DefaultList<java.lang.String,GuiOutputManager>

Parameters:

from - Start index in the range.

to - End index in the range.

Returns:

true if selection was changed by this call

repaint

public void repaint()

The scrollable list's boundary does not keep track of the view size - it posts a repaint event for the entire list, regardless how small a part is visible.

If the list is attached to a parent, then the repaint will be posted for its parent.

Specified by:

repaint in interface Widget<GuiOutputManager>

Overrides:

repaint in class AbstractWidget<GuiOutputManager>

getEffectiveMousePointer

public MousePtrWrapper getEffectiveMousePointer()

Get the current effective custom mouse pointer

Specified by:

getEffectiveMousePointer in interface Widget<GuiOutputManager>

Overrides:

getEffectiveMousePointer in class AbstractWidget<GuiOutputManager>

Returns:

the current effective custom mouse pointer

getLoadedMousePointer

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

Get the Loaded custom mouse pointer if it is set

Specified by:

getLoadedMousePointer in interface Widget<GuiOutputManager>

Overrides:

getLoadedMousePointer in class AbstractWidget<GuiOutputManager>

Returns:

the loaded custom mouse pointer if it is set

enforceDefaultMousePtr

public boolean enforceDefaultMousePtr()

Check if the default mouse pointer should be used regardless of the parent settings

Returns:

true if the default mouse pointer should always be used

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

setOnItemSelected

public void setOnItemSelected(java.lang.Runnable action)

Set an action to be called when item is selected. The action is called only when the selection also uncoditionally terminates the list.

Parameters:

action - The action to run.

setHighlighted

public void setHighlighted(boolean highlighted)

Set the mode if the current row is drawing as selected or not.

Specified by:

setHighlighted in interface Widget<GuiOutputManager>

Overrides:

setHighlighted in class AbstractWidget<GuiOutputManager>

Parameters:

highlighted - If TRUE - the current row is drawing with selected color attributes, FALSE - the current row is drawing as the rest of the list.

shiftCurrentRow

protected boolean shiftCurrentRow(int delta,
                                  boolean scroll)

Shifts current row by specified delta.

Overrides:

shiftCurrentRow in class DefaultList<java.lang.String,GuiOutputManager>

Parameters:

delta - the number of list items to shift current row by

scroll - indicates whether list should be scrolled to the shift row

Returns:

true if widget needs repainting

calculateScrollYPosition

protected int calculateScrollYPosition()

Calculate the scroll Y position based on the current state.

Overrides:

calculateScrollYPosition in class DefaultList<java.lang.String,GuiOutputManager>

Returns:

the new scroll Y position

fixTopRow

private int fixTopRow(int desiredTopRow)

Converts the passed in value to a valid row unless the value is already valid.

Parameters:

desiredTopRow - The value to check and fix.

Returns:

valid row value