Open topic with navigation

com.hp.lft.sdk.stdwin

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

- java.lang.Object
- - com.hp.lft.sdk.DescriptionBase.Init<T>
  - - com.hp.lft.sdk.stdwin.UiObjectBaseDescription.Init<T>

- Direct Known Subclasses:
    ScrollBarDescription.Init, SpinBoxDescription.Init, StatusBarDescription.Init, UiObjectWithLayoutInfoDescription.Init
  Enclosing class:
    UiObjectBaseDescription

      protected abstract static class UiObjectBaseDescription.Init<T extends UiObjectBaseDescription.Init<T>>
      extends DescriptionBase.Init<T>

  Helper class for derived Builder classes.

- - ### Constructor Summary

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

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `T` | `absoluteLocation(java.lang.Integer absX, java.lang.Integer absY)` Sets the object's absolute coordinates relative to the screen (in pixels).
    `T` | `absoluteLocation(LocationProperty absLocation)` Sets the object's absolute coordinates relative to the screen (in pixels).
    `T` | `absoluteLocation(java.awt.Point absLocation)` Sets the object's absolute coordinates relative to the screen (in pixels).
    `T` | `accessibleName(java.lang.String accessibleName)` Sets the object's name, available for windowless objects only.
    `T` | `accessibleName(StringProperty accessibleName)` Sets the object's name, available for windowless objects only.
    `T` | `attachedText(java.lang.String attachedText)` Sets the static text that is attached to this object.
    `T` | `attachedText(StringProperty attachedText)` Sets the static text that is attached to this object.
    `T` | `enabled(java.lang.Boolean isEnabled)` Sets whether the current object is enabled.
    `T` | `focused(java.lang.Boolean isFocused)` Sets whether the current object is focused.
    `T` | `location(java.lang.Integer x, java.lang.Integer y)` Sets the object's coordinates relative to the parent window (in pixels).
    `T` | `location(LocationProperty location)` Sets the object's coordinates relative to the parent window (in pixels).
    `T` | `location(java.awt.Point location)` Sets the object's coordinates relative to the parent window (in pixels).
    `T` | `nativeClass(java.lang.String nativeClass)` Sets the object's window class name.
    `T` | `nativeClass(StringProperty nativeClass)` Initializes the object's window class name.
    `T` | `size(java.awt.Dimension size)` Sets the test object's size (in pixels).
    `T` | `size(java.lang.Integer width, java.lang.Integer height)` Sets the test object's size (in pixels).
    `T` | `size(SizeProperty size)` Sets the test object's size (in pixels).
    `T` | `text(java.lang.String text)` Sets the permanent part of the text associated with the object.
    `T` | `text(StringProperty text)` Sets the permanent part of the text associated with the object.
    `T` | `visible(java.lang.Boolean isVisible)` Sets whether the current element is visible.
    `T` | `windowClassRegExp(java.lang.String windowClassRegExp)` Sets the permanent part of the MFC window class.
    `T` | `windowClassRegExp(StringProperty windowClassRegExp)` Sets the permanent part of the MFC window class.
    `T` | `windowExtendedStyle(java.util.EnumSet<WindowExtendedStyles> windowExtendedStyle)` Sets the extended window style of the object.
    `T` | `windowExtendedStyle(java.lang.Long windowExtendedStyle)` Sets the extended window style of the object as long. Note: the two windowExtendedStyle overloads are mutually exclusive, using both will cause a runtime exception.
    `T` | `windowId(java.lang.Integer windowId)` Sets the object's window identifier.
    `T` | `windowStyle(java.util.EnumSet<WindowStyles> windowStyle)` Sets the window style of the object.
    `T` | `windowStyle(java.lang.Long windowStyle)` Sets the window style of the object as long. Note: the two windowStyle overloads are mutually exclusive, using both will cause a runtime exception.
    `T` | `windowTitleRegExp(java.lang.String windowTitleRegExp)` Sets the permanent part of the constant part of the window title.
    `T` | `windowTitleRegExp(StringProperty windowTitleRegExp)` Sets the permanent part of the constant part of the window title.

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

      `build, 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

    - #### nativeClass

          public T nativeClass(StringProperty nativeClass)

      Initializes the object's window class name.
      Parameters:
        `nativeClass` - a StringProperty (or RegExpProperty) representing the object's window class name.
      Returns:
        the description instance with the update state (builder pattern).

    - #### nativeClass

          public T nativeClass(java.lang.String nativeClass)

      Sets the object's window class name.
      Parameters:
        `nativeClass` - the object's window class name.
      Returns:
        the description instance with the update state (builder pattern).

    - #### windowId

          public T windowId(java.lang.Integer windowId)

      Sets the object's window identifier.
      Parameters:
        `windowId` - object's window identifier.
      Returns:
        the description instance with the update state (builder pattern).

    - #### accessibleName

          public T accessibleName(StringProperty accessibleName)

      Sets the object's name, available for windowless objects only.
      Parameters:
        `accessibleName` - a StringProperty (or RegExpProperty) representing the object's name, available for windowless objects only.
      Returns:
        the description instance with the update state (builder pattern).

    - #### accessibleName

          public T accessibleName(java.lang.String accessibleName)

      Sets the object's name, available for windowless objects only.
      Parameters:
        `accessibleName` - the object's name, available for windowless objects only.
      Returns:
        the description instance with the update state (builder pattern).

    - #### attachedText

          public T attachedText(StringProperty attachedText)

      Sets the static text that is attached to this object.
      Parameters:
        `attachedText` - a StringProperty (or RegExpProperty) representing the static text that is attached to a control.
      Returns:
        the description instance with the update state (builder pattern).

    - #### attachedText

          public T attachedText(java.lang.String attachedText)

      Sets the static text that is attached to this object.
      Parameters:
        `attachedText` - the static text that is attached to a control.
      Returns:
        the description instance with the update state (builder pattern).

    - #### enabled

          public T enabled(java.lang.Boolean isEnabled)

      Sets whether the current object is enabled.
      Parameters:
        `isEnabled` - sets whether the current object is enabled.
      Returns:
        the description instance with the update state (builder pattern).

    - #### focused

          public T focused(java.lang.Boolean isFocused)

      Sets whether the current object is focused.
      Parameters:
        `isFocused` - the indication whether the current object is focused.
      Returns:
        the description instance with the update state (builder pattern).

    - #### windowClassRegExp

          public T windowClassRegExp(StringProperty windowClassRegExp)

      Sets the permanent part of the MFC window class.
      Parameters:
        `windowClassRegExp` - a StringProperty (or RegExpProperty) representing the permanent part of the MFC window class.
      Returns:
        the description instance with the update state (builder pattern).

    - #### windowClassRegExp

          public T windowClassRegExp(java.lang.String windowClassRegExp)

      Sets the permanent part of the MFC window class.
      Parameters:
        `windowClassRegExp` - the permanent part of the MFC window class.
      Returns:
        the description instance with the update state (builder pattern).

    - #### windowTitleRegExp

          public T windowTitleRegExp(StringProperty windowTitleRegExp)

      Sets the permanent part of the constant part of the window title.
      Parameters:
        `windowTitleRegExp` - a StringProperty (or RegExpProperty) representing the constant part of the window title.
      Returns:
        the description instance with the update state (builder pattern).

    - #### windowTitleRegExp

          public T windowTitleRegExp(java.lang.String windowTitleRegExp)

      Sets the permanent part of the constant part of the window title.
      Parameters:
        `windowTitleRegExp` - the constant part of the window title.
      Returns:
        the description instance with the update state (builder pattern).

    - #### visible

          public T visible(java.lang.Boolean isVisible)

      Sets whether the current element is visible.
      Parameters:
        `isVisible` - sets whether the current element is visible.
      Returns:
        the description instance with the update state (builder pattern).

    - #### text

          public T text(StringProperty text)

      Sets the permanent part of the text associated with the object.
      Parameters:
        `text` - a StringProperty (or RegExpProperty) representing text associated with the object.
      Returns:
        the description instance with the update state (builder pattern).

    - #### text

          public T text(java.lang.String text)

      Sets the permanent part of the text associated with the object.
      Parameters:
        `text` - the text associated with the object.
      Returns:
        the description instance with the update state (builder pattern).

    - #### windowExtendedStyle

          public T windowExtendedStyle(java.util.EnumSet<WindowExtendedStyles> windowExtendedStyle)

      Sets the extended window style of the object. Possible values: `WindowExtendedStyles`
      Note: the two windowExtendedStyle overloads are mutually exclusive, using both will cause a runtime exception.
      Parameters:
        `windowExtendedStyle` - the extended window style of the object.
      Returns:
        the extended window style of the object.

    - #### windowStyle

          public T windowStyle(java.util.EnumSet<WindowStyles> windowStyle)

      Sets the window style of the object. Possible values: `WindowStyles`
      Note: the two windowStyle overloads are mutually exclusive, using both will cause a runtime exception.
      Parameters:
        `windowStyle` - the window style of the object. Possible values: `WindowStyles`
      Returns:
        the window style of the object.

    - #### windowExtendedStyle

          public T windowExtendedStyle(java.lang.Long windowExtendedStyle)

      Sets the extended window style of the object as long.
      Note: the two windowExtendedStyle overloads are mutually exclusive, using both will cause a runtime exception.
      Parameters:
        `windowExtendedStyle` - the extended window style of the object as long.
      Returns:
        the extended window style of the object.

    - #### windowStyle

          public T windowStyle(java.lang.Long windowStyle)

      Sets the window style of the object as long.
      Note: the two windowStyle overloads are mutually exclusive, using both will cause a runtime exception.
      Parameters:
        `windowStyle` - the window style of the object as long.
      Returns:
        the window style of the object.

    - #### location

          public T location(java.lang.Integer x,
                            java.lang.Integer y)

      Sets the object's coordinates relative to the parent window (in pixels).
      Parameters:
        `x` - the X coordinate of the test object location.
        `y` - the Y coordinate of the test object location.
      Returns:
        the description instance with the update state (builder pattern).

    - #### location

          public T location(LocationProperty location)

      Sets the object's coordinates relative to the parent window (in pixels).
      Parameters:
        `location` - a LocationProperty representing the object's coordinates relative to the parent window (in pixels).
      Returns:
        the description instance with the update state (builder pattern).

    - #### location

          public T location(java.awt.Point location)

      Sets the object's coordinates relative to the parent window (in pixels).
      Parameters:
        `location` - a Point representing the object's coordinates relative to the parent window (in pixels).
      Returns:
        the description instance with the update state (builder pattern).

    - #### absoluteLocation

          public T absoluteLocation(java.lang.Integer absX,
                                    java.lang.Integer absY)

      Sets the object's absolute coordinates relative to the screen (in pixels). 0,0 is the top-left corner of the (primary) monitor.
      Parameters:
        `absX` - the absolute X coordinate of the test object location.
        `absY` - the absolute Y coordinate of the test object location.
      Returns:
        the description instance with the update state (builder pattern).

    - #### absoluteLocation

          public T absoluteLocation(LocationProperty absLocation)

      Sets the object's absolute coordinates relative to the screen (in pixels). 0,0 is the top-left corner of the (primary) monitor.
      Parameters:
        `absLocation` - a LocationProperty representing the object's absolute coordinates relative to the screen (in pixels).
      Returns:
        the description instance with the update state (builder pattern).

    - #### absoluteLocation

          public T absoluteLocation(java.awt.Point absLocation)

      Sets the object's absolute coordinates relative to the screen (in pixels). 0,0 is the top-left corner of the (primary) monitor.
      Parameters:
        `absLocation` - a Point representing the object's absolute coordinates relative to the screen (in pixels).
      Returns:
        the description instance with the update state (builder pattern).

    - #### size

          public T size(SizeProperty size)

      Sets the test object's size (in pixels).
      Parameters:
        `size` - the test object's size (in pixels).
      Returns:
        the description instance with the update state (builder pattern).

    - #### size

          public T size(java.lang.Integer width,
                        java.lang.Integer height)

      Sets the test object's size (in pixels).
      Parameters:
        `width` - the width of the test object (in pixels).
        `height` - the height of the test object (in pixels).
      Returns:
        the description instance with the update state (builder pattern).

    - #### size

          public T size(java.awt.Dimension size)

      Sets the test object's size (in pixels).
      Parameters:
        `size` - the test object's size (in pixels).
      Returns:
        the description instance with the update state (builder pattern).