com.goldencode.p2j.ui.client.gui

Class ScrollableListGuiImpl

java.lang.Object

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

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

com.goldencode.p2j.ui.client.gui.ScrollableListGuiImpl

All Implemented Interfaces:

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

public class ScrollableListGuiImpl
extends DefaultList<java.lang.String,GuiOutputManager>
implements WidgetWithConfig<BaseConfig>

Scrollable list GUI implementation.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	allowDeselect Flag indicating if the list elements can be unselected.
private BaseConfig	config Widget configuration
private GuiColorResolver	gc Color resolver
private GuiDriver	gd Screen driver
private GuiFontResolver	gf Font resolver
private boolean	inheritHeight Inherit parent height
private boolean	inheritWidth Inherit parent width
private int	rowHeight Row height

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
ScrollableListGuiImpl(WidgetId id, ListModel<java.lang.String> model, boolean allowDeselect) Constructor.

Method Summary

Modifier and Type	Method and Description
int	addItem(java.lang.String item) Add new item to list.
void	afterConfigUpdate(BaseConfig beforeUpdate) The method is called after the configuration associated with the implementor changes.
BaseConfig	config() Get the widget config.
void	deleteItems() Delete all items.
void	draw() Draw widget.
private GuiFontResolver.FontCache	font() Resolve font.
double	height() Get widget height.
void	initialize(WidgetId id, BaseConfig 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.
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	mouseWheelMoved(java.awt.event.MouseWheelEvent e) Notification of a mouse wheel moved event occurred for this widget.
void	processKeyEvent(KeyInput event) Process key event.
void	setInheritHeight(boolean inheritHeight) Set if width is inherited from parent widget.
void	setInheritWidth(boolean inheritWidth) Set if width is inherited from parent widget.
double	width() Get widget width.

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

addScrollListener, addSelectionListener, calculateScrollYPosition, currentRow, deselect, dimension, ensureRowVisible, ensureRowVisible, first, getColumns, getScrollDimension, getScrollStep, getVisibleDimension, isScrollPopupSupported, isSingleSelectionMode, minimumSize, model, postScrollEvent, processKey, resetView, scroll, select, selectCurrentRow, selected, selection, selectionClear, selectionMode, selectionSize, set, setColumns, setCurrentRow, setSelectionMode, setVisibleRows, shiftCurrentRow, value, visibleRows

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, 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, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, 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, 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, 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

mouseEntered, mouseExited, mousePressed, mouseReleased

Methods inherited from interface java.awt.event.MouseMotionListener

mouseDragged, mouseMoved

Field Detail

gd

private GuiDriver gd

Screen driver

config

private BaseConfig config

Widget configuration

gc

private GuiColorResolver gc

Color resolver

gf

private GuiFontResolver gf

Font resolver

rowHeight

private int rowHeight

Row height

allowDeselect

private final boolean allowDeselect

Flag indicating if the list elements can be unselected.

inheritWidth

private boolean inheritWidth

Inherit parent width

inheritHeight

private boolean inheritHeight

Inherit parent height

Constructor Detail

ScrollableListGuiImpl

public ScrollableListGuiImpl(WidgetId id,
                             ListModel<java.lang.String> model,
                             boolean allowDeselect)

Constructor.

Parameters:

id - The widget's ID.

model - List model.

allowDeselect - true if the list elements can be unselected.

Method Detail

initialize

public void initialize(WidgetId id,
                       BaseConfig 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<BaseConfig>

Parameters:

id - The widget's ID.

cfg - The config used to initialize this widget.

config

public BaseConfig config()

Get the widget config.

Specified by:

config in interface Widget<GuiOutputManager>

Specified by:

config in interface ConfigOwner<BaseConfig>

Overrides:

config in class AbstractWidget<GuiOutputManager>

Returns:

See above.

afterConfigUpdate

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

Parameters:

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

setInheritWidth

public void setInheritWidth(boolean inheritWidth)

Set if width is inherited from parent widget.

Parameters:

inheritWidth - true if width is inherited from parent.

setInheritHeight

public void setInheritHeight(boolean inheritHeight)

Set if width is inherited from parent widget.

Parameters:

inheritHeight - true if height is inherited from parent.

width

public double width()

Get widget width.

Specified by:

width in interface Widget<GuiOutputManager>

Overrides:

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

Returns:

widget width.

height

public double height()

Get widget height.

Specified by:

height in interface Widget<GuiOutputManager>

Overrides:

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

Returns:

widget height.

draw

public void draw()

Draw widget.

Specified by:

draw in interface Widget<GuiOutputManager>

Specified by:

draw in class AbstractWidget<GuiOutputManager>

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.

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.

processKeyEvent

public void processKeyEvent(KeyInput event)

Process key event.

Specified by:

processKeyEvent in interface Widget<GuiOutputManager>

Overrides:

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

Parameters:

event - Key event to process.

addItem

public int addItem(java.lang.String item)

Add new item to list.

Parameters:

item - Item to add.

Returns:

First visible row. Could be negative.

deleteItems

public void deleteItems()

Delete all items.

mouseActions

protected int[] mouseActions()

Determine the mouse actions processed by this widget.

Overrides:

mouseActions in class AbstractWidget<GuiOutputManager>

Returns:

See above.

font

private GuiFontResolver.FontCache font()

Resolve font. Because the font could be changed dynamically whenever we draw the widget we have to check if font was changed and rebuild font object if true.

Returns:

Font cache instance.