Open topic with navigation

com.hp.lft.sdk.sap.gui

## Class EditorDescription

- java.lang.Object
- - com.hp.lft.sdk.internal.PropertiesDescriptionBase
  - - com.hp.lft.sdk.PropertiesDescription
    - - com.hp.lft.sdk.DescriptionBase
      - - com.hp.lft.sdk.sap.gui.ElementDescription
        - - com.hp.lft.sdk.sap.gui.EditorDescription

- All Implemented Interfaces:
    CloneableObject, Description, com.hp.lft.sdk.internal.DescriptionWithVri, java.lang.Cloneable

      public class EditorDescription
      extends ElementDescription

  Description of a SAP GUI for Windows editable text area object.

- - ### Nested Class Summary

    Modifier and Type | Class and Description
    --- | ---
    `static class` | `EditorDescription.Builder` This class can be used to construct an instance of the EditorDescription class using the builder pattern.
    `protected static class` | `EditorDescription.Init<T extends EditorDescription.Init<T>>` Helper class for EditorDescription.Builder.

  - ### Field Summary

    - ### Fields inherited from class com.hp.lft.sdk.internal.PropertiesDescriptionBase

      `properties`

  - ### Constructor Summary

    Modifier | Constructor and Description
    --- | ---
    `` | `EditorDescription()` Initializes a new instance of the EditorDescription class.
    `protected` | `EditorDescription(EditorDescription.Init<?> init)` Initializes a new instance of the EditorDescription class using the Builder pattern.

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `StringProperty` | `getText()` Returns the text of the editor.
    `java.lang.Boolean` | `isEnabled()` Indicates whether the editor can accept user input.
    `void` | `setEnabled(java.lang.Boolean isEnabled)` Sets whether the editor can accept user input.
    `void` | `setText(java.lang.String text)` Sets the text of the editor.
    `void` | `setText(StringProperty text)` Sets the text of the editor.

    - ### Methods inherited from class com.hp.lft.sdk.sap.gui.ElementDescription

      `getAbsoluteLocation, getId, getLocation, getName, getSize, getType, setAbsoluteLocation, setAbsoluteLocation, setAbsoluteLocation, setId, setId, setLocation, setLocation, setLocation, setName, setName, setSize, setSize, setSize, setType`

    - ### Methods inherited from class com.hp.lft.sdk.DescriptionBase

      `cloneTo, getIndex, getIndexType, getVRI, setIndex, setIndexType, setVRI, setVRI`

    - ### Methods inherited from class com.hp.lft.sdk.PropertiesDescription

      `clone`

    - ### Methods inherited from class com.hp.lft.sdk.internal.PropertiesDescriptionBase

      `getValueAs, getValueAsStringProperty, insertValue`

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

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

    - ### Methods inherited from interface com.hp.lft.sdk.CloneableObject

      `clone`

- - ### Constructor Detail

    - #### EditorDescription

          public EditorDescription()

      Initializes a new instance of the EditorDescription class.

    - #### EditorDescription

          protected EditorDescription(EditorDescription.Init<?> init)

      Initializes a new instance of the EditorDescription class using the Builder pattern.
      Parameters:
        `init` - the Builder pattern.

  - ### Method Detail

    - #### setText

          public void setText(StringProperty text)

      Sets the text of the editor.
      Parameters:
        `text` - a `StringProperty` or `RegExpProperty`.

    - #### setText

          public void setText(java.lang.String text)

      Sets the text of the editor.
      Parameters:
        `text` - the text value of the editor.

    - #### getText

          public StringProperty getText()

      Returns the text of the editor.
      Returns:
        a StringProperty representing the text value of the editor.

    - #### setEnabled

          public void setEnabled(java.lang.Boolean isEnabled)

      Sets whether the editor can accept user input.
      Parameters:
        `isEnabled` - true to set as enabled.

    - #### isEnabled

          public java.lang.Boolean isEnabled()

      Indicates whether the editor can accept user input.
      Returns:
        true if enabled.