Package com.smartgwt.client.util.workflow

Class ShowHideTask

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.ShowHideTask
All Implemented Interfaces:
HasHandlers
public class ShowHideTask extends ComponentTask
Show or hide a component. When showing, reveals any hidden parents as well.
See Also:

  • Constructor Details

    • ShowHideTask

      public ShowHideTask()

    • ShowHideTask

      public ShowHideTask(JavaScriptObject jsObj)

  • Method Details

    • getOrCreateRef

      public static ShowHideTask getOrCreateRef(JavaScriptObject jsObj)

    • create

      public JavaScriptObject create()
      Overrides:
      create in class ComponentTask

    • setHide

      public ShowHideTask setHide(Boolean hide) throws IllegalStateException
      Should the target form item be hidden?
      Parameters:
      hide - New hide value. Default value is null
      Returns:
      ShowHideTask instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created

    • getHide

      public Boolean getHide()
      Should the target form item be hidden?
      Returns:
      Current hide value. Default value is null

    • setMoveFocusToTarget

      public ShowHideTask setMoveFocusToTarget(Boolean moveFocusToTarget) throws IllegalStateException
      Should focus be moved to target component when showing?
      Parameters:
      moveFocusToTarget - New moveFocusToTarget value. Default value is null
      Returns:
      ShowHideTask instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created

    • getMoveFocusToTarget

      public Boolean getMoveFocusToTarget()
      Should focus be moved to target component when showing?
      Returns:
      Current moveFocusToTarget value. Default value is null

    • setScrollIntoView

      public ShowHideTask setScrollIntoView(Boolean scrollIntoView) throws IllegalStateException
      Set to false to prevent scrolling the component into view when showing.
      Parameters:
      scrollIntoView - New scrollIntoView value. Default value is null
      Returns:
      ShowHideTask instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created

    • getScrollIntoView

      public Boolean getScrollIntoView()
      Set to false to prevent scrolling the component into view when showing.
      Returns:
      Current scrollIntoView value. Default value is null

    • setShowRecursively

      public ShowHideTask setShowRecursively(Boolean showRecursively) throws IllegalStateException
      Set to false to not show a component's parents.
      Parameters:
      showRecursively - New showRecursively value. Default value is null
      Returns:
      ShowHideTask instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created

    • getShowRecursively

      public Boolean getShowRecursively()
      Set to false to not show a component's parents.
      Returns:
      Current showRecursively value. Default value is null

    • setTargetFieldName

      public ShowHideTask setTargetFieldName(String targetFieldName) throws IllegalStateException
      If componentId targets 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:
      ShowHideTask instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTargetFieldName

      public String getTargetFieldName()
      If componentId targets 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

      public ShowHideTask setTargetSectionName(String targetSectionName) throws IllegalStateException
      If componentId targets a SectionStack, this property specifies the name of the target section. Alternately, the target section can be specified by using targetSectionTitle.
      Parameters:
      targetSectionName - New targetSectionName value. Default value is null
      Returns:
      ShowHideTask instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created

    • getTargetSectionName

      public String getTargetSectionName()
      If componentId targets a SectionStack, this property specifies the name of the target section. Alternately, the target section can be specified by using targetSectionTitle.
      Returns:
      Current targetSectionName value. Default value is null

    • setTargetSectionTitle

      public ShowHideTask setTargetSectionTitle(String targetSectionTitle) throws IllegalStateException
      If componentId targets a SectionStack, this property specifies the title of the target section. Alternately, the target section can be specified by using targetSectionName.
      Parameters:
      targetSectionTitle - New targetSectionTitle value. Default value is null
      Returns:
      ShowHideTask instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created

    • getTargetSectionTitle

      public String getTargetSectionTitle()
      If componentId targets a SectionStack, this property specifies the title of the target section. Alternately, the target section can be specified by using targetSectionName.
      Returns:
      Current targetSectionTitle value. Default value is null

    • setTargetTabName

      public ShowHideTask setTargetTabName(String targetTabName) throws IllegalStateException
      If componentId targets 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:
      ShowHideTask instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
      See Also:

    • getTargetTabName

      public String getTargetTabName()
      If componentId targets 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: