fr.cnes.genius.highLevel

Class GMenu

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.highLevel.GMenu

All Implemented Interfaces:

MouseWheelListener, EventListener

public class GMenu
extends GComponent

Class defining the menus to be used into the menu bars.

Author:

J. Fourcade

Nested Class Summary

Nested classes/interfaces inherited from class fr.cnes.genius.main.GComponent

GComponent.CopyPasteOperation, GComponent.DisplayIndicatorStatus, GComponent.ItemType, GComponent.Operation

Field Summary

Fields inherited from class fr.cnes.genius.main.GComponent

NAME_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
GMenu(JMenu menu) Constructor.
GMenu(String name) Constructor.
GMenu(String widgetId, JMenu menu) Constructor.
GMenu(String widgetId, String name) Constructor.

Method Summary

Modifier and Type	Method and Description
void	add(GMenu submenu) Adds a menu to the menu, creating an hierachical menu.
void	add(GMenu submenu, int idx) Adds a submenu to the menu, at the index selected.
void	add(GMenuItem menuItem) Adds a menu item to the menu.
void	add(GMenuItem menuItem, int idx) Adds a menu to the menu, at the index selected.
void	add(JMenu submenu, int idx) Adds a submenu to the menu, at the index selected.
void	add(JMenuItem menuItem, int idx) Adds a menu to the menu, at the index selected.
void	delete(GMenu submenu) Deletes a submenu from the menu.
void	delete(GMenuItem menuItem) Deletes a menu from the menu.
void	delete(JMenuItem menuItem) Deletes a menu from the menu.
void	delete(String menuItem) Deletes a menu from the menu.
Component	getComponent() Returns the low level Swing Component encapsulated by the class if any, otherwise returns null.
GMenuItem	getGMenuItem(String menuItem) Getter for a menu item
JMenu	getJMenu() Get the JMenu object associated with the widget.
boolean	isEnabled() Gets the enable status of the widget.
void	move(GMenu submenu, int idx) Moves a menu to the indicated index
void	move(GMenuItem menuItem, int idx) Moves a menu to the indicated index
void	move(JMenu submenu, int idx) Moves a menu to the indicated index
void	move(JMenuItem menuItem, int idx) Moves a menu to the indicated index
void	move(String menuItem, int idx) Moves a menu to the indicated index
void	setEnabled(boolean b) Set the enable status of the component.
void	setShortcut(int shorcutKey) Set the shortcut key attached to the menu.

Methods inherited from class fr.cnes.genius.main.GComponent

activateConstraintsByType, attachCopyPasteMenu, attachCopyPasteMenu, beginOfElement, beginOfElement, beginOfElement, beginOfElement, clearAllInnerDescendantConstraint, clearConstraint, clearInnerDescendantContraint, composeWidgetId, doDisplay, endOfElement, getCommentInConfigFile, getConstraint, getCurrentOperation, getDisplayIndicatorStatus, getDisplayIsModifiedIndicator, getElement, getGClassName, getGPanel, getGParent, getGUnitInConfigFile, getInnerDescendantConstraint, getName, getNameInConfigFile, getOperationSaveValue, getPathInConfigFile, getSimpleWidgetId, getStatus, getStringConstraint, getSubComponent, getWidgetId, handleCopyPasteEvent, handleCopyPasteEvent, handleProcessEventException, isCopyPasteEvent, isForcedStatus, isModified, launchInvalidPositionException, mouseWheelMoved, parseSimpleConstraint, processGEvent, processMouseWheelEvent, setBusyCursor, setCommentInConfigFile, setConstraint, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDefaultConstraints, setDisplayIsModifiedIndicator, setElement, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setName, setNameAndCommentInConfigFile, setNameInConfigFile, setPathInConfigFile, setStatus, setStringConstraint, setToolTipText, setWidgetId, setWidth, setWindowBusyCursor, updateIsModifiedIndicator, writeCollection, writeCollection, writeCollection, writeCollection, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GMenu

public GMenu(String name)

Constructor. The widget identifier is created automatically.

Parameters:

name - of the menu.

GMenu

public GMenu(String widgetId,
             String name)

Constructor.

Parameters:

widgetId - widget identifier.

name - of the menu.

GMenu

public GMenu(String widgetId,
             JMenu menu)

Constructor.

Parameters:

widgetId - widget identifier.

menu - JMenu

GMenu

public GMenu(JMenu menu)

Constructor.

Parameters:

menu - JMenu

Method Detail

add

public void add(GMenuItem menuItem)

Adds a menu item to the menu.

Parameters:

menuItem - to be added to the menu.

add

public void add(GMenu submenu)

Adds a menu to the menu, creating an hierachical menu.

Parameters:

submenu - the menu to be added to the menu.

isEnabled

public boolean isEnabled()

Gets the enable status of the widget.

Overrides:

isEnabled in class GComponent

Returns:

true if the component is enabled, false otherwise.

setEnabled

public void setEnabled(boolean b)

Set the enable status of the component.

Overrides:

setEnabled in class GComponent

Parameters:

b - new enable status of the component.

getJMenu

public JMenu getJMenu()

Get the JMenu object associated with the widget.

Returns:

the JMenu object associated with the widget.

add

public void add(GMenuItem menuItem,
                int idx)

Adds a menu to the menu, at the index selected.

Parameters:

menuItem - the menu to be added to the menu.

idx - the index at which the menu will be added

add

public void add(JMenuItem menuItem,
                int idx)

Adds a menu to the menu, at the index selected.

Parameters:

menuItem - the menu to be added to the menu.

idx - the index at which the menu will be added

add

public void add(GMenu submenu,
                int idx)

Adds a submenu to the menu, at the index selected.

Parameters:

submenu - the menu to be added to the menu.

idx - the index at which the menu will be added

add

public void add(JMenu submenu,
                int idx)

Adds a submenu to the menu, at the index selected.

Parameters:

submenu - the menu to be added to the menu.

idx - the index at which the menu will be added

move

public void move(GMenuItem menuItem,
                 int idx)

Moves a menu to the indicated index

Parameters:

menuItem - the menu to be moved.

idx - the index at which the menu will be moved

move

public void move(JMenuItem menuItem,
                 int idx)

Moves a menu to the indicated index

Parameters:

menuItem - the menu to be moved.

idx - the index at which the menu will be moved

move

public void move(GMenu submenu,
                 int idx)

Moves a menu to the indicated index

Parameters:

submenu - the menu to be moved.

idx - the index at which the menu will be moved

move

public void move(JMenu submenu,
                 int idx)

Moves a menu to the indicated index

Parameters:

submenu - the menu to be moved.

idx - the index at which the menu will be moved

move

public void move(String menuItem,
                 int idx)

Moves a menu to the indicated index

Parameters:

menuItem - the menu to be moved.

idx - the index at which the menu will be moved

delete

public void delete(GMenuItem menuItem)

Deletes a menu from the menu.

Parameters:

menuItem - menu to delete

delete

public void delete(JMenuItem menuItem)

Deletes a menu from the menu.

Parameters:

menuItem - menu to delete

delete

public void delete(String menuItem)

Deletes a menu from the menu.

Parameters:

menuItem - menu to delete

delete

public void delete(GMenu submenu)

Deletes a submenu from the menu.

Parameters:

submenu - submenu to delete

getGMenuItem

public GMenuItem getGMenuItem(String menuItem)

Getter for a menu item

Parameters:

menuItem - menuItem that we want to get

Returns:

GMenuItem the GMenuItem;

getComponent

public Component getComponent()

Returns the low level Swing Component encapsulated by the class if any, otherwise returns null.

Overrides:

getComponent in class GComponent

Returns:

the Swing Component encapsulated by the class if any, otherwise returns null.

setShortcut

public void setShortcut(int shorcutKey)

Set the shortcut key attached to the menu.

Parameters:

shorcutKey - the shortcut key to be attached to the menu.