com.ibm.dse.gui
Class SpPopupMenu

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPopupMenu
                          |
                          +--com.ibm.dse.gui.SpPopupMenu

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

Inner classes inherited from class javax.swing.JPopupMenu
javax.swing.JPopupMenu.AccessibleJPopupMenu, javax.swing.JPopupMenu.Separator
 
Inner classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
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.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
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, firePopupMenuCanceled, firePopupMenuWillBecomeInvisible, firePopupMenuWillBecomeVisible, getAccessibleContext, getComponent, getComponentAtIndex, getComponentIndex, getDefaultLightWeightPopupEnabled, getInvoker, getLabel, getMargin, getSelectionModel, getSubElements, getUI, getUIClassID, insert, insert, isBorderPainted, isLightWeightPopupEnabled, isVisible, menuSelectionChanged, pack, paintBorder, paramString, processKeyEvent, processMouseEvent, remove, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInsets, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintComponent, paintImmediately, paintImmediately, processComponentKeyEvent, processFocusEvent, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, processEvent, removeAll, removeContainerListener, setCursor, setLayout, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hide, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, processComponentEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setLocale, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus
 
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.
Overrides:
add in class javax.swing.JPopupMenu
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.
Tags copied from interface: DataExchanger
Parameters:
ae - java.awt.event.ActionEvent

addCoordinatedEventListener

public void addCoordinatedEventListener(CoordinatedEventListener newListener)
Adds an CoordinatedEventListener.
Parameters:
newListener - CoordinatedEventListener

addDataChangedListener

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

Adds a DataChangedListener.
Parameters:
newListener - 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.
Returns:
The alternativeDataName property value.

getDataDirection

public java.lang.String getDataDirection()
Gets the dataDirection property (java.lang.String) value.
Returns:
String - The dataDirection property value.

getDataName

public java.lang.String getDataName()
Gets the dataName property (java.lang.String) value.
Returns:
String - The dataName property value.

getDataToClear

public java.lang.String getDataToClear()
Gets the dataToClear property (java.lang.String) value.
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.
Returns:
Object - The dataValue property value.

getDSECoordinatedPanel

public DSECoordinatedPanel getDSECoordinatedPanel()
Gets the DSECoordinatedPanel where the component is placed
Returns:
com.ibm.dse.gui.DSECoordinatedPanel

getErrorMessage

public java.lang.String getErrorMessage()
Gets the ErrorMessage property value from its formatters (if exists).
Returns:
java.lang.String - the error message

getNavigationParameters

public NavigationParameters getNavigationParameters()
Gets the navigationParameters property (com.ibm.dse.gui.NavigationParameters) value.
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.
Returns:
The type property value.

hasAlternativeDataName

public boolean hasAlternativeDataName()
Returns if the SpButtonGroup has alternative data name attribute.
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.
Returns:
boolean - if it is in error or not

isKeyedValue

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

isRequired

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

removeActionListener

public void removeActionListener(java.awt.event.ActionListener ae)
not implemented, To comply with DataExchanger interface.
Tags copied from interface: DataExchanger
Parameters:
ae - java.awt.event.ActionEvent

removeCoordinatedEventListener

public void removeCoordinatedEventListener(CoordinatedEventListener newListener)
Removes a CoordinatedEventListener.
Parameters:
newListener - DataChangedListener

removeDataChangedListener

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

Removes a DataChangedListener.
Parameters:
newListener - DataChangedListener

setAlternativeDataName

public void setAlternativeDataName(java.lang.String alternativeDataName)
Sets the alternativeDataName property (java.lang.String) value.
Parameters:
alternativeDataName - The new value for the property.

setDataDirection

public void setDataDirection(java.lang.String o)
Sets the dataDirection property (java.lang.String) value.
Parameters:
dataDirection - String, The new value for the property.

setDataName

public void setDataName(java.lang.String o)
Sets the dataName property (java.lang.String) value.
Parameters:
dataName - String, The new value for the property.

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.
Parameters:
dataValue - Object, The new value for the propert

setHelpID

public void setHelpID(java.lang.String helpID)
Sets the helpID property (java.lang.String) value.
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.
Parameters:
navigationParameters - The new value for the property.

setRequired

public void setRequired(boolean required)
Sets the required property (boolean) value.
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.
Parameters:
type - The new value for the property.