Share this page

com.hp.lft.sdk.web

## 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.web.WebBaseDescription
        - - com.hp.lft.sdk.web.WebElementDescription
          - - com.hp.lft.sdk.web.FormFieldDescription
            - - com.hp.lft.sdk.web.EditFieldBaseDescription
              - - com.hp.lft.sdk.web.EditFieldDescription

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

      public class EditFieldDescription
      extends EditFieldBaseDescription

  The description of the base interface for Web edit fields, such as, edit, number, and file fields.

- - ### 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` | `getDefaultValue()` Returns the default value that will be displayed in the edit field.
    `java.lang.Integer` | `getMaxLength()` Returns the maximum number of characters that can be entered in the input field.
    `StringProperty` | `getPattern()` Returns the input pattern, for example, a phone number.
    `java.lang.Integer` | `getRowsCount()` Returns the number of rows for multi-line objects.
    `void` | `setDefaultValue(java.lang.String defaultValue)` Sets the default value that will be presented in the edit field.
    `void` | `setDefaultValue(StringProperty defaultValue)` Sets the default value that will be presented in the edit field.
    `void` | `setMaxLength(java.lang.Integer maxLength)` Sets the maximum number of characters that can be entered in the input field.
    `void` | `setPattern(java.lang.String pattern)` Sets the input pattern, for example, a phone number.
    `void` | `setPattern(StringProperty pattern)` Sets the input pattern, for example, a phone number.
    `void` | `setRowsCount(java.lang.Integer rowsCount)` Sets the number of rows for multi-line objects.

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

      `getMaxCharsInLine, getPlaceholder, getValue, isEnabled, isReadOnly, isRequired, setEnabled, setMaxCharsInLine, setPlaceholder, setPlaceholder, setReadOnly, setRequired, setValue, setValue`

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

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

    - #### setDefaultValue

          public void setDefaultValue(StringProperty defaultValue)

      Sets the default value that will be presented in the edit field.
      Parameters:
        `defaultValue` - a StringProperty (or RegExpProperty) representing the default value that will be presented in the edit field.

    - #### setDefaultValue

          public void setDefaultValue(java.lang.String defaultValue)

      Sets the default value that will be presented in the edit field.
      Parameters:
        `defaultValue` - the default value that will be presented in the edit field.

    - #### getDefaultValue

          public StringProperty getDefaultValue()

      Returns the default value that will be displayed in the edit field.
      Returns:
        the default value that will be displayed in the edit field.

    - #### setMaxLength

          public void setMaxLength(java.lang.Integer maxLength)

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

    - #### getMaxLength

          public java.lang.Integer getMaxLength()

      Returns the maximum number of characters that can be entered in the input field.
      Returns:
        the maximum number of characters that can be entered in the input field.

    - #### setPattern

          public void setPattern(StringProperty pattern)

      Sets the input pattern, for example, a phone number.
      Parameters:
        `pattern` - a StringProperty (or RegExpProperty) representing the pattern of the input.

    - #### setPattern

          public void setPattern(java.lang.String pattern)

      Sets the input pattern, for example, a phone number.
      Parameters:
        `pattern` - the pattern of the input.

    - #### getPattern

          public StringProperty getPattern()

      Returns the input pattern, for example, a phone number.
      Returns:
        the input pattern.

    - #### setRowsCount

          public void setRowsCount(java.lang.Integer rowsCount)

      Sets the number of rows for multi-line objects.
      Parameters:
        `rowsCount` - the number of rows for multi-line objects.

    - #### getRowsCount

          public java.lang.Integer getRowsCount()

      Returns the number of rows for multi-line objects.
      Returns:
        the number of rows for multi-line objects.

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: