Share this page

com.hp.lft.sdk.web

## Class EditFieldBaseDescription

- java.lang.Object
- - com.hp.lft.sdk.internal.PropertiesDescriptionBase
  - - com.hp.lft.sdk.PropertiesDescription
    - - com.hp.lft.sdk.DescriptionBase
      - - com.hp.lft.sdk.web.WebBaseDescription
        - - com.hp.lft.sdk.web.WebElementDescription
          - - com.hp.lft.sdk.web.FormFieldDescription
            - - com.hp.lft.sdk.web.EditFieldBaseDescription

- All Implemented Interfaces:
    CloneableObject, Description, com.hp.lft.sdk.internal.DescriptionWithVri, java.lang.Cloneable
  Direct Known Subclasses:
    EditFieldDescription, FileFieldDescription

      public abstract class EditFieldBaseDescription
      extends FormFieldDescription

  A base class description for all edit fields (Edit, Number and File).

- - ### Nested Class Summary

    Modifier and Type | Class and Description
    --- | ---
    `protected static class` | `EditFieldBaseDescription.Init<T extends EditFieldBaseDescription.Init<T>>`

    - ### Nested classes/interfaces inherited from class com.hp.lft.sdk.web.WebElementDescription

      `WebElementDescription.Builder`

  - ### Field Summary

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

      `properties`

  - ### Constructor Summary

    Modifier | Constructor and Description
    --- | ---
    `protected` | `EditFieldBaseDescription()`
    `protected` | `EditFieldBaseDescription(EditFieldBaseDescription.Init<?> init)`

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `java.lang.Integer` | `getMaxCharsInLine()` Returns the number of characters that will be presented in each row.
    `StringProperty` | `getPlaceholder()` Returns the hint text that is displayed in the edit box until a value is entered into it.
    `StringProperty` | `getValue()` Returns the current text in the field.
    `java.lang.Boolean` | `isReadOnly()` Returns true if the object is read-only.
    `java.lang.Boolean` | `isEnabled()` Indicates whether the check box is enabled. Supported on UFT Developer versions 15.0.1 and later
    `java.lang.Boolean` | `isRequired()` Returns true if the field is mandatory.
    `void` | `setEnabled(java.lang.Boolean isEnabled)` Sets whether the check box is enabled. Supported on UFT Developer versions 15.0.1 and later
    `void` | `setMaxCharsInLine(java.lang.Integer maxCharsInLine)` Sets the number of characters that will be presented in each row.
    `void` | `setPlaceholder(java.lang.String placeholder)` Sets the hint text that is displayed in the edit box until a value is entered into it.
    `void` | `setPlaceholder(StringProperty placeholder)` Sets the hint text that is displayed in the edit box until a value is entered into it.
    `void` | `setReadOnly(java.lang.Boolean readOnly)` Sets whether or not the control is read only.
    `void` | `setRequired(java.lang.Boolean required)` Sets whether or not the field is mandatory in the form.
    `void` | `setValue(java.lang.String value)` Sets the text in the field.
    `void` | `setValue(StringProperty value)` Sets the text in the field.

    - ### Methods inherited from class com.hp.lft.sdk.web.FormFieldDescription

      `getType, setType, setType`

    - ### Methods inherited from class com.hp.lft.sdk.web.WebElementDescription

      `getAccessibilityName, getCSSSelector, getRole, getXPath, setAccessibilityName, setAccessibilityName, setCSSSelector, setCSSSelector, setRole, setRole, setXPath, setXPath`

    - ### Methods inherited from class com.hp.lft.sdk.web.WebBaseDescription

      `cloneTo, getAbsoluteLocation, getAttributes, getClassName, getId, getInnerHTML, getInnerText, getLocation, getName, getOuterHTML, getOuterText, getSize, getStyles, getTagName, getTitle, isVisible, setAbsoluteLocation, setAbsoluteLocation, setAbsoluteLocation, setAttributes, setClassName, setClassName, setId, setId, setInnerHTML, setInnerHTML, setInnerText, setInnerText, setLocation, setLocation, setLocation, setName, setName, setOuterHTML, setOuterHTML, setOuterText, setOuterText, setSize, setSize, setSize, setStyles, setTagName, setTagName, setTitle, setTitle, setVisible`

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

      `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

    - #### EditFieldBaseDescription

          protected EditFieldBaseDescription(EditFieldBaseDescription.Init<?> init)

    - #### EditFieldBaseDescription

          protected EditFieldBaseDescription()

  - ### Method Detail

    - #### setValue

          public void setValue(StringProperty value)

      Sets the text in the field.
      Parameters:
        `value` - a StringProperty (or RegExpProperty) representing the text in the field.

    - #### setValue

          public void setValue(java.lang.String value)

      Sets the text in the field.
      Parameters:
        `value` - the text in the field.

    - #### getValue

          public StringProperty getValue()

      Returns the current text in the field.
      Returns:
        the current text in the field.

    - #### setPlaceholder

          public void setPlaceholder(StringProperty placeholder)

      Sets the hint text that is displayed in the edit box until a value is entered into it.
      Parameters:
        `placeholder` - a StringProperty (or RegExpProperty) representing the hint text that is displayed in the edit box until a value is entered into it.

    - #### setPlaceholder

          public void setPlaceholder(java.lang.String placeholder)

      Sets the hint text that is displayed in the edit box until a value is entered into it.
      Parameters:
        `placeholder` - the hint text that is displayed in the edit box until a value is entered into it.

    - #### getPlaceholder

          public StringProperty getPlaceholder()

      Returns the hint text that is displayed in the edit box until a value is entered into it.
      Returns:
        the hint text that is displayed in the edit box until a value is entered into it.

    - #### setReadOnly

          public void setReadOnly(java.lang.Boolean readOnly)

      Sets whether or not the control is read only.
      Parameters:
        `readOnly` - whether or not the control is read only.

    - #### isReadOnly

          public java.lang.Boolean isReadOnly()

      Returns true if the object is read-only.
      Returns:
        true if read-only.

    - #### setRequired

          public void setRequired(java.lang.Boolean required)

      Sets whether or not the field is mandatory in the form.
      Parameters:
        `required` - whether or not the field is mandatory in the form.

    - #### isRequired

          public java.lang.Boolean isRequired()

      Returns true if the field is mandatory.
      Returns:
        True if the field is mandatory.

    - #### setEnabled

      Supported on UFT Developer versions 15.0.1 and later

          public void setEnabled(java.lang.Boolean isEnabled)

      Sets whether the check box is enabled.
      Parameters:
        `isEnabled` - true if enabled.

    - #### isEnabled

      Supported on UFT Developer versions 15.0.1 and later

          public java.lang.Boolean isEnabled()

      Indicates whether the check box is enabled.
      Returns:
        true if enabled.

    - #### setMaxCharsInLine

          public void setMaxCharsInLine(java.lang.Integer maxCharsInLine)

      Sets the number of characters that will be presented in each row.
      Parameters:
        `maxCharsInLine` - the number of characters that will be presented in each row.

    - #### getMaxCharsInLine

          public java.lang.Integer getMaxCharsInLine()

      Returns the number of characters that will be presented in each row.
      Returns:
        the number of characters that will be presented in each row.

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: