public class SetTitleTask extends ComponentTask
For a label, button or window 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:
targetTabName references the Tab.name.targetSectionName for SectionStackSection.name or targetSectionTitle for SectionStackSection.title.targetFieldName for FormItem.name.config, configOnly, factoryCreated, factoryProperties, id, scClassName| Constructor and Description |
|---|
SetTitleTask() |
SetTitleTask(com.google.gwt.core.client.JavaScriptObject jsObj) |
| Modifier and Type | Method and Description |
|---|---|
com.google.gwt.core.client.JavaScriptObject |
create() |
static SetTitleTask |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
java.lang.String |
getTargetFieldName()
If
componentId targets a DynamicForm, this
property specifies the name of the target field to assign new title. |
java.lang.String |
getTargetSectionName()
If
componentId targets a SectionStack, this
property specifies the name of the target section. |
java.lang.String |
getTargetSectionTitle()
If
componentId targets a SectionStack, this
property specifies the title of the target section. |
java.lang.String |
getTargetTabName()
If
componentId targets a TabSet, this property
specifies the name or ID of the target tab to assign new title. |
UserSummary |
getTextFormula()
Formula to be used to calculate the component title.
|
java.lang.String |
getTitle()
Title to assign to component.
|
SetTitleTask |
setTargetFieldName(java.lang.String targetFieldName)
If
componentId targets a DynamicForm, this
property specifies the name of the target field to assign new title. |
SetTitleTask |
setTargetSectionName(java.lang.String targetSectionName)
If
componentId targets a SectionStack, this
property specifies the name of the target section. |
SetTitleTask |
setTargetSectionTitle(java.lang.String targetSectionTitle)
If
componentId targets a SectionStack, this
property specifies the title of the target section. |
SetTitleTask |
setTargetTabName(java.lang.String targetTabName)
If
componentId targets a TabSet, this property
specifies the name or ID of the target tab to assign new title. |
SetTitleTask |
setTextFormula(UserSummary textFormula)
Formula to be used to calculate the component title.
|
SetTitleTask |
setTitle(java.lang.String title)
Title to assign to component.
|
getComponentBaseClass, getComponentBaseClassAsStringArray, getComponentId, getComponentRequiresDataSource, getTargetComponent, getTargetComponent, setComponentBaseClass, setComponentBaseClass, setComponentId, setComponentRequiresDataSourcecompleteElement, convertToJavaScriptArray, executeElement, getBindOutput, getClassDescription, getDescription, getDynamicValue, getEditorType, getElementDescription, getForceSingle, getID, getJsObj, getMockMode, getNextElement, getOrCreateJsObj, getPassThruOutput, getProcessElements, getSupportsMultipleInputRecords, getTextFormulaValue, getTypeTitle, isCreated, objectReferencesLastTaskOutput, onInit, reset, setAttribute, setBindOutput, setClassDescription, setDescription, setEditorType, setForceSingle, setID, setJavaScriptObject, setMockMode, setNextElement, setPassThruOutput, setSupportsMultipleInputRecords, setTypeTitle, updateGlobalIDInCriteria, 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 SetTitleTask()
public SetTitleTask(com.google.gwt.core.client.JavaScriptObject jsObj)
public static SetTitleTask getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public com.google.gwt.core.client.JavaScriptObject create()
create in class ComponentTaskpublic SetTitleTask setTargetFieldName(java.lang.String targetFieldName) throws java.lang.IllegalStateException
componentId targets a DynamicForm, this
property specifies the name of the target field to assign new title.targetFieldName - New targetFieldName value. Default value is nullSetTitleTask 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 specifies the name of the target field to assign new title.FieldNamepublic SetTitleTask setTargetSectionName(java.lang.String targetSectionName) throws java.lang.IllegalStateException
componentId targets a SectionStack, this
property specifies the name of the target section. Alternately, the target section can be specified by using targetSectionTitle.targetSectionName - New targetSectionName value. Default value is nullSetTitleTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.String getTargetSectionName()
componentId targets a SectionStack, this
property specifies the name of the target section. Alternately, the target section can be specified by using targetSectionTitle.public SetTitleTask setTargetSectionTitle(java.lang.String targetSectionTitle) throws java.lang.IllegalStateException
componentId targets a SectionStack, this
property specifies the title of the target section. Alternately, the target section can be specified by using targetSectionName.targetSectionTitle - New targetSectionTitle value. Default value is nullSetTitleTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic java.lang.String getTargetSectionTitle()
componentId targets a SectionStack, this
property specifies the title of the target section. Alternately, the target section can be specified by using targetSectionName.public SetTitleTask setTargetTabName(java.lang.String targetTabName) throws java.lang.IllegalStateException
componentId targets a TabSet, this property
specifies the name or ID of the target tab to assign new title.targetTabName - New targetTabName value. Default value is nullSetTitleTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdTabNamepublic java.lang.String getTargetTabName()
componentId targets a TabSet, this property
specifies the name or ID of the target tab to assign new title.TabNamepublic SetTitleTask setTextFormula(UserSummary textFormula) throws java.lang.IllegalStateException
title property to assign a static title instead. Available fields for use in the formula are the current rule context.
textFormula - New textFormula value. Default value is nullSetTitleTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdpublic UserSummary getTextFormula()
title property to assign a static title instead. Available fields for use in the formula are the current rule context.
public SetTitleTask setTitle(java.lang.String title) throws java.lang.IllegalStateException
textFormula.title - New title value. Default value is nullSetTitleTask instance, for chaining setter callsjava.lang.IllegalStateException - this property cannot be changed after the underlying component has been createdHTMLStringpublic java.lang.String getTitle()
textFormula.HTMLString