javax.rad.genui.menu
Class UIPopupMenu

java.lang.Object
  javax.rad.genui.UIResource<C>
      javax.rad.genui.UIComponent<C>
          javax.rad.genui.UIContainer<IPopupMenu>
              javax.rad.genui.menu.UIPopupMenu

All Implemented Interfaces:

ITranslatable, IComponent, IContainer, IResource, IPopupMenu, INamedObject, ITranslator

public class UIPopupMenu
extends UIContainer<IPopupMenu>
implements IPopupMenu

Platform and technology independent popup menu. It is designed for use with AWT, Swing, SWT, JSP, JSF, ... .

Field Summary

Fields inherited from class javax.rad.genui.UIContainer

allComponents, components

Fields inherited from class javax.rad.genui.UIComponent

bTranslate, lLastTranslationModified, parent, popupMenu

Fields inherited from class javax.rad.genui.UIResource

uiResource

Constructor Summary

	UIPopupMenu() Creates a new instance of UIPopupMenu.
	UIPopupMenu(IComponent... pMenuItems) Creates a new instance of UIPopupMenu.
protected	UIPopupMenu(IPopupMenu pMenu) Creates a new instance of UIPopupMenu with the given popup menu.

Method Summary

void	add(IComponent pComponent, java.lang.Object pConstraints, int pIndex) Adds the specified IComponent to this container with the specified constraints at the specified index.
void	addSeparator() Appends a new separator at the end of the menu.
void	addSeparator(int pIndex) Inserts a separator at the specified position.
PopupMenuHandler<IPopupMenuCanceledListener>	eventPopupMenuCanceled() The PopupMenuHandler for the popup menu canceled event.
PopupMenuHandler<IPopupMenuWillBecomeInvisibleListener>	eventPopupMenuWillBecomeInvisible() The PopupMenuHandler for the popup menu will become invisible event.
PopupMenuHandler<IPopupMenuWillBecomeVisibleListener>	eventPopupMenuWillBecomeVisible() The PopupMenuHandler for the popup menu will become visible event.
void	show(IComponent pOrigin, int pX, int pY) Shows the popup menu at the x, y position relative to an origin component.

Methods inherited from class javax.rad.genui.UIContainer

add, add, add, addInternal, addNotify, beforeAddNotify, checkAdd, contains, getComponent, getComponentCount, getComponents, getInsets, getLayout, getUIResourceContainer, indexOf, remove, remove, removeAll, removeInternal, removeNotify, setLayout, setUIResourceContainer, setZOrder, updateTranslation

Methods inherited from class javax.rad.genui.UIComponent

capture, createComponentName, createComponentNamePrefix, debug, doEventKey, doTriggerPopMenu, equals, error, eventComponentMoved, eventComponentResized, eventFocusGained, eventFocusLost, eventKey, eventKeyPressed, eventKeyReleased, eventKeyTyped, eventMouseClicked, eventMouseEntered, eventMouseExited, eventMousePressed, eventMouseReleased, getBackground, getBounds, getComponentUIResource, getCurrentTranslation, getCursor, getDefaultName, getEventSource, getExistingNames, getFactory, getFont, getForeground, getLocation, getLocationOffset, getLocationRelativeTo, getMaximumSize, getMinimumSize, getName, getParent, getPopupMenu, getPreferredSize, getResource, getRootName, getSize, getStyle, getTabIndex, getToolTipText, getTranslation, getUIComponent, hashCode, incrementNameIfExists, info, invokeAndWait, invokeAndWait, invokeInThread, invokeInThread, invokeLater, invokeLater, isBackgroundSet, isBeforeNotified, isCursorSet, isEnabled, isFocusable, isFontSet, isForegroundSet, isMaximumSizeSet, isMinimumSizeSet, isNotified, isPreferredSizeSet, isTranslationChanged, isTranslationEnabled, isVisible, requestFocus, setBackground, setBounds, setBounds, setCursor, setDefaultName, setEnabled, setEventSource, setFocusable, setFont, setForeground, setLocation, setLocation, setLocationRelativeTo, setMaximumSize, setMaximumSize, setMinimumSize, setMinimumSize, setName, setParent, setPopupMenu, setPreferredSize, setPreferredSize, setRootName, setSize, setSize, setStyle, setTabIndex, setToolTipText, setTranslation, setTranslationEnabled, setUIComponent, setVisible, translate

Methods inherited from class javax.rad.genui.UIResource

eventResourceChanged, eventResourceChanged, fireResourceChanged, getObject, getObjectNames, getUIResource, hasResourceHandler, putObject, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.rad.ui.IContainer

add, add, add, getComponent, getComponentCount, getLayout, indexOf, remove, remove, removeAll, setLayout

Methods inherited from interface javax.rad.ui.IComponent

capture, eventComponentMoved, eventComponentResized, eventFocusGained, eventFocusLost, eventKeyPressed, eventKeyReleased, eventKeyTyped, eventMouseClicked, eventMouseEntered, eventMouseExited, eventMousePressed, eventMouseReleased, getBackground, getBounds, getCursor, getEventSource, getFactory, getFont, getForeground, getLocation, getLocationRelativeTo, getMaximumSize, getMinimumSize, getName, getParent, getPreferredSize, getSize, getStyle, getTabIndex, getToolTipText, isBackgroundSet, isCursorSet, isEnabled, isFocusable, isFontSet, isForegroundSet, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isVisible, requestFocus, setBackground, setBounds, setCursor, setEnabled, setEventSource, setFocusable, setFont, setForeground, setLocation, setLocationRelativeTo, setMaximumSize, setMinimumSize, setName, setParent, setPreferredSize, setSize, setStyle, setTabIndex, setToolTipText, setVisible

Methods inherited from interface javax.rad.ui.IResource

getResource

Constructor Detail

UIPopupMenu

public UIPopupMenu()

Creates a new instance of UIPopupMenu.

See Also:

IPopupMenu

UIPopupMenu

protected UIPopupMenu(IPopupMenu pMenu)

Creates a new instance of UIPopupMenu with the given popup menu.

Parameters:

pMenu - the popup menu

See Also:

IPopupMenu

UIPopupMenu

public UIPopupMenu(IComponent... pMenuItems)

Creates a new instance of UIPopupMenu.

Parameters:

pMenuItems - the menu items.

See Also:

UIContainer.add(IComponent)

Method Detail

addSeparator

public void addSeparator()

Appends a new separator at the end of the menu.

Specified by:

addSeparator in interface IPopupMenu

addSeparator

public void addSeparator(int pIndex)

Inserts a separator at the specified position.

Specified by:

addSeparator in interface IPopupMenu

Parameters:

pIndex - an integer specifying the position at which to insert the menu separator

show

public void show(IComponent pOrigin,
                 int pX,
                 int pY)

Shows the popup menu at the x, y position relative to an origin component. The origin component must be contained within the component hierarchy of the popup menu's parent. Both the origin and the parent must be showing on the screen for this method to be valid.

If this PopupMenu is being used as a Menu (i.e., it has a non-Component parent), then you cannot call this method on the PopupMenu.

Specified by:

show in interface IPopupMenu

Parameters:

pOrigin - the component which defines the coordinate space

pX - the x coordinate position to popup the menu

pY - the y coordinate position to popup the menu

eventPopupMenuWillBecomeVisible

public PopupMenuHandler<IPopupMenuWillBecomeVisibleListener> eventPopupMenuWillBecomeVisible()

The PopupMenuHandler for the popup menu will become visible event.

Specified by:

eventPopupMenuWillBecomeVisible in interface IPopupMenu

Returns:

the PopupMenuHandler for the focus gained event.

eventPopupMenuWillBecomeInvisible

public PopupMenuHandler<IPopupMenuWillBecomeInvisibleListener> eventPopupMenuWillBecomeInvisible()

The PopupMenuHandler for the popup menu will become invisible event.

Specified by:

eventPopupMenuWillBecomeInvisible in interface IPopupMenu

Returns:

the PopupMenuHandler for the popup menu will become invisible event.

eventPopupMenuCanceled

public PopupMenuHandler<IPopupMenuCanceledListener> eventPopupMenuCanceled()

The PopupMenuHandler for the popup menu canceled event.

Specified by:

eventPopupMenuCanceled in interface IPopupMenu

Returns:

the PopupMenuHandler for the popup menu canceled event.

add

public void add(IComponent pComponent,
                java.lang.Object pConstraints,
                int pIndex)

Adds the specified IComponent to this container with the specified constraints at the specified index. Also notifies the layout manager to add the component to the this container's layout using the specified constraints object.

Specified by:

add in interface IContainer

Overrides:

add in class UIContainer<IPopupMenu>

Parameters:

pComponent - the IComponent to be added

pConstraints - an object expressing layout contraints for this

pIndex - the position in the container's list at which to insert the IComponent; -1 means insert at the end component

See Also:

IComponent