public class UserTask extends Task
A UserTask takes the following steps:
targetView DynamicForm designated as the
targetForm or to a ValuesManager designated as the targetVM, via setValues() SubmitItem is pressed in either the targetForm or any form
that is a member of the targetVM. Likewise a CancelItem triggers cancellation. Direct calls to
DynamicForm.cancelEditing() or DynamicForm.completeEditing() achieve the same result.
cancelElement config, configOnly, factoryCreated, factoryProperties, id, scClassName| Constructor and Description |
|---|
UserTask() |
UserTask(com.google.gwt.core.client.JavaScriptObject jsObj) |
| Modifier and Type | Method and Description |
|---|---|
void |
cancelEditing()
Revert any changes made in a form and finish this userTask execution.
|
void |
completeEditing()
Finish editing and store edited values in
process state. |
com.google.gwt.core.client.JavaScriptObject |
create() |
java.lang.String |
getCancelElement()
Next element to proceed to if the task is cancelled because the
targetForm or targetVM had cancelEditing() called on it. |
Canvas |
getInlineView()
An inline definition of the form.
|
static UserTask |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
java.lang.String |
getPreviousElement()
|
java.lang.Boolean |
getSaveToServer()
If saveToServer is set then associated form will perform the normal
DynamicForm.submit() actions when called (typically from a SubmitItem). |
DynamicForm |
getTargetForm()
DynamicForm that should be populated with data and that should provide the data for the task outputs.
|
Canvas |
getTargetView()
Optional widget that should be shown to allow user input.
|
ValuesManager |
getTargetVM()
Optional ValuesManager which will receive task inputs and provide task outputs.
|
java.lang.Boolean |
getWizard()
If wizard is set then associated form will be hidden after user goes to next or prev step of current workflow.
|
void |
goToPrevious()
Set
previousElement as next element of workflow. |
void |
setCancelElement(java.lang.String cancelElement)
Next element to proceed to if the task is cancelled because the
targetForm or targetVM had cancelEditing() called on it. |
void |
setInlineView(Canvas inlineView)
An inline definition of the form.
|
void |
setPreviousElement(java.lang.String previousElement)
|
void |
setSaveToServer(java.lang.Boolean saveToServer)
If saveToServer is set then associated form will perform the normal
DynamicForm.submit() actions when called (typically from a SubmitItem). |
void |
setTargetForm(DynamicForm targetForm)
DynamicForm that should be populated with data and that should provide the data for the task outputs.
|
void |
setTargetView(Canvas targetView)
Optional widget that should be shown to allow user input.
|
void |
setTargetView(java.lang.String targetView)
Optional widget that should be shown to allow user input.
|
void |
setTargetVM(java.lang.String targetVM)
Optional ValuesManager which will receive task inputs and provide task outputs.
|
void |
setTargetVM(ValuesManager targetVM)
Optional ValuesManager which will receive task inputs and provide task outputs.
|
void |
setWizard(java.lang.Boolean wizard)
If wizard is set then associated form will be hidden after user goes to next or prev step of current workflow.
|
getInputField, getInputFieldList, getOutputField, getOutputFieldList, setInputField, setInputFieldList, setOutputField, setOutputFieldListconvertToJavaScriptArray, getID, getJsObj, getNextElement, getOrCreateJsObj, getProcessElements, isCreated, onInit, setAttribute, setID, setJavaScriptObject, setNextElementapplyFactoryProperties, asSGWTComponent, createJsObj, destroy, doAddHandler, doInit, error, error, errorIfNotCreated, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getClassName, getConfig, getHandlerCount, getRef, getScClassName, getTestInstance, hasAutoAssignedID, internalSetID, internalSetID, isConfigOnly, isFactoryCreated, onBind, registerID, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setFactoryCreated, setProperty, setProperty, setProperty, setProperty, setScClassNamepublic UserTask()
public UserTask(com.google.gwt.core.client.JavaScriptObject jsObj)
public static UserTask getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public void setCancelElement(java.lang.String cancelElement)
throws java.lang.IllegalStateException
targetForm or targetVM had cancelEditing() called on it.cancelElement - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.String getCancelElement()
targetForm or targetVM had cancelEditing() called on it.public void setInlineView(Canvas inlineView)
inlineView - Default value is nullpublic Canvas getInlineView()
public void setPreviousElement(java.lang.String previousElement)
throws java.lang.IllegalStateException
sequence or element that is helpful for wizards. This element will be
executed if goToPrevious() method of userTask will be
invoked. You can get userTask for attached form by using userTask property.previousElement - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.String getPreviousElement()
sequence or element that is helpful for wizards. This element will be
executed if goToPrevious() method of userTask will be
invoked. You can get userTask for attached form by using userTask property.public void setSaveToServer(java.lang.Boolean saveToServer)
throws java.lang.IllegalStateException
DynamicForm.submit() actions when called (typically from a SubmitItem). By default the form submit action is bypassed.saveToServer - Default value is falsejava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.Boolean getSaveToServer()
DynamicForm.submit() actions when called (typically from a SubmitItem). By default the form submit action is bypassed.public void setTargetForm(DynamicForm targetForm) throws java.lang.IllegalStateException
Use targetVM to use a ValuesManager instead.
targetForm - Default value is nulljava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic DynamicForm getTargetForm()
Use targetVM to use a ValuesManager instead.
public void setWizard(java.lang.Boolean wizard)
throws java.lang.IllegalStateException
wizard - Default value is falsejava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.Boolean getWizard()
public void cancelEditing()
cancelElement will be proceed as the next element of
current process.public void completeEditing()
process state.public void goToPrevious()
previousElement as next element of workflow.
This method could be used to create wizard-like UI behavior.public void setTargetView(Canvas targetView)
targetForm unless either
targetForm or targetVM is set.
UserTask will automatically handle various scenarios of the targetView being not currently
visible or draw()n, according to the following rules:
pane of a tab in a TabSet, the tab will be selected items for a which is either
collapsed or hidden section, the section will be shown and expanded items for a Window, the Window will be shown targetView - targetView Default value is nullpublic Canvas getTargetView()
targetForm unless either
targetForm or targetVM is set.
UserTask will automatically handle various scenarios of the targetView being not currently
visible or draw()n, according to the following rules:
pane of a tab in a TabSet, the tab will be selected items for a which is either
collapsed or hidden section, the section will be shown and expanded items for a Window, the Window will be shown public void setTargetView(java.lang.String targetView)
targetForm unless either
targetForm or targetVM is set.
UserTask will automatically handle various scenarios of the targetView being not currently
visible or draw()n, according to the following rules:
pane of a tab in a TabSet, the tab will be selected items for a which is either
collapsed or hidden section, the section will be shown and expanded items for a Window, the Window will be shown targetView - targetView Default value is nullpublic void setTargetVM(ValuesManager targetVM)
targetForm instead of you want to use a DynamicForm.targetVM - targetVM Default value is nullpublic ValuesManager getTargetVM()
targetForm instead of you want to use a DynamicForm.public void setTargetVM(java.lang.String targetVM)
targetForm instead of you want to use a DynamicForm.targetVM - targetVM Default value is null