public class SapWindow extends SapComponent implements IMoveable
Modifier | Constructor and Description |
---|---|
protected |
SapWindow(JtfObjectHandle handle,
Desktop desktop)
Creates a new SapWindow with a JtfObjectHandle.
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Closes the window.
|
void |
closeSynchron()
Closes the window and waits until the window is closed.
|
void |
closeSynchron(boolean closeConfirm)
Closes the window and waits until the window is closed.
|
List<IMoveable> |
getCloseWindows()
Returns the windows that need to be closed in order so that only the main window of the application is open.
|
TestObject |
getFocus()
Returns the object with the input focus.
|
SapComponent |
getGuiFocus()
Gets the element within SAP GUI that currently has the focus.
|
IMoveable |
getNextCloseWindow()
Returns the next window that need to be closed in order to close all windows of the application except the main window.
|
SapComponent |
getSystemFocus()
Gets the element within SAP GUI that has the focus from the server application's perspective.
|
int |
getWindowHandle()
Gets the window handle of the control that is connected to the GuiShell.
|
int |
getWindowState()
Gets the state of a window.
|
int |
getWorkingPaneHeight()
Gets the current height of the working pane.
|
int |
getWorkingPaneWidth()
Gets the current width of the working pane.
|
boolean |
isActive()
Returns whether the window is set to active.
|
boolean |
isButtonbarVisible()
Gets whether the application toolbar, the lower toolbar within SAP GUI, is visible.
|
boolean |
isStatusbarVisible()
Gets whether the statusbar is visible.
|
boolean |
isTitlebarVisible()
Gets whether the titlebar is visible.
|
boolean |
isToolbarVisible()
Gets whether the toolbar is visible.
|
boolean |
isVkeyAllowed(VKey vkey)
The method returns True if the given virtual key can be executed on the current screen.
|
void |
jumpBackward()
Execute the Ctrl+Shift+Tab key on the window to jump backward one block.
|
void |
jumpForward()
Execute the Ctrl+Tab key on the window to jump forward one block.
|
void |
maximize()
Maximizes the window.
|
void |
minimize()
Reduces the window to an icon.
|
void |
move(Point pos)
Moves the window.
|
void |
resizeWorkingPane(int width,
int height,
boolean throwOnFail)
The ResizeWorkingPane function will resize the window so that the available working area has the given width and height in character metric.
|
void |
resizeWorkingPaneEx(int width,
int height,
boolean throwOnFail)
The ResizeWorkingPaneEx function will resize the window so that the available working area has the given width and height in pixels.
|
void |
restore()
Restores the window to its previous size.
|
void |
sendVKey(VKey vkey)
Send a virtual key to the system.
|
void |
setActive()
Makes the window active.
|
void |
size(int width,
int height)
Resizes the window.
|
void |
tabBackward()
Execute the Shift+Tab key on the window to jump backward one element.
|
void |
tabForward()
Execute the Tab key on the window to jump forward one element.
|
getAccessibilityText, getAccessibilityTextOnRequest, getAccessibilityTooltip, getDefaultTooltip, getHeight, getIconName, getLeft, getName, getScreenLeft, getScreenTop, getTooltip, getTop, getWidth, isChangeable, isFocused, isModified, isSymbolFont, setFocus, showContextMenu
captureBitmap, captureBitmap, exists, exists, generateLocator, getChildren, getDynamicMethodList, getParent, getPropertyList, getRect, getRect, getText, getValue, highlightObject, highlightObject, highlightObject, invokeMethods, textCapture, textCapture, textClick, textClick, textClick, textClick, textClick, textClick, textExists, textExists, textExists, textExists, textExists, textRectangle, textRectangle, textRectangle, textRectangle, textRectangle, waitForChildDisappearance, waitForChildDisappearance, waitForDisappearance, waitForDisappearance, waitForObject, waitForObject, waitForProperty, waitForProperty
equals, exists, find, find, findAll, findAll, getCustomTypeName, getDesktop, getHandle, getLocator, getProperty, getTypeName, hashCode, imageClick, imageClick, imageClick, imageClick, imageClick, imageClick, imageClickFile, imageClickFile, imageClickFile, imageClickFile, imageClickFile, imageClickFile, imageExists, imageExists, imageExists, imageExistsFile, imageExistsFile, imageExistsFile, imageRectangle, imageRectangle, imageRectangle, imageRectangleFile, imageRectangleFile, imageRectangleFile, invoke, preventFinalLocator, setProperty, toString
protected SapWindow(JtfObjectHandle handle, Desktop desktop)
handle
- the handle that identifies the SapWindowdesktop
- the desktop on which this object livespublic void closeSynchron()
The method attempts to close the window by trying the following events, in this sequence, stopping when the window closes:
close()
method on the window.closeConfirm
parameter is set to true
: Click the list of buttons specified with the option OPT_CLOSE_WINDOW_BUTTONS.This method supports several specifications you can make to help the Open Agent closes a window. You can make these specification by use Desktop.setOption(String, Object) to set the appropriate values for the mentioned options. For example, if closing the window opens a confirmation dialog with a button that contains the text "Do not save" use:
desktop.setOption(CommonOptions.OPT_CLOSE_CONFIRM_BUTTONS, Arrays.asList("Do not save"));
Close may fail. For example, if closing a window causes the application to display a message box and closeConfirm is set to false
, or if the buttons used to close the message box are not covered under the OPT_CLOSE_CONFIRM_BUTTONS option, the call will fail and raise a CloseFailedException.
closeSynchron
in interface IMoveable
public void closeSynchron(boolean closeConfirm)
The method attempts to close the window by trying the following events, in this sequence, stopping when the window closes:
close()
method on the window.closeConfirm
parameter is set to true
: Click the list of buttons specified with the option OPT_CLOSE_WINDOW_BUTTONS.This method supports several specifications you can make to help the Open Agent closes a window. You can make these specification by use Desktop.setOption(String, Object) to set the appropriate values for the mentioned options. For example, if closing the window opens a confirmation dialog with a button that contains the text "Do not save" use:
desktop.setOption(CommonOptions.OPT_CLOSE_CONFIRM_BUTTONS, Arrays.asList("Do not save"));
Close may fail. For example, if closing a window causes the application to display a message box and closeConfirm is set to false
, or if the buttons used to close the message box are not covered under the OPT_CLOSE_CONFIRM_BUTTONS option, the call will fail and raise a CloseFailedException.
closeSynchron
in interface IMoveable
closeConfirm
- specifies whether to close confirmation dialogs that may pop up when closing the window, for example a 'Save changes' dialog. Use true
to close confirmation dialogs and false
to raise an exception if a confirmation dialog pops up. If set to true
the value of the option OPT_CLOSE_CONFIRM_BUTTONS is used to determine which button to select in order to close confirmation dialogs.public List<IMoveable> getCloseWindows()
getCloseWindows
in interface IMoveable
public TestObject getFocus()
public IMoveable getNextCloseWindow()
getNextCloseWindow
in interface IMoveable
public boolean isActive()
public boolean isVkeyAllowed(VKey vkey)
vkey
- the key to evaluatepublic void jumpBackward()
public void jumpForward()
public void minimize()
public void move(Point pos)
public void resizeWorkingPane(int width, int height, boolean throwOnFail)
width
- the new width of the working paneheight
- the new height of the working panethrowOnFail
- whether an exception should be thrown in case of an failurepublic void resizeWorkingPaneEx(int width, int height, boolean throwOnFail)
width
- the new width of the working paneheight
- the new height of the working panethrowOnFail
- whether an exception should be thrown in case of an failurepublic void restore()
public void sendVKey(VKey vkey)
vkey
- the virtual key to sendpublic void setActive()
public void size(int width, int height)
public void tabBackward()
public void tabForward()
public boolean isButtonbarVisible()
public SapComponent getGuiFocus()
public boolean isStatusbarVisible()
public SapComponent getSystemFocus()
public boolean isTitlebarVisible()
public boolean isToolbarVisible()
public int getWindowHandle()
public int getWindowState()
getWindowState
in interface IMoveable
public int getWorkingPaneHeight()
public int getWorkingPaneWidth()
Copyright 2009-2012 Micro Focus. All Rights Reserved.