Class EnableDisableTask

All Implemented Interfaces:
HasHandlers

public class EnableDisableTask extends ComponentTask
Enable or disable a button, tab or form field.

For a button the componentId specifies everything necessary to identify the target.

For a tab or form control more information is needed. The componentId identifies the container (i.e. TabSet or DynamicForm) and the individual component is specified as:

See Also:
  • Constructor Details

    • EnableDisableTask

      public EnableDisableTask()
    • EnableDisableTask

      public EnableDisableTask(JavaScriptObject jsObj)
  • Method Details

    • getOrCreateRef

      public static EnableDisableTask getOrCreateRef(JavaScriptObject jsObj)
    • create

      public JavaScriptObject create()
      Overrides:
      create in class ComponentTask
    • setDisable

      public EnableDisableTask setDisable(Boolean disable) throws IllegalStateException
      Should the target be disabled?
      Parameters:
      disable - New disable value. Default value is null
      Returns:
      EnableDisableTask instance, for chaining setter calls
      Throws:
      IllegalStateException - this property cannot be changed after the underlying component has been created
    • getDisable

      public Boolean getDisable()
      Should the target be disabled?
      Returns:
      Current disable value. Default value is null
    • setTargetFieldName

      public EnableDisableTask setTargetFieldName(String targetFieldName) throws IllegalStateException
      Field to enable/disable.
      Parameters:
      targetFieldName - New targetFieldName value. Default value is null
      Returns:
      EnableDisableTask 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()
      Field to enable/disable.
      Returns:
      Current targetFieldName value. Default value is null
      See Also:
    • setTargetTabName

      public EnableDisableTask 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:
      EnableDisableTask 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: