Share this page

com.hp.lft.sdk.sap.gui

## Class LabelDescription

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

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

      public class LabelDescription
      extends ElementDescription

  Description of a SAP GUI for Windows label.

- - ### Nested Class Summary

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

  - ### Field Summary

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

      `properties`

  - ### Constructor Summary

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

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `StringProperty` | `getIconName()` Returns the name of the icon used within the label.
    `java.lang.Integer` | `getMaxLength()` Returns the maximum number of characters that can be displayed in the label.
    `StringProperty` | `getRelativeId()` Returns the object's unique identifier relative to the parent window ID in text format.
    `StringProperty` | `getText()` Returns the text of the label.
    `java.lang.Boolean` | `isHighlighted()` Indicates whether the label is highlighted.
    `java.lang.Boolean` | `isNumerical()` Indicates whether the label is a numerical field.
    `void` | `setHighlighted(java.lang.Boolean isHighlighted)` Sets whether the label is highlighted.
    `void` | `setIconName(java.lang.String iconName)` Sets the name of the icon used in the label.
    `void` | `setIconName(StringProperty iconName)` Sets the name of the icon used in the label.
    `void` | `setMaxLength(java.lang.Integer maxLength)` Sets the maximum number of characters that can be displayed in the label.
    `void` | `setNumerical(java.lang.Boolean isNumerical)` Sets whether the label is a numerical field.
    `void` | `setRelativeId(java.lang.String relativeId)` Sets the object's unique identifier relative to the parent window ID.
    `void` | `setRelativeId(StringProperty relativeId)` Sets the object's unique identifier relative to the parent window ID in text format.
    `void` | `setText(java.lang.String text)` Sets the the text of the label.
    `void` | `setText(StringProperty text)` Sets the the text of the label.

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

    - #### LabelDescription

          public LabelDescription()

      Initializes a new instance of the LabelDescription class.

    - #### LabelDescription

          protected LabelDescription(LabelDescription.Init<?> init)

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

  - ### Method Detail

    - #### setText

          public void setText(StringProperty text)

      Sets the the text of the label.
      Parameters:
        `text` - a `StringProperty` or `RegExpProperty`.

    - #### setText

          public void setText(java.lang.String text)

      Sets the the text of the label.
      Parameters:
        `text` - the text.

    - #### getText

          public StringProperty getText()

      Returns the text of the label.
      Returns:
        the text.

    - #### setHighlighted

          public void setHighlighted(java.lang.Boolean isHighlighted)

      Sets whether the label is highlighted.
      Parameters:
        `isHighlighted` - true to set highlighted.

    - #### isHighlighted

          public java.lang.Boolean isHighlighted()

      Indicates whether the label is highlighted.
      Returns:
        true if highlighted.

    - #### setIconName

          public void setIconName(StringProperty iconName)

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

    - #### setIconName

          public void setIconName(java.lang.String iconName)

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

    - #### getIconName

          public StringProperty getIconName()

      Returns the name of the icon used within the label.
      Returns:
        the name of the icon.

    - #### setMaxLength

          public void setMaxLength(java.lang.Integer maxLength)

      Sets the maximum number of characters that can be displayed in the label.
      Parameters:
        `maxLength` - the maximum number of characters.

    - #### getMaxLength

          public java.lang.Integer getMaxLength()

      Returns the maximum number of characters that can be displayed in the label.
      Returns:
        the maximum number of characters.

    - #### setNumerical

          public void setNumerical(java.lang.Boolean isNumerical)

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

    - #### isNumerical

          public java.lang.Boolean isNumerical()

      Indicates whether the label is a numerical field.
      Returns:
        true if numerical field.

    - #### setRelativeId

          public void setRelativeId(StringProperty relativeId)

      Sets the object's unique identifier relative to the parent window ID in text format.
      Parameters:
        `relativeId` - a `StringProperty` or `RegExpProperty`.

    - #### setRelativeId

          public void setRelativeId(java.lang.String relativeId)

      Sets the object's unique identifier relative to the parent window ID.
      Parameters:
        `relativeId` - the UID in text format.

    - #### getRelativeId

          public StringProperty getRelativeId()

      Returns the object's unique identifier relative to the parent window ID in text format.
      Returns:
        the UID in text format.

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: