filenet.vw.toolkit.runtime.step.beans

Class VWButton

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.AbstractButton

javax.swing.JButton

filenet.vw.toolkit.runtime.step.beans.VWButton

All Implemented Interfaces:

IVWPanelComponent, java.awt.image.ImageObserver, java.awt.ItemSelectable, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.SwingConstants

public class VWButton
extends javax.swing.JButton
implements IVWPanelComponent

This class adds a button control to the VWPanel container. This control extends JButton and implements the IVWPanelComponent interface, which is required for all controls that can be contained by the VWPanel container.

To implement, complete the following steps:

1. Add a button control to a VWPanel container by adding code similar to the following (in the section where you initialize the controls):

 getContentPane().add(VWButtonOne);
 VWButtonOne.setBounds(168,84,96,36);

2. Set the display text, and set the parameterName value to one of the values listed in the IVWPanelComponent topic. For example:

 VWButtonOne.setText("Save");
 VWButtonOne.setParameterNameIVWPanelComponent.PARAM_SAVE);

Note that the VWButton control supports the following actions only:

• Cancel (IVWPanelComponent.PARAM_CANCEL)
• Complete (IVWPanelComponent.PARAM_COMPLETE)
• Help (IVWPanelComponent.PARAM_HELP)
• History (IVWPanelComponent.PARAM_HISTORY)
• Reassign (IVWPanelComponent.PARAM_REASSIGN)
• Return (IVWPanelComponent.PARAM_RETURN)
• Save (IVWPanelComponent.PARAM_SAVE)
• Status (IVWPanelComponent.PARAM_STATUS)

You can use the explicit string value for the action. For example, for a Save button control, specify either F_Save or PARAM_SAVE string constants.

Note: If you are using an Integrated Development Environment (IDE) that supports drag-and-drop placement of Swing components, select the component and enter the appropriate string in the ParameterName field.

3. Add a statement similar to the following (in the section where you declare the controls):

 filenet.vw.toolkit.runtime.step.beans.VWButton VWButtonOne = new filenet.vw.toolkit.runtime.step.beans.VWButton();

Since:

IWWS1.00

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.BaselineResizeBehavior

Field Summary

Fields inherited from class javax.swing.AbstractButton

BORDER_PAINTED_CHANGED_PROPERTY, 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, MARGIN_CHANGED_PROPERTY, MNEMONIC_CHANGED_PROPERTY, 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

TOOL_TIP_TEXT_KEY, 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 filenet.vw.toolkit.runtime.step.IVWPanelComponent

PARAM_CANCEL, PARAM_COMMENT, PARAM_COMPLETE, PARAM_DATE_RECEIVED, PARAM_DEADLINE, PARAM_EXCEPTION_DESCRIPTION, PARAM_EXCEPTION_MAP, PARAM_HELP, PARAM_HISTORY, PARAM_LAUNCH_DATE, PARAM_OPERATION_NAME, PARAM_ORIGINATOR, PARAM_PARTICIPANT, PARAM_QUEUE_NAME, PARAM_REASSIGN, PARAM_RESPONSES, PARAM_RETURN, PARAM_ROSTER_NAME, PARAM_SAVE, PARAM_SELECTED_RESPONSE, PARAM_STATUS, PARAM_STEP_DESCRIPTION, PARAM_STEP_NAME, PARAM_SUBJECT, PARAM_TAG, PARAM_WORK_CLASS_NAME, PARAM_WORK_OBJECT_NAME, PARAM_WORK_OBJECT_NUMBER, PARAM_WORKFLOW_NAME, PARAM_WORKFLOW_NUMBER

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

Constructors

Constructor and Description
VWButton()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	doSave() Completes the workflow step when the step is saved.
java.lang.String	getParameterName() Retrieves the string value of the parameter name.
void	setParameterName(java.lang.String name) Sets the string value of the parameter name.
void	setStepElement(filenet.vw.api.VWStepElement stepElement) The VWPanel container calls this method to initialize the control by setting the VWStepElement object.

Methods inherited from class javax.swing.JButton

getAccessibleContext, getUIClassID, isDefaultButton, isDefaultCapable, removeNotify, setDefaultCapable, updateUI

Methods inherited from class javax.swing.AbstractButton

addActionListener, addChangeListener, addItemListener, doClick, doClick, getAction, getActionCommand, getActionListeners, getChangeListeners, getDisabledIcon, getDisabledSelectedIcon, getDisplayedMnemonicIndex, getHideActionText, 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, removeActionListener, removeChangeListener, removeItemListener, setAction, setActionCommand, setBorderPainted, setContentAreaFilled, setDisabledIcon, setDisabledSelectedIcon, setDisplayedMnemonicIndex, setEnabled, setFocusPainted, setHideActionText, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabel, setLayout, setMargin, setMnemonic, setMnemonic, setModel, setMultiClickThreshhold, setPressedIcon, setRolloverEnabled, setRolloverIcon, setRolloverSelectedIcon, setSelected, setSelectedIcon, setText, setUI, setVerticalAlignment, setVerticalTextPosition

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

VWButton

public VWButton()

Method Detail

getParameterName

public java.lang.String getParameterName()

Retrieves the string value of the parameter name. This method returns the "PARAM_" constant for the field parameter name. For example, calling the getParameterName() method on a Cancel VWButton returns F_Cancel.

Specified by:

getParameterName in interface IVWPanelComponent

Returns:

A string containing the parameter name. See the "PARAM_" constant field description for IVWPanelComponent to see how the "PARAM_" constant maps to a "F_" string value.

Since:

IWWS1.00

setParameterName

public void setParameterName(java.lang.String name)

Sets the string value of the parameter name. This method must be called for each component.

Specified by:

setParameterName in interface IVWPanelComponent

Parameters:

name - A string containing the new name parameter name. Use the "PARAM_" constant, as shown in the IVWPanelComponent Field Detail section.

Since:

IWWS1.00

doSave

public boolean doSave()

Completes the workflow step when the step is saved. (This is included for consistency - this object just returns TRUE.)

Specified by:

doSave in interface IVWPanelComponent

Returns:

A boolean value. The method returns TRUE if the save operation succeeded; otherwise, the method returns FALSE.

Since:

IWWS1.00

setStepElement

public void setStepElement(filenet.vw.api.VWStepElement stepElement)

The VWPanel container calls this method to initialize the control by setting the VWStepElement object.

Specified by:

setStepElement in interface IVWPanelComponent

Parameters:

stepElement - A valid VWStepElement object.

Since:

IWWS1.00

See Also:

VWStepElement