javax.rad.genui.menu
Class UIMenu

java.lang.Object
  javax.rad.genui.UIResource<C>
      javax.rad.genui.UIComponent<C>
          javax.rad.genui.component.AbstractUIActionComponent<C>
              javax.rad.genui.menu.AbstractUIMenuItem<IMenu>
                  javax.rad.genui.menu.UIMenu

All Implemented Interfaces:

ITranslatable, IActionComponent, IIcon, ILabel, IAlignmentConstants, IComponent, IContainer, IResource, IMenu, IMenuItem, INamedObject, ITranslator

public class UIMenu
extends AbstractUIMenuItem<IMenu>
implements IMenu

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

Field Summary

protected java.util.List<IComponent>

components List of subcomponents.

Fields inherited from class javax.rad.genui.UIComponent

bTranslate, lLastTranslationModified, parent, popupMenu

Fields inherited from class javax.rad.genui.UIResource

uiResource

Fields inherited from interface javax.rad.ui.IAlignmentConstants

ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_DEFAULT, ALIGN_LEFT, ALIGN_RIGHT, ALIGN_STRETCH, ALIGN_TOP

Constructor Summary

	UIMenu() Creates a new instance of UIMenu.
protected	UIMenu(IMenu pMenu) Creates a new instance of UIMenu with the given menu instance.
	UIMenu(java.lang.String pText) Creates a new instance of UIMenu.
	UIMenu(java.lang.String pText, IComponent... pMenuItems) Creates a new instance of UIMenu.

Method Summary

void	add(IComponent pComponent) Adds the specified IComponent to the end of this container.
void	add(IComponent pComponent, int pIndex) Adds the specified IComponent to this container at the specified index.
void	add(IComponent pComponent, java.lang.Object pConstraints) Adds the specified IComponent to the end of this container.
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	addIntern(IComponent pComponent, java.lang.Object pConstraints, int pIndex) Internal function, for adding physical component and supporting layers.
void	addNotify() Makes this UIComponent displayable by adding it to an UIContainer.
void	addSeparator() Appends a new separator at the end of the menu.
void	addSeparator(int pIndex) Inserts a separator at the specified position.
void	beforeAddNotify(IComponent pParent) Invoked before this component is added.
IComponent	getComponent(int pIndex) Gets the nth IComponent in this container.
int	getComponentCount() Gets the number of IComponents in this panel.
ILayout	getLayout() Gets the layout manager for this container.
int	indexOf(IComponent pComponent) Gets the nth position of an IComponent in this container.
void	remove(IComponent pComponent) Removes the specified component from this container.
void	remove(int pIndex) Removes the IComponent, specified by index, from this container.
void	removeAll() Removes all the components from this container.
void	removeNotify() Makes this UIComponent undisplayable by removing it to an UIContainer.
void	setLayout(ILayout pLayout) Sets the layout manager for this container.
void	updateTranslation() Notification for updating the translation.

Methods inherited from class javax.rad.genui.menu.AbstractUIMenuItem

findMenu, getMenu

Methods inherited from class javax.rad.genui.component.AbstractUIActionComponent

eventAction, getAccelerator, getActionCommand, getHorizontalAlignment, getImage, getMargins, getText, getVerticalAlignment, isPreserveAspectRatio, setAccelerator, setActionCommand, setHorizontalAlignment, setImage, setMargins, setMargins, setPreserveAspectRatio, setText, setVerticalAlignment

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.component.IActionComponent

eventAction, getAccelerator, getActionCommand, getMargins, setAccelerator, setActionCommand, setMargins

Methods inherited from interface javax.rad.ui.component.IIcon

getImage, isPreserveAspectRatio, setImage, setPreserveAspectRatio

Methods inherited from interface javax.rad.ui.component.ILabel

getText, setText

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

Methods inherited from interface javax.rad.ui.IAlignmentConstants

getHorizontalAlignment, getVerticalAlignment, setHorizontalAlignment, setVerticalAlignment

Field Detail

components

protected java.util.List<IComponent> components

List of subcomponents.

Constructor Detail

UIMenu

public UIMenu()

Creates a new instance of UIMenu.

See Also:

IMenu

UIMenu

protected UIMenu(IMenu pMenu)

Creates a new instance of UIMenu with the given menu instance.

Parameters:

pMenu - the menu

See Also:

IMenu

UIMenu

public UIMenu(java.lang.String pText)

Creates a new instance of UIMenu.

Parameters:

pText - the text

See Also:

IMenu

UIMenu

public UIMenu(java.lang.String pText,
              IComponent... pMenuItems)

Creates a new instance of UIMenu.

Parameters:

pText - the text.

pMenuItems - the menu items.

See Also:

add(IComponent), AbstractUIActionComponent.setText(String)

Method Detail

getLayout

public ILayout getLayout()

Gets the layout manager for this container.

Specified by:

getLayout in interface IContainer

Returns:

the ILayout

See Also:

ILayout, IContainer.setLayout(javax.rad.ui.ILayout)

setLayout

public void setLayout(ILayout pLayout)

Sets the layout manager for this container.

Specified by:

setLayout in interface IContainer

Parameters:

pLayout - the specified layout manager

See Also:

ILayout, IContainer.getLayout()

addSeparator

public void addSeparator()

Appends a new separator at the end of the menu.

Specified by:

addSeparator in interface IMenu

addSeparator

public void addSeparator(int pIndex)

Inserts a separator at the specified position.

Specified by:

addSeparator in interface IMenu

Parameters:

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

add

public void add(IComponent pComponent)

Adds the specified IComponent to the end of this container.

Specified by:

add in interface IContainer

Parameters:

pComponent - the IComponent to be added

See Also:

IComponent

add

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

Adds the specified IComponent to the end of this container. Also notifies the layout manager to add the component to this container's layout using the specified constraints object.

Specified by:

add in interface IContainer

Parameters:

pComponent - the IComponent to be added

pConstraints - an object expressing layout contraints for this component

See Also:

IComponent

add

public void add(IComponent pComponent,
                int pIndex)

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

Specified by:

add in interface IContainer

Parameters:

pComponent - the IComponent to be added

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

See Also:

IComponent

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

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

remove

public void remove(int pIndex)

Removes the IComponent, specified by index, from this container. This method also notifies the layout manager to remove the component from this container's layout via the removeLayoutComponent method.

Specified by:

remove in interface IContainer

Parameters:

pIndex - the index of the IComponent to be removed

See Also:

IContainer.add(javax.rad.ui.IComponent), IContainer.getComponentCount()

remove

public void remove(IComponent pComponent)

Removes the specified component from this container.

Specified by:

remove in interface IContainer

Parameters:

pComponent - the IComponent to be removed

See Also:

IContainer.add(javax.rad.ui.IComponent), IContainer.remove(int)

removeAll

public void removeAll()

Removes all the components from this container. This method also notifies the layout manager to remove the components from this container's layout via the removeLayoutComponent method.

Specified by:

removeAll in interface IContainer

See Also:

IContainer.add(javax.rad.ui.IComponent), IContainer.remove(int)

getComponentCount

public int getComponentCount()

Gets the number of IComponents in this panel.

Specified by:

getComponentCount in interface IContainer

Returns:

the number of components in this panel.

See Also:

IContainer.getComponent(int)

getComponent

public IComponent getComponent(int pIndex)

Gets the n^th IComponent in this container.

Specified by:

getComponent in interface IContainer

Parameters:

pIndex - the index of the IComponent to get.

Returns:

the n^th component in this container.

indexOf

public int indexOf(IComponent pComponent)

Gets the n^th position of an IComponent in this container.

Specified by:

indexOf in interface IContainer

Parameters:

pComponent - the IComponent to search

Returns:

the n^th position of pComponent in this container or -1 if pComponent is not added

updateTranslation

public void updateTranslation()

Notification for updating the translation. This method will be called when the UIComponent will be added to a displayable containment hierarchy, when its containment hierarchy is made displayable or the translation table will be changed.

Overrides:

updateTranslation in class AbstractUIActionComponent<IMenu>

See Also:

UIComponent.setTranslation(TranslationMap), UIComponent.addNotify()

beforeAddNotify

public void beforeAddNotify(IComponent pParent)

Invoked before this component is added.

Overrides:

beforeAddNotify in class UIComponent<IMenu>

Parameters:

pParent - the parent

addNotify

public void addNotify()

Makes this UIComponent displayable by adding it to an UIContainer. This method is called internally by the genui and should not be called directly.

Overrides:

addNotify in class UIComponent<IMenu>

See Also:

UIComponent.removeNotify(), UIComponent.isNotified()

removeNotify

public void removeNotify()

Makes this UIComponent undisplayable by removing it to an UIContainer.

This method is called by the genui internally and should not be called directly. Code overriding this method should call super.removeNotify as the first line of the overriding method.

Overrides:

removeNotify in class UIComponent<IMenu>

See Also:

UIComponent.addNotify(), UIComponent.isNotified()

addIntern

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

Internal function, for adding physical component and supporting layers.

Parameters:

pComponent - the Component to be added

pConstraints - an object expressing layout contraints for this

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

See Also:

add(IComponent, Object, int)