Package com.hp.lft.sdk.uiapro

Interface WindowPattern

public interface WindowPattern

The methods and properties used to interact with a window control.

Method Summary

Modifier and Type	Method	Description
boolean	canMaximize()
boolean	canMinimize()
void	close()	Attempts to close the current window.
WindowInteractionState	getWindowInteractionState()
WindowVisualState	getWindowVisualState()
boolean	isMaximized()
boolean	isMinimized()
boolean	isModal()
boolean	isTopmost()
void	maximize()	Sets the window visual state to WindowVisualState.Maximized
void	minimize()	Sets the window visual state to WindowVisualState.Minimized
void	restore()	Sets the window visual state to WindowVisualState.Normal
boolean	tryWaitForInputIdle(int milliseconds)	Waits until the object is ready for input or the timeout expires. Note: This method is not supported when you enable the legacy UIA Pro Add-in
void	waitForInputIdle(int milliseconds)	Deprecated.

Method Details

canMaximize

boolean canMaximize()
             throws GeneralLeanFtException

Returns:

Indicates whether the UIA Pro element can be maximized.

Throws:

GeneralLeanFtException - if error occurs during execution.

canMinimize

boolean canMinimize()
             throws GeneralLeanFtException

Returns:

Indicates whether the UIA Pro element can be minimized.

Throws:

GeneralLeanFtException - if error occurs during execution.

isModal

boolean isModal()
         throws GeneralLeanFtException

Returns:

Indicates whether the UIA Pro element is modal.

Throws:

GeneralLeanFtException - if error occurs during execution.

isTopmost

boolean isTopmost()
           throws GeneralLeanFtException

Returns:

Indicates whether the UIA Pro element is the topmost element in the z-order.

Throws:

GeneralLeanFtException - if error occurs during execution.

getWindowInteractionState

WindowInteractionState getWindowInteractionState()
                                          throws GeneralLeanFtException

Returns:

The WindowInteractionState of the UIA Pro element.

Throws:

GeneralLeanFtException - if error occurs during execution.

getWindowVisualState

WindowVisualState getWindowVisualState()
                                throws GeneralLeanFtException

Returns:

Gets the WindowVisualState of the UIA Pro element.

Throws:

GeneralLeanFtException - if error occurs during execution.

isMaximized

boolean isMaximized()
             throws GeneralLeanFtException

Returns:

Indicates whether the UIA Pro visual state is WindowVisualState.Maximized

Throws:

GeneralLeanFtException - if error occurs during execution.

isMinimized

boolean isMinimized()
             throws GeneralLeanFtException

Returns:

Indicates whether the UIA Pro visual state is WindowVisualState.Minimized

Throws:

GeneralLeanFtException - if error occurs during execution.

maximize

void maximize()
       throws GeneralLeanFtException

Sets the window visual state to WindowVisualState.Maximized

Throws:

GeneralLeanFtException - if error occurs during execution.

minimize

void minimize()
       throws GeneralLeanFtException

Sets the window visual state to WindowVisualState.Minimized

Throws:

GeneralLeanFtException - if error occurs during execution.

restore

void restore()
      throws GeneralLeanFtException

Sets the window visual state to WindowVisualState.Normal

Throws:

GeneralLeanFtException - if error occurs during execution.

close

void close()
    throws GeneralLeanFtException

Attempts to close the current window.

Throws:

GeneralLeanFtException - if error occurs during execution.

tryWaitForInputIdle

boolean tryWaitForInputIdle(int milliseconds)
                     throws GeneralLeanFtException

Waits until the object is ready for input or the timeout expires.
Note: This method is not supported when you enable the legacy UIA Pro Add-in

Parameters:

milliseconds - The number of milliseconds to wait for the object to become ready. The maximum is int.MaxValue

Returns:

True if the window is ready for input, False if the timeout expired

Throws:

GeneralLeanFtException - if error occurs during execution.

waitForInputIdle

@Deprecated
void waitForInputIdle(int milliseconds)
               throws GeneralLeanFtException

Deprecated.

Waits until the object is ready for input or the timeout expires.
Note: This method is only supported when you enable the legacy UIA Pro Add-in

Parameters:

milliseconds - The number of milliseconds to wait for the object to become ready. The maximum is int.MaxValue

Throws:

GeneralLeanFtException - if error occurs during execution.