IBM Branch Transformation Toolkit Javadoc

com.ibm.dse.gui
Class SpButton

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended byjavax.swing.AbstractButton
                  extended byjavax.swing.JButton
                      extended bycom.ibm.dse.gui.SpButton
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.event.ActionListener, java.util.EventListener, GUIComponent, java.awt.image.ImageObserver, java.awt.ItemSelectable, java.awt.event.KeyListener, java.awt.MenuContainer, PanelActions, java.io.Serializable, javax.swing.SwingConstants
Direct Known Subclasses:
MenuButton, TaskLauncherButton

public class SpButton
extends javax.swing.JButton
implements GUIComponent, PanelActions, java.awt.event.ActionListener, java.awt.event.KeyListener

The SpButton class is a Bean that provides a push button that the user can select to perform an action.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JButton
javax.swing.JButton.AccessibleJButton
 
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
SpButton()
          This constructor creates a SpButton object.
 
Method Summary
 void actionPerformed(java.awt.event.ActionEvent ae)
          Method to handle events for the ActionListener interface.
 void addActionListener(java.awt.event.ActionListener l)
          Documented in the JDK.
 void addCoordinatedEventListener(CoordinatedEventListener newListener)
          Adds an CoordinatedEventListener.
 void fireCoordinationEvent()
          Fires a DSECoordinationEvent when data has changed.
 void fireCoordinationEvent(DSECoordinationEvent event)
          Fires a DSECoordinationEvent when data has changed.
 boolean getActivatedOkKey()
          Gets the activatedOkKey property (boolean) value.
 java.lang.String getDataToClear()
          Gets the dataToClear property (java.lang.String) value.
 boolean getDisableExecuteButton()
          Gets the disableExecuteButton property (boolean) value.
 DSECoordinatedPanel getDSECoordinatedPanel()
          Gets the DSECoordinatedPanel where the component is placed
 java.lang.String getFollowMandatory()
          Gets the followMandatory property (java.lang.String) value.
 java.lang.String getHelpID()
          Gets the helpID property (java.lang.String) value.
 NavigationParameters getNavigationParameters()
          Gets the navigationParameters property (com.ibm.dse.gui.NavigationParameters) value.
 SpPanel getSpPanel()
          Gets the SpPanel where the component is placed
 java.lang.String getType()
          Gets the type property (java.lang.String) value.
 void keyPressed(java.awt.event.KeyEvent e)
          Handles events for the KeyListener interface.
 void keyReleased(java.awt.event.KeyEvent e)
          Handles events for the KeyListener interface.
 void keyTyped(java.awt.event.KeyEvent e)
          Handles events for the KeyListener interface.
static void main(java.lang.String[] args)
          Provides a main entry point.
protected  void processComponentKeyEvent(java.awt.event.KeyEvent e)
          It is called after interested listeners have managed the event.
 void removeCoordinatedEventListener(CoordinatedEventListener newListener)
          Removes a CoordinatedEventListener.
 void setActivatedOkKey(boolean activatedOkKey)
          Sets the activatedOkKey property (boolean) value.
 void setDataToClear(java.lang.String dataToClear)
          Sets the dataToClear property (java.lang.String) value.
 void setDisableExecuteButton(boolean disableExecuteButton)
          Sets the disableExecuteButton property (boolean) value.
 void setFollowMandatory(java.lang.String followMandatory)
          Sets the followMandatory property (java.lang.String) value.
 void setHelpID(java.lang.String helpID)
          Sets the helpID property (java.lang.String) value.
 void setMnemonic(char a)
          Created to solve a bug in swing.
 void setMnemonic(int a)
          Created to solve a bug in swing.
 void setNavigationParameters(NavigationParameters navigationParameters)
          Sets the navigationParameters property (com.ibm.dse.gui.NavigationParameters) value.
 void setType(java.lang.String type)
          Sets the type property (java.lang.String) value.
 
Methods inherited from class javax.swing.JButton
configurePropertiesFromAction, getAccessibleContext, getUIClassID, isDefaultButton, isDefaultCapable, paramString, removeNotify, setDefaultCapable, updateUI
 
Methods inherited from class javax.swing.AbstractButton
addChangeListener, addItemListener, checkHorizontalKey, checkVerticalKey, createActionListener, createActionPropertyChangeListener, 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, init, isBorderPainted, isContentAreaFilled, isFocusPainted, isRolloverEnabled, isSelected, paintBorder, removeActionListener, removeChangeListener, removeItemListener, setAction, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setDisplayedMnemonicIndex, setEnabled, setFocusPainted, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabel, setMargin, 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, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, 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, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SpButton

public SpButton()
This constructor creates a SpButton object.

Method Detail

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent ae)
Method to handle events for the ActionListener interface.

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

addActionListener

public void addActionListener(java.awt.event.ActionListener l)
Documented in the JDK.


addCoordinatedEventListener

public void addCoordinatedEventListener(CoordinatedEventListener newListener)
Adds an CoordinatedEventListener.

Parameters:
newListener - CoordinatedEventListener

fireCoordinationEvent

public void fireCoordinationEvent()
Fires a DSECoordinationEvent when data has changed.


fireCoordinationEvent

public void fireCoordinationEvent(DSECoordinationEvent event)
Fires a DSECoordinationEvent when data has changed.

Parameters:
event - DSECoordinationEvent

getActivatedOkKey

public boolean getActivatedOkKey()
Gets the activatedOkKey property (boolean) value.

Specified by:
getActivatedOkKey in interface GUIComponent
Returns:
boolean - the activatedOkKey property value
See Also:
setActivatedOkKey(boolean)

getDataToClear

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

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

getDisableExecuteButton

public boolean getDisableExecuteButton()
Gets the disableExecuteButton property (boolean) value.

Returns:
The disableExecuteButton property value.
See Also:
setDisableExecuteButton(boolean)

getDSECoordinatedPanel

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

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

getFollowMandatory

public java.lang.String getFollowMandatory()
Gets the followMandatory property (java.lang.String) value.

Returns:
The followMandatory property value.
See Also:
setFollowMandatory(java.lang.String)

getHelpID

public java.lang.String getHelpID()
Gets the helpID property (java.lang.String) value.

Returns:
String - the helpID property value.
See Also:
setHelpID(java.lang.String)

getNavigationParameters

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

Returns:
The navigationParameters property value.
See Also:
setNavigationParameters(com.ibm.dse.gui.NavigationParameters)

getSpPanel

public SpPanel getSpPanel()
Gets the SpPanel where the component is placed

Specified by:
getSpPanel in interface PanelActions
Returns:
com.ibm.dse.gui.SpPanel

getType

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

Specified by:
getType in interface PanelActions
Returns:
String - the type property value.
See Also:
setType(java.lang.String)

keyPressed

public void keyPressed(java.awt.event.KeyEvent e)
Handles events for the KeyListener interface.

Specified by:
keyPressed in interface GUIComponent
Parameters:
e - java.awt.event.KeyEvent

keyReleased

public void keyReleased(java.awt.event.KeyEvent e)
Handles events for the KeyListener interface.

Specified by:
keyReleased in interface java.awt.event.KeyListener
Parameters:
e - java.awt.event.KeyEvent

keyTyped

public void keyTyped(java.awt.event.KeyEvent e)
Handles events for the KeyListener interface.

Specified by:
keyTyped in interface java.awt.event.KeyListener
Parameters:
e - java.awt.event.KeyEvent

main

public static void main(java.lang.String[] args)
Provides a main entry point. It starts the part when it is run as an application.

Parameters:
args - java.lang.String[]

processComponentKeyEvent

protected void processComponentKeyEvent(java.awt.event.KeyEvent e)
It is called after interested listeners have managed the event. In case the event is due to an special key, the event is consumed.


removeCoordinatedEventListener

public void removeCoordinatedEventListener(CoordinatedEventListener newListener)
Removes a CoordinatedEventListener.

Parameters:
newListener - DataChangedListener

setActivatedOkKey

public void setActivatedOkKey(boolean activatedOkKey)
Sets the activatedOkKey property (boolean) value.

Specified by:
setActivatedOkKey in interface GUIComponent
Parameters:
activatedOkKey - boolean, the new value for the property
See Also:
getActivatedOkKey()

setDataToClear

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

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

setDisableExecuteButton

public void setDisableExecuteButton(boolean disableExecuteButton)
Sets the disableExecuteButton property (boolean) value.

Parameters:
disableExecuteButton - The new value for the property.
See Also:
getDisableExecuteButton()

setFollowMandatory

public void setFollowMandatory(java.lang.String followMandatory)
Sets the followMandatory property (java.lang.String) value.

Parameters:
followMandatory - The new value for the property.
See Also:
getFollowMandatory()

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.
See Also:
getHelpID()

setMnemonic

public void setMnemonic(char a)
Created to solve a bug in swing.


setMnemonic

public void setMnemonic(int a)
Created to solve a bug in swing.


setNavigationParameters

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

Parameters:
navigationParameters - The new value for the property.
See Also:
getNavigationParameters()

setType

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

Parameters:
type - String, the new value for the type property.
See Also:
getType()

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005