com.goldencode.p2j.ui.client.gui

Class ButtonListGuiImpl.Items

java.lang.Object

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

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

com.goldencode.p2j.ui.client.widget.BorderedPanel<GuiOutputManager>

com.goldencode.p2j.ui.client.gui.BorderedPanelGuiImpl

com.goldencode.p2j.ui.client.gui.ButtonListGuiImpl.Items

All Implemented Interfaces:

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

Enclosing class:

ButtonListGuiImpl

public class ButtonListGuiImpl.Items
extends BorderedPanelGuiImpl
implements ScrollableWidget<GuiOutputManager>

Represents a scrollable items list.

Field Summary

Fields

Modifier and Type	Field and Description
private ButtonListGroupItemConfig[]	configs The array of item's configurations
private int	heightInPixels The height of this widget given in pixel units
private int	itemHeightInPixels The height of an item calculated in pixels
private int	itemIndexOffset The index of the first visible item in the view
private int	numberOfAllItems The number of all items
private int	numberOfVisibleItems The number of items in the viewport
private int	widthInPixels The width of this widget given in pixel units

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

border

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

listeners, location, mousePtr, nativeInsets, physicalLocation

Constructor Summary

Constructors

Constructor and Description
Items(WidgetId id, ButtonListGroupItemConfig[] configs) Creates the widget that represents the group button.

Method Summary

Modifier and Type	Method and Description
Dimension	calculateVisibleDimension() Calculates the visible size of this widget in character units.
boolean	canBeScrolledDown() Tests if the items can be scrolled an item down.
boolean	canBeScrolledUp() Tests if the items can be scrolled an item up.
Dimension	dimension() Calculates the size of this widget in character units.
Widget<GuiOutputManager>	findMouseSource(NativePoint p) Find the item under the mouse pointer.
int	getItemHeight() Gets an item's height in pixels.
int	getItemWidth() Gets an item's width in pixels.
NativeDimension	getScrollDimension() Calculates the scroll size of this widget given in pixel units.
NativeDimension	getScrollStep() Returns the minimum scroll step.
NativeDimension	getVisibleDimension() Returns the visible size of this widget in pixel units.
double	height() Returns the height of this widget.
int	indexOf(ButtonListGuiImpl.Item item) Get the item's index assigned by this item's container.
boolean	isScrollPopupSupported() Tests if this widget supports a scroll popup.
Dimension	minimumSize() Returns the minimum size of this widget.
void	onHide() Setup its initial location.
private void	onResize() Update the number of visible items and reset the index of the first visible item in the view on resize, and reset its relative location.
void	onShow() Shows this widget and recalculates its native dimension.
void	scroll(java.lang.Integer newXPosition, java.lang.Integer newYPosition) Scrolls the widget's content according to the given physical translation.
void	updateFont(int font) Updates the current item font.
void	updateItems(ButtonListGroupItemConfig[] configs) Updates items list.
double	width() Returns the width of this widget.

Methods inherited from class com.goldencode.p2j.ui.client.gui.BorderedPanelGuiImpl

draw, drawPanel, getId, is3DBorder, isRMBEntrySupported, set3DBorder, setColorResolver, setCustomDraw, setId, setOptionalDraw

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

border, insets, isTransparent, setBorder, setTransparent

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

add, add, add, addContainerStateListener, addDirectly, belongsTo, checkWidget, childrenLocation, clipping, clipRectangle, copyState, currentFocus, currentFocus, cycleFocus, defaultFocus, deregisterSelectedWidget, destroy, detach, doLayout, dumpCurrentWidgets, dumpWidgets, endSizeChange, firstFocus, focus, focusTraversable, focusWorker, formatDump, get, getAllSelectedWidgets, getClipRect, getEffectiveScrollableSize, getFocusInt, getIgnoreFocus, getLayout, getScrollableSize, getTabItemList, hasFocusable, lastFocus, 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

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, createMouseHoverAction, deactivateDirectManipulation, debug, disable, disableTooltip, displayPhysicalLocation, drawCaret, enable, enableTooltip, enclosingFrame, forceCursorOnFocus, forceVisibility, getActualBounds, getAndResetBitmap, getAndSetBitmap, getBitmapCopy, getCachedScreenLocation, getCachedScreenPhysicalLocation, getCustomMousePointer, getDefaultEvent, getEffectiveMousePointer, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getPortableMouseEventCoordinates, getSelectedText, getState, getTextHeight, getTextHeightNative, getTextHeightNative, getTextWidth, getTextWidth, getTextWidthNative, getTextWidthNative, getVisiblePart, getZOrderClass, hasFocus, hasTooltip, hidden, hide, highlighted, ignoreAction, initialHeight, initialWidth, isCurrent, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDirectManipulationCapable, isDirectManipulationRequired, isDisplayed, isEnabled, isFocusable, isHeader, isMouseDrag, isRealized, isRepaintDisabled, 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, reflectSizeChanged, refresh, registerWidgetListener, repaint, repaint, requestSync, resetBitmap, resizeTo, resolveFont, resolvePopupMenuId, resolveTitleFont, screen, screenDimension, screenHeight, screenLocation, screenPhysicalLocation, screenWidth, setBitmap, setCachedScreenLocation, setCachedScreenPhysicalLocation, setDirectManipulationActive, setEnabled, setHidden, setHighlighted, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, setSensitiveForUIB, setState, setVisible, 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.widget.Widget

acceptsEscAsAnyKey, acceptTrigger, addFocusListener, addKeyListener, ancestor, ancestorId, bounds, canMovetoTop, clearWidget, completeTrigger, config, defaultMousePtr, destroy, displayPhysicalLocation, draw, drawCaret, enclosingFrame, enforceDefaultMousePtr, 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, processKeyEvent, 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

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

widgetsAsList

Field Detail

widthInPixels

private int widthInPixels

The width of this widget given in pixel units

heightInPixels

private int heightInPixels

The height of this widget given in pixel units

configs

private ButtonListGroupItemConfig[] configs

The array of item's configurations

numberOfVisibleItems

private int numberOfVisibleItems

The number of items in the viewport

numberOfAllItems

private int numberOfAllItems

The number of all items

itemIndexOffset

private int itemIndexOffset

The index of the first visible item in the view

itemHeightInPixels

private int itemHeightInPixels

The height of an item calculated in pixels

Constructor Detail

Items

public Items(WidgetId id,
             ButtonListGroupItemConfig[] configs)

Creates the widget that represents the group button.

Parameters:

id - The given widget's id.

configs - The array of item's configurations

Method Detail

updateItems

public void updateItems(ButtonListGroupItemConfig[] configs)

Updates items list.

Parameters:

configs - The array of item's configurations

indexOf

public int indexOf(ButtonListGuiImpl.Item item)

Get the item's index assigned by this item's container.

Parameters:

item - The target item

Returns:

The item's index or -1 iff item is not found within this items

onShow

public void onShow()

Shows this widget and recalculates its native dimension.

onResize

private void onResize()

Update the number of visible items and reset the index of the first visible item in the view on resize, and reset its relative location.

updateFont

public void updateFont(int font)

Updates the current item font.

Parameters:

font - The new font

onHide

public void onHide()

Setup its initial location.

getScrollDimension

public NativeDimension getScrollDimension()

Calculates the scroll size of this widget given in pixel units.

Specified by:

getScrollDimension in interface ScrollableWidget<GuiOutputManager>

Returns:

The scroll size of this widget given in pixel units

getVisibleDimension

public NativeDimension getVisibleDimension()

Returns the visible size of this widget in pixel units.

Specified by:

getVisibleDimension in interface ScrollableWidget<GuiOutputManager>

Returns:

The visible size of this widget given in pixel units

getScrollStep

public NativeDimension getScrollStep()

Returns the minimum scroll step.

Specified by:

getScrollStep in interface ScrollableWidget<GuiOutputManager>

Returns:

The minimum scroll step given in pixel units

canBeScrolledUp

public boolean canBeScrolledUp()

Tests if the items can be scrolled an item up.

Returns:

The test result

canBeScrolledDown

public boolean canBeScrolledDown()

Tests if the items can be scrolled an item down.

Returns:

The test result

getItemHeight

public int getItemHeight()

Gets an item's height in pixels.

Returns:

The item's height in pixels

getItemWidth

public int getItemWidth()

Gets an item's width in pixels.

Returns:

The item's width in pixels

scroll

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

Scrolls the widget's content according to the given physical translation.

Specified by:

scroll in interface ScrollableWidget<GuiOutputManager>

Parameters:

newXPosition - The given translation along a horizontal in pixel units

newYPosition - The given translation along a vertical in pixel units

isScrollPopupSupported

public boolean isScrollPopupSupported()

Tests if this widget supports a scroll popup. This implementation always returns false.

Specified by:

isScrollPopupSupported in interface ScrollableWidget<GuiOutputManager>

Returns:

false

dimension

public Dimension dimension()

Calculates the size of this widget in character units.

Specified by:

dimension in interface Widget<GuiOutputManager>

Overrides:

dimension in class AbstractContainer<GuiOutputManager>

Returns:

The size of this widget in character units

calculateVisibleDimension

public Dimension calculateVisibleDimension()

Calculates the visible size of this widget in character units.

Returns:

The size of this widget in character units

height

public double height()

Returns the height of this widget.

Specified by:

height in interface Widget<GuiOutputManager>

Overrides:

height in class AbstractContainer<GuiOutputManager>

Returns:

The widget's height in character units.

minimumSize

public Dimension minimumSize()

Returns the minimum size of this widget.

Specified by:

minimumSize in interface Widget<GuiOutputManager>

Overrides:

minimumSize in class AbstractContainer<GuiOutputManager>

Returns:

The minimum size of this widget

width

public double width()

Returns the width of this widget.

Specified by:

width in interface Widget<GuiOutputManager>

Overrides:

width in class AbstractContainer<GuiOutputManager>

Returns:

The widget's width in character units.

findMouseSource

public Widget<GuiOutputManager> findMouseSource(NativePoint p)

Find the item under the mouse pointer.

Specified by:

findMouseSource in interface Widget<GuiOutputManager>

Overrides:

findMouseSource in class AbstractContainer<GuiOutputManager>

Parameters:

p - The mouse coordinates relative to its parent container

Returns:

The item under the mouse pointer.