Process UI Toolkit API

filenet.vw.toolkit.runtime.step.beans
Class VWLabel

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JLabel
                  extended by filenet.vw.toolkit.runtime.step.beans.VWLabel
All Implemented Interfaces:
IVWPanelComponent, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.SwingConstants

public class VWLabel
extends javax.swing.JLabel
implements IVWPanelComponent

This class adds a label control to the VWPanel container. This control extends JLabel, and it 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 label control to a VWPanel container by adding code similar to the following (in the section where you initialize the controls):

 getContentPane().add(VWLabelOne);
 VWLabelOne.setBounds(156,84,204,40);

2. Set the parameterName value to a custom parameter name or one of the values listed in the IVWPanelComponent topic; for example, to set the ParameterName property for a deadline label:

 VWLabelOne.setParameterName(IVWParameter.PARAM_DEADLINE);

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.VWLabel VWLabelOne = new filenet.vw.toolkit.runtime.step.beans.VWLabel();

Since:
IWWS1.00
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
 
Field Summary
 
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
VWLabel()
           
 
Method Summary
 boolean doSave()
          Completes the workflow step when the step is saved.
 java.lang.String getParameterName()
          This method returns the string value for the field 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.JLabel
getAccessibleContext, getDisabledIcon, getDisplayedMnemonic, getDisplayedMnemonicIndex, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getLabelFor, getText, getUI, getUIClassID, getVerticalAlignment, getVerticalTextPosition, imageUpdate, setDisabledIcon, setDisplayedMnemonic, setDisplayedMnemonic, setDisplayedMnemonicIndex, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabelFor, setText, setUI, setVerticalAlignment, setVerticalTextPosition, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, 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, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, 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, setLayout, transferFocusBackward, 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, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

VWLabel

public VWLabel()
Method Detail

getParameterName

public java.lang.String getParameterName()
This method returns the string value for the field parameter name. For example, calling the getParameterName() method on a Comment VWLabel returns "F_Comment".

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 parameter name. Use either a literal value or a "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.

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

Process UI Toolkit API

© Copyright IBM Corporation 2002, 2008. All rights reserved.