com.smartgwt.client.util.workflow

## Class SetSectionTitleTask

- 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.SetSectionTitleTask

- All Implemented Interfaces:
    com.google.gwt.event.shared.HasHandlers

      public class SetSectionTitleTask
      extends ComponentTask

  Sets the title of a SectionStack section. The section is identified by specifying either the `targetSectionName` or `targetSectionTitle`.
  See Also:
    `SectionStack.setSectionTitle(java.lang.String, java.lang.String)`

- - ### Field Summary

    - ### Fields inherited from class com.smartgwt.client.core.BaseClass

      `config, configOnly, factoryCreated, factoryProperties, id, scClassName`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `SetSectionTitleTask()`
    `SetSectionTitleTask(com.google.gwt.core.client.JavaScriptObject jsObj)`

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `com.google.gwt.core.client.JavaScriptObject` | `create()`
    `static SetSectionTitleTask` | `getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)`
    `java.lang.String` | `getTargetSectionName()` The name of the target section.
    `java.lang.String` | `getTargetSectionTitle()` The current title of the target section.
    `UserSummary` | `getTextFormula()` Formula to be used to calculate the section title contents.
    `java.lang.String` | `getTitle()` Title to assign to section.
    `SetSectionTitleTask` | `setTargetSectionName(java.lang.String targetSectionName)` The name of the target section.
    `SetSectionTitleTask` | `setTargetSectionTitle(java.lang.String targetSectionTitle)` The current title of the target section.
    `SetSectionTitleTask` | `setTextFormula(UserSummary textFormula)` Formula to be used to calculate the section title contents.
    `SetSectionTitleTask` | `setTitle(java.lang.String title)` Title to assign to section.

    - ### Methods inherited from class com.smartgwt.client.util.workflow.ComponentTask

      `getComponentBaseClass, getComponentBaseClassAsStringArray, getComponentId, getComponentRequiresDataSource, setComponentBaseClass, setComponentBaseClass, setComponentId, setComponentRequiresDataSource`

    - ### Methods inherited from class com.smartgwt.client.util.workflow.ProcessElement

      `convertToJavaScriptArray, getClassDescription, getDescription, getEditorType, getElementDescription, getID, getJsObj, getNextElement, getOrCreateJsObj, getPassThruOutput, getProcessElements, isCreated, onInit, setAttribute, setClassDescription, setDescription, setEditorType, setID, setJavaScriptObject, setNextElement, setPassThruOutput`

    - ### Methods inherited from class com.smartgwt.client.core.BaseClass

      `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`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### SetSectionTitleTask

          public SetSectionTitleTask()

    - #### SetSectionTitleTask

          public SetSectionTitleTask(com.google.gwt.core.client.JavaScriptObject jsObj)

  - ### Method Detail

    - #### getOrCreateRef

          public static SetSectionTitleTask getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)

    - #### create

          public com.google.gwt.core.client.JavaScriptObject create()

      Overrides:
        `create` in class `ComponentTask`

    - #### setTargetSectionName

          public SetSectionTitleTask setTargetSectionName(java.lang.String targetSectionName)
                                                   throws java.lang.IllegalStateException

      The name of the target section.
      Parameters:
        `targetSectionName` - New targetSectionName value. Default value is null
      Returns:
        `SetSectionTitleTask` instance, for chaining setter calls
      Throws:
        `java.lang.IllegalStateException` - this property cannot be changed after the underlying component has been created

    - #### getTargetSectionName

          public java.lang.String getTargetSectionName()

      The name of the target section.
      Returns:
        Current targetSectionName value. Default value is null

    - #### setTargetSectionTitle

          public SetSectionTitleTask setTargetSectionTitle(java.lang.String targetSectionTitle)
                                                    throws java.lang.IllegalStateException

      The current title of the target section.
      Parameters:
        `targetSectionTitle` - New targetSectionTitle value. Default value is null
      Returns:
        `SetSectionTitleTask` instance, for chaining setter calls
      Throws:
        `java.lang.IllegalStateException` - this property cannot be changed after the underlying component has been created

    - #### getTargetSectionTitle

          public java.lang.String getTargetSectionTitle()

      The current title of the target section.
      Returns:
        Current targetSectionTitle value. Default value is null

    - #### setTextFormula

          public SetSectionTitleTask setTextFormula(UserSummary textFormula)
                                             throws java.lang.IllegalStateException

      Formula to be used to calculate the section title contents. Use `title` property 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:
        `SetSectionTitleTask` instance, for chaining setter calls
      Throws:
        `java.lang.IllegalStateException` - this property cannot be changed after the underlying component has been created

    - #### getTextFormula

          public UserSummary getTextFormula()

      Formula to be used to calculate the section title contents. Use `title` property 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

          public SetSectionTitleTask setTitle(java.lang.String title)
                                       throws java.lang.IllegalStateException

      Title to assign to section. To assign a dynamic value see `textFormula`.
      Overrides:
        `setTitle` in class `ProcessElement`
      Parameters:
        `title` - New title value. Default value is null
      Returns:
        `SetSectionTitleTask` instance, for chaining setter calls
      Throws:
        `java.lang.IllegalStateException` - this property cannot be changed after the underlying component has been created
      See Also:
        `HTMLString`

    - #### getTitle

          public java.lang.String getTitle()

      Title to assign to section. To assign a dynamic value see `textFormula`.
      Overrides:
        `getTitle` in class `ProcessElement`
      Returns:
        Current title value. Default value is null
      See Also:
        `HTMLString`