com.goldencode.p2j.ui.client.gui

Class MenuGuiImpl

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

com.goldencode.p2j.ui.client.gui.MenuGuiImpl

All Implemented Interfaces:

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

Direct Known Subclasses:

BrowsePopupMenu, EditorPopupGuiImpl, ScrollPopupGuiImpl, WindowTitlePopupGuiImpl

public class MenuGuiImpl
extends Menu<GuiOutputManager>
implements MouseWidgetsEnumerator, MenuStructure<GuiOutputManager>

Menu GUI client implementation class.

Nested Class Summary

Nested classes/interfaces inherited from class com.goldencode.p2j.ui.client.Menu

Menu.PopupKeyListener

Field Summary

Fields

Modifier and Type	Field and Description
private GuiDriver	gd Screen driver
private int	menubarLines Number of MENUBAR lines
private boolean	mnemonicsOn If true => mnemonics are drawn.

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

listeners, location, mousePtr, nativeInsets, physicalLocation

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	clearItemsHighlight() Resets all highlight related variables to default state.
private void	detachFromPopupWindow(TopLevelWindow wnd) Detahces this widget from the parent window.
void	doLayout() Lay out container.
void	doShowPopup(Widget<GuiOutputManager> src, NativePoint location, java.lang.Runnable dismissHandler) The abstract portion of the logic making pop-up menu shown.
void	draw() Draw the peer container.
protected static Widget<GuiOutputManager>	findMenuMouseSource(AbstractContainer menu, NativePoint p, NativeRectangle bodyBounds) Find the mouse source in this menu, recursive.
Widget<GuiOutputManager>	findMouseSource(NativePoint p) Find the widget positioned just bellow the specified mouse position (in physical units), in this menu bar, walking the entire opened menu tree, recursively.
Widget<GuiOutputManager>	getFirstEnabledWidget() Looks up the very first enabled widget.
protected Widget	getFirstFocusableItem() Returns the first focusable child.
protected Widget	getLastFocusableItem() Returns the last focusable child.
java.util.List<Widget>	getMouseWidgets() Returns the list of widgets that will be considered when registering mouse widgets by GUI driver.
double	height() Replace original version to take into account P2J specific behavior.
void	hide() Hide widget.
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.
boolean	isLegacyFocus() Returns a flag marking the widget as subject to legacy focus handling.
boolean	isMnemonicsOn() Get keyboard mnemonics mode.
void	leaveMenu() Close all opened bodies and remove focus from the menu.
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.
protected boolean	processAccelerator(KeyInput event, MenuItem<?> m) Process accelerator event.
void	processKeyEvent(KeyInput event) Process key event.
void	setMnemonicsOn(boolean mnemonicsOn) Set mnemonics mode.
void	setVisible(boolean visible) Hide/show widget.
double	width() Replace original version to take into account P2J specific behavior.
private double	width(boolean includeNested) Replace original version to take into account P2J specific behavior.

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

afterConfigUpdate, config, currentFocus, destroy, enterMenu, focusWorker, getMenu, getTabItemList, hasFocus, hasMenuFocus, isMenubarElement, processKeyAccelerator, setMenuClosedHandler, showPopup, triggerMenuClosed

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, dumpCurrentWidgets, dumpWidgets, endSizeChange, firstFocus, focus, focusTraversable, formatDump, get, getAllSelectedWidgets, getClipRect, getEffectiveScrollableSize, getFocusInt, getIgnoreFocus, getLayout, getScrollableSize, hasFocusable, 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

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, 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, 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.MenuStructure

getParentMenu, getParentMenuContainer, getParentSubMenu, getParentSubMenuBody, getRootSubMenu

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

acceptsEscAsAnyKey, acceptTrigger, addFocusListener, addKeyListener, ancestor, ancestorId, bounds, canMovetoTop, clearWidget, completeTrigger, config, defaultMousePtr, destroy, dimension, displayPhysicalLocation, 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, highlighted, ignoreEnable, initialHeight, initialWidth, insets, isCurrent, isCurrent, isDirectManipulable, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDisplayed, isDroppable, isEnabled, isFocusable, isHeader, isInitialValueLayout, isProcessProgressEvent, isRealized, isRepaintDisabled, isRMBEntrySupported, isTabStop, isThreeD, isTotallyObscured, isVisible, isVisible, location, maySwitchFocus, minimumSize, 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, 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

Methods inherited from interface java.awt.event.MouseWheelListener

mouseWheelMoved

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

widgetsAsList

Field Detail

gd

private GuiDriver gd

Screen driver

menubarLines

private int menubarLines

Number of MENUBAR lines

mnemonicsOn

private boolean mnemonicsOn

If true => mnemonics are drawn. This mode is intended only for MENUBAR. It activated using ALT key.

Constructor Detail

MenuGuiImpl

public MenuGuiImpl(WidgetId id,
                   MenuConfig cfg)

Special constructor used to restore component using given configuration.

Parameters:

id - The widget's ID.

cfg - Configuration data.

Method Detail

findMenuMouseSource

protected static Widget<GuiOutputManager> findMenuMouseSource(AbstractContainer menu,
                                                              NativePoint p,
                                                              NativeRectangle bodyBounds)

Find the mouse source in this menu, recursive.

Parameters:

menu - The (sub)menu parent.

p - The mouse location, relative to parent.

bodyBounds - The bounds of the (sub)menu's body.

Returns:

The selected sub-menu or menu-item; null if the mouse is not over a child in the menu tree.

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>

Overrides:

initialize in class Menu<GuiOutputManager>

Parameters:

id - The widget's ID.

cfg - The config used to initialize this widget.

isMnemonicsOn

public boolean isMnemonicsOn()

Get keyboard mnemonics mode.

Returns:

true if mnemonics are active in the menu.

setMnemonicsOn

public void setMnemonicsOn(boolean mnemonicsOn)

Set mnemonics mode.

Parameters:

mnemonicsOn - true if mnemonics should become active in the menu.

clearItemsHighlight

public void clearItemsHighlight()

Resets all highlight related variables to default state.

mouseActions

protected int[] mouseActions()

Determine the mouse actions processed by this widget.

Overrides:

mouseActions in class AbstractWidget<GuiOutputManager>

Returns:

See above.

draw

public void draw()

Draw the peer container. The methods calls the draw() method for ScrollPane instance for the peer container. In addition the required clipping rectangle is calculated for ChildFrame containers because they must be rendered inside the parent container.

Drawing for the redirected terminal differs. Labels/headers are drawn only once per page, instead of the usual once per menu.

Specified by:

draw in interface Widget<GuiOutputManager>

Overrides:

draw in class AbstractContainer<GuiOutputManager>

isLegacyFocus

public boolean isLegacyFocus()

Returns a flag marking the widget as subject to legacy focus handling. The value is used by focus manager and adjusts its logic accordingly.

Specified by:

isLegacyFocus in interface Widget<GuiOutputManager>

Returns:

See above.

width

public double width()

Replace original version to take into account P2J specific behavior.

Specified by:

width in interface Widget<GuiOutputManager>

Overrides:

width in class AbstractContainer<GuiOutputManager>

Returns:

widget width.

See Also:

Widget.width()

height

public double height()

Replace original version to take into account P2J specific behavior.

Specified by:

height in interface Widget<GuiOutputManager>

Overrides:

height in class AbstractContainer<GuiOutputManager>

Returns:

widget height.

See Also:

Widget.height()

doLayout

public void doLayout()

Lay out container. Set children locations.

Specified by:

doLayout in interface Container<GuiOutputManager>

Overrides:

doLayout in class AbstractContainer<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.

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

Overrides:

setVisible in class Menu<GuiOutputManager>

Parameters:

visible - New visible state.

findMouseSource

public Widget<GuiOutputManager> findMouseSource(NativePoint p)

Find the widget positioned just bellow the specified mouse position (in physical units), in this menu bar, walking the entire opened menu tree, recursively.

Specified by:

findMouseSource in interface Widget<GuiOutputManager>

Overrides:

findMouseSource in class AbstractContainer<GuiOutputManager>

Parameters:

p - The mouse physical location.

Returns:

A widget over which the mouse is positioned or null if none found.

getFirstEnabledWidget

public Widget<GuiOutputManager> getFirstEnabledWidget()

Looks up the very first enabled widget.

Specified by:

getFirstEnabledWidget in class Menu<GuiOutputManager>

Returns:

the first enabled widget or null

hide

public void hide()

Hide widget.

Specified by:

hide in interface Widget<GuiOutputManager>

Overrides:

hide in class AbstractWidget<GuiOutputManager>

leaveMenu

public void leaveMenu()

Close all opened bodies and remove focus from the menu.

Overrides:

leaveMenu in class Menu<GuiOutputManager>

getMouseWidgets

public java.util.List<Widget> getMouseWidgets()

Returns the list of widgets that will be considered when registering mouse widgets by GUI driver.

Specified by:

getMouseWidgets in interface MouseWidgetsEnumerator

Returns:

list of widgets, may be null.

processKeyEvent

public void processKeyEvent(KeyInput event)

Process key event.

Specified by:

processKeyEvent in interface Widget<GuiOutputManager>

Overrides:

processKeyEvent in class Menu<GuiOutputManager>

Parameters:

event - Key event to process.

getFirstFocusableItem

protected Widget getFirstFocusableItem()

Returns the first focusable child.

Returns:

focusable child.

getLastFocusableItem

protected Widget getLastFocusableItem()

Returns the last focusable child.

Returns:

focusable child.

doShowPopup

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

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

Overrides:

doShowPopup in class Menu<GuiOutputManager>

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.

processAccelerator

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

Process accelerator event. If some MENUBAR sub-menu has a focus, than event must be ignored.

Overrides:

processAccelerator in class Menu<GuiOutputManager>

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.

width

private double width(boolean includeNested)

Replace original version to take into account P2J specific behavior.

Parameters:

includeNested - true if we should process nested sub-menus

Returns:

See above.

detachFromPopupWindow

private void detachFromPopupWindow(TopLevelWindow wnd)

Detahces this widget from the parent window.

Parameters:

wnd - Parent window to detach from.