com.goldencode.p2j.ui.client.gui

Class MenuItemGuiImpl

java.lang.Object

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

com.goldencode.p2j.ui.client.MenuItem<GuiOutputManager>

com.goldencode.p2j.ui.client.gui.MenuItemGuiImpl

All Implemented Interfaces:

FocusListener, MenuElement<GuiOutputManager>, MenuStructure<GuiOutputManager>, Widget<GuiOutputManager>, WidgetWithConfig<MenuItemConfig>, ConfigOwner<MenuItemConfig>, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

public class MenuItemGuiImpl
extends MenuItem<GuiOutputManager>
implements FocusListener

MenuItem GUI client implementation class.

Field Summary

Fields

Modifier and Type	Field and Description
private double	cachedHeight Cached height of this item.
private double	cachedWidth Cached width of this item.
private GuiDriver	gd Screen driver
private GuiFontResolver	gf Font resolver
private java.util.Map<java.lang.Integer,java.util.Set<java.awt.event.MouseAdapter>>	mouseListeners TODO: move that to future subclass, intended specially for system pop-ups.

Fields inherited from class com.goldencode.p2j.ui.client.MenuItem

config

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

insets, listeners, location, LOG, mousePtr, nativeInsets, physicalLocation

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
private void	addMouseClickListener(java.awt.event.MouseAdapter listener) Adds custom mouse click listener for this item
static MenuItemGuiImpl	createDynamicItem(java.lang.String title, boolean enabled, java.awt.event.MouseAdapter evt) Create a dynamic item with the specified title and mouse actions for system pop-up menus.
(package private) static MenuItemGuiImpl	createDynamicItem(java.lang.String title, java.awt.event.MouseAdapter evt) Create a dynamic item with the specified title and mouse actions for system pop-up menus.
static MenuItemGuiImpl	createDynamicRule() Create a dynamic RULE item.
protected MnemonicInfo	createLabelInfo() Creates new MnemonicInfo instance
Dimension	dimension() Get widget dimension.
void	draw() Draw widget.
boolean	focusTraversable() Check if widget is focus traversable.
double	height() Get widget height.
void	initialize(WidgetId id, MenuItemConfig 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.
void	invalidateCachedSize() Invalidate the cached size of this item.
boolean	isLegacyFocus() Returns a flag marking the widget as subject to legacy focus handling.
boolean	manageSystemActions() Check if the current widget can manage non-global system actions on its own, and not via the enclosing event loop.
Dimension	minimumSize() Get widget minimum size.
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	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.
boolean	navigable() Returns true only if this widget is navigable.
void	onFocusGained(FocusEvent event) This method is invoked when focus is gained.
void	onFocusLost(FocusEvent event) This method is invoked when focus is lost.
protected Point	prepParentLocation(Widget<?> parent) Trick, that lets to correct parent location in cases, when it needed, for example for menus.
void	processKeyEvent(KeyInput event) Process key event.
protected void	selectMenuItem() Process an event which trigger selection of this menu-item, depending if the item is a toggle-box or not.
java.lang.String	toString() Returns a string representation of the object.
double	width() Get widget width.

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

afterConfigUpdate, config, forceCursorOnFocus, getPreparedLabel, getPreparedTitle, isEnabled, isInitDisabled, isNormal, isRule, isSkip, setTitle

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, 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, isFocusable, isHeader, isMouseDrag, isRealized, isRepaintDisabled, isRMBEntrySupported, isScreenLocationCached, isTabStop, isThreeD, isTotallyObscured, isVisible, isVisible, location, mouseDragged, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved, moveToBottom, moveToTop, name, oleDoDrop, oleDrag, oleDragging, oleStartDragging, onOleDragging, onOleDropEnd, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalBounds, physicalDimension, physicalLocation, postprocessConfig, 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, 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.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, defaultMousePtr, destroy, displayPhysicalLocation, drawCaret, enclosingFrame, enforceDefaultMousePtr, findMouseSource, 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, isFocusable, isHeader, isInitialValueLayout, isProcessProgressEvent, isRealized, isRepaintDisabled, isRMBEntrySupported, isTabStop, isThreeD, isTotallyObscured, isVisible, isVisible, location, maySwitchFocus, moveToBottom, moveToTop, name, 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

mousePressed, mouseReleased

Methods inherited from interface java.awt.event.MouseMotionListener

mouseDragged, mouseMoved

Methods inherited from interface java.awt.event.MouseWheelListener

mouseWheelMoved

Field Detail

gf

private GuiFontResolver gf

Font resolver

gd

private GuiDriver gd

Screen driver

mouseListeners

private java.util.Map<java.lang.Integer,java.util.Set<java.awt.event.MouseAdapter>> mouseListeners

TODO: move that to future subclass, intended specially for system pop-ups. Set of custom mouse listeners by mouse event types like MouseEvent.MOUSE_CLICKED. This mouse listeners are custom actions (like triggers) but for non-standard cases such as system pop-up menus: editor pop-ups, scroll pop-ups and window title pop-ups.

For example, such listener can call clipboard operation when corresponding menu-item was selected.

cachedWidth

private double cachedWidth

Cached width of this item. If 0 or negative, value is invalidated and need re-computed.

cachedHeight

private double cachedHeight

Cached height of this item. If 0 or negative, value is invalidated and need re-computed.

Constructor Detail

MenuItemGuiImpl

public MenuItemGuiImpl(WidgetId id,
                       MenuItemConfig cfg)

Special constructor used to restore component using given configuration.

Parameters:

id - The widget's ID.

cfg - Configuration data.

Method Detail

createDynamicItem

static MenuItemGuiImpl createDynamicItem(java.lang.String title,
                                         java.awt.event.MouseAdapter evt)

Create a dynamic item with the specified title and mouse actions for system pop-up menus. Such menus are used for WindowTitleBar; Scrollbar; default popup for FillIn, Editor.

Parameters:

title - The title of the popup item in the window's system popup menu.

evt - The event processing.

Returns:

A MenuItemGuiImpl.

createDynamicItem

public static MenuItemGuiImpl createDynamicItem(java.lang.String title,
                                                boolean enabled,
                                                java.awt.event.MouseAdapter evt)

Create a dynamic item with the specified title and mouse actions for system pop-up menus. Such menus are used for WindowTitleBar; Scrollbar; default popup for FillIn, Editor.

Parameters:

title - The title of the popup item in the window's system popup menu.

enabled - Flag indicating if the item is enabled or not.

evt - The event processing.

Returns:

A MenuItemGuiImpl.

createDynamicRule

public static MenuItemGuiImpl createDynamicRule()

Create a dynamic RULE item. Such menus are used for WindowTitleBar; Scrollbar; default popup for FillIn, Editor.

Returns:

A MenuItemGuiImpl.

initialize

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

Overrides:

initialize in class MenuItem<GuiOutputManager>

Parameters:

id - The widget's ID.

cfg - The config used to initialize this widget.

mouseActions

protected int[] mouseActions()

Determine the mouse actions processed by this widget.

Overrides:

mouseActions in class AbstractWidget<GuiOutputManager>

Returns:

See above.

dimension

public Dimension dimension()

Get widget dimension.

Specified by:

dimension in interface Widget<GuiOutputManager>

Specified by:

dimension in class AbstractWidget<GuiOutputManager>

Returns:

widget dimension.

navigable

public boolean navigable()

Returns true only if this widget is navigable.

Specified by:

navigable in interface Widget<GuiOutputManager>

Overrides:

navigable in class AbstractWidget<GuiOutputManager>

Returns:

true if widget is navigable.

focusTraversable

public boolean focusTraversable()

Check if widget is focus traversable. SKIP and RULE aren't traversable.

Specified by:

focusTraversable in interface Widget<GuiOutputManager>

Overrides:

focusTraversable in class AbstractWidget<GuiOutputManager>

Returns:

true if widget is focus traversable.

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.

draw

public void draw()

Draw widget.

Specified by:

draw in interface Widget<GuiOutputManager>

Specified by:

draw in class AbstractWidget<GuiOutputManager>

invalidateCachedSize

public void invalidateCachedSize()

Invalidate the cached size of this item. This way, the next time the height/width is requested it is automatically re calculated using new environment.

height

public double height()

Get widget height.

Specified by:

height in interface Widget<GuiOutputManager>

Specified by:

height in class AbstractWidget<GuiOutputManager>

Returns:

widget height.

width

public double width()

Get widget width. There are two cases:

• if this is a menu bar element, only the width of the text is taken into consideration (adjusted with padding and theme minimum width);
• Otherwise the item is part of a vertical menu/popup so all siblings in the parent menu are measured. In this case space is reserved, including checkmark/icon, accelerators and right arrow for submenus.

Specified by:

width in interface Widget<GuiOutputManager>

Specified by:

width in class AbstractWidget<GuiOutputManager>

Returns:

widget width.

manageSystemActions

public boolean manageSystemActions()

Check if the current widget can manage non-global system actions on its own, and not via the enclosing event loop.

Overrides:

manageSystemActions in class AbstractWidget<GuiOutputManager>

Returns:

Always true.

minimumSize

public Dimension minimumSize()

Get widget minimum size.

Specified by:

minimumSize in interface Widget<GuiOutputManager>

Specified by:

minimumSize in class AbstractWidget<GuiOutputManager>

Returns:

widget minimum size.

processKeyEvent

public void processKeyEvent(KeyInput event)

Process key event.

Specified by:

processKeyEvent in interface Widget<GuiOutputManager>

Overrides:

processKeyEvent in class MenuItem<GuiOutputManager>

Parameters:

event - Key event to process.

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.

mouseEntered

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

Notification of a mouse entered event occurred for this widget.

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)

