com.goldencode.p2j.ui.client

Class Menu<O extends OutputManager<?>>

java.lang.Object

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

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

com.goldencode.p2j.ui.client.Menu<O>

All Implemented Interfaces:

Container<O>, Widget<O>, WidgetWithConfig<MenuConfig>, ConfigOwner<MenuConfig>, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

Direct Known Subclasses:

MenuChuiImpl, MenuGuiImpl

public abstract class Menu<O extends OutputManager<?>>
extends AbstractContainer<O>
implements WidgetWithConfig<MenuConfig>

Menu client abstract implementation class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Menu.PopupKeyListener Key listener, intended to show pop-up menu.

Field Summary

Fields

Modifier and Type	Field and Description
private MenuConfig	config Menu attribute container.
private java.lang.Runnable	menuClosed Executed when a menu item is selected

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

listeners, location, mousePtr, nativeInsets, physicalLocation

Constructor Summary

Constructors

Constructor and Description
Menu(WidgetId id, MenuConfig cfg) Special constructor used to restore component using given configuration.

Method Summary

Modifier and Type	Method and Description
void	afterConfigUpdate(MenuConfig beforeUpdate) The method is called after the configuration associated with the implementor changes.
MenuConfig	config() Provide access to the attributes stored in the widget.
Widget<O>	currentFocus(boolean recurse) Get widget which is in focus.
private boolean	delegateToProcessAccelerator(KeyInput event) The helper method that delegates accelerator key to processAccelerator.
void	destroy() Destroy this widget.
void	doShowPopup(Widget<O> src, NativePoint location, java.lang.Runnable dismissHandler) The abstract portion of the logic making pop-up menu shown.
void	enterMenu() Activates the menu.
private MenuItem<O>	findMenuItem(int accelCode, AbstractContainer<O> menu) Find MENU-ITEM by specified accelerator key code in specified MENU (SUB-MENU) recursively.
protected void	focusWorker(boolean direction) Search for the next or previous focusable widget in the container and set focus on it.
abstract Widget<O>	getFirstEnabledWidget() Looks up the very first enabled widget.
static Menu<?>	getMenu(MenuElement<?> mel) Get menu widget from menu-item or sub-menu.
java.util.List<Widget<O>>	getTabItemList() Returns the tab item list for this container.
boolean	hasFocus() Check if widget has focus.
static boolean	hasMenuFocus(MenuStructure element) Checks whether the menu of the passed in menu element has focus, i.e.
void	initialize(WidgetId id, MenuConfig 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.
static boolean	isMenubarElement(Widget<?> item) Check if this menu-item is right inside MENUBAR (first level)
void	leaveMenu() Close all opened bodies and remove focus from the menu.
protected boolean	processAccelerator(KeyInput event, MenuItem<?> m) Process accelerator event.
void	processKeyAccelerator(KeyInput event) Processes menu key accelerator event.
void	processKeyEvent(KeyInput event) Process key event.
void	setMenuClosedHandler(java.lang.Runnable menuClosed) Sets a handler that will be executed when a menu item is selected.
void	setVisible(boolean visible) Hide/show widget.
void	showPopup(Widget<O> src, NativePoint location, java.lang.Runnable dismissHandler) Shows this pop-up menu.
void	triggerMenuClosed() Triggers the menu-closed event handler.

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

add, add, add, addContainerStateListener, addDirectly, belongsTo, checkWidget, childrenLocation, clipping, clipRectangle, copyState, currentFocus, cycleFocus, defaultFocus, deregisterSelectedWidget, detach, dimension, doLayout, draw, dumpCurrentWidgets, dumpWidgets, endSizeChange, findMouseSource, firstFocus, focus, focusTraversable, formatDump, get, getAllSelectedWidgets, getClipRect, getEffectiveScrollableSize, getFocusInt, getIgnoreFocus, getLayout, getScrollableSize, hasFocusable, height, insets, lastFocus, minimumSize, 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, 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, copyColors, createMouseHoverAction, deactivateDirectManipulation, debug, disable, disableTooltip, displayPhysicalLocation, drawCaret, enable, enableTooltip, enclosingFrame, 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, 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, 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, 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, getId, getIdForTrigger, getLegacyWidget, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getSelectedText, getState, getTriggerWidget, getTriggerWidget, getVisiblePart, getZOrderClass, hasFocus, hasTooltip, hidden, hide, highlighted, ignoreEnable, initialHeight, initialWidth, 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, requestSync, resizeTo, resolvePopupMenuId, screen, screenLocation, screenPhysicalLocation, setDirectManipulationActive, setEnabled, setHidden, setHighlighted, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, setSensitiveForUIB, setState, setWindow, show, startTrigger, supportsCustomMousePointer, systemFocusGrabbed, topLevelWindow, unregisterWidgetListener, validateDisplayValue, 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

menuClosed

private java.lang.Runnable menuClosed

Executed when a menu item is selected

config

private MenuConfig config

Menu attribute container.

Constructor Detail

Menu

public Menu(WidgetId id,
            MenuConfig cfg)

Special constructor used to restore component using given configuration.

Parameters:

id - The widget's ID.

cfg - Configuration data.

Method Detail

isMenubarElement

public static boolean isMenubarElement(Widget<?> item)

Check if this menu-item is right inside MENUBAR (first level)

Parameters:

item - MenuItem or SubMenu

Returns:

true if yes.

hasMenuFocus

public static boolean hasMenuFocus(MenuStructure element)

Checks whether the menu of the passed in menu element has focus, i.e. any of the child elements are focused and accept input.

Parameters:

element - A menu element.

Returns:

true if the menu has focus.

showPopup

public final void showPopup(Widget<O> src,
                            NativePoint location,
                            java.lang.Runnable dismissHandler)

Shows this pop-up menu.

Parameters:

src - Source widget.

location - The popup location.

dismissHandler - When not null, the runnable instance is executed when the popup menu is dismissed, regardless whether an item is chosen or not.

getMenu

public static Menu<?> getMenu(MenuElement<?> mel)

Get menu widget from menu-item or sub-menu.

Parameters:

mel - MenuItem or SubMenu

Returns:

The menu, containing specified item.

getFirstEnabledWidget

public abstract Widget<O> getFirstEnabledWidget()

Looks up the very first enabled widget.

Returns:

the first enabled widget or null

initialize

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

Parameters:

id - The widget's ID.

cfg - The config used to initialize this widget.

config

public MenuConfig config()

Provide access to the attributes stored in the widget.

Specified by:

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

Specified by:

config in interface ConfigOwner<MenuConfig>

Overrides:

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

Returns:

Reference to attribute container.

afterConfigUpdate

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

Parameters:

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

setVisible

public void setVisible(boolean visible)

Hide/show widget.

If the menu is being shown and not yet attached to a window, attached it to the default window.

Specified by:

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

Overrides:

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

Parameters:

visible - New visible state.

hasFocus

public boolean hasFocus()

Check if widget has focus.

Specified by:

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

Returns:

true if widget has focus.

currentFocus

public Widget<O> currentFocus(boolean recurse)

Get widget which is in focus.

The method allows to choose whether the focused widget is searched in the nested containers (recurse == true) or whether only this container is searched (recurse == false).

Specified by:

currentFocus in interface Container<O extends OutputManager<?>>

Overrides:

currentFocus in class AbstractContainer<O extends OutputManager<?>>

Parameters:

recurse - The parameter controls whether the method should recurse to the nested containers when searching for the focused widget.

Returns:

focused widget.

processKeyEvent

public void processKeyEvent(KeyInput event)

Process key event.

Specified by:

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

Overrides:

processKeyEvent in class AbstractContainer<O extends OutputManager<?>>

Parameters:

event - Key event to process.

processKeyAccelerator

public void processKeyAccelerator(KeyInput event)

Processes menu key accelerator event.

Parameters:

event - The key event.

getTabItemList

public java.util.List<Widget<O>> getTabItemList()

Returns the tab item list for this container. If the tab item list is not given, then an empty list is returned.

Specified by:

getTabItemList in interface Container<O extends OutputManager<?>>

Overrides:

getTabItemList in class AbstractContainer<O extends OutputManager<?>>

Returns:

The tab item list.

enterMenu

public void enterMenu()

Activates the menu. Brings focus to the first focusable menu item (or submenu), handles highliting and repaints. If the menu isn't visible, the method is a NOP.

leaveMenu

public void leaveMenu()

Close all opened bodies and remove focus from the menu.

processAccelerator

protected boolean processAccelerator(KeyInput event,
                                     MenuItem<?> m)

Process accelerator event. Can be overridden.

Parameters:

event - KeyInput object, related to key event.

m - Target accelerator source menu-item.

Returns:

true means accelerator was processed. false means accelerator was ignored.

destroy

public void destroy()

Destroy this widget.

Specified by:

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

Overrides:

destroy in class AbstractContainer<O extends OutputManager<?>>

setMenuClosedHandler

public void setMenuClosedHandler(java.lang.Runnable menuClosed)

Sets a handler that will be executed when a menu item is selected. Only one (or no) handler can be set at a time. The handler is executed after the menu UI is made invisible but before the related progress events are posted (CHOOSE, VALUE-CHANGED).

Parameters:

menuClosed - May be null.

triggerMenuClosed

public void triggerMenuClosed()

Triggers the menu-closed event handler.

focusWorker

protected void focusWorker(boolean direction)

Search for the next or previous focusable widget in the container and set focus on it.

Overrides:

focusWorker in class AbstractContainer<O extends OutputManager<?>>

Parameters:

direction - Widget search direction.

doShowPopup

public void doShowPopup(Widget<O> src,
                        NativePoint location,
                        java.lang.Runnable dismissHandler)

The abstract portion of the logic making pop-up menu shown.

Parameters:

src - Source widget.

location - The popup location.

dismissHandler - When not null, the runnable instance is executed when the popup menu is dismissed, regardless whether an item is chosen or not.

delegateToProcessAccelerator

private boolean delegateToProcessAccelerator(KeyInput event)

The helper method that delegates accelerator key to processAccelerator.

Parameters:

event - The key input event

Returns:

The true value if key event is an accelerator key for this menu, otherwise false.

findMenuItem

private MenuItem<O> findMenuItem(int accelCode,
                                 AbstractContainer<O> menu)

Find MENU-ITEM by specified accelerator key code in specified MENU (SUB-MENU) recursively. If there are several menu-items have the same accelerator - the first found by DFS menu-item with specified accelerator key code is returned.

Parameters:

accelCode - Key code of accelerator.

menu - Current menu or sub-menu

Returns:

MENU-ITEM with accelerator code equals accelCode or null