IBM FileNet P8, Version 5.2.1            

Java Step Processor UI Toolkit Overview

The Java™ Step Processor UI Toolkit APIs are designed to help you develop Swing-based applications that use the Process Java API. The APIs include interfaces, classes, and beans.

For more information, see Process API Class Calling Sequences and Java Step Processor UI Toolkit.

Interfaces

Name Description
IVWAppLauncher Interface that must be implemented by all applications that need to share session information with child applications.
IVWFrameInterface Interface that specifies which methods the dialogs support. This interface is a parent class for the IVWAppLauncher and IVWLaunchableApp interfaces.
IVWLaunchableApp Interface that must be implemented in child applications that need to share session information with the parent application.
IVWPanelComponent Implements required methods for all components for which VWPanel or VWLaunchPanel beans act as a container.
IVWParameterConstants Interface that contains String versions of all of the necessary parameters for starting and running applets and applications.
IVWStepProcessor Interface that is to be implemented by any Step Processor application that allows the toolkit to modify its title.
IVWStepProcessorComponent Interface that is to be implemented by all components that are implemented as a Step Processor bean. Additionally, the VWPanel or VWLaunchPanel bean can contain these objects.

Support Classes

Name Description
VWDriverFrame Provides a container for customized frame implementations (extends the java.awt.Frame class).
VWPanelComponentInfo Implements required interfaces for all components that are contained by the VWPanel. Retrieves information about the specified parameter from the step element and saves the changes to the step element.
VWSessionInfo Provides a container for session-related information (like host name, connection point name, and other necessary session data).

Beans (containers and controls)

See the Java Step Processor UI Toolkit Parameters topic for information on the parameters that are supported by these beans.

Name Description
VWAttachmentPanel Provides the means for listing attachments that are associated with the current step. This bean provides the only programmatic means to interact with the attachments within the Java Step Processor UI Toolkit APIs.
VWButton Provides support for some Step Processor operations, like save, complete, cancel, or reassign.
VWCheckBox Provides a means for exposing the state of a Boolean data field. If the field is editable, the user changes the state by clicking the control.
VWComboBox Displays a list of responses. Calling the doSave() method saves the selected response.
VWFieldPanel Displays the data fields that are exposed at the step. The panel allows users to modify the values based on the specified workflow definition mode.
VWLabel Provides a means for displaying read-only parameter data.
VWLaunchPanel Provides a container for other controls. This class is used to build a Launch Step Processor. The class creates the workflow, initializes the other components, and serves as an ActionListener for the button press events from the VWButton objects.
VWMilestonePanel Provides a read-only milestone list.
VWPanel Provides a container for other controls. This class is used to build a Step Processor. The class retrieves the VWStepElement, initializes the other components, and implements an ActionListener for the button press events from the VWButton objects.
VWTabbedPane Provides a tabbed control for displaying the attachments, fields, and workflow group beans. In addition, the control allows an user to select a response and enter comments.
VWTextArea Provides a multi-row control for displaying step instructions, or allowing the user to enter comments.
VWTextField Provides a single-row control for displaying field data.
VWWflGroupPanel Provides a dialog box for displaying the Workflow Group parameters that are exposed at this step. The panel allows users to modify the contents of the groups.

All of the component beans have an associated information class. The information classes are named by using the convention of adding beaninfo to the bean name. For example, the information class for VWButton is named VWButtonBeanInfo. The information classes describe the associated beans and support the following methods:



Last updated: March 2016
java_ui_class_overview.htm

© Copyright IBM Corporation 2016.