IBM Branch Transformation Toolkit Javadoc

com.ibm.dse.gui
Class SpPopupMenu

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.JPopupMenu
                  extended bycom.ibm.dse.gui.SpPopupMenu
All Implemented Interfaces:
javax.accessibility.Accessible, DataExchanger, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.MenuElement, Outsider, PanelActions, java.io.Serializable

public class SpPopupMenu
extends javax.swing.JPopupMenu
implements Outsider

The SpPopupMenu class is a Bean that provides an implementation of a PopupMenu. You add SpMenu or SpMeniItems objects to the popup to construct a menu.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JPopupMenu
javax.swing.JPopupMenu.AccessibleJPopupMenu, javax.swing.JPopupMenu.Separator
 
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.JPopupMenu
 
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 java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
SpPopupMenu()
          This constructor creates a SpMenuPopupMenu object.
SpPopupMenu(java.lang.String label)
          This constructor creates a SpPopupMenu object.
 
Method Summary
 javax.swing.JMenuItem add(javax.swing.JMenuItem menuItem)
          Appends a menuitem to the end of this menu.
 void addActionListener(java.awt.event.ActionListener ae)
          Documented in the JDK.
 void addCoordinatedEventListener(CoordinatedEventListener newListener)
          Adds an CoordinatedEventListener.
 void addDataChangedListener(DataChangedListener adl)
          Deprecated. (use addCoordinatedEventListener(CoordinatedEventListener newListener))
 void fireCoordinationEvent()
          Fires a DSECoordinationEvent when a MenuItem has been selected.
 void fireCoordinationEvent(DSECoordinationEvent event)
          Fires a DSECoordinationEvent when a MenuItuem has been selected.
 java.lang.String getAlternativeDataName()
          Gets the alternativeDataName property (java.lang.String) value.
 java.lang.String getDataDirection()
          Gets the dataDirection property (java.lang.String) value.
 java.lang.String getDataName()
          Gets the dataName property (java.lang.String) value.
 java.lang.String getDataToClear()
          Gets the dataToClear property (java.lang.String) value.
 java.lang.Object getDataValue()
          Gets the dataValue property (java.lang.Object) value.
 DSECoordinatedPanel getDSECoordinatedPanel()
          Gets the DSECoordinatedPanel where the component is placed
 java.lang.String getErrorMessage()
          Gets the ErrorMessage property value from its formatters (if exists).
 NavigationParameters getNavigationParameters()
          Gets the navigationParameters property (com.ibm.dse.gui.NavigationParameters) value.
 SpPanel getSpPanel()
          Gets the spPanel property (com.ibm.dse.gui.SpPanel) value.
 java.lang.String getType()
          Gets the type property (java.lang.String) value.
 boolean hasAlternativeDataName()
          Returns if the SpButtonGroup has alternative data name attribute.
 boolean isInError()
          Complies with the DataExchanger interface.
 boolean isKeyedValue()
          if true this bean returns a composed data value.
 boolean isRequired()
          Returns if the SpPopupMenu is required or not.
 void removeActionListener(java.awt.event.ActionListener ae)
          not implemented, To comply with DataExchanger interface.
 void removeCoordinatedEventListener(CoordinatedEventListener newListener)
          Removes a CoordinatedEventListener.
 void removeDataChangedListener(DataChangedListener dcl)
          Deprecated. (use removeCoordinatedEventListener(CoordinatedEventListener newListener))
 void setAlternativeDataName(java.lang.String alternativeDataName)
          Sets the alternativeDataName property (java.lang.String) value.
 void setDataDirection(java.lang.String o)
          Sets the dataDirection property (java.lang.String) value.
 void setDataName(java.lang.String o)
          Sets the dataName property (java.lang.String) value.
 void setDataToClear(java.lang.String dataToClear)
          Sets the dataToClear property (java.lang.String) value.
 void setDataValue(java.lang.Object o)
          Sets the dataValue property (java.lang.String) value.
 void setHelpID(java.lang.String helpID)
          Sets the helpID property (java.lang.String) value.
 void setNavigationParameters(NavigationParameters navigationParameters)
          Sets the navigationParameters property (com.ibm.dse.gui.NavigationParameters) value.
 void setRequired(boolean required)
          Sets the required property (boolean) value.
 void setSpPanel(SpPanel spPanel)
          Sets the spPanel property (com.ibm.dse.gui.SpPanel) value.
 void setType(java.lang.String type)
          Sets the type property (java.lang.String) value.
 
Methods inherited from class javax.swing.JPopupMenu
add, add, addPopupMenuListener, addSeparator, createActionChangeListener, createActionComponent, firePopupMenuCanceled, firePopupMenuWillBecomeInvisible, firePopupMenuWillBecomeVisible, getAccessibleContext, getComponent, getComponentAtIndex, getComponentIndex, getDefaultLightWeightPopupEnabled, getInvoker, getLabel, getMargin, getPopupMenuListeners, getSelectionModel, getSubElements, getUI, getUIClassID, insert, insert, isBorderPainted, isLightWeightPopupEnabled, isPopupTrigger, isVisible, menuSelectionChanged, pack, paintBorder, paramString, processFocusEvent, processKeyEvent, processKeyEvent, processMouseEvent, remove, removePopupMenuListener, setBorderPainted, setDefaultLightWeightPopupEnabled, setInvoker, setLabel, setLightWeightPopupEnabled, setLocation, setPopupSize, setPopupSize, setSelected, setSelectionModel, setUI, setVisible, show, updateUI
 
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, 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, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, 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, 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, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, 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, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SpPopupMenu

public SpPopupMenu()
This constructor creates a SpMenuPopupMenu object.


SpPopupMenu

public SpPopupMenu(java.lang.String label)
This constructor creates a SpPopupMenu object. Create a JPopupMenu with the specified title.

Parameters:
label - The string that a UI may use to display as a title for the popup menu.
Method Detail

add

public javax.swing.JMenuItem add(javax.swing.JMenuItem menuItem)
Appends a menuitem to the end of this menu. Returns the menuitem added.

Parameters:
menuItem - the JMenuitem to be added
Returns:
the JMenuItem added

addActionListener

public void addActionListener(java.awt.event.ActionListener ae)
Documented in the JDK. Complies with the DataExchanger interface. not implemented, To comply with DataExchanger interface.

Specified by:
addActionListener in interface DataExchanger
Parameters:
ae - java.awt.event.ActionEvent

addCoordinatedEventListener

public void addCoordinatedEventListener(CoordinatedEventListener newListener)
Adds an CoordinatedEventListener.

Specified by:
addCoordinatedEventListener in interface DataExchanger
Parameters:
newListener - CoordinatedEventListener

addDataChangedListener

public void addDataChangedListener(DataChangedListener adl)
Deprecated. (use addCoordinatedEventListener(CoordinatedEventListener newListener))

Adds a DataChangedListener.

Specified by:
addDataChangedListener in interface DataExchanger
Parameters:
adl - DataChangedListener

fireCoordinationEvent

public void fireCoordinationEvent()
Fires a DSECoordinationEvent when a MenuItem has been selected.


fireCoordinationEvent

public void fireCoordinationEvent(DSECoordinationEvent event)
Fires a DSECoordinationEvent when a MenuItuem has been selected.

Parameters:
event - DSECoordinationEvent

getAlternativeDataName

public java.lang.String getAlternativeDataName()
Gets the alternativeDataName property (java.lang.String) value.

Specified by:
getAlternativeDataName in interface DataExchanger
Returns:
The alternativeDataName property value.

getDataDirection

public java.lang.String getDataDirection()
Gets the dataDirection property (java.lang.String) value.

Specified by:
getDataDirection in interface DataExchanger
Returns:
String - The dataDirection property value.

getDataName

public java.lang.String getDataName()
Gets the dataName property (java.lang.String) value.

Specified by:
getDataName in interface DataExchanger
Returns:
String - The dataName property value.

getDataToClear

public java.lang.String getDataToClear()
Gets the dataToClear property (java.lang.String) value.

Specified by:
getDataToClear in interface PanelActions
Returns:
The dataToClear property value.
See Also:
setDataToClear(java.lang.String)

getDataValue

public java.lang.Object getDataValue()
Gets the dataValue property (java.lang.Object) value.

Specified by:
getDataValue in interface DataExchanger
Returns:
Object - The dataValue property value.

getDSECoordinatedPanel

public DSECoordinatedPanel getDSECoordinatedPanel()
Gets the DSECoordinatedPanel where the component is placed

Specified by:
getDSECoordinatedPanel in interface PanelActions
Returns:
com.ibm.dse.gui.DSECoordinatedPanel

getErrorMessage

public java.lang.String getErrorMessage()
Gets the ErrorMessage property value from its formatters (if exists).

Specified by:
getErrorMessage in interface DataExchanger
Returns:
java.lang.String - the error message

getNavigationParameters

public NavigationParameters getNavigationParameters()
Gets the navigationParameters property (com.ibm.dse.gui.NavigationParameters) value.

Specified by:
getNavigationParameters in interface DataExchanger
Returns:
The navigationParameters property value.

getSpPanel

public SpPanel getSpPanel()
Gets the spPanel property (com.ibm.dse.gui.SpPanel) value.

Specified by:
getSpPanel in interface Outsider
Returns:
SpPanel - The spPanel property value.

getType

public java.lang.String getType()
Gets the type property (java.lang.String) value.

Specified by:
getType in interface DataExchanger
Returns:
The type property value.

hasAlternativeDataName

public boolean hasAlternativeDataName()
Returns if the SpButtonGroup has alternative data name attribute.

Specified by:
hasAlternativeDataName in interface DataExchanger
Returns:
boolean - if it has alternative data name atribute

isInError

public boolean isInError()
Complies with the DataExchanger interface. A SpPopupMenu can never be in error.

Specified by:
isInError in interface DataExchanger
Returns:
boolean - if it is in error or not

isKeyedValue

public boolean isKeyedValue()
if true this bean returns a composed data value.

Specified by:
isKeyedValue in interface DataExchanger
Returns:
boolean

isRequired

public boolean isRequired()
Returns if the SpPopupMenu is required or not.

Specified by:
isRequired in interface DataExchanger
Returns:
boolean - if it is required or not

removeActionListener

public void removeActionListener(java.awt.event.ActionListener ae)
not implemented, To comply with DataExchanger interface.

Specified by:
removeActionListener in interface DataExchanger
Parameters:
ae - java.awt.event.ActionEvent

removeCoordinatedEventListener

public void removeCoordinatedEventListener(CoordinatedEventListener newListener)
Removes a CoordinatedEventListener.

Specified by:
removeCoordinatedEventListener in interface DataExchanger
Parameters:
newListener - DataChangedListener

removeDataChangedListener

public void removeDataChangedListener(DataChangedListener dcl)
Deprecated. (use removeCoordinatedEventListener(CoordinatedEventListener newListener))

Removes a DataChangedListener.

Specified by:
removeDataChangedListener in interface DataExchanger
Parameters:
dcl - com.ibm.dse.gui.DataChangedListener

setAlternativeDataName

public void setAlternativeDataName(java.lang.String alternativeDataName)
Sets the alternativeDataName property (java.lang.String) value.

Specified by:
setAlternativeDataName in interface DataExchanger
Parameters:
alternativeDataName - The new value for the property.

setDataDirection

public void setDataDirection(java.lang.String o)
Sets the dataDirection property (java.lang.String) value.

Specified by:
setDataDirection in interface DataExchanger
Parameters:
o - java.lang.String, the data direction

setDataName

public void setDataName(java.lang.String o)
Sets the dataName property (java.lang.String) value.

Specified by:
setDataName in interface DataExchanger
Parameters:
o - java.lang.String, the data name

setDataToClear

public void setDataToClear(java.lang.String dataToClear)
Sets the dataToClear property (java.lang.String) value.

Parameters:
dataToClear - The new value for the property.
See Also:
getDataToClear()

setDataValue

public void setDataValue(java.lang.Object o)
Sets the dataValue property (java.lang.String) value.

Specified by:
setDataValue in interface DataExchanger
Parameters:
o - java.lang.Object, the data value

setHelpID

public void setHelpID(java.lang.String helpID)
Sets the helpID property (java.lang.String) value.

Specified by:
setHelpID in interface DataExchanger
Parameters:
helpID - String, the new value for the helpID property.

setNavigationParameters

public void setNavigationParameters(NavigationParameters navigationParameters)
Sets the navigationParameters property (com.ibm.dse.gui.NavigationParameters) value.

Specified by:
setNavigationParameters in interface DataExchanger
Parameters:
navigationParameters - The new value for the property.
See Also:
DataExchanger.getNavigationParameters()

setRequired

public void setRequired(boolean required)
Sets the required property (boolean) value.

Specified by:
setRequired in interface DataExchanger
Parameters:
required - boolean, the new value for the property

setSpPanel

public void setSpPanel(SpPanel spPanel)
Sets the spPanel property (com.ibm.dse.gui.SpPanel) value.

Specified by:
setSpPanel in interface Outsider
Parameters:
spPanel - SpPanel, The new value for the property.

setType

public void setType(java.lang.String type)
Sets the type property (java.lang.String) value.

Specified by:
setType in interface DataExchanger
Parameters:
type - The new value for the property.

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005