Class SetTitleTask
java.lang.Object
com.smartgwt.client.core.BaseClass
com.smartgwt.client.util.workflow.ProcessElement
com.smartgwt.client.util.workflow.ComponentTask
com.smartgwt.client.util.workflow.SetTitleTask
- All Implemented Interfaces:
HasHandlers
Sets the title of a tab, section, window, label, button, form control or facet chart.
For a label, button, window,
or chart the componentId specifies everything
necessary to identify the target.
For a tab, section or form control more information is needed. The componentId identifies the container (i.e. TabSet,
SectionStack or DynamicForm) and the individual component is specified as:
- Tab -
targetTabNamereferences theTab.name. - Section -
targetSectionNameforSectionStackSection.nameortargetSectionTitleforSectionStackSection.title. - FormItem -
targetFieldNameforFormItem.name.
-
Field Summary
Fields inherited from class com.smartgwt.client.core.BaseClass
config, configOnly, factoryCreated, factoryProperties, id, scClassName -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreate()static SetTitleTaskgetOrCreateRef(JavaScriptObject jsObj) IfcomponentIdtargets a DynamicForm, this property specifies the name of the target field to assign new title.IfcomponentIdtargets a SectionStack, this property specifies the name of the target section.IfcomponentIdtargets a SectionStack, this property specifies the title of the target section.IfcomponentIdtargets a TabSet, this property specifies the name or ID of the target tab to assign new title.Formula to be used to calculate the component title.getTitle()Title to assign to component.setTargetFieldName(String targetFieldName) IfcomponentIdtargets a DynamicForm, this property specifies the name of the target field to assign new title.setTargetSectionName(String targetSectionName) IfcomponentIdtargets a SectionStack, this property specifies the name of the target section.setTargetSectionTitle(String targetSectionTitle) IfcomponentIdtargets a SectionStack, this property specifies the title of the target section.setTargetTabName(String targetTabName) IfcomponentIdtargets a TabSet, this property specifies the name or ID of the target tab to assign new title.setTextFormula(UserSummary textFormula) Formula to be used to calculate the component title.Title to assign to component.Methods inherited from class com.smartgwt.client.util.workflow.ComponentTask
getComponentBaseClass, getComponentBaseClassAsStringArray, getComponentId, getComponentRequiresDataSource, getTargetBaseClass, getTargetBaseClassAsStringArray, getTargetComponent, getTargetComponent, getUnsupportedComponentMessage, setComponentBaseClass, setComponentBaseClass, setComponentId, setComponentRequiresDataSource, setTargetBaseClass, setTargetBaseClass, setUnsupportedComponentMessageMethods inherited from class com.smartgwt.client.util.workflow.ProcessElement
completeElement, 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, updateLastElementInValuesMethods inherited from class com.smartgwt.client.core.BaseClass
addDynamicProperty, 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, setScClassName
-
Constructor Details
-
SetTitleTask
public SetTitleTask() -
SetTitleTask
-
-
Method Details
-
getOrCreateRef
-
create
- Overrides:
createin classComponentTask
-
setTargetFieldName
IfcomponentIdtargets a DynamicForm, this property specifies the name of the target field to assign new title.- Parameters:
targetFieldName- New targetFieldName value. Default value is null- Returns:
SetTitleTaskinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getTargetFieldName
IfcomponentIdtargets a DynamicForm, this property specifies the name of the target field to assign new title.- Returns:
- Current targetFieldName value. Default value is null
- See Also:
-
setTargetSectionName
IfcomponentIdtargets a SectionStack, this property specifies the name of the target section. Alternately, the target section can be specified by usingtargetSectionTitle.- Parameters:
targetSectionName- New targetSectionName value. Default value is null- Returns:
SetTitleTaskinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getTargetSectionName
IfcomponentIdtargets a SectionStack, this property specifies the name of the target section. Alternately, the target section can be specified by usingtargetSectionTitle.- Returns:
- Current targetSectionName value. Default value is null
-
setTargetSectionTitle
IfcomponentIdtargets a SectionStack, this property specifies the title of the target section. Alternately, the target section can be specified by usingtargetSectionName.- Parameters:
targetSectionTitle- New targetSectionTitle value. Default value is null- Returns:
SetTitleTaskinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getTargetSectionTitle
IfcomponentIdtargets a SectionStack, this property specifies the title of the target section. Alternately, the target section can be specified by usingtargetSectionName.- Returns:
- Current targetSectionTitle value. Default value is null
-
setTargetTabName
IfcomponentIdtargets a TabSet, this property specifies the name or ID of the target tab to assign new title.- Parameters:
targetTabName- New targetTabName value. Default value is null- Returns:
SetTitleTaskinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getTargetTabName
IfcomponentIdtargets a TabSet, this property specifies the name or ID of the target tab to assign new title.- Returns:
- Current targetTabName value. Default value is null
- See Also:
-
setTextFormula
Formula to be used to calculate the component title. Usetitleproperty to assign a static title instead.Available fields for use in the formula are the current
rule context.- Parameters:
textFormula- New textFormula value. Default value is null- Returns:
SetTitleTaskinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created
-
getTextFormula
Formula to be used to calculate the component title. Usetitleproperty to assign a static title instead.Available fields for use in the formula are the current
rule context.- Returns:
- Current textFormula value. Default value is null
-
setTitle
Title to assign to component. To assign a dynamic value seetextFormula.- Parameters:
title- New title value. Default value is null- Returns:
SetTitleTaskinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the underlying component has been created- See Also:
-
getTitle
Title to assign to component. To assign a dynamic value seetextFormula.- Returns:
- Current title value. Default value is null
- See Also:
-