Notification of a mouse exited event occurred for this widget.

Specified by:

mouseExited in interface java.awt.event.MouseListener

Overrides:

mouseExited in class AbstractWidget<GuiOutputManager>

Parameters:

e - The mouse event.

onFocusGained

public void onFocusGained(FocusEvent event)

This method is invoked when focus is gained.

Specified by:

onFocusGained in interface FocusListener

Parameters:

event - Event which triggered this call.

onFocusLost

public void onFocusLost(FocusEvent event)

This method is invoked when focus is lost. If current focus is on in subtree of this sub-menu, than hide body.

Specified by:

onFocusLost in interface FocusListener

Parameters:

event - Event which triggered this call.

toString

public java.lang.String toString()

Returns a string representation of the object.

Overrides:

toString in class AbstractWidget<GuiOutputManager>

Returns:

A string representation of the object.

selectMenuItem

protected void selectMenuItem()

Process an event which trigger selection of this menu-item, depending if the item is a toggle-box or not.

Overrides:

selectMenuItem in class MenuItem<GuiOutputManager>

createLabelInfo

protected MnemonicInfo createLabelInfo()

Creates new MnemonicInfo instance

Overrides:

createLabelInfo in class MenuItem<GuiOutputManager>

Returns:

MnemonicInfo or its descendant.

prepParentLocation

protected Point prepParentLocation(Widget<?> parent)

Trick, that lets to correct parent location in cases, when it needed, for example for menus.

Overrides:

prepParentLocation in class AbstractWidget<GuiOutputManager>

Parameters:

parent - Parent component - must be a sub-menu.

Returns:

corrected parent location.

addMouseClickListener

private void addMouseClickListener(java.awt.event.MouseAdapter listener)

Adds custom mouse click listener for this item

Parameters:

listener - MouseAdapter instance.