Package com.smartgwt.client.util.workflow

Class AddScreenTask

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.AddScreenTask
All Implemented Interfaces:
HasHandlers
public class AddScreenTask extends ComponentTask
Adds a new screen instance to a Layout, as a new Tab in a TabSet or as a new Section in a SectionStack. When the target is a TabSet or SectionStack, a static title or dynamic titleFormula can be assigned for the new Tab or Section.

The new screen's dataContext can be configured with dataContextBinding evaluated in the scope of this task.

  • Constructor Details

    • AddScreenTask

      public AddScreenTask()

    • AddScreenTask

      public AddScreenTask(JavaScriptObject jsObj)

  • Method Details

    • getOrCreateRef

      public static AddScreenTask getOrCreateRef(JavaScriptObject jsObj)

    • create

      public JavaScriptObject create()
      Overrides:
      create in class ComponentTask

    • setCanClose

      public AddScreenTask setCanClose(Boolean canClose) throws IllegalStateException
      Can the created SectionStackSection or TabSet be closed by the user?
      Parameters:
      canClose - New canClose value. Default value is null
      Returns:
      AddScreenTask instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created

    • getCanClose

      public Boolean getCanClose()
      Can the created SectionStackSection or TabSet be closed by the user?
      Returns:
      Current canClose value. Default value is null

    • setDataContextBinding

      public AddScreenTask setDataContextBinding(DataContextBinding dataContextBinding) throws IllegalStateException
      A DataContextBinding to be applied to the created screen via Canvas.setDataContext().
      Parameters:
      dataContextBinding - New dataContextBinding value. Default value is null
      Returns:
      AddScreenTask instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created

    • getDataContextBinding

      public DataContextBinding getDataContextBinding()
      A DataContextBinding to be applied to the created screen via Canvas.setDataContext().
      Returns:
      Current dataContextBinding value. Default value is null

    • setScreenName

      public AddScreenTask setScreenName(String screenName) throws IllegalStateException
      Name of screen to be added.
      Parameters:
      screenName - New screenName value. Default value is null
      Returns:
      AddScreenTask instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created

    • getScreenName

      public String getScreenName()
      Name of screen to be added.
      Returns:
      Current screenName value. Default value is null

    • setTitle

      public AddScreenTask setTitle(String title) throws IllegalStateException
      Title of new SectionStackSection or TabSet when componentId targets a SectionStack or TabSet. To use a dynamic title see titleFormula.
      Parameters:
      title - New title value. Default value is null
      Returns:
      AddScreenTask instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created

    • getTitle

      public String getTitle()
      Title of new SectionStackSection or TabSet when componentId targets a SectionStack or TabSet. To use a dynamic title see titleFormula.
      Returns:
      Current title value. Default value is null

    • setTitleFormula

      public AddScreenTask setTitleFormula(UserSummary titleFormula) throws IllegalStateException
      Formula to be used to calculate the title contents. Use title property to assign a static title instead.

      Available fields for use in the formula are the current rule context.

      Parameters:
      titleFormula - New titleFormula value. Default value is null
      Returns:
      AddScreenTask instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created

    • getTitleFormula

      public UserSummary getTitleFormula()
      Formula to be used to calculate the 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 titleFormula value. Default value is null