com.goldencode.p2j.ui.client

Class SubMenu<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.SubMenu<O>

All Implemented Interfaces:

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

Direct Known Subclasses:

SubMenuChuiImpl, SubMenuGuiImpl

public abstract class SubMenu<O extends OutputManager<?>>
extends AbstractContainer<O>
implements WidgetWithConfig<SubMenuConfig>, MenuElement<O>

SubMenu client abstract implementation class.

Field Summary

Fields

Modifier and Type	Field and Description
protected SubMenuConfig	config Menu attribute container.
private MnemonicInfo	label Label with mnemonic info
protected boolean	showBody Flag indicating if the body must be displayed.

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

listeners, location, mousePtr, nativeInsets, physicalLocation

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	afterConfigUpdate(SubMenuConfig beforeUpdate) The method is called after the configuration associated with the implementor changes.
TitledWindow<O>	ancestor() Get ancestor window for this widget.This method must be called only for widgets that are already attached to Window.
protected abstract Dimension	bodyDimension() Calculates body dimension
protected abstract Point	bodyLocation() Get location of SUB-MENU body, relative to container.
SubMenuConfig	config() Provide access to the attributes stored in the widget.
protected MnemonicInfo	createLabelInfo() Creates new MnemonicInfo instance.
Widget<O>	currentFocus(boolean recurse) Get widget which is in focus.
Widget<O>	defaultFocus() Get default focusable widget.
boolean	focusTraversable() Check if widget is focus traversable.
protected void	focusWorker(boolean direction) Search for the next or previous focusable widget in the container and set focus on it.
boolean	forceCursorOnFocus() Check if widget needs in cursor to be on when having the input focus.
protected Widget<O>	getFirstFocusableItem() Returns the first focusable child.
protected Widget<?>	getFocusedChild() Get first focused sub-menu child (menu-iter or other sub-menu)
protected Widget<O>	getLastFocusableItem() Returns the last focusable child.
MnemonicInfo	getPreparedLabel() Get MENU-ITEM prepared label.
java.lang.String	getPreparedTitle() Get MENU-ITEM prepared label.
static boolean	hasChildSubmenu(Container<?> menu) Check if specified MENU/SUB-MENU contains SUB-MENU child.
void	hideBody(boolean recursiveUp) Hides sub-menu body.
void	initialize(WidgetId id, SubMenuConfig 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	isEnabled() Check if this sub-menu is enabled.
boolean	isShowBody() Get the state of the showBody flag.
boolean	manageSystemActions() Check if the current widget can manage non-global system actions on its own, and not via the enclosing event loop.
protected abstract void	menuDropEvents(boolean fromMnemonic) Raise the MENU-DROP 4GL events.
void	processKeyEvent(KeyInput event) Process key event.
static boolean	processMnemonicEvent(AbstractContainer<?> menu, KeyInput event) Check menu items (first-level) for specified mnemonic.
void	repaint() Request widget repainting.
void	requestFocus() Request focus.
protected void	setInitialFocus() Sets initial focus on first traversable child.
void	setVisible(boolean visible) Hide/show widget.
protected void	showBody() Shows this sub-menu body.
abstract double	titleWidth() Gets sub-menu title width (with '->' if sub-menu is in other sub-menu or in popup menu)

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, dimension, doLayout, draw, dumpCurrentWidgets, dumpWidgets, endSizeChange, findMouseSource, firstFocus, focus, formatDump, get, getAllSelectedWidgets, getClipRect, getEffectiveScrollableSize, getFocusInt, getIgnoreFocus, getLayout, getScrollableSize, getTabItemList, 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, 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, ancestorId, autoResize, bounds, clear, clearWidget, clipRectangle, clipRectangle, clipWith, copyColors, createMouseHoverAction, deactivateDirectManipulation, debug, disable, disableTooltip, displayPhysicalLocation, drawCaret, enable, enableTooltip, enclosingFrame, 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, isFocusable, isHeader, isMouseDrag, isRealized, isRepaintDisabled, isRMBEntrySupported, isScreenLocationCached, isTabStop, isThreeD, isTotallyObscured, isVisible, isVisible, location, 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.MenuStructure

getParentMenu, getParentMenuContainer, getParentSubMenu, getParentSubMenuBody, getRootSubMenu

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

acceptsEscAsAnyKey, acceptTrigger, addFocusListener, addKeyListener, ancestorId, bounds, canMovetoTop, clearWidget, completeTrigger, defaultMousePtr, destroy, dimension, displayPhysicalLocation, draw, drawCaret, enclosingFrame, enforceDefaultMousePtr, findMouseSource, forceVisibility, getActualBounds, getCustomMousePointer, getEffectiveMousePointer, getId, getIdForTrigger, getLegacyWidget, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getSelectedText, getState, getTriggerWidget, getTriggerWidget, getVisiblePart, getZOrderClass, hasFocus, hasFocus, hasTooltip, height, hidden, hide, highlighted, ignoreEnable, initialHeight, initialWidth, insets, isCurrent, isCurrent, isDirectManipulable, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDisplayed, isDroppable, isFocusable, isHeader, isInitialValueLayout, isLegacyFocus, 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, 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, width, 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

config

protected SubMenuConfig config

Menu attribute container.

showBody

protected boolean showBody

Flag indicating if the body must be displayed.

label

private MnemonicInfo label

Label with mnemonic info

Constructor Detail

SubMenu

public SubMenu(WidgetId id,
               SubMenuConfig cfg)

Special constructor used to restore component using given configuration.

Parameters:

id - The widget's ID.

cfg - Configuration data.

Method Detail

processMnemonicEvent

public static boolean processMnemonicEvent(AbstractContainer<?> menu,
                                           KeyInput event)

Check menu items (first-level) for specified mnemonic. If menu item with such mnemonic found, than post ItemEvent.

Parameters:

menu - MENU or SUB-MENU

event - Key event with event.keyChar() != KeyInput.CHAR_UNDEFINED

Returns:

true if corresponding menu item found, otherwise - false

Throws:

java.lang.IllegalArgumentException - If event is generated by other source than character pressing.

hasChildSubmenu

public static boolean hasChildSubmenu(Container<?> menu)

Check if specified MENU/SUB-MENU contains SUB-MENU child.

Parameters:

menu - MENU/SUB-MENU container.

Returns:

true if specified container contains SUB-MENU child.

titleWidth

public abstract double titleWidth()

Gets sub-menu title width (with '->' if sub-menu is in other sub-menu or in popup menu)

Returns:

width of sub-menu title

bodyLocation

protected abstract Point bodyLocation()

Get location of SUB-MENU body, relative to container.

Returns:

body location.

bodyDimension

protected abstract Dimension bodyDimension()

Calculates body dimension

Returns:

Dimension

menuDropEvents

protected abstract void menuDropEvents(boolean fromMnemonic)

Raise the MENU-DROP 4GL events.

Parameters:

fromMnemonic - Flag which indicates that the generated menu drop event is caused my a key event (mnemonic). This is used by the event processor to detect if the first element of the menu should be focused or not.

initialize

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

Parameters:

id - The widget's ID.

cfg - The config used to initialize this widget.

config

public SubMenuConfig 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<SubMenuConfig>

Overrides:

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

Returns:

Reference to attribute container.

afterConfigUpdate

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

Parameters:

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

ancestor

public TitledWindow<O> ancestor()

Get ancestor window for this widget.This method must be called only for widgets that are already attached to Window.

Specified by:

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

Overrides:

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

Returns:

ancestor Window.

getPreparedLabel

public MnemonicInfo getPreparedLabel()

Get MENU-ITEM prepared label.

Specified by:

getPreparedLabel in interface MenuElement<O extends OutputManager<?>>

Returns:

Label.

getPreparedTitle

public java.lang.String getPreparedTitle()

Get MENU-ITEM prepared label.

Specified by:

getPreparedTitle in interface MenuElement<O extends OutputManager<?>>

Returns:

Label.

hideBody

public void hideBody(boolean recursiveUp)

Hides sub-menu body.

Parameters:

recursiveUp - true means hide body for all parent sub-menus.

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.

repaint

public void repaint()

Request widget repainting.

Specified by:

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

Overrides:

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

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.

forceCursorOnFocus

public boolean forceCursorOnFocus()

Check if widget needs in cursor to be on when having the input focus. By default this method always returns true so it needs to be overwritten if other return value is required for particular widget implementation class.

Specified by:

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

Overrides:

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

Returns:

true as the default value.

defaultFocus

public Widget<O> defaultFocus()

Get default focusable widget.

Specified by:

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

Overrides:

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

Returns:

default focusable widget.

focusTraversable

public boolean focusTraversable()

Check if widget is focus traversable.

Specified by:

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

Overrides:

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

Returns:

true if widget is focus traversable.

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<O extends OutputManager<?>>

Returns:

true as the widget has its own event management.

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). The override allows the submenu widget to become focused even without any of the child widgets in focus. This allows the widget to process key events.

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.

requestFocus

public void requestFocus()

Request focus. The override allows the submenu widget to become focused even without any of the child widgets in focus. This allows the widget to process key events.

Specified by:

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

isEnabled

public boolean isEnabled()

Check if this sub-menu is enabled.

Specified by:

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

Overrides:

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

Returns:

true if widget is enabled.

isShowBody

public boolean isShowBody()

Get the state of the showBody flag.

Returns:

See above.

createLabelInfo

protected MnemonicInfo createLabelInfo()

Creates new MnemonicInfo instance.

Returns:

MnemonicInfo or its descendant.

getFocusedChild

protected Widget<?> getFocusedChild()

Get first focused sub-menu child (menu-iter or other sub-menu)

Returns:

MenuItem or SubMenu

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.

showBody

protected void showBody()

Shows this sub-menu body.

setInitialFocus

protected void setInitialFocus()

Sets initial focus on first traversable child.

getFirstFocusableItem

protected Widget<O> getFirstFocusableItem()

Returns the first focusable child.

Returns:

focusable child.

getLastFocusableItem

protected Widget<O> getLastFocusableItem()

Returns the last focusable child.

Returns:

focusable child.