public class SetPropertiesTask extends ComponentTask
last task output. For a canvas the componentId specifies everything necessary to identify
the target. For a form control more information is needed. The componentId identifies the container (i.e. DynamicForm)
and the individual field is specified as targetFieldName.
SetPropertiesTask is an advanced and rarely used task. If you need a component property to be dynamic, you can configure that property as a Dynamic Property without the need for a Workflow. Dynamic Properties created this way automatically update as your users make changes.
config, configOnly, factoryCreated, factoryProperties, id, scClassName| Constructor and Description |
|---|
SetPropertiesTask() |
SetPropertiesTask(com.google.gwt.core.client.JavaScriptObject jsObj) |
| Modifier and Type | Method and Description |
|---|---|
com.google.gwt.core.client.JavaScriptObject |
create() |
static SetPropertiesTask |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
PropertyValue[] |
getProperties()
Properties and associated values to be set on
componentId. |
java.lang.String |
getTargetFieldName()
If
componentId targets a DynamicForm, this
property optionally specifies the name of the target field. |
SetPropertiesTask |
setProperties(PropertyValue... properties)
Properties and associated values to be set on
componentId. |
SetPropertiesTask |
setTargetFieldName(java.lang.String targetFieldName)
If
componentId targets a DynamicForm, this
property optionally specifies the name of the target field. |
getComponentBaseClass, getComponentBaseClassAsStringArray, getComponentId, getComponentRequiresDataSource, getTargetBaseClass, getTargetBaseClassAsStringArray, getTargetComponent, getTargetComponent, getUnsupportedComponentMessage, setComponentBaseClass, setComponentBaseClass, setComponentId, setComponentRequiresDataSource, setTargetBaseClass, setTargetBaseClass, setUnsupportedComponentMessagecompleteElement, convertToJavaScriptArray, executeElement, getBindOutput, getClassDescription, getComponentReferences, getDescription, getDynamicValue, getEditorType, getElementDescription, getForceSingle, getID, getInvalidTaskMessage, getJsObj, getMockMode, getNextElement, getOrCreateJsObj, getPassThruOutput, getProcessElements, getSupportsMultipleInputRecords, getTextFormulaValue, getTypeTitle, getUndefinedComponentMessage, getUnresolvedComponentMessage, getWaitDuration, getWaitFor, getWaitLocator, isCreated, isValid, objectReferencesLastTaskOutput, onInit, reset, setAttribute, setBindOutput, setClassDescription, setDescription, setEditorType, setForceSingle, setID, setJavaScriptObject, setMockMode, setNextElement, setPassThruOutput, setSupportsMultipleInputRecords, setTypeTitle, setUndefinedComponentMessage, setUnresolvedComponentMessage, setWaitDuration, setWaitFor, setWaitLocator, updateGlobalIDInCriteria, updateGlobalIDInTextFormula, updateGlobalIDInValueProperty, updateGlobalIDInValues, updateGlobalIDReferences, updateLastElementBindingReferences, updateLastElementInCriteria, updateLastElementInValueProperty, updateLastElementInValuesaddDynamicProperty, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, asSGWTComponent, clearDynamicProperty, createJsObj, destroy, doAddHandler, doInit, error, error, errorIfNotCreated, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getClassName, getConfig, getHandlerCount, getRef, getRuleScope, getScClassName, getTestInstance, hasAutoAssignedID, hasDynamicProperty, 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, setRuleScope, setScClassNamepublic SetPropertiesTask()
public SetPropertiesTask(com.google.gwt.core.client.JavaScriptObject jsObj)
public static SetPropertiesTask getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public com.google.gwt.core.client.JavaScriptObject create()
create in class ComponentTaskpublic SetPropertiesTask setProperties(PropertyValue... properties) throws java.lang.IllegalStateException
componentId.properties - New properties value. Default value is nullSetPropertiesTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic PropertyValue[] getProperties()
componentId.public SetPropertiesTask setTargetFieldName(java.lang.String targetFieldName) throws java.lang.IllegalStateException
componentId targets a DynamicForm, this
property optionally specifies the name of the target field.targetFieldName - New targetFieldName value. Default value is nullSetPropertiesTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdFieldNamepublic java.lang.String getTargetFieldName()
componentId targets a DynamicForm, this
property optionally specifies the name of the target field.FieldName