com.opera.core.systems.scope.stp.services

Class ScopeWindowManager

java.lang.Object

com.opera.core.systems.scope.AbstractService

com.opera.core.systems.scope.stp.services.ScopeWindowManager

All Implemented Interfaces:

Service, WindowManager

public class ScopeWindowManager
extends AbstractService
implements WindowManager

The Window Manager service handles events such as opening a URL, filtering and closing windows, and tracks windows being loaded. We want to be able to work with windows on a higher level than before. One important goal is to opt-in on the messages you get instead of being flooded. This protocol will prevent a lot of flooding from the other services, but it will on the other hand flood a bit itself. There is no way to stop it from sending OnWindowActivated messages for example.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLOSE_ALL_PAGES_ACTION
static org.apache.commons.jxpath.CompiledExpression	WINDOW_FINDER_EXPRESSION

Fields inherited from class com.opera.core.systems.scope.AbstractService

services

Fields inherited from interface com.opera.core.systems.scope.services.WindowManager

SERVICE_NAME

Constructor Summary

Constructors

Constructor and Description
ScopeWindowManager(ScopeServices services)

Method Summary

Methods

Modifier and Type	Method and Description
void	addWindow(WmProtos.WindowInfo info)
void	clearFilter()
void	closeAllWindows() Closes all open windows, including dialogues, by iterating through them and calling WindowManager.closeWindow(int) on each of them if version 2.1 or greater of the Window Manager service is available.
void	closeWindow(int windowId) Requests the closing of a specific window.
void	createWindow()
void	filterActiveWindow() Filter only the active window so we don't get messages from other windows (like thread messages).
void	filterWindow(Integer windowId)
void	findDriverWindow() Find a window suitable for driving, find the active window, if it is not a normal window, find the first normal window via JXPath.
int	getActiveWindowId()
AtomicInteger	getLastHttpResponseCode()
int	getOpenWindowCount()
List<Integer>	getWindowHandles()
void	init() Get the list of all windows, then find a driver window (which needs to be 'normal' window) after that set the active window to that window.
void	openUrl(int windowId, String url)
void	removeWindow(Integer windowId)
void	resetWindowsList()
void	setActiveWindow(String title)
void	setActiveWindowId(Integer windowId) Sets the active window if the window is of type 'normal' discards any other window such as 'dialog' or 'unknown'.

Methods inherited from class com.opera.core.systems.scope.AbstractService

buildPayload, executeMessage, executeMessage, executeMessage, getServiceName, getServiceVersion, isVersionInRange, sleep, toString, xpathIterator, xpathPointer

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.opera.core.systems.scope.Service

getServiceName, getServiceVersion

Field Detail

CLOSE_ALL_PAGES_ACTION

public static final String CLOSE_ALL_PAGES_ACTION

See Also:

Constant Field Values

WINDOW_FINDER_EXPRESSION

public static final org.apache.commons.jxpath.CompiledExpression WINDOW_FINDER_EXPRESSION

Constructor Detail

ScopeWindowManager

public ScopeWindowManager(ScopeServices services)

Method Detail

getLastHttpResponseCode

public AtomicInteger getLastHttpResponseCode()

Specified by:

getLastHttpResponseCode in interface WindowManager

getOpenWindowCount

public int getOpenWindowCount()

Specified by:

getOpenWindowCount in interface WindowManager

setActiveWindowId

public void setActiveWindowId(Integer windowId)

Description copied from interface: WindowManager

Sets the active window if the window is of type 'normal' discards any other window such as 'dialog' or 'unknown'.

Specified by:

setActiveWindowId in interface WindowManager

getActiveWindowId

public int getActiveWindowId()

Specified by:

getActiveWindowId in interface WindowManager

addWindow

public void addWindow(WmProtos.WindowInfo info)

Specified by:

addWindow in interface WindowManager

removeWindow

public void removeWindow(Integer windowId)

Specified by:

removeWindow in interface WindowManager

init

public void init()

Get the list of all windows, then find a driver window (which needs to be 'normal' window) after that set the active window to that window.

Specified by:

init in interface Service

findDriverWindow

public void findDriverWindow()

Description copied from interface: WindowManager

Find a window suitable for driving, find the active window, if it is not a normal window, find the first normal window via JXPath.

Specified by:

findDriverWindow in interface WindowManager

filterActiveWindow

public void filterActiveWindow()

Filter only the active window so we don't get messages from other windows (like thread messages).

Specified by:

filterActiveWindow in interface WindowManager

setActiveWindow

public void setActiveWindow(String title)

Specified by:

setActiveWindow in interface WindowManager

createWindow

public void createWindow()

Specified by:

createWindow in interface WindowManager

getWindowHandles

public List<Integer> getWindowHandles()

Specified by:

getWindowHandles in interface WindowManager

resetWindowsList

public void resetWindowsList()

Specified by:

resetWindowsList in interface WindowManager

clearFilter

public void clearFilter()

Specified by:

clearFilter in interface WindowManager

filterWindow

public void filterWindow(Integer windowId)

Specified by:

filterWindow in interface WindowManager

openUrl

public void openUrl(int windowId,
           String url)

Specified by:

openUrl in interface WindowManager

closeWindow

public void closeWindow(int windowId)

Description copied from interface: WindowManager

Requests the closing of a specific window. Window closing is asynchronous and your request may be silently ignored or denied. If the window actually was closed, then an OnWindowClosed event will fire. Attempting to close a non-existent window will trigger an error. Closes the specified window, including dialogues, by using Scope's CloseWindow command if version 2.1 or greater of the Window Manager service is available. This method is blocking and will not return until the window has been closed unless it hits the OperaIntervals.WINDOW_CLOSE_TIMEOUT timeout.

Specified by:

closeWindow in interface WindowManager

closeAllWindows

public void closeAllWindows()

Description copied from interface: WindowManager

Closes all open windows, including dialogues, by iterating through them and calling WindowManager.closeWindow(int) on each of them if version 2.1 or greater of the Window Manager service is available. This method deviates from WindowManager.closeWindow(int) and will if not attempt to use Opera's action system to close the windows and dialogues. This method is normally blocking, and will not return until the window has been closed or until it hits the OperaIntervals.WINDOW_CLOSE_TIMEOUT timeout. However, note that using the action system is slower than Scope, and that it is also notoriously unreliable. We cannot guarantee that this method will be blocking if the action mechanism is used.

Specified by:

closeAllWindows in interface WindowManager