Process UI Toolkit API

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

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--filenet.vw.toolkit.runtime.step.beans.VWPanel
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.event.ActionListener, java.util.EventListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable
Direct Known Subclasses:
VWLaunchPanel

public class VWPanel
extends javax.swing.JPanel
implements java.awt.event.ActionListener

This class acts as a container for grouping and easily accessing the Java Step Processor UI Toolkit controls and containers. The class retrieves and queries a valid VWStepElement object and provides the necessary information to initialize its components (dependent controls and containers). Additionally, the class implements an ActionListener to monitor the button press events in the contained VWButton objects.

You can create a subclass of the VWPanel container or create a new instance. (The Java Step and Launch Step Processor samples demonstrate how to subclass and use the VWPanel class.)

To create a new instance of the container, include a statement similar to the following:

 filenet.vw.toolkit.runtime.step.beans.VWPanel VWPanelOne = new filenet.vw.toolkit.runtime.step.beans.VWPanel();

Once you have a container, you can add any of the following containers and controls: Supported containers:

Supported controls:

Note: This class extends the Swing JPanel class; refer to the appropriate Sun SDK documentation for more information on the JPanel class and on the inherited methods and fields for the Swing JComponent and the AWT Container and Component classes.

Since:
IWWS1.00
See Also:
Serialized Form

Inner classes inherited from class javax.swing.JPanel
javax.swing.JPanel.AccessibleJPanel
 
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
 
Field Summary
protected  java.lang.String m_cancelWarningMsg
           
protected  java.util.Vector m_componentList
           
protected  java.lang.String m_confirmCancelMsg
           
protected  java.lang.String m_failedToCancelMsg
           
protected  java.lang.String m_failedToCompleteMsg
           
protected  javax.swing.JApplet m_parentApplet
           
protected  java.awt.Container m_parentContainer
           
protected  java.awt.Frame m_parentFrame
           
protected  boolean m_readOnly
           
protected  filenet.vw.toolkit.runtime.step.beans.VWSession m_vwSession
           
protected  filenet.vw.toolkit.runtime.step.beans.VWStepElement m_vwStepElement
           
 
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 java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
VWPanel()
           
 
Method Summary
 void actionPerformed(java.awt.event.ActionEvent event)
          Invoked when an action occurs.
 java.awt.Component add(java.awt.Component newComponent)
          Adds the specified component (either a control or container) to the end of this container.
 void add(java.awt.Component newComponent, java.lang.Object constraints)
          Adds the specified component (either a control or container, as specified by the constraint) to the end of this container.
 void destroy()
          Allows the VWPanel object to exit gracefully.
protected  void displayHelp()
          Displays a HTML-formatted help file.
protected  void displayHistory()
          Displays a history dialog.
protected  void doAbort()
          Unlocks a work item associated with the current step without updating the fields on the work item.
protected  void doClose()
          Closes the window hosting this applet.
protected  void doClose(java.lang.String closingMessage)
          Closes the window hosting this applet.
 void init(VWSessionInfo sessionInfo)
          Initializes the container to interact with other APIs and controls.
protected  void performExtraCancelOperations()
          Adds additional operations to perform during the cancel process.
protected  void performExtraCompleteOperations()
          Adds operations to perform during the Complete process.
protected  void performExtraLoadOperations()
          Adds additional operations to perform during the Load process This method is called before the controls are created.
protected  void performExtraReassignOperations()
          Adds additional operations to perform during the Reassign process This method is called after doReassign().
protected  void performExtraReturnOperations()
          Adds additional operations to perform during the "Return to queue" process.
protected  void performExtraSaveOperations()
          Adds additional operations to perform during the Save process.
 
Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUIClassID, paramString, updateUI
 
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, 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, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processFocusEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, 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, 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, imageUpdate, 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
 

Field Detail

m_vwSession

protected filenet.vw.toolkit.runtime.step.beans.VWSession m_vwSession

m_vwStepElement

protected filenet.vw.toolkit.runtime.step.beans.VWStepElement m_vwStepElement

m_componentList

protected java.util.Vector m_componentList

m_parentContainer

protected java.awt.Container m_parentContainer

m_parentApplet

protected javax.swing.JApplet m_parentApplet

m_parentFrame

protected java.awt.Frame m_parentFrame

m_cancelWarningMsg

protected java.lang.String m_cancelWarningMsg

m_confirmCancelMsg

protected java.lang.String m_confirmCancelMsg

m_failedToCompleteMsg

protected java.lang.String m_failedToCompleteMsg

m_failedToCancelMsg

protected java.lang.String m_failedToCancelMsg

m_readOnly

protected boolean m_readOnly
Constructor Detail

VWPanel

public VWPanel()
Method Detail

init

public void init(VWSessionInfo sessionInfo)
Initializes the container to interact with other APIs and controls.
Parameters:
sessionInfo - The VWSessionInfo object contains the session-related information necessary to initialize the container and allow the container to access other Process APIs. VWSessionInfo is used to retrieve the queue name and the work object number necessary to retrieve a VWStepElement object.
Since:
IWWS1.00

destroy

public void destroy()
Allows the VWPanel object to exit gracefully. This method calls doAbort(), which in turn performs the clean up function.
Since:
IWWS1.00

add

public java.awt.Component add(java.awt.Component newComponent)
Adds the specified component (either a control or container) to the end of this container.
Overrides:
add in class java.awt.Container
Parameters:
newComponent - A Component object to add to the container.
Returns:
The argument passed by the specified components.
Since:
IWWS1.00

add

public void add(java.awt.Component newComponent,
                java.lang.Object constraints)
Adds the specified component (either a control or container, as specified by the constraint) to the end of this container. Also notifies the layout manager to add the component to this container's layout using the specified constraints object.
Overrides:
add in class java.awt.Container
Parameters:
comp - the component object to be added.
constraints - an object containing layout constraints for this component.
Since:
IWWS1.00
See Also:
LayoutManager

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent event)
Invoked when an action occurs.
Specified by:
actionPerformed in interface java.awt.event.ActionListener
Parameters:
event - an ActionEvent object
Since:
IWWS1.00

displayHelp

protected void displayHelp()
Displays a HTML-formatted help file. The location and file location is relative to IDMWS\Application\WF_Help\stepproc\stepproc.htm (on the web server). To call your own custom help file, create a subclass of the VWPanel class, and implement a displayHelp() method that overrides this method.
Since:
IWWS1.00

displayHistory

protected void displayHistory()
Displays a history dialog. To call your own custom history dialog, create a subclass of the VWPanel class, and implement a displayHistory() method that overrides this method.
Since:
2.0

doAbort

protected void doAbort()
Unlocks a work item associated with the current step without updating the fields on the work item. Calling this method accomplishes the same result as calling the VWStepElement.doAbort() method in the Process APIs.
Since:
IWWS1.00

doClose

protected void doClose(java.lang.String closingMessage)
Closes the window hosting this applet.
Parameters:
closingMessage - String message to display in the window once applet is closed
Since:
IWWS1.00

doClose

protected void doClose()
Closes the window hosting this applet.
Since:
IWWS1.00

performExtraCancelOperations

protected void performExtraCancelOperations()
Adds additional operations to perform during the cancel process. This method is called after doAbort(). Create a subclass of the VWPanel class and implement a method that overrides this method.
Since:
IWWS1.00

performExtraCompleteOperations

protected void performExtraCompleteOperations()
Adds operations to perform during the Complete process. This method is called before doDispatch(). Create a subclass of the VWPanel class and implement a method that overrides this method.
Since:
IWWS1.00

performExtraLoadOperations

protected void performExtraLoadOperations()
Adds additional operations to perform during the Load process This method is called before the controls are created. Create a subclass of the VWPanel class and implement a method that overrides this method.
Since:
IWWS1.00

performExtraReassignOperations

protected void performExtraReassignOperations()
Adds additional operations to perform during the Reassign process This method is called after doReassign(). Create a subclass of the VWPanel class and implement a method that overrides this method.
Since:
IWWS1.00

performExtraReturnOperations

protected void performExtraReturnOperations()
Adds additional operations to perform during the "Return to queue" process. This method is called after doReassign(). Create a subclass of the VWPanel class and implement a method that overrides this method.
Since:
IWWS1.00

performExtraSaveOperations

protected void performExtraSaveOperations()
Adds additional operations to perform during the Save process. This method is called after doSave(). Create a subclass of the VWPanel class and implement a method that overrides this method.
Since:
IWWS1.00


Copyright © 2002, 2003 FileNet Corporation. All rights reserved.