Open topic with navigation

com.hp.lft.sdk.stdwin

## Class WindowDescription

- java.lang.Object
- - com.hp.lft.sdk.internal.PropertiesDescriptionBase
  - - com.hp.lft.sdk.PropertiesDescription
    - - com.hp.lft.sdk.DescriptionBase
      - - com.hp.lft.sdk.stdwin.UiObjectBaseDescription
        - - com.hp.lft.sdk.stdwin.UiObjectWithLayoutInfoDescription
          - - com.hp.lft.sdk.stdwin.WindowDescription

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

      public class WindowDescription
      extends UiObjectWithLayoutInfoDescription

  The description of a standard Windows Window test object.

- - ### Nested Class Summary

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

  - ### Field Summary

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

      `properties`

  - ### Constructor Summary

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

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `java.lang.Boolean` | `hasBorder()` Indicates whether this window has a thin-line border.
    `java.lang.Boolean` | `hasCaption()` Indicates whether the window has a title bar.
    `java.lang.Boolean` | `hasSizebox()` Indicates whether this window has a sizing border.
    `java.lang.Boolean` | `hasSystemMenu()` Indicates whether this window has a window menu on its title bar.
    `java.lang.Boolean` | `isActive()` Indicates whether this window is the foreground object
    `java.lang.Boolean` | `isChildWindow()` Indicates whether this window is a child window.
    `java.lang.Boolean` | `isMaximizable()` Indicates whether this window can be maximized.
    `java.lang.Boolean` | `isMdiChildWindow()` Indicates whether this window is a multiple-document interface (MDI) child window.
    `java.lang.Boolean` | `isMinimizable()` Indicates whether this window can be minimized.
    `java.lang.Boolean` | `isOwnedWindow()` Indicates whether this window has an owner window.
    `java.lang.Boolean` | `isPopupWindow()` Indicates whether this window is a pop-up window.
    `java.lang.Boolean` | `isToolWindow()` Indicates whether this window is a tool window (a window intended to be used as a floating toolbar).
    `java.lang.Boolean` | `isTopmost()` Indicates whether this window is placed above all non-topmost windows and remains in place, even when this window is deactivated.
    `void` | `setActive(java.lang.Boolean isActive)` Sets whether this window is the foreground window.
    `void` | `setBorder(java.lang.Boolean hasBorder)` Sets whether this window has a thin-line border.
    `void` | `setCaption(java.lang.Boolean hasCaption)` Sets whether this window has a title bar property.
    `void` | `setChildWindow(java.lang.Boolean isChildWindow)` Set whether this window is a child window.
    `void` | `setIsMdiChildWindow(java.lang.Boolean isMdiChildWindow)` Set whether this window is a multiple-document interface (MDI) child window.
    `void` | `setMaximizable(java.lang.Boolean isMaximizable)` Sets whether this window can be maximized.
    `void` | `setMinimizable(java.lang.Boolean isMinimizable)` Set whether this window can be minimized.
    `void` | `setOwnedWindow(java.lang.Boolean isOwnedWindow)` Set whether this window has an owner window.
    `void` | `setPopupWindow(java.lang.Boolean isPopupWindow)` Set whether this window is a pop-up window.
    `void` | `setSizebox(java.lang.Boolean hasSizebox)` Sets whether this window has a sizing border.
    `void` | `setSystemMenu(java.lang.Boolean hasSystemMenu)` Sets whether this window has a window menu on its title bar.
    `void` | `setToolWindow(java.lang.Boolean isToolWindow)` Set whether this window is a tool window (a window intended to be used as a floating toolbar).
    `void` | `setTopmost(java.lang.Boolean isTopmost)` Set whether this window is placed above all non-topmost windows and remains in place, even when this window is deactivated.

    - ### Methods inherited from class com.hp.lft.sdk.stdwin.UiObjectWithLayoutInfoDescription

      `isRightAligned, isRightToLeftLayout, isRightToLeftReading, setRightAligned, setRightToLeftLayout, setRightToLeftReading`

    - ### Methods inherited from class com.hp.lft.sdk.stdwin.UiObjectBaseDescription

      `getAbsoluteLocation, getAccessibleName, getAttachedText, getLocation, getNativeClass, getSize, getText, getWindowClassRegExp, getWindowExtendedStyle, getWindowExtendedStyleAsLong, getWindowId, getWindowStyle, getWindowStyleAsLong, getWindowTitleRegExp, isEnabled, isFocused, isVisible, setAbsoluteLocation, setAbsoluteLocation, setAbsoluteLocation, setAccessibleName, setAccessibleName, setAttachedText, setAttachedText, setEnabled, setFocused, setLocation, setLocation, setLocation, setNativeClass, setNativeClass, setSize, setSize, setSize, setText, setText, setVisible, setWindowClassRegExp, setWindowClassRegExp, setWindowExtendedStyle, setWindowExtendedStyle, setWindowId, setWindowStyle, setWindowStyle, setWindowTitleRegExp, setWindowTitleRegExp`

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

    - #### WindowDescription

          public WindowDescription()

      Initializes a new instance of the WindowDescription class.

    - #### WindowDescription

          protected WindowDescription(WindowDescription.Init<?> init)

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

  - ### Method Detail

    - #### setActive

          public void setActive(java.lang.Boolean isActive)

      Sets whether this window is the foreground window.
      Parameters:
        `isActive` - sets whether this is the foreground window.

    - #### isActive

          public java.lang.Boolean isActive()

      Indicates whether this window is the foreground object
      Returns:
        true when this window is the foreground object.

    - #### setBorder

          public void setBorder(java.lang.Boolean hasBorder)

      Sets whether this window has a thin-line border.
      Parameters:
        `hasBorder` - sets whether this window has a thin-line border.

    - #### hasBorder

          public java.lang.Boolean hasBorder()

      Indicates whether this window has a thin-line border.
      Returns:
        true if this window has a thin-line border.

    - #### setCaption

          public void setCaption(java.lang.Boolean hasCaption)

      Sets whether this window has a title bar property.
      Parameters:
        `hasCaption` - sets whether this window has a title bar.

    - #### hasCaption

          public java.lang.Boolean hasCaption()

      Indicates whether the window has a title bar.
      Returns:
        true if this window has a title bar.

    - #### setSizebox

          public void setSizebox(java.lang.Boolean hasSizebox)

      Sets whether this window has a sizing border.
      Parameters:
        `hasSizebox` - sets whether this window has a sizing border.

    - #### hasSizebox

          public java.lang.Boolean hasSizebox()

      Indicates whether this window has a sizing border.
      Returns:
        true if the window has a sizing border.

    - #### setSystemMenu

          public void setSystemMenu(java.lang.Boolean hasSystemMenu)

      Sets whether this window has a window menu on its title bar.
      Parameters:
        `hasSystemMenu` - sets whether this window has a window menu on its title bar.

    - #### hasSystemMenu

          public java.lang.Boolean hasSystemMenu()

      Indicates whether this window has a window menu on its title bar.
      Returns:
        true if this window has a window menu on its title bar.

    - #### setChildWindow

          public void setChildWindow(java.lang.Boolean isChildWindow)

      Set whether this window is a child window.
      Parameters:
        `isChildWindow` - sets whether this window is a child window.

    - #### isChildWindow

          public java.lang.Boolean isChildWindow()

      Indicates whether this window is a child window.
      Returns:
        true if the window is a child window.

    - #### setOwnedWindow

          public void setOwnedWindow(java.lang.Boolean isOwnedWindow)

      Set whether this window has an owner window.
      Parameters:
        `isOwnedWindow` - sets whether this window has an owner window.

    - #### isOwnedWindow

          public java.lang.Boolean isOwnedWindow()

      Indicates whether this window has an owner window.
      Returns:
        true if the window has an owner window.

    - #### setIsMdiChildWindow

          public void setIsMdiChildWindow(java.lang.Boolean isMdiChildWindow)

      Set whether this window is a multiple-document interface (MDI) child window.
      Parameters:
        `isMdiChildWindow` - sets whether this window is a multiple-document interface (MDI) child window.

    - #### isMdiChildWindow

          public java.lang.Boolean isMdiChildWindow()

      Indicates whether this window is a multiple-document interface (MDI) child window.
      Returns:
        true if this window is a multiple-document interface (MDI) child window.

    - #### setPopupWindow

          public void setPopupWindow(java.lang.Boolean isPopupWindow)

      Set whether this window is a pop-up window.
      Parameters:
        `isPopupWindow` - sets whether this window is a pop-up window.

    - #### isPopupWindow

          public java.lang.Boolean isPopupWindow()

      Indicates whether this window is a pop-up window.
      Returns:
        true if the window is a pop-up window.

    - #### setToolWindow

          public void setToolWindow(java.lang.Boolean isToolWindow)

      Set whether this window is a tool window (a window intended to be used as a floating toolbar).
      Parameters:
        `isToolWindow` - sets whether this window is a tool window.

    - #### isToolWindow

          public java.lang.Boolean isToolWindow()

      Indicates whether this window is a tool window (a window intended to be used as a floating toolbar).
      Returns:
        true if this window is a tool window.

    - #### setMaximizable

          public void setMaximizable(java.lang.Boolean isMaximizable)

      Sets whether this window can be maximized.
      Parameters:
        `isMaximizable` - sets whether this window can be maximized.

    - #### isMaximizable

          public java.lang.Boolean isMaximizable()

      Indicates whether this window can be maximized.
      Returns:
        true if this window can be maximized.

    - #### setMinimizable

          public void setMinimizable(java.lang.Boolean isMinimizable)

      Set whether this window can be minimized.
      Parameters:
        `isMinimizable` - sets whether this window can be minimized.

    - #### isMinimizable

          public java.lang.Boolean isMinimizable()

      Indicates whether this window can be minimized.
      Returns:
        true if this window can be minimized.

    - #### setTopmost

          public void setTopmost(java.lang.Boolean isTopmost)

      Set whether this window is placed above all non-topmost windows and remains in place, even when this window is deactivated.
      Parameters:
        `isTopmost` - sets whether this window is placed above all non-topmost windows.

    - #### isTopmost

          public java.lang.Boolean isTopmost()

      Indicates whether this window is placed above all non-topmost windows and remains in place, even when this window is deactivated.
      Returns:
        true if this window is placed above all non-topmost windows.