Share this page

com.hp.lft.sdk.sap.gui

## Class EditFieldDescription

- 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.EditFieldDescription

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

      public class EditFieldDescription
      extends ElementDescription

  Description of a SAP GUI for Windows edit box.

- - ### Nested Class Summary

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

  - ### Field Summary

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

      `properties`

  - ### Constructor Summary

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

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `StringProperty` | `getAttachedText()` Returns the static text attached to the edit field.
    `StringProperty` | `getIconName()` Returns the name of the icon used in the edit box.
    `java.lang.Integer` | `getMaxLength()` Returns the maximum number of characters that can be entered in the edit box.
    `StringProperty` | `getText()` Returns the text string value of the object.
    `java.lang.Boolean` | `isEnabled()` Indicates whether the object can accept user input.
    `java.lang.Boolean` | `isHighlighted()` Indicates whether whether the edit box is highlighted.
    `java.lang.Boolean` | `isNumerical()` Returns the whether the edit box is a numerical field.
    `java.lang.Boolean` | `isRequired()` Returns the whether the edit box is required.
    `void` | `setAttachedText(java.lang.String attachedText)` Sets the static text attached to the edit field.
    `void` | `setAttachedText(StringProperty attachedText)` Sets the static text attached to the edit field.
    `void` | `setEnabled(java.lang.Boolean isEnabled)` Sets whether the object can accept user input.
    `void` | `setHighlighted(java.lang.Boolean isHighlighted)` Sets whether whether the edit box is highlighted.
    `void` | `setIconName(java.lang.String iconName)` Sets the name of the icon used in the edit box.
    `void` | `setIconName(StringProperty iconName)` Sets the name of the icon used in the edit box.
    `void` | `setMaxLength(java.lang.Integer maxLength)` Sets the maximum number of characters that can be entered in the edit box.
    `void` | `setNumerical(java.lang.Boolean isNumerical)` Sets whether whether the edit box is a numerical field.
    `void` | `setRequired(java.lang.Boolean isRequired)` Sets the whether the edit box is required.
    `void` | `setText(java.lang.String text)` Sets the text string value of the object.
    `void` | `setText(StringProperty text)` Sets the text string value of the object.

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

    - #### EditFieldDescription

          public EditFieldDescription()

      Initializes a new instance of the EditFieldDescription class.

    - #### EditFieldDescription

          protected EditFieldDescription(EditFieldDescription.Init<?> init)

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

  - ### Method Detail

    - #### setAttachedText

          public void setAttachedText(StringProperty attachedText)

      Sets the static text attached to the edit field.
      Parameters:
        `attachedText` - a `StringProperty` or `RegExpProperty`.

    - #### setAttachedText

          public void setAttachedText(java.lang.String attachedText)

      Sets the static text attached to the edit field.
      Parameters:
        `attachedText` - the static text.

    - #### getAttachedText

          public StringProperty getAttachedText()

      Returns the static text attached to the edit field.
      Returns:
        the static text.

    - #### setEnabled

          public void setEnabled(java.lang.Boolean isEnabled)

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

    - #### isEnabled

          public java.lang.Boolean isEnabled()

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

    - #### setHighlighted

          public void setHighlighted(java.lang.Boolean isHighlighted)

      Sets whether whether the edit box is highlighted.
      Parameters:
        `isHighlighted` - true to set as highlighted.

    - #### isHighlighted

          public java.lang.Boolean isHighlighted()

      Indicates whether whether the edit box is highlighted.
      Returns:
        true if highlighted.

    - #### setIconName

          public void setIconName(StringProperty iconName)

      Sets the name of the icon used in the edit box.
      Parameters:
        `iconName` - a `StringProperty` or `RegExpProperty`.

    - #### setIconName

          public void setIconName(java.lang.String iconName)

      Sets the name of the icon used in the edit box.
      Parameters:
        `iconName` - the name of the icon.

    - #### getIconName

          public StringProperty getIconName()

      Returns the name of the icon used in the edit box.
      Returns:
        the name of the icon.

    - #### setMaxLength

          public void setMaxLength(java.lang.Integer maxLength)

      Sets the maximum number of characters that can be entered in the edit box.
      Parameters:
        `maxLength` - the maximum number of characters.

    - #### getMaxLength

          public java.lang.Integer getMaxLength()

      Returns the maximum number of characters that can be entered in the edit box.
      Returns:
        the maximum number of characters.

    - #### setNumerical

          public void setNumerical(java.lang.Boolean isNumerical)

      Sets whether whether the edit box is a numerical field.
      Parameters:
        `isNumerical` - true to set as numerical field

    - #### isNumerical

          public java.lang.Boolean isNumerical()

      Returns the whether the edit box is a numerical field.
      Returns:
        true if numerical field

    - #### setRequired

          public void setRequired(java.lang.Boolean isRequired)

      Sets the whether the edit box is required.
      Parameters:
        `isRequired` - true to set as required.

    - #### isRequired

          public java.lang.Boolean isRequired()

      Returns the whether the edit box is required.
      Returns:
        true if required.

    - #### setText

          public void setText(StringProperty text)

      Sets the text string value of the object.
      Parameters:
        `text` - a `StringProperty` or `RegExpProperty`.

    - #### setText

          public void setText(java.lang.String text)

      Sets the text string value of the object.
      Parameters:
        `text` - the text.

    - #### getText

          public StringProperty getText()

      Returns the text string value of the object.
      Returns:
        a StringProperty representing the text string value of the object.

Tips to improve your search results... UFT Developer Java SDK Reference Version 15.0-15.0.2 UFT Developer SDK Reference All View Local Help Center View Online Help Center back Go back in browser history forward Go forward in browser history Remove search highlights next topic Go to next topic previous topic Go to previous topic Print the current topic Version: