fr.cnes.genius.highLevel

Class GMenuItem

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.highLevel.GMenuItem

All Implemented Interfaces:

ActionListener, MouseWheelListener, EventListener

Direct Known Subclasses:

GCommandLauncher.GExecMenuItem

public class GMenuItem
extends GComponent
implements ActionListener

Class defining the elements of menu to be used for creation of the menu bar.

Author:

fourcadej

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
GMenuItem(JMenuItem menu) Constructor.
GMenuItem(String name) Constructor.
GMenuItem(String widgetId, JMenuItem menu) Constructor.
GMenuItem(String widgetId, String name) Constructor.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e)
Component	getComponent() Returns the low level Swing Component encapsulated by the class if any, otherwise returns null.
JMenuItem	getJMenuItem() Get the JMenuItem object associated with the widget.
String	getText() Get the text associated to the menu item.
String	getToolTipText() Getter for the tooltip text from the menu item.
boolean	isEnabled() Gets the enable status of the widget.
void	setAccelerator(int acceleratorKey, int modifierKeys) Set the accelerator key or key combination attached to the menu item.
void	setEnabled(boolean b) Set the enable status of the component.
void	setIcon(ImageIcon ico) Set the icon associated to the menu item.
void	setShortcut(int shorcutKey) Set the shortcut key attached to the menu item.
void	setText(String text) Set the text associated to the menu item.
void	setToolTipText(String toolTipText) Setter of a tooltip text to a menu item.

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, 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

GMenuItem

public GMenuItem(String name)

Constructor. The widget identifier is automatically created.

Parameters:

name - of the menu item.

GMenuItem

public GMenuItem(String widgetId,
                 String name)

Constructor.

Parameters:

widgetId - widget identifier.

name - of the menu item.

GMenuItem

public GMenuItem(String widgetId,
                 JMenuItem menu)

Constructor.

Parameters:

widgetId - widget identifier.

menu - JmenuItem

GMenuItem

public GMenuItem(JMenuItem menu)

Constructor. The widget identifier is automatically created.

Parameters:

menu - JmenuItem

Method Detail

getText

public String getText()

Get the text associated to the menu item.

Returns:

the text associated to the menu item.

setText

public void setText(String text)

Set the text associated to the menu item.

Parameters:

text - the text associated to the menu item.

setIcon

public void setIcon(ImageIcon ico)

Set the icon associated to the menu item.

Parameters:

ico - icon associated to the menu item.

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.

getJMenuItem

public JMenuItem getJMenuItem()

Get the JMenuItem object associated with the widget.

Returns:

the JMenuItem object associated with the widget.

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.

actionPerformed

public void actionPerformed(ActionEvent e)

Specified by:

actionPerformed in interface ActionListener

setShortcut

public void setShortcut(int shorcutKey)

Set the shortcut key attached to the menu item. The menu must be deployed.

Parameters:

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

setAccelerator

public void setAccelerator(int acceleratorKey,
                           int modifierKeys)

Set the accelerator key or key combination attached to the menu item. No need to deploy the menu.

Parameters:

acceleratorKey - the key to be attached to the menu item.

modifierKeys - the modifier key or key combination to be pressed together with the shortcut key (usually Ctrl or Ctrl+Alt).

setToolTipText

public void setToolTipText(String toolTipText)

Setter of a tooltip text to a menu item.

Overrides:

setToolTipText in class GComponent

Parameters:

toolTipText - to be set to the menu item

getToolTipText

public String getToolTipText()

Getter for the tooltip text from the menu item.

Returns:

the tooltip Text from the menu item