filenet.vw.toolkit.runtime.step
Interface IVWPanelComponent
- All Known Implementing Classes:
- VWButton, VWCheckBox, VWComboBox, VWLabel, VWPanelComponentInfo, VWTextArea, VWTextField
public interface IVWPanelComponent
This class provides an interface that allows implementing classes to easily
use the Java Step Processor UI Toolkit controls. These parameters and
methods apply to all controls that can be contained by a VWPanel container.
The following sections list the fields supported by the different UI controls.
(System field information other than that listed here is ignored.) The
IVWPanelComponent interface provides support for creating user-defined fields
as follows:
The VWButton control supports the following parameters:
- F_Cancel (PARAM_CANCEL)
- F_Complete (PARAM_COMPLETE)
- F_Help (PARAM_HELP)
- F_History (PARAM_HISTORY)
- F_Reassign (PARAM_REASSIGN)
- F_Return (PARAM_RETURN)
- F_Save (PARAM_SAVE)
- F_Status (PARAM_STATUS)
The VWComboBox control supports the following parameter:
- F_Responses (PARAM_RESPONSES)
The VWCheckBox, VWLabel, VWTextArea, and VWTextField controls support the following parameters:
- User-defined fields
- F_Comment (PARAM_COMMENT)
- F_DateReceived (PARAM_DATE_RECEIVED)
- F_DeadLine (PARAM_DEADLINE)
- F_ExceptionDescription (PARAM_EXCEPTION_DESCRIPTION)
- F_ExceptionMap (PARAM_EXCEPTION_MAP)
- F_LaunchDate (PARAM_LAUNCH_DATE)
- F_OperationName (PARAM_OPERATION_NAME)
- F_Originator (PARAM_ORIGINATOR)
- F_Participant (PARAM_PARTICIPANT)
- F_QueueName (PARAM_QUEUE_NAME)
- F_RosterName (PARAM_ROSTER_NAME)
- F_SelectedResponses (PARAM_SELECTED_RESPONSE)
- F_StepDescription (PARAM_STEP_DESCRIPTION)
- F_StepName (PARAM_STEP_NAME)
- F_Subject (PARAM_SUBJECT)
- F_Tag (PARAM_TAG)
- F_WorkClassName (PARAM_WORK_CLASS_NAME)
- F_WorkflowName (PARAM_WORK_CLASS_NAME)
- F_WorkflowNumber (PARAM_WORKFLOW_NUMBER)
- F_WorkObjectName (PARAM_WORK_OBJECT_NAME)
- F_WorkObjectNumber (PARAM_WORK_OBJECT_NUMBER)
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
(either the "F_" or the "PARAM_" values).
- Since:
- IWWS1.00
Field Summary |
static java.lang.String |
PARAM_CANCEL
PARAM_CANCEL maps to "F_Cancel". |
static java.lang.String |
PARAM_COMMENT
PARAM_COMMENT maps to "F_Comment". |
static java.lang.String |
PARAM_COMPLETE
PARAM_COMPLETE maps to "F_Complete". |
static java.lang.String |
PARAM_DATE_RECEIVED
PARAM_DATE_RECEIVED maps to "F_DateReceived". |
static java.lang.String |
PARAM_DEADLINE
PARAM_DEADLINE maps to "F_DeadLine". |
static java.lang.String |
PARAM_EXCEPTION_DESCRIPTION
PARAM_EXCEPTION_DESCRIPTION maps to "F_ExceptionDescription". |
static java.lang.String |
PARAM_EXCEPTION_MAP
PARAM_EXCEPTION_MAP maps to "F_ExceptionMap". |
static java.lang.String |
PARAM_HELP
PARAM_HELP maps to "F_Help". |
static java.lang.String |
PARAM_HISTORY
PARAM_HISTORY maps to "F_History". |
static java.lang.String |
PARAM_LAUNCH_DATE
PARAM_LAUNCH_DATE maps to "F_LaunchDate". |
static java.lang.String |
PARAM_OPERATION_NAME
PARAM_OPERATION_NAME maps to "F_OperationName". |
static java.lang.String |
PARAM_ORIGINATOR
PARAM_ORIGINATOR maps to "F_Originator". |
static java.lang.String |
PARAM_PARTICIPANT
PARAM_PARTICIPANT maps to "F_Participant". |
static java.lang.String |
PARAM_QUEUE_NAME
PARAM_QUEUE_NAME maps to "F_ParticQueueName". |
static java.lang.String |
PARAM_REASSIGN
PARAM_REASSIGN maps to "F_Reassign". |
static java.lang.String |
PARAM_RESPONSES
PARAM_RESPONSES maps to "F_Responses". |
static java.lang.String |
PARAM_RETURN
PARAM_RETURN maps to "F_Return". |
static java.lang.String |
PARAM_ROSTER_NAME
PARAM_ROSTER_NAME maps to "F_RosterName". |
static java.lang.String |
PARAM_SAVE
PARAM_SAVE maps to "F_Save". |
static java.lang.String |
PARAM_SELECTED_RESPONSE
PARAM_SELECTED_RESPONSE maps to "F_SelectedResponse". |
static java.lang.String |
PARAM_STATUS
PARAM_STATUS maps to "F_Status". |
static java.lang.String |
PARAM_STEP_DESCRIPTION
PARAM_STEP_DESCRIPTION maps to "F_StepDescription". |
static java.lang.String |
PARAM_STEP_NAME
PARAM_STEP_NAME maps to "F_StepName". |
static java.lang.String |
PARAM_SUBJECT
PARAM_SUBJECT maps to "F_Subject". |
static java.lang.String |
PARAM_TAG
PARAM_TAG maps to "F_TAG". |
static java.lang.String |
PARAM_WORK_CLASS_NAME
PARAM_WORK_CLASS_NAME maps to "F_WorkClassName". |
static java.lang.String |
PARAM_WORK_OBJECT_NAME
PARAM_WORK_OBJECT_NAME maps to "F_WorkObjectName". |
static java.lang.String |
PARAM_WORK_OBJECT_NUMBER
PARAM_WORK_OBJECT_NUMBER maps to "F_WorkObjectNumber". |
static java.lang.String |
PARAM_WORKFLOW_NAME
PARAM_WORKFLOW_NAME maps to "F_WorkflowName". |
static java.lang.String |
PARAM_WORKFLOW_NUMBER
PARAM_WORKFLOW_NUMBER maps to "F_WorkflowNumber". |
Method Summary |
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. |
PARAM_CANCEL
static final java.lang.String PARAM_CANCEL
- PARAM_CANCEL maps to "F_Cancel". To create a "Cancel" VWButton, specify
either the "F_" or the "PARAM_" values when using the setParameterName()
method (or the ParameterName property, if you are using an IDE that
supports drag-and-drop development).
- See Also:
- Constant Field Values
PARAM_COMMENT
static final java.lang.String PARAM_COMMENT
- PARAM_COMMENT maps to "F_Comment". To create a VWTextArea control (or
one of the other supported controls), specify either the "F_" or the
"PARAM_" values when using the setParameterName() method (or the
ParameterName property, if you are using an IDE that supports
drag-and-drop development).
- See Also:
- Constant Field Values
PARAM_COMPLETE
static final java.lang.String PARAM_COMPLETE
- PARAM_COMPLETE maps to "F_Complete". To create a VWButton control,
specify either the "F_" or the "PARAM_" values when using the
setParameterName() method (or the ParameterName property, if you are
using an IDE that supports drag-and-drop development).
- See Also:
- Constant Field Values
PARAM_DATE_RECEIVED
static final java.lang.String PARAM_DATE_RECEIVED
- PARAM_DATE_RECEIVED maps to "F_DateReceived". To create a VWLabel
control (or one of the other supported controls), specify either the
"F_" or the "PARAM_" values when using the setParameterName() method
(or the ParameterName property, if you are using an IDE that supports
drag-and-drop development).
- See Also:
- Constant Field Values
PARAM_DEADLINE
static final java.lang.String PARAM_DEADLINE
- PARAM_DEADLINE maps to "F_DeadLine". To create a VWLabel control (or
one of the other supported controls), specify either the "F_" or the
"PARAM_" values when using the setParameterName() method (or the
ParameterName property, if you are using an IDE that supports
drag-and-drop development).
- See Also:
- Constant Field Values
PARAM_EXCEPTION_DESCRIPTION
static final java.lang.String PARAM_EXCEPTION_DESCRIPTION
- PARAM_EXCEPTION_DESCRIPTION maps to "F_ExceptionDescription". To create
a VWLabel control (or one of the other supported controls), specify
either the "F_" or the "PARAM_" values when using the setParameterName()
method (or the ParameterName property, if you are using an IDE that
supports drag-and-drop development).
- See Also:
- Constant Field Values
PARAM_EXCEPTION_MAP
static final java.lang.String PARAM_EXCEPTION_MAP
- PARAM_EXCEPTION_MAP maps to "F_ExceptionMap". To create a VWLabel control
(or one of the other supported controls), specify either the "F_" or the
"PARAM_" values when using the setParameterName() method (or the
ParameterName property, if you are using an IDE that supports
drag-and-drop development).
- See Also:
- Constant Field Values
PARAM_HELP
static final java.lang.String PARAM_HELP
- PARAM_HELP maps to "F_Help". To create a VWButton control, specify
either the "F_" or the "PARAM_" values when using the setParameterName()
method (or the ParameterName property, if you are using an IDE that
supports drag-and-drop development)
- See Also:
- Constant Field Values
PARAM_HISTORY
static final java.lang.String PARAM_HISTORY
- PARAM_HISTORY maps to "F_History". To create a VWButton control, specify
either the "F_" or the "PARAM_" values when using the setParameterName()
method (or the ParameterName property, if you are using an IDE that
supports drag-and-drop development)
- See Also:
- Constant Field Values
PARAM_LAUNCH_DATE
static final java.lang.String PARAM_LAUNCH_DATE
- PARAM_LAUNCH_DATE maps to "F_LaunchDate". To create a VWLabel control
(or one of the other supported controls), specify either the "F_" or
the "PARAM_" values when using the setParameterName() method (or the
ParameterName property, if you are using an IDE that supports
drag-and-drop development).
- See Also:
- Constant Field Values
PARAM_OPERATION_NAME
static final java.lang.String PARAM_OPERATION_NAME
- PARAM_OPERATION_NAME maps to "F_OperationName". To create a VWLabel
control (or one of the other supported controls), specify either the
"F_" or the "PARAM_" values when using the setParameterName() method
(or the ParameterName property, if you are using an IDE that supports
drag-and-drop development).
- See Also:
- Constant Field Values
PARAM_STEP_NAME
static final java.lang.String PARAM_STEP_NAME
- PARAM_STEP_NAME maps to "F_StepName". To create a VWLabel control (or
one of the other supported controls), specify either the "F_" or the
"PARAM_" values when using the setParameterName() method (or the
ParameterName property, if you are using an IDE that supports
drag-and-drop development).
- See Also:
- Constant Field Values
PARAM_ORIGINATOR
static final java.lang.String PARAM_ORIGINATOR
- PARAM_ORIGINATOR maps to "F_Originator". To create a VWLabel control (or
one of the other supported controls), specify either the "F_" or the
"PARAM_" values when using the setParameterName() method (or the
ParameterName property, if you are using an IDE that supports
drag-and-drop development).
- See Also:
- Constant Field Values
PARAM_PARTICIPANT
static final java.lang.String PARAM_PARTICIPANT
- PARAM_PARTICIPANT maps to "F_Participant". To create a VWTextArea control
(or one of the other supported controls), specify either the "F_" or the
"PARAM_" values when using the setParameterName() method (or the
ParameterName property, if you are using an IDE that supports
drag-and-drop development).
- See Also:
- Constant Field Values
PARAM_QUEUE_NAME
static final java.lang.String PARAM_QUEUE_NAME
- PARAM_QUEUE_NAME maps to "F_ParticQueueName". To create a VWTextArea
control (or one of the other supported controls), specify either the
"F_" or the "PARAM_" values when using the setParameterName() method
(or the ParameterName property, if you are using an IDE that supports
drag-and-drop development).
- See Also:
- Constant Field Values
PARAM_REASSIGN
static final java.lang.String PARAM_REASSIGN
- PARAM_REASSIGN maps to "F_Reassign". To create a VWButton control,
specify either the "F_" or the "PARAM_" values when using the
setParameterName() method (or the ParameterName property, if you are
using an IDE that supports drag-and-drop development).
- See Also:
- Constant Field Values
PARAM_RESPONSES
static final java.lang.String PARAM_RESPONSES
- PARAM_RESPONSES maps to "F_Responses". To create a ComboBox control,
specify either the "F_" or the "PARAM_" values when using the
setParameterName() method (or the ParameterName property, if you are
using an IDE that supports drag-and-drop development).
- See Also:
- Constant Field Values
PARAM_RETURN
static final java.lang.String PARAM_RETURN
- PARAM_RETURN maps to "F_Return". To create a VWButton control, specify
either the "F_" or the "PARAM_" values when using the setParameterName()
method (or the ParameterName property, if you are using an IDE that
supports drag-and-drop development).
- See Also:
- Constant Field Values
PARAM_ROSTER_NAME
static final java.lang.String PARAM_ROSTER_NAME
- PARAM_ROSTER_NAME maps to "F_RosterName". To create a VWTextField control
(or one of the other supported controls), specify either the "F_" or the
"PARAM_" values when using the setParameterName() method (or the
ParameterName property, if you are using an IDE that supports
drag-and-drop development).
- See Also:
- Constant Field Values
PARAM_SAVE
static final java.lang.String PARAM_SAVE
- PARAM_SAVE maps to "F_Save". To create a VWButton control, specify either
the "F_" or the "PARAM_" values when using the setParameterName() method
(or the ParameterName property, if you are using an IDE that supports
drag-and-drop development).
- See Also:
- Constant Field Values
PARAM_SELECTED_RESPONSE
static final java.lang.String PARAM_SELECTED_RESPONSE
- PARAM_SELECTED_RESPONSE maps to "F_SelectedResponse". To create a
CheckBox control (or one of the other supported controls), specify either
the "F_" or the "PARAM_" values when using the setParameterName() method
(or the ParameterName property, if you are using an IDE that supports
drag-and-drop development).
- See Also:
- Constant Field Values
PARAM_STATUS
static final java.lang.String PARAM_STATUS
- PARAM_STATUS maps to "F_Status". To create a VWButton control, specify
either the "F_" or the "PARAM_" values when using the setParameterName()
method (or the ParameterName property, if you are using an IDE that
supports drag-and-drop development)
- See Also:
- Constant Field Values
PARAM_STEP_DESCRIPTION
static final java.lang.String PARAM_STEP_DESCRIPTION
- PARAM_STEP_DESCRIPTION maps to "F_StepDescription". To create a TextArea
control (or one of the other supported controls), specify either the
"F_" or the "PARAM_" values when using the setParameterName() method
(or the ParameterName property, if you are using an IDE that supports
drag-and-drop development).
- See Also:
- Constant Field Values
PARAM_SUBJECT
static final java.lang.String PARAM_SUBJECT
- PARAM_SUBJECT maps to "F_Subject". To create a TextArea control (or one
of the other supported controls), specify either the "F_" or the
"PARAM_" values when using the setParameterName() method (or the
ParameterName property, if you are using an IDE that supports
drag-and-drop development).
- See Also:
- Constant Field Values
PARAM_TAG
static final java.lang.String PARAM_TAG
- PARAM_TAG maps to "F_TAG". To create a VWLabel control (or one of the
other supported controls), specify either the "F_" or the "PARAM_"
values when using the setParameterName() method (or the ParameterName
property, if you are using an IDE that supports drag-and-drop development).
- See Also:
- Constant Field Values
PARAM_WORK_CLASS_NAME
static final java.lang.String PARAM_WORK_CLASS_NAME
- PARAM_WORK_CLASS_NAME maps to "F_WorkClassName". To create a VWTextField
control (or one of the other supported controls), specify either the "F_"
or the "PARAM_" values when using the setParameterName() method (or the
ParameterName property, if you are using an IDE that supports drag-and-drop
development).
If you want to create a "Work Class Name" control using a form layout tool, specify "F_WorkClassName" for the "ParameterName" property.
- See Also:
- Constant Field Values
PARAM_WORKFLOW_NAME
static final java.lang.String PARAM_WORKFLOW_NAME
- PARAM_WORKFLOW_NAME maps to "F_WorkflowName". To create a VWTextField
control (or one of the other supported controls), specify either the
"F_" or the "PARAM_" values when using the setParameterName() method
(or the ParameterName property, if you are using an IDE that supports
drag-and-drop development).
- See Also:
- Constant Field Values
PARAM_WORKFLOW_NUMBER
static final java.lang.String PARAM_WORKFLOW_NUMBER
- PARAM_WORKFLOW_NUMBER maps to "F_WorkflowNumber". To create a VWTextField
control (or one of the other supported controls), specify either the "F_"
or the "PARAM_" values when using the setParameterName() method (or the
ParameterName property, if you are using an IDE that supports
drag-and-drop development).
If you want to create a "Workflow Number" control using a form layout
tool, specify "F_WorkflowNumber" for the "ParameterName" property.
- See Also:
- Constant Field Values
PARAM_WORK_OBJECT_NAME
static final java.lang.String PARAM_WORK_OBJECT_NAME
- PARAM_WORK_OBJECT_NAME maps to "F_WorkObjectName". To create a
VWTextField control (or one of the other supported controls), specify
either the "F_" or the "PARAM_" values when using the setParameterName()
method (or the ParameterName property, if you are using an IDE that
supports drag-and-drop development).
- See Also:
- Constant Field Values
PARAM_WORK_OBJECT_NUMBER
static final java.lang.String PARAM_WORK_OBJECT_NUMBER
- PARAM_WORK_OBJECT_NUMBER maps to "F_WorkObjectNumber". To create a
VWTextField control (or one of the other supported controls), specify
either the "F_" or the "PARAM_" values when using the setParameterName()
method (or the ParameterName property, if you are using an IDE that
supports drag-and-drop development).
- See Also:
- Constant Field Values
doSave
boolean doSave()
- Completes the workflow step when the step is saved.
- Returns:
- A boolean value; the method returns TRUE if the save operation
succeeded; otherwise, the method returns FALSE.
- Since:
- IWWS1.00
getParameterName
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.
- Returns:
- A string containing the parameter name. See the "PARAM_" constant
field description to see how the "PARAM_" constant maps to a "F_" string
value.
- Since:
- IWWS1.00
setParameterName
void setParameterName(java.lang.String name)
- Sets the string value of the parameter name. This method must be called
for each component.
- Parameters:
name
- A string containing the new name parameter name. Use either
the "PARAM_" or "F_" constant, as shown in the Field Detail section (above).- Since:
- IWWS1.00
setStepElement
void setStepElement(filenet.vw.api.VWStepElement stepElement)
- The VWPanel container calls this method to initialize the control.
- Parameters:
stepElement
- A valid VWStepElement object.- Since:
- IWWS1.00
- See Also:
VWStepElement
© Copyright IBM Corporation 2002, 2008. All rights reserved.