com.ibm.as400.vaccess
Class ProgramCallButton

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.AbstractButton
                          |
                          +--javax.swing.JButton
                                |
                                +--com.ibm.as400.vaccess.ProgramCallButton
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.ItemSelectable, java.awt.MenuContainer, java.io.Serializable, javax.swing.SwingConstants

public class ProgramCallButton
extends javax.swing.JButton
implements java.io.Serializable

The ProgramCallButton class represents a button that calls an AS/400 program when pressed. Results of the program are returned in a message list.

ProgramCallButton objects generate the following events:

See Also:
ProgramCall, AS400Message, Serialized Form

Inner classes inherited from class javax.swing.JButton
javax.swing.JButton.AccessibleJButton
 
Inner classes inherited from class javax.swing.AbstractButton
javax.swing.AbstractButton.AccessibleAbstractButton, javax.swing.AbstractButton.ButtonChangeListener
 
Inner classes inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Inner classes inherited from class java.awt.Container
java.awt.Container.AccessibleAWTContainer
 
Inner classes inherited from class java.awt.Component
java.awt.Component.AccessibleAWTComponent
 
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.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface javax.swing.SwingConstants
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NORTH, NORTH_EAST, NORTH_WEST, 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
ProgramCallButton()
          Constructs a ProgramCallButton object.
ProgramCallButton(java.lang.String text)
          Constructs a ProgramCallButton object.
ProgramCallButton(java.lang.String text, javax.swing.Icon icon)
          Constructs a ProgramCallButton object.
ProgramCallButton(java.lang.String text, javax.swing.Icon icon, AS400 system)
          Constructs a ProgramCallButton object.
ProgramCallButton(java.lang.String text, javax.swing.Icon icon, AS400 system, java.lang.String program, ProgramParameter[] parmlist)
          Constructs a ProgramCallButton object.
 
Method Summary
 void addActionCompletedListener(ActionCompletedListener listener)
          Adds a listener to be notified when a program has been called.
 void addErrorListener(ErrorListener listener)
          Adds a listener to be notified when an error occurs.
 void addParameter(ProgramParameter parameter)
          Adds a parameter to the end of the parameter list.
 void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
          Adds a listener to be notified when the value of any bound property changes.
 void addVetoableChangeListener(java.beans.VetoableChangeListener listener)
          Adds a listener to be notified when the value of any constrained property changes.
 AS400Message[] getMessageList()
          Returns the message list resulting from the last program call that was run.
 java.lang.String getMessageText()
          Returns the message text from the last program that was run.
 ProgramParameter[] getParameterList()
          Returns the parameter list.
 java.lang.String getProgram()
          Returns the program which will be called when the button is pressed.
 AS400 getSystem()
          Returns the AS/400 on which programs are run.
 void removeActionCompletedListener(ActionCompletedListener listener)
          Removes an action completed listener.
 void removeErrorListener(ErrorListener listener)
          Removes an error listener.
 void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
          Removes a property change listener.
 void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
          Removes a vetoable change listener.
 void setParameterList(ProgramParameter[] parmlist)
          Sets the list of parameters to pass to the AS/400 program.
 void setProgram(java.lang.String program)
          Sets the program.
 void setSystem(AS400 system)
          Sets the AS/400 on which programs are run.
 
Methods inherited from class javax.swing.JButton
configurePropertiesFromAction, getAccessibleContext, getUIClassID, isDefaultButton, isDefaultCapable, paramString, removeNotify, setDefaultCapable, updateUI
 
Methods inherited from class javax.swing.AbstractButton
addActionListener, addChangeListener, addItemListener, checkHorizontalKey, checkVerticalKey, createActionListener, createActionPropertyChangeListener, createChangeListener, createItemListener, doClick, doClick, fireActionPerformed, fireItemStateChanged, fireStateChanged, getAction, getActionCommand, getDisabledIcon, getDisabledSelectedIcon, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getLabel, getMargin, getMnemonic, getModel, getPressedIcon, getRolloverIcon, getRolloverSelectedIcon, getSelectedIcon, getSelectedObjects, getText, getUI, getVerticalAlignment, getVerticalTextPosition, imageUpdate, init, isBorderPainted, isContentAreaFilled, isFocusPainted, isFocusTraversable, isRolloverEnabled, isSelected, paintBorder, removeActionListener, removeChangeListener, removeItemListener, setAction, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setEnabled, setFocusPainted, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setLabel, setMargin, setMnemonic, setMnemonic, setModel, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelected, setSelectedIcon, setText, setUI, setVerticalAlignment, setVerticalTextPosition
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processFocusEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removePropertyChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVerifyInputWhenFocusTarget, setVisible, 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, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setLayout, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocale, setLocation, 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

ProgramCallButton

public ProgramCallButton()
Constructs a ProgramCallButton object.

ProgramCallButton

public ProgramCallButton(java.lang.String text)
Constructs a ProgramCallButton object.
Parameters:
text - The button text, or null if there is no text.

ProgramCallButton

public ProgramCallButton(java.lang.String text,
                         javax.swing.Icon icon)
Constructs a ProgramCallButton object.
Parameters:
text - The button text, or null if there is no text.
icon - The button icon, or null if there is no icon.

ProgramCallButton

public ProgramCallButton(java.lang.String text,
                         javax.swing.Icon icon,
                         AS400 system)
Constructs a ProgramCallButton object.
Parameters:
text - The button text, or null if there is no text.
icon - The button icon, or null if there is no icon.
system - The AS/400 on which the programs are run.

ProgramCallButton

public ProgramCallButton(java.lang.String text,
                         javax.swing.Icon icon,
                         AS400 system,
                         java.lang.String program,
                         ProgramParameter[] parmlist)
Constructs a ProgramCallButton object.
Parameters:
text - The button text, or null if there is no text.
icon - The button icon, or null if there is no icon.
system - The AS/400 on which the programs are run.
program - The program name as a fully qualified path name in the library file system. The library and program name must each be 10 characters or less.
parmlist - A list of up to 35 parameters with which to run the program.
Method Detail

addActionCompletedListener

public void addActionCompletedListener(ActionCompletedListener listener)
Adds a listener to be notified when a program has been called.
Parameters:
listener - The listener.

addErrorListener

public void addErrorListener(ErrorListener listener)
Adds a listener to be notified when an error occurs.
Parameters:
listener - The listener.

addParameter

public void addParameter(ProgramParameter parameter)
                  throws java.beans.PropertyVetoException
Adds a parameter to the end of the parameter list.
Parameters:
parameter - The parameter.
Throws:
java.beans.PropertyVetoException - If the change is vetoed.

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Adds a listener to be notified when the value of any bound property changes.
Overrides:
addPropertyChangeListener in class javax.swing.JComponent
Parameters:
listener - The listener.

addVetoableChangeListener

public void addVetoableChangeListener(java.beans.VetoableChangeListener listener)
Adds a listener to be notified when the value of any constrained property changes.
Overrides:
addVetoableChangeListener in class javax.swing.JComponent
Parameters:
listener - The listener.

getMessageList

public AS400Message[] getMessageList()
Returns the message list resulting from the last program call that was run.
Returns:
The message list.

getMessageText

public java.lang.String getMessageText()
Returns the message text from the last program that was run. The message will be the first message received.
Returns:
The message text.

getParameterList

public ProgramParameter[] getParameterList()
Returns the parameter list.
Returns:
The parameter list.

getProgram

public java.lang.String getProgram()
Returns the program which will be called when the button is pressed.
Returns:
The program which will be called when the button is pressed.

getSystem

public AS400 getSystem()
Returns the AS/400 on which programs are run.
Returns:
The AS400 on which programs are run.

removeActionCompletedListener

public void removeActionCompletedListener(ActionCompletedListener listener)
Removes an action completed listener.
Parameters:
listener - The listener.

removeErrorListener

public void removeErrorListener(ErrorListener listener)
Removes an error listener.
Parameters:
listener - The listener.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Removes a property change listener.
Overrides:
removePropertyChangeListener in class javax.swing.JComponent
Parameters:
listener - The listener.

removeVetoableChangeListener

public void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
Removes a vetoable change listener.
Overrides:
removeVetoableChangeListener in class javax.swing.JComponent
Parameters:
listener - The listener.

setParameterList

public void setParameterList(ProgramParameter[] parmlist)
                      throws java.beans.PropertyVetoException
Sets the list of parameters to pass to the AS/400 program.
Parameters:
parmlist - A list of up to 35 parameters with which to run the program. It will replace any parameters previously set.
Throws:
java.beans.PropertyVetoException - If the change is vetoed.

setProgram

public void setProgram(java.lang.String program)
                throws java.beans.PropertyVetoException
Sets the program.
Parameters:
program - The program.
Throws:
java.beans.PropertyVetoException - If the change is veoted.

setSystem

public void setSystem(AS400 system)
               throws java.beans.PropertyVetoException
Sets the AS/400 on which programs are run.
Parameters:
system - The AS/400 on which programs are run.
Throws:
java.beans.PropertyVetoException - If the change is vetoed.