at.mug.iqm.gui.menu

Class PluginMenu

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.AbstractButton

javax.swing.JMenuItem

javax.swing.JMenu

at.mug.iqm.gui.menu.PluginMenu

All Implemented Interfaces:

IDeactivatableMenu, IPluginMenu, ActionListener, ImageObserver, ItemSelectable, MenuContainer, Serializable, EventListener, Accessible, MenuElement, SwingConstants

public class PluginMenu
extends JMenu
implements IPluginMenu

This class represents a dynamic menu for IQM plugins.

Author:

Philipp Kainz

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JMenu

JMenu.AccessibleJMenu, JMenu.WinListener

Nested classes/interfaces inherited from class javax.swing.JMenuItem

JMenuItem.AccessibleJMenuItem

Nested classes/interfaces inherited from class javax.swing.AbstractButton

AbstractButton.AccessibleAbstractButton, AbstractButton.ButtonChangeListener

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
private HashMap<String,OperatorMenuItem>	imageItems A registry of all image menu items.
private JMenu	imageMenu The menu for the image plugins.
private HashMap<String,JMenu>	imageSubMenus A list of relative paths in the image plugin menu.
private HashMap<String,OperatorMenuItem>	otherItems A registry of all other menu items.
private JMenu	otherMenu The menu for the other plugins.
private HashMap<String,JMenu>	otherSubMenus A list of relative paths in the OTHER plugin menu.
private HashMap<String,OperatorMenuItem>	plotItems A registry of all plot menu items.
private JMenu	plotMenu The menu for the plot plugins.
private HashMap<String,JMenu>	plotSubMenus A list of relative paths in the plot plugin menu.
private ScriptMenu	scriptMenu The menu for the scripts.
private static long	serialVersionUID The UID for serialization.

Fields inherited from class javax.swing.JMenu

popupListener

Fields inherited from class javax.swing.AbstractButton

actionListener, BORDER_PAINTED_CHANGED_PROPERTY, changeEvent, changeListener, CONTENT_AREA_FILLED_CHANGED_PROPERTY, DISABLED_ICON_CHANGED_PROPERTY, DISABLED_SELECTED_ICON_CHANGED_PROPERTY, FOCUS_PAINTED_CHANGED_PROPERTY, HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY, ICON_CHANGED_PROPERTY, itemListener, MARGIN_CHANGED_PROPERTY, MNEMONIC_CHANGED_PROPERTY, model, MODEL_CHANGED_PROPERTY, PRESSED_ICON_CHANGED_PROPERTY, ROLLOVER_ENABLED_CHANGED_PROPERTY, ROLLOVER_ICON_CHANGED_PROPERTY, ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY, SELECTED_ICON_CHANGED_PROPERTY, TEXT_CHANGED_PROPERTY, VERTICAL_ALIGNMENT_CHANGED_PROPERTY, VERTICAL_TEXT_POSITION_CHANGED_PROPERTY

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Modifier	Constructor and Description
private	PluginMenu() Private constructor.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent e)
void	activate(OperatorType type) Activates OperatorMenuItems according to a given type.
void	activateAll() Activates all menu items on the menu.
protected void	activateImageMenuItems() Activates all image menu items.
protected void	activatePlotMenuItems() Activates all plot menu items.
void	addMenuItem(IPlugin plugin) Adds a menu item for a plugin to the root of each menu ("/").
void	addMenuItem(IPlugin plugin, String relativePath) Adds a menu item for a plugin at a given relative path, or "mounting point" within the menu.
protected JMenu	buildMenuStructure(JMenu rootMenu, String relativePath, HashMap<String,JMenu> registry) Builds a deep structure and adds the new JMenu items to a given registry.
void	deactivate(OperatorType type) Deactivates OperatorMenuItems according to a given type.
void	deactivateAll() Deactivates all menu items on the menu.
protected void	deactivateImageMenuItems() Deactivates all image menu items.
protected void	deactivatePlotMenuItems() Deactivates all plot menu items.
static IPluginMenu	getInstance() Gets the reference to this singleton.
void	sortAndAdd() Sorts the menu items in all menus in an alphabetically ascending fashion.
void	update() Updates the menu structure.

Methods inherited from class javax.swing.JMenu

add, add, add, add, add, addMenuListener, addSeparator, applyComponentOrientation, createActionChangeListener, createActionComponent, createWinListener, doClick, fireMenuCanceled, fireMenuDeselected, fireMenuSelected, getAccessibleContext, getComponent, getDelay, getItem, getItemCount, getMenuComponent, getMenuComponentCount, getMenuComponents, getMenuListeners, getPopupMenu, getPopupMenuOrigin, getSubElements, getUIClassID, insert, insert, insert, insertSeparator, isMenuComponent, isPopupMenuVisible, isSelected, isTearOff, isTopLevelMenu, menuSelectionChanged, paramString, processKeyEvent, remove, remove, remove, removeAll, removeMenuListener, setAccelerator, setComponentOrientation, setDelay, setMenuLocation, setModel, setPopupMenuVisible, setSelected, updateUI

Methods inherited from class javax.swing.JMenuItem

actionPropertyChanged, addMenuDragMouseListener, addMenuKeyListener, configurePropertiesFromAction, fireMenuDragMouseDragged, fireMenuDragMouseEntered, fireMenuDragMouseExited, fireMenuDragMouseReleased, fireMenuKeyPressed, fireMenuKeyReleased, fireMenuKeyTyped, getAccelerator, getMenuDragMouseListeners, getMenuKeyListeners, init, isArmed, processKeyEvent, processMenuDragMouseEvent, processMenuKeyEvent, processMouseEvent, removeMenuDragMouseListener, removeMenuKeyListener, setArmed, setEnabled, setUI

Methods inherited from class javax.swing.AbstractButton

addActionListener, addChangeListener, addImpl, addItemListener, checkHorizontalKey, checkVerticalKey, createActionListener, createActionPropertyChangeListener, createChangeListener, createItemListener, doClick, fireActionPerformed, fireItemStateChanged, fireStateChanged, getAction, getActionCommand, getActionListeners, getChangeListeners, getDisabledIcon, getDisabledSelectedIcon, getDisplayedMnemonicIndex, getHideActionText, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getItemListeners, getLabel, getMargin, getMnemonic, getModel, getMultiClickThreshhold, getPressedIcon, getRolloverIcon, getRolloverSelectedIcon, getSelectedIcon, getSelectedObjects, getText, getUI, getVerticalAlignment, getVerticalTextPosition, imageUpdate, isBorderPainted, isContentAreaFilled, isFocusPainted, isRolloverEnabled, paintBorder, removeActionListener, removeChangeListener, removeItemListener, removeNotify, setAction, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setDisplayedMnemonicIndex, setFocusPainted, setHideActionText, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabel, setLayout, setMargin, setMnemonic, setMnemonic, setMultiClickThreshhold, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelectedIcon, setText, setUI, setVerticalAlignment, setVerticalTextPosition

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.swing.MenuElement

processKeyEvent, processMouseEvent

Field Detail

serialVersionUID

private static final long serialVersionUID

The UID for serialization.

See Also:

Constant Field Values

imageMenu

private JMenu imageMenu

The menu for the image plugins.

imageItems

private HashMap<String,OperatorMenuItem> imageItems

A registry of all image menu items.

imageSubMenus

private HashMap<String,JMenu> imageSubMenus

A list of relative paths in the image plugin menu.

plotMenu

private JMenu plotMenu

The menu for the plot plugins.

plotItems

private HashMap<String,OperatorMenuItem> plotItems

A registry of all plot menu items.

plotSubMenus

private HashMap<String,JMenu> plotSubMenus

A list of relative paths in the plot plugin menu.

otherMenu

private JMenu otherMenu

The menu for the other plugins.

otherItems

private HashMap<String,OperatorMenuItem> otherItems

A registry of all other menu items.

otherSubMenus

private HashMap<String,JMenu> otherSubMenus

A list of relative paths in the OTHER plugin menu.

scriptMenu

private ScriptMenu scriptMenu

The menu for the scripts.

Constructor Detail

PluginMenu

private PluginMenu()

Private constructor.

Method Detail

getInstance

public static IPluginMenu getInstance()

Gets the reference to this singleton.

Returns:

the singleton instance

addMenuItem

public void addMenuItem(IPlugin plugin)

Description copied from interface: IPluginMenu

Adds a menu item for a plugin to the root of each menu ("/").

Specified by:

addMenuItem in interface IPluginMenu

Parameters:

plugin - the plugin

addMenuItem

public void addMenuItem(IPlugin plugin,
                        String relativePath)

Description copied from interface: IPluginMenu

Adds a menu item for a plugin at a given relative path, or "mounting point" within the menu.

Specified by:

addMenuItem in interface IPluginMenu

Parameters:

plugin - the plugin

relativePath - the relative path in the menu

buildMenuStructure

protected JMenu buildMenuStructure(JMenu rootMenu,
                                   String relativePath,
                                   HashMap<String,JMenu> registry)

Builds a deep structure and adds the new JMenu items to a given registry.

Parameters:

rootMenu - either the image, plot or script root menu

relativePath - the relative path as string like "/group/subgroup"

registry - the registry where the new created (sub)menus go

Returns:

a reference to the deepest element in the created menu structure for a given relative path

update

public void update()

Description copied from interface: IPluginMenu

Updates the menu structure.

Specified by:

update in interface IPluginMenu

sortAndAdd

public void sortAndAdd()

Description copied from interface: IPluginMenu

Sorts the menu items in all menus in an alphabetically ascending fashion.

Specified by:

sortAndAdd in interface IPluginMenu

actionPerformed

public void actionPerformed(ActionEvent e)

Specified by:

actionPerformed in interface ActionListener

deactivate

public void deactivate(OperatorType type)

Description copied from interface: IDeactivatableMenu

Deactivates OperatorMenuItems according to a given type.

Specified by:

deactivate in interface IDeactivatableMenu

activate

public void activate(OperatorType type)

Description copied from interface: IDeactivatableMenu

Activates OperatorMenuItems according to a given type.

Specified by:

activate in interface IDeactivatableMenu

deactivateAll

public void deactivateAll()

Description copied from interface: IDeactivatableMenu

Deactivates all menu items on the menu.

Specified by:

deactivateAll in interface IDeactivatableMenu

activateAll

public void activateAll()

Description copied from interface: IDeactivatableMenu

Activates all menu items on the menu.

Specified by:

activateAll in interface IDeactivatableMenu

activateImageMenuItems

protected void activateImageMenuItems()

Activates all image menu items.

activatePlotMenuItems

protected void activatePlotMenuItems()

Activates all plot menu items.

deactivateImageMenuItems

protected void deactivateImageMenuItems()

Deactivates all image menu items.

deactivatePlotMenuItems

protected void deactivatePlotMenuItems()

Deactivates all plot menu items.