IBM Branch Transformation Toolkit Javadoc

com.ibm.dse.desktop
Class MenuItem

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.AbstractButton
                  extended byjavax.swing.JMenuItem
                      extended bycom.ibm.dse.desktop.MenuItem
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.event.ActionListener, java.util.EventListener, java.awt.image.ImageObserver, java.awt.ItemSelectable, java.awt.MenuContainer, javax.swing.MenuElement, java.io.Serializable, javax.swing.SwingConstants, TaskLauncher

public class MenuItem
extends javax.swing.JMenuItem
implements TaskLauncher, java.awt.event.ActionListener

The MenuItem class provides a menu item inside a menu button. It is responsible for launching the specified operation.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JMenuItem
javax.swing.JMenuItem.AccessibleJMenuItem
 
Nested classes inherited from class javax.swing.AbstractButton
javax.swing.AbstractButton.AccessibleAbstractButton, javax.swing.AbstractButton.ButtonChangeListener
 
Nested classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Nested classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Nested classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
 
Field Summary
 
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
accessibleContext, 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.Container
 
Fields inherited from class java.awt.Component
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
MenuItem()
          This constructor creates a MenuItem object.
MenuItem(javax.swing.Icon icon)
          This constructor creates a MenuItem object.
MenuItem(java.lang.String text)
          This constructor creates a MenuItem object.
MenuItem(java.lang.String text, javax.swing.Icon icon)
          This constructor creates a MenuItem object.
MenuItem(java.lang.String text, int mnemonic)
          This constructor creates a MenuItem object.
 
Method Summary
 void actionPerformed(java.awt.event.ActionEvent e)
          Handles events for the ActionListener interface.
 java.lang.String getApplication()
          Gets the ID of the application related to the task described by the TaskLauncher.
 java.lang.String getCode()
          Gets the code of the task described by the MenuItem.
 java.lang.String getErrorMessageOnInstantiateOperation()
          Gets the error message of the task described by the MenuItem.
 java.lang.Boolean getExecuteOperation()
          Gets the executeOperation property of the MenuItem.
 int getHeightNavigationArea()
          Returns the height of the Navigation Area.
 java.lang.String getLaunchable()
          Returns the name of the process/operation/application launched from the TaskLauncher.
 java.lang.String getLongDescription()
          Gets the long description of the task described by the MenuItem.
 java.lang.String getOperation()
          Gets the ID of the operation related to the task described by the MenuItem.
 java.lang.String getOperationPanel()
          Gets the name of the operation panel related to the task described by the MenuItem.
 java.lang.String getParameters()
          Gets the parameters of the task described by the MenuItem.
 java.lang.String getProcess()
          Gets the ID of the process related to the task described by the TaskLauncher.
 java.lang.String getShortDescription()
          Gets the short description of the task described by the MenuItem.
 java.lang.String getTaskName()
          Gets the name of the task described by the MenuItem.
 java.lang.String getTypeLaunchable()
          Gets the type of the task described by the TaskLauncherButton.
 int getWidthNavigationArea()
          Returns the width of the Navigation Area.
 int getXNavigationArea()
          Returns the X position of the Navigation Area.
 int getYNavigationArea()
          Returns the Y position of the Navigation Area.
 void openTask()
          Asks the Desktop to launch the task described by the MenuItem.
 void setApplication(java.lang.Object o)
          Sets the ID of the operation related to the task described by the TaskLauncherButton.
 void setCode(java.lang.Object o)
          Sets the code of the task described by the MenuItem.
 void setErrorMessageOnInstantiateOperation(java.lang.Object o)
          Sets the error message of the task described by the MenuItem.
 void setExecuteOperation(java.lang.Object o)
          Sets the executeOperation property of the MenuItem.
 void setHeightNavigationArea(java.lang.Object o)
          This method sets the height of the Navigation Area.
 void setLabel(java.lang.Object o)
          Sets the label of the MenuItem.
 void setLongDescription(java.lang.Object o)
          Sets the long description of the task described by the MenuItem.
 void setMnemonic(java.lang.Object o)
          Sets the letter used as the mnemonic for the MenuItem.
 void setName(java.lang.Object o)
          Sets the name of the MenuItem.
 void setOperation(java.lang.Object o)
          Sets the ID of the operation related to the task described by the MenuItem.
 void setOperationPanel(java.lang.Object o)
          Sets the name of the operation panel related to the task described by the MenuItem.
 void setParameters(java.lang.Object o)
          Sets the paramters of the task described by the MenuItem.
 void setProcess(java.lang.Object o)
          Sets the ID of the process related to the task described by the TaskLauncherButton.
 void setShortDescription(java.lang.Object o)
          Sets the short description of the task described by the MenuItem.
 void setTaskName(java.lang.Object o)
          Sets the name of the task described by the MenuItem.
 void setToolTipText(java.lang.Object o)
          Sets the toolTipText of the MenuItem.
 void setTypeLaunchable(java.lang.String o)
          Sets the type of the task described by the TaskLauncherButton.
 void setWidthNavigationArea(java.lang.Object o)
          Sets the width of the Navigation Area.
 void setXNavigationArea(java.lang.Object o)
          Sets the X position of the Navigation Area.
 void setYNavigationArea(java.lang.Object o)
          Sets the Y position of the Navigation Area.
 java.lang.String toString()
          Returns a string representation of the MenuItem.
 
Methods inherited from class javax.swing.JMenuItem
addMenuDragMouseListener, addMenuKeyListener, configurePropertiesFromAction, createActionPropertyChangeListener, fireMenuDragMouseDragged, fireMenuDragMouseEntered, fireMenuDragMouseExited, fireMenuDragMouseReleased, fireMenuKeyPressed, fireMenuKeyReleased, fireMenuKeyTyped, getAccelerator, getAccessibleContext, getComponent, getMenuDragMouseListeners, getMenuKeyListeners, getSubElements, getUIClassID, init, isArmed, menuSelectionChanged, paramString, processKeyEvent, processMenuDragMouseEvent, processMenuKeyEvent, processMouseEvent, removeMenuDragMouseListener, removeMenuKeyListener, setAccelerator, setArmed, setEnabled, setUI, updateUI
 
Methods inherited from class javax.swing.AbstractButton
addActionListener, addChangeListener, addItemListener, checkHorizontalKey, checkVerticalKey, createActionListener, createChangeListener, createItemListener, doClick, doClick, fireActionPerformed, fireItemStateChanged, fireStateChanged, getAction, getActionCommand, getActionListeners, getChangeListeners, getDisabledIcon, getDisabledSelectedIcon, getDisplayedMnemonicIndex, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getItemListeners, getLabel, getMargin, getMnemonic, getModel, getMultiClickThreshhold, getPressedIcon, getRolloverIcon, getRolloverSelectedIcon, getSelectedIcon, getSelectedObjects, getText, getUI, getVerticalAlignment, getVerticalTextPosition, imageUpdate, isBorderPainted, isContentAreaFilled, isFocusPainted, isRolloverEnabled, isSelected, paintBorder, removeActionListener, removeChangeListener, removeItemListener, setAction, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setDisplayedMnemonicIndex, setFocusPainted, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabel, setMargin, setMnemonic, setMnemonic, setModel, setMultiClickThreshhold, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelected, setSelectedIcon, setText, setUI, setVerticalAlignment, setVerticalTextPosition
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFont, setForeground, 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, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MenuItem

public MenuItem()
This constructor creates a MenuItem object.


MenuItem

public MenuItem(java.lang.String text)
This constructor creates a MenuItem object.

Parameters:
text - java.lang.String

MenuItem

public MenuItem(java.lang.String text,
                int mnemonic)
This constructor creates a MenuItem object.

Parameters:
text - java.lang.String
mnemonic - int

MenuItem

public MenuItem(java.lang.String text,
                javax.swing.Icon icon)
This constructor creates a MenuItem object.

Parameters:
text - java.lang.String
icon - com.sun.java.swing.Icon

MenuItem

public MenuItem(javax.swing.Icon icon)
This constructor creates a MenuItem object.

Parameters:
icon - com.sun.java.swing.Icon
Method Detail

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)
Handles events for the ActionListener interface.

Specified by:
actionPerformed in interface java.awt.event.ActionListener
Parameters:
e - java.awt.event.ActionEvent

getApplication

public java.lang.String getApplication()
Gets the ID of the application related to the task described by the TaskLauncher.

Specified by:
getApplication in interface TaskLauncher
Returns:
java.lang.String

getCode

public java.lang.String getCode()
Gets the code of the task described by the MenuItem.

Specified by:
getCode in interface TaskLauncher
Returns:
java.lang.String

getErrorMessageOnInstantiateOperation

public java.lang.String getErrorMessageOnInstantiateOperation()
Gets the error message of the task described by the MenuItem.

Specified by:
getErrorMessageOnInstantiateOperation in interface TaskLauncher
Returns:
java.lang.String

getExecuteOperation

public java.lang.Boolean getExecuteOperation()
Gets the executeOperation property of the MenuItem.

Specified by:
getExecuteOperation in interface TaskLauncher
Returns:
boolean

getHeightNavigationArea

public int getHeightNavigationArea()
Returns the height of the Navigation Area.

Specified by:
getHeightNavigationArea in interface TaskLauncher
Returns:
int - the current value of height

getLaunchable

public java.lang.String getLaunchable()
Returns the name of the process/operation/application launched from the TaskLauncher.

Specified by:
getLaunchable in interface TaskLauncher

getLongDescription

public java.lang.String getLongDescription()
Gets the long description of the task described by the MenuItem.

Specified by:
getLongDescription in interface TaskLauncher
Returns:
java.lang.String

getOperation

public java.lang.String getOperation()
Gets the ID of the operation related to the task described by the MenuItem.

Specified by:
getOperation in interface TaskLauncher
Returns:
java.lang.String

getOperationPanel

public java.lang.String getOperationPanel()
Gets the name of the operation panel related to the task described by the MenuItem.

Specified by:
getOperationPanel in interface TaskLauncher
Returns:
java.lang.String

getParameters

public java.lang.String getParameters()
Gets the parameters of the task described by the MenuItem.

Specified by:
getParameters in interface TaskLauncher
Returns:
java.lang.String

getProcess

public java.lang.String getProcess()
Gets the ID of the process related to the task described by the TaskLauncher.

Specified by:
getProcess in interface TaskLauncher
Returns:
java.lang.String

getShortDescription

public java.lang.String getShortDescription()
Gets the short description of the task described by the MenuItem.

Specified by:
getShortDescription in interface TaskLauncher
Returns:
java.lang.String

getTaskName

public java.lang.String getTaskName()
Gets the name of the task described by the MenuItem.

Specified by:
getTaskName in interface TaskLauncher
Returns:
java.lang.String

getTypeLaunchable

public java.lang.String getTypeLaunchable()
Gets the type of the task described by the TaskLauncherButton.

Specified by:
getTypeLaunchable in interface TaskLauncher
Returns:
int

getWidthNavigationArea

public int getWidthNavigationArea()
Returns the width of the Navigation Area.

Specified by:
getWidthNavigationArea in interface TaskLauncher
Returns:
int

getXNavigationArea

public int getXNavigationArea()
Returns the X position of the Navigation Area.

Specified by:
getXNavigationArea in interface TaskLauncher
Returns:
int

getYNavigationArea

public int getYNavigationArea()
Returns the Y position of the Navigation Area.

Specified by:
getYNavigationArea in interface TaskLauncher
Returns:
int

openTask

public void openTask()
Asks the Desktop to launch the task described by the MenuItem.


setApplication

public void setApplication(java.lang.Object o)
Sets the ID of the operation related to the task described by the TaskLauncherButton.

Parameters:
o - java.lang.Object

setCode

public void setCode(java.lang.Object o)
Sets the code of the task described by the MenuItem.

Parameters:
o - java.lang.Object

setErrorMessageOnInstantiateOperation

public void setErrorMessageOnInstantiateOperation(java.lang.Object o)
Sets the error message of the task described by the MenuItem.

Parameters:
o - java.lang.Object

setExecuteOperation

public void setExecuteOperation(java.lang.Object o)
Sets the executeOperation property of the MenuItem.


setHeightNavigationArea

public void setHeightNavigationArea(java.lang.Object o)
This method sets the height of the Navigation Area.


setLabel

public void setLabel(java.lang.Object o)
Sets the label of the MenuItem.

Parameters:
o - java.lang.Object

setLongDescription

public void setLongDescription(java.lang.Object o)
Sets the long description of the task described by the MenuItem.


setMnemonic

public void setMnemonic(java.lang.Object o)
Sets the letter used as the mnemonic for the MenuItem.

Parameters:
o - java.lang.Object

setName

public void setName(java.lang.Object o)
Sets the name of the MenuItem.

Parameters:
o - java.lang.Object

setOperation

public void setOperation(java.lang.Object o)
Sets the ID of the operation related to the task described by the MenuItem.

Parameters:
o - java.lang.Object

setOperationPanel

public void setOperationPanel(java.lang.Object o)
Sets the name of the operation panel related to the task described by the MenuItem.


setParameters

public void setParameters(java.lang.Object o)
Sets the paramters of the task described by the MenuItem.

Parameters:
o - java.lang.Object

setProcess

public void setProcess(java.lang.Object o)
Sets the ID of the process related to the task described by the TaskLauncherButton.

Parameters:
o - java.lang.Object

setShortDescription

public void setShortDescription(java.lang.Object o)
Sets the short description of the task described by the MenuItem.

Parameters:
o - java.lang.Object

setTaskName

public void setTaskName(java.lang.Object o)
Sets the name of the task described by the MenuItem.

Parameters:
o - java.lang.Object

setToolTipText

public void setToolTipText(java.lang.Object o)
Sets the toolTipText of the MenuItem.

Parameters:
o - java.lang.Object

setTypeLaunchable

public void setTypeLaunchable(java.lang.String o)
Sets the type of the task described by the TaskLauncherButton.

Parameters:
o - java.lang.Object

setWidthNavigationArea

public void setWidthNavigationArea(java.lang.Object o)
Sets the width of the Navigation Area.


setXNavigationArea

public void setXNavigationArea(java.lang.Object o)
Sets the X position of the Navigation Area.


setYNavigationArea

public void setYNavigationArea(java.lang.Object o)
Sets the Y position of the Navigation Area.


toString

public java.lang.String toString()
Returns a string representation of the MenuItem.

Returns:
java.lang.String

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005