com.goldencode.p2j.ui.client.gui

Class ButtonListGuiImpl

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

All Implemented Interfaces:

FocusListener, Container<GuiOutputManager>, Widget<GuiOutputManager>, WidgetWithConfig<ButtonListConfig>, ConfigOwner<ButtonListConfig>, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

public class ButtonListGuiImpl
extends BorderedPanelGuiImpl
implements WidgetWithConfig<ButtonListConfig>, FocusListener

Implements the button list widget.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ButtonListGuiImpl.GroupButton Represents the button with items
class	ButtonListGuiImpl.Item Defines the item panel with its icon and its label.
class	ButtonListGuiImpl.Items Represents a scrollable items list.
class	ButtonListGuiImpl.ItemsControl Defines the items control.

Field Summary

Fields

Modifier and Type	Field and Description
private double	availableSpaceInChars The available vertical space to extend the number of visible items
private int	bgItemColor The background color used by Item
private static int	BUTTON_MARGIN The standard margins around a given button
private static int	BUTTON_SIZE The standard button's size
private static int	BUTTON_WIDTH The group button's width
private GuiFontResolver	buttonFontResolver Button font resolver
private CoordinatesConversion	cc Coordinate converter
private ButtonListConfig	config Holds its settings
private int	fgItemColor The foreround color used by Item
private GuiDriver	gd Screen driver
private GuiColorResolver	groupColorResolver Group button color resolver
private static int	ICON_SIZE The standard image icon size
private boolean	init This flag has been set once, required for this widget initialization
private static int	ITEM_IMAGE_MARGIN The standard left and right margins for the image of item
private static int	ITEM_LEFT_MARGIN The standard margin between item border and its content
private static int	ITEM_PADDING The standard up and bottom padding of an item
private GuiColorResolver	itemsColorResolver Items color resolver for button list header
private BaseConfig	itemsConfig Items config
private GuiFontResolver	itemsFontResolver Items font resolver
private static CentralLogger	LOG The button-list widget logger
private static int	ROWS_NUMBER The default number of visible rows used for items view
private GuiOutputManager	screen Output manager

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
ButtonListGuiImpl(WidgetId id, ButtonListConfig cfg) Creates the button list widget.

Method Summary

Modifier and Type	Method and Description
void	afterConfigUpdate(ButtonListConfig beforeUpdate) Notifies this widget that its settings are changed.
void	colapseAllItems() Hides all items.
ButtonListConfig	config() Returns the widget's configuration.
ButtonGuiImpl	createButton(WidgetId wid, java.lang.String name, int width, int height, java.util.function.Consumer<ButtonGuiImpl> imageSetter) Defines a factory method to create a button.
Widget<GuiOutputManager>	currentFocus() Returns this widget itself.
Widget<GuiOutputManager>	defaultFocus() Returns this widget itself.
Dimension	dimension() Calculates the size of this widget in character units.
void	fireValueChanged() Fire a new value changed event.
void	firstFocus() Sets the current focus to this widget itself.
boolean	focusTraversable() Returns true.
boolean	hasFocusable(Widget<GuiOutputManager> exclude) Tests if there is a focusable widget in this container except the given widget.
double	height() Returns the height of this widget.
void	initialize(WidgetId id, ButtonListConfig cfg) Initializes the button list widget.
Dimension	minimumSize() Returns the minimum size of this widget.
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	mouseDragged(java.awt.event.MouseEvent e) Notification of a mouse dragged event occurred for this widget.
void	mouseEntered(java.awt.event.MouseEvent e) Notification of a mouse entered event occurred for this widget.
void	mouseExited(java.awt.event.MouseEvent e) Notification of a mouse exited event occurred for this widget.
void	mouseMoved(java.awt.event.MouseEvent e) Notification of a mouse moved event occurred for this widget.
void	mousePressed(java.awt.event.MouseEvent e) Notification of a mouse pressed event occurred for this widget.
void	mouseReleased(java.awt.event.MouseEvent e) Notification of a mouse released event occurred for this widget.
void	onFocusGained(FocusEvent event) Handles the focus gained event.
void	onFocusLost(FocusEvent event) Handles the focus lost event.
void	processKeyEvent(KeyInput keyEvent) Process key events that have been generated by this component.
private void	updateFont() Updates the current font.
private void	updateGroups() Updates the current list of buttons.
private boolean	updateItemsColors(ButtonListGroupConfig[] listOfGroupConfigs) Updates the bgColorRgb and fgColorRgb of each item in each group.
void	updateSize() Update widget's size.
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, cycleFocus, deregisterSelectedWidget, destroy, detach, doLayout, dumpCurrentWidgets, dumpWidgets, endSizeChange, findMouseSource, focus, focusWorker, formatDump, get, getAllSelectedWidgets, getClipRect, getEffectiveScrollableSize, getFocusInt, getIgnoreFocus, getLayout, getScrollableSize, getTabItemList, lastFocus, moveAfterTabItem, moveBeforeTabItem, moveToBottom, moveToBottomInClass, moveToTop, moveToTopInClass, moveToZpos, nextFocus, normalizeZOrder, onWidgetAdded, onWidgetRemoved, paintOnTop, parentOf, prepareWidgets, prevFocus, 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, 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, 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.Container

widgetsAsList

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

acceptsEscAsAnyKey, acceptTrigger, addFocusListener, addKeyListener, ancestor, ancestorId, bounds, canMovetoTop, clearWidget, completeTrigger, defaultMousePtr, displayPhysicalLocation, drawCaret, enclosingFrame, enforceDefaultMousePtr, forceCursorOnFocus, forceVisibility, getActualBounds, getCustomMousePointer, getEffectiveMousePointer, getIdForTrigger, getLegacyWidget, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getSelectedText, getState, getTriggerWidget, getTriggerWidget, getVisiblePart, getZOrderClass, hasFocus, hasFocus, hasTooltip, hidden, hide, highlighted, ignoreEnable, initialHeight, initialWidth, isCurrent, isCurrent, isDirectManipulable, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDisplayed, isDroppable, isEnabled, isFocusable, isHeader, isInitialValueLayout, isLegacyFocus, isProcessProgressEvent, isRealized, isRepaintDisabled, 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, 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, unregisterWidgetListener, validateDisplayValue, window

Methods inherited from interface java.awt.event.MouseWheelListener

mouseWheelMoved

Field Detail

LOG

private static final CentralLogger LOG

The button-list widget logger

BUTTON_SIZE

private static final int BUTTON_SIZE

The standard button's size

See Also:

Constant Field Values

BUTTON_WIDTH

private static final int BUTTON_WIDTH

The group button's width

See Also:

Constant Field Values

ICON_SIZE

private static final int ICON_SIZE

The standard image icon size

See Also:

Constant Field Values

BUTTON_MARGIN

private static final int BUTTON_MARGIN

The standard margins around a given button

See Also:

Constant Field Values

ITEM_IMAGE_MARGIN

private static final int ITEM_IMAGE_MARGIN

The standard left and right margins for the image of item

See Also:

Constant Field Values

ITEM_PADDING

private static final int ITEM_PADDING

The standard up and bottom padding of an item

See Also:

Constant Field Values

ITEM_LEFT_MARGIN

private static final int ITEM_LEFT_MARGIN

The standard margin between item border and its content

See Also:

Constant Field Values

ROWS_NUMBER

private static final int ROWS_NUMBER

The default number of visible rows used for items view

See Also:

Constant Field Values

config

private ButtonListConfig config

Holds its settings

gd

private GuiDriver gd

Screen driver

screen

private GuiOutputManager screen

Output manager

cc

private CoordinatesConversion cc

Coordinate converter

groupColorResolver

private GuiColorResolver groupColorResolver

Group button color resolver

itemsColorResolver

private GuiColorResolver itemsColorResolver

Items color resolver for button list header

buttonFontResolver

private GuiFontResolver buttonFontResolver

Button font resolver

itemsFontResolver

private GuiFontResolver itemsFontResolver

Items font resolver

itemsConfig

private BaseConfig itemsConfig

Items config

bgItemColor

private int bgItemColor

The background color used by Item

fgItemColor

private int fgItemColor

The foreround color used by Item

init

private boolean init

This flag has been set once, required for this widget initialization

availableSpaceInChars

private double availableSpaceInChars

The available vertical space to extend the number of visible items

Constructor Detail

ButtonListGuiImpl

public ButtonListGuiImpl(WidgetId id,
                         ButtonListConfig cfg)

Creates the button list widget.

Parameters:

id - The given widget's id.

cfg - The widget's configuration

Method Detail

createButton

public ButtonGuiImpl createButton(WidgetId wid,
                                  java.lang.String name,
                                  int width,
                                  int height,
                                  java.util.function.Consumer<ButtonGuiImpl> imageSetter)

Defines a factory method to create a button.

Parameters:

wid - The widget id

name - The given name

width - The given widget's width

height - The given widget's height

imageSetter - Sets the target images for a new created button.

Returns:

The target button implementation

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

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.

config

public ButtonListConfig config()

Returns the widget's configuration.

Specified by:

config in interface Widget<GuiOutputManager>

Specified by:

config in interface ConfigOwner<ButtonListConfig>

Overrides:

config in class AbstractWidget<GuiOutputManager>

Returns:

The button list configuration

colapseAllItems

public void colapseAllItems()

Hides all items.

afterConfigUpdate

public void afterConfigUpdate(ButtonListConfig beforeUpdate)

Notifies this widget that its settings are changed.

Specified by:

afterConfigUpdate in interface ConfigOwner<ButtonListConfig>

Parameters:

beforeUpdate - The old configuration

updateItemsColors

private boolean updateItemsColors(ButtonListGroupConfig[] listOfGroupConfigs)

Updates the bgColorRgb and fgColorRgb of each item in each group.

Parameters:

listOfGroupConfigs - The updated list of groups configuration.

Returns:

true if every item configuration bgColorRgb and fgColorRgb was updated.

updateFont

private void updateFont()

Updates the current font.

updateGroups

private void updateGroups()

Updates the current list of buttons.

initialize

public void initialize(WidgetId id,
                       ButtonListConfig cfg)

Initializes the button list widget.

Specified by:

initialize in interface WidgetWithConfig<ButtonListConfig>

Parameters:

id - This widget id

cfg - This widget configuration

onFocusGained

public void onFocusGained(FocusEvent event)

Handles the focus gained event.

Specified by:

onFocusGained in interface FocusListener

Parameters:

event - The focus event

onFocusLost

public void onFocusLost(FocusEvent event)

Handles the focus lost event.

Specified by:

onFocusLost in interface FocusListener

Parameters:

event - The focus event

firstFocus

public void firstFocus()

Sets the current focus to this widget itself.

Specified by:

firstFocus in interface Container<GuiOutputManager>

Overrides:

firstFocus in class AbstractContainer<GuiOutputManager>

focusTraversable

public boolean focusTraversable()

Returns true.

Specified by:

focusTraversable in interface Widget<GuiOutputManager>

Overrides:

focusTraversable in class AbstractContainer<GuiOutputManager>

Returns:

True

currentFocus

public Widget<GuiOutputManager> currentFocus()

Returns this widget itself.

Specified by:

currentFocus in interface Container<GuiOutputManager>

Overrides:

currentFocus in class AbstractContainer<GuiOutputManager>

Returns:

The widget itself

defaultFocus

public Widget<GuiOutputManager> defaultFocus()

Returns this widget itself.

Specified by:

defaultFocus in interface Container<GuiOutputManager>

Overrides:

defaultFocus in class AbstractContainer<GuiOutputManager>

Returns:

The widget itself

hasFocusable

public boolean hasFocusable(Widget<GuiOutputManager> exclude)

Tests if there is a focusable widget in this container except the given widget.

Specified by:

hasFocusable in interface Container<GuiOutputManager>

Overrides:

hasFocusable in class AbstractContainer<GuiOutputManager>

Parameters:

exclude - The given widget

Returns:

True

fireValueChanged

public void fireValueChanged()

Fire a new value changed event.

updateSize

public void updateSize()

Update widget's size.

processKeyEvent

public void processKeyEvent(KeyInput keyEvent)

Process key events that have been generated by this component.

Specified by:

processKeyEvent in interface Widget<GuiOutputManager>

Overrides:

processKeyEvent in class AbstractContainer<GuiOutputManager>

Parameters:

keyEvent - The key event to be handled.

mouseActions

protected int[] mouseActions()

Determine the mouse actions processed by this widget.

Overrides:

mouseActions in class AbstractWidget<GuiOutputManager>

Returns:

The mouse actions processed by this widget

mouseDragged

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

Notification of a mouse dragged event occurred for this widget.

Specified by:

mouseDragged in interface java.awt.event.MouseMotionListener

Overrides:

mouseDragged in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mouseClicked

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

Notification of a mouse clicked event occurred for this widget. Invoke server side trigger if is already registered.

Specified by:

mouseClicked in interface java.awt.event.MouseListener

Overrides:

mouseClicked in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mousePressed

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

Notification of a mouse pressed event occurred for this widget. Invoke server side trigger if is already registered.

Specified by:

mousePressed in interface java.awt.event.MouseListener

Overrides:

mousePressed in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mouseReleased

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

Notification of a mouse released event occurred for this widget. Invoke server side trigger if is already registered.

Specified by:

mouseReleased in interface java.awt.event.MouseListener

Overrides:

mouseReleased in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mouseMoved

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

Notification of a mouse moved event occurred for this widget. Invoke server side trigger if is already registered.

Specified by:

mouseMoved in interface java.awt.event.MouseMotionListener

Overrides:

mouseMoved in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mouseEntered

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

Description copied from class: AbstractWidget

Notification of a mouse entered event occurred for this widget. No-op by default.

Specified by:

mouseEntered in interface java.awt.event.MouseListener

Overrides:

mouseEntered in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

mouseExited

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

Description copied from class: AbstractWidget

Notification of a mouse exited event occurred for this widget. No-op by default.

Specified by:

mouseExited in interface java.awt.event.MouseListener

Overrides:

mouseExited in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.