Open topic with navigation

com.hp.lft.sdk.sap.gui

## Class LabelDescription.Init<T extends LabelDescription.Init<T>>

- java.lang.Object
- - com.hp.lft.sdk.DescriptionBase.Init<T>
  - - com.hp.lft.sdk.sap.gui.ElementDescription.Init<T>
    - - com.hp.lft.sdk.sap.gui.LabelDescription.Init<T>

- Direct Known Subclasses:
    LabelDescription.Builder
  Enclosing class:
    LabelDescription

      protected abstract static class LabelDescription.Init<T extends LabelDescription.Init<T>>
      extends ElementDescription.Init<T>

  Helper class for LabelDescription.Builder.

- - ### Constructor Summary

    Modifier | Constructor and Description
    --- | ---
    `protected` | `Init()`

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `LabelDescription` | `build()` Returns the built description instance (builder pattern).
    `T` | `highlighted(java.lang.Boolean isHighlighted)` Initializes whether the label is highlighted.
    `T` | `iconName(java.lang.String iconName)` Initializes the name of the icon used in the label.
    `T` | `iconName(StringProperty iconName)` Initializes the name of the icon used in the label.
    `T` | `maxLength(java.lang.Integer maxLength)` Initializes the maximum number of characters that can be displayed in the label.
    `T` | `numerical(java.lang.Boolean isNumerical)` Initializes whether the label is a numerical field.
    `T` | `relativeId(java.lang.String id)` Initializes the object's unique identifier relative to the parent window ID.
    `T` | `relativeId(StringProperty id)` Initializes the object's unique identifier relative to the parent window ID.
    `T` | `text(java.lang.String text)` Initializes the text of the label.
    `T` | `text(StringProperty text)` Initializes the text of the label.

    - ### Methods inherited from class com.hp.lft.sdk.sap.gui.ElementDescription.Init

      `absoluteLocation, absoluteLocation, absoluteLocation, id, id, location, location, location, name, name, size, size, size, type`

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

      `index, self, vri, vri`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### Init

          protected Init()

  - ### Method Detail

    - #### build

          public LabelDescription build()

      Description copied from class: `DescriptionBase.Init`
      Returns the built description instance (builder pattern).
      Overrides:
        `build` in class `ElementDescription.Init<T extends LabelDescription.Init<T>>`
      Returns:
        The built description instance (builder pattern).

    - #### text

          public T text(StringProperty text)

      Initializes the text of the label.
      Parameters:
        `text` - a `StringProperty` or `RegExpProperty`.
      Returns:
        the description instance with the update state (builder pattern).

    - #### text

          public T text(java.lang.String text)

      Initializes the text of the label.
      Parameters:
        `text` - the text.
      Returns:
        the description instance with the update state (builder pattern).

    - #### highlighted

          public T highlighted(java.lang.Boolean isHighlighted)

      Initializes whether the label is highlighted.
      Parameters:
        `isHighlighted` - true to set as highlighted.
      Returns:
        the description instance with the update state (builder pattern).

    - #### iconName

          public T iconName(StringProperty iconName)

      Initializes the name of the icon used in the label.
      Parameters:
        `iconName` - a `StringProperty` or `RegExpProperty`.
      Returns:
        the description instance with the update state (builder pattern).

    - #### iconName

          public T iconName(java.lang.String iconName)

      Initializes the name of the icon used in the label.
      Parameters:
        `iconName` - the name of the icon.
      Returns:
        the description instance with the update state (builder pattern).

    - #### maxLength

          public T maxLength(java.lang.Integer maxLength)

      Initializes the maximum number of characters that can be displayed in the label.
      Parameters:
        `maxLength` - the maximum number of characters.
      Returns:
        the description instance with the update state (builder pattern).

    - #### numerical

          public T numerical(java.lang.Boolean isNumerical)

      Initializes whether the label is a numerical field.
      Parameters:
        `isNumerical` - true to set as numerical field.
      Returns:
        the description instance with the update state (builder pattern).

    - #### relativeId

          public T relativeId(StringProperty id)

      Initializes the object's unique identifier relative to the parent window ID.
      Parameters:
        `id` - a `StringProperty` or `RegExpProperty`.
      Returns:
        the description instance with the update state (builder pattern).

    - #### relativeId

          public T relativeId(java.lang.String id)

      Initializes the object's unique identifier relative to the parent window ID.
      Parameters:
        `id` - the object's unique identifier.
      Returns:
        the description instance with the update state (builder pattern).