Open topic with navigation

com.hp.lft.sdk.java

# 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.java.UiObjectBaseDescription
        - - com.hp.lft.sdk.java.EditorDescription

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

      public class EditorDescription
      extends UiObjectBaseDescription

  The description of a Java Editor test 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 editor's text.
    `java.lang.Boolean` | `isReadOnly()` Indicates whether the object is read only.
    `void` | `setReadOnly(java.lang.Boolean readOnly)` Sets whether the object is read only.
    `void` | `setText(java.lang.String text)` Sets the editor's text.
    `void` | `setText(StringProperty text)` Sets the editor's text.

    - ### Methods inherited from class com.hp.lft.sdk.java.UiObjectBaseDescription

      `getAbsoluteLocation, getAttachedText, getBackgroundColor, getForegroundColor, getLabel, getLocation, getNativeClass, getObjectName, getPath, getSize, getTagName, isEnabled, isFocused, isVisible, setAbsoluteLocation, setAbsoluteLocation, setAbsoluteLocation, setAttachedText, setAttachedText, setBackgroundColor, setBackgroundColor, setEnabled, setFocused, setForegroundColor, setForegroundColor, setLabel, setLabel, setLocation, setLocation, setLocation, setNativeClass, setNativeClass, setObjectName, setObjectName, setPath, setPath, setSize, setSize, setSize, setTagName, setTagName, setVisible`

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

    - #### setReadOnly

          public void setReadOnly(java.lang.Boolean readOnly)

      Sets whether the object is read only.
      Parameters:
        `readOnly` - true if read only.

    - #### isReadOnly

          public java.lang.Boolean isReadOnly()

      Indicates whether the object is read only.
      Returns:
        true if read only.

    - #### setText

          public void setText(StringProperty text)

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

    - #### setText

          public void setText(java.lang.String text)

      Sets the editor's text.
      Parameters:
        `text` - the text.

    - #### getText

          public StringProperty getText()

      Returns the editor's text.
      Returns:
        the text.