fr.cnes.genius.lowLevel

Class GPopupMenu

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GPopupMenu

All Implemented Interfaces:

MouseListener, MouseWheelListener, EventListener

public class GPopupMenu
extends GComponent
implements MouseListener

Class used to handle the display of a pop-up menu. The pop-up menu is displayed by default when clicking with the right button of the mouse on the associated widget. The button which requests display by mouse, is configurable by application makers, and may be different in several instances of the class. Method add(GMenuItem) allows creation of sub menus using GMenuItem objects.

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
GPopupMenu(GComponent component) Constructor.
GPopupMenu(String widgetId, GComponent component) Constructor.

Method Summary

Modifier and Type	Method and Description
void	add(GLabel labelItem) Add a label to the popup menu.
void	add(GMenuItem menuItem) Add a menu item to the popup menu.
void	addSeparator() Add a separtor to the popup menu.
Component	getComponent() Returns the low level Swing Component encapsulated by the class if any, otherwise returns null.
JPopupMenu	getJPopupMenu() Return the JPopupMenu Swing component associated with the GPopupMenu.
boolean	isEmpty() Returns if the poup menu is empty.
void	mouseClicked(MouseEvent e)
void	mouseEntered(MouseEvent e)
void	mouseExited(MouseEvent e)
void	mousePressed(MouseEvent e)
void	mouseReleased(MouseEvent e)
void	remove(int position) Remove the menu item at the specified position.
void	removeAll() Remove all the menu items.
void	setMouseEvent(int event) Set the event that will trigger the displaying of the popup 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, isEnabled, isForcedStatus, isModified, launchInvalidPositionException, mouseWheelMoved, parseSimpleConstraint, processGEvent, processMouseWheelEvent, setBusyCursor, setCommentInConfigFile, setConstraint, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDefaultConstraints, setDisplayIsModifiedIndicator, setElement, setEnabled, 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

GPopupMenu

public GPopupMenu(String widgetId,
                  GComponent component)

Constructor. Creates a popup menu associated with the component component.

Parameters:

widgetId - identifier of the widget.

component - component to which the popup menu is associated.

GPopupMenu

public GPopupMenu(GComponent component)

Constructor. The widget id is assigned automatically.

Parameters:

component - component to which the popup menu is associated.

Method Detail

add

public void add(GMenuItem menuItem)

Add a menu item to the popup menu.

Parameters:

menuItem - to add to the popup menu.

add

public void add(GLabel labelItem)

Add a label to the popup menu.

Parameters:

labelItem - label to add to the popup menu.

addSeparator

public void addSeparator()

Add a separtor to the popup menu.

remove

public void remove(int position)

Remove the menu item at the specified position.

Parameters:

position - of the menu item to remove.

removeAll

public void removeAll()

Remove all the menu items.

setMouseEvent

public void setMouseEvent(int event)

Set the event that will trigger the displaying of the popup menu. In general the trigger of the popup menu is associated to a mouse button event.

Parameters:

event - to trigger the popup menu, see Swing events for possible choices.

getComponent

public Component getComponent()

Description copied from class: GComponent

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.

getJPopupMenu

public JPopupMenu getJPopupMenu()

Return the JPopupMenu Swing component associated with the GPopupMenu.

Returns:

the JPopupMenu Swing component associated with the GPopupMenu.

mouseReleased

public void mouseReleased(MouseEvent e)

Specified by:

mouseReleased in interface MouseListener

mouseClicked

public void mouseClicked(MouseEvent e)

Specified by:

mouseClicked in interface MouseListener

mousePressed

public void mousePressed(MouseEvent e)

Specified by:

mousePressed in interface MouseListener

mouseEntered

public void mouseEntered(MouseEvent e)

Specified by:

mouseEntered in interface MouseListener

mouseExited

public void mouseExited(MouseEvent e)

Specified by:

mouseExited in interface MouseListener

isEmpty

public boolean isEmpty()

Returns if the poup menu is empty.

Returns:

if the poup menu is empty.