Share this page

com.hp.lft.sdk.te

## Class FieldDescription

- java.lang.Object
- - com.hp.lft.sdk.internal.PropertiesDescriptionBase
  - - com.hp.lft.sdk.PropertiesDescription
    - - com.hp.lft.sdk.DescriptionBase
      - - com.hp.lft.sdk.te.FieldDescription

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

      public class FieldDescription
      extends DescriptionBase

  The description of a terminal emulator field that fully supports HLLAPI.

- - ### Nested Class Summary

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

  - ### Field Summary

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

      `properties`

  - ### Constructor Summary

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

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `StringProperty` | `getAttachedText()` Sets the attached text attribute for TeField.
    `java.lang.Integer` | `getId()` Returns the id value of the field.
    `java.lang.Integer` | `getLength()` Returns the field length in characters.
    `PositionProperty` | `getStartPosition()` Returns the 'start row' and 'start column' attributes for TeField.
    `StringProperty` | `getText()` Sets the content of TeField.
    `java.lang.Boolean` | `isNumeric()` Indicates whether the TeField is numeric.
    `java.lang.Boolean` | `isProtected()` Indicates whether the TeField is protected.
    `java.lang.Boolean` | `isVisible()` Indicates whether the TeField is visible.
    `void` | `setAttachedText(java.lang.String attachedText)` Sets the attached text attribute for TeField.
    `void` | `setAttachedText(StringProperty attachedText)` Sets the attached text attribute for TeField.
    `void` | `setId(java.lang.Integer id)` Sets the id value of the field.
    `void` | `setLength(java.lang.Integer length)` Sets the field length in characters.
    `void` | `setNumeric(java.lang.Boolean numeric)` Sets the numeric attribute for TeField.
    `void` | `setProtected(java.lang.Boolean isProtected)` Sets the protected attribute for TeField.
    `void` | `setStartPosition(java.lang.Integer row, java.lang.Integer column)` Sets the 'start row' and 'start column' attributes for TeField.
    `void` | `setStartPosition(Position position)` Sets the'start row' and 'start column' attributes for TeField.
    `void` | `setStartPosition(PositionProperty position)` Sets the 'start row' and 'start column' attributes for TeField.
    `void` | `setText(java.lang.String text)` Sets the content of TeField.
    `void` | `setText(StringProperty text)` Sets the content of TeField.
    `void` | `setVisible(java.lang.Boolean visible)` Sets the Visible attribute for TeField.

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

    - #### FieldDescription

          public FieldDescription()

      Constructs a new FieldDescription.

    - #### FieldDescription

          protected FieldDescription(FieldDescription.Init<?> init)

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

  - ### Method Detail

    - #### setStartPosition

          public void setStartPosition(PositionProperty position)

      Sets the 'start row' and 'start column' attributes for TeField.
      Parameters:
        `position` - the 'start row' and 'start column' attributes for TeField.

    - #### setStartPosition

          public void setStartPosition(Position position)

      Sets the'start row' and 'start column' attributes for TeField.
      Parameters:
        `position` - the 'start row' and 'start column' attributes for TeField.

    - #### setStartPosition

          public void setStartPosition(java.lang.Integer row,
                                       java.lang.Integer column)

      Sets the 'start row' and 'start column' attributes for TeField.
      Parameters:
        `row` - in pixels.
        `column` - in pixels.

    - #### getStartPosition

          public PositionProperty getStartPosition()

      Returns the 'start row' and 'start column' attributes for TeField.
      Returns:
        the 'start row' and 'start column' attributes for TeField.

    - #### setId

          public void setId(java.lang.Integer id)

      Sets the id value of the field.
      Parameters:
        `id` - the id value of the field

    - #### getId

          public java.lang.Integer getId()

      Returns the id value of the field.
      Returns:
        the id value of the field.

    - #### setLength

          public void setLength(java.lang.Integer length)

      Sets the field length in characters.
      Parameters:
        `length` - the field length in characters.

    - #### getLength

          public java.lang.Integer getLength()

      Returns the field length in characters.
      Returns:
        the field length in characters.

    - #### setAttachedText

          public void setAttachedText(StringProperty attachedText)

      Sets the attached text attribute for TeField.
      Parameters:
        `attachedText` - a StringProperty(or RegExpProperty) representing the attached text attribute for TeField.

    - #### setAttachedText

          public void setAttachedText(java.lang.String attachedText)

      Sets the attached text attribute for TeField.
      Parameters:
        `attachedText` - the attached text attribute for TeField.

    - #### getAttachedText

          public StringProperty getAttachedText()

      Sets the attached text attribute for TeField.
      Returns:
        the attached text attribute for TeField.

    - #### setText

          public void setText(StringProperty text)

      Sets the content of TeField.
      Parameters:
        `text` - a StringProperty(or RegExpProperty) representing the content of TeField.

    - #### setText

          public void setText(java.lang.String text)

      Sets the content of TeField.
      Parameters:
        `text` - the content of TeField.

    - #### getText

          public StringProperty getText()

      Sets the content of TeField.
      Returns:
        the content of TeField.

    - #### setVisible

          public void setVisible(java.lang.Boolean visible)

      Sets the Visible attribute for TeField.
      Parameters:
        `visible` - true if visible.

    - #### isVisible

          public java.lang.Boolean isVisible()

      Indicates whether the TeField is visible.
      Returns:
        true if visible.

    - #### setNumeric

          public void setNumeric(java.lang.Boolean numeric)

      Sets the numeric attribute for TeField.
      Parameters:
        `numeric` - true if numeric.

    - #### isNumeric

          public java.lang.Boolean isNumeric()

      Indicates whether the TeField is numeric.
      Returns:
        true if numeric.

    - #### setProtected

          public void setProtected(java.lang.Boolean isProtected)

      Sets the protected attribute for TeField.
      Parameters:
        `isProtected` - true if protected.

    - #### isProtected

          public java.lang.Boolean isProtected()

      Indicates whether the TeField is protected.
      Returns:
        true if protected.

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: