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

Class ScopeDesktopWindowManager

java.lang.Object

com.opera.core.systems.scope.AbstractService

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

All Implemented Interfaces:

Service, DesktopWindowManager

public class ScopeDesktopWindowManager
extends AbstractService
implements DesktopWindowManager

Field Summary

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

services

Fields inherited from interface com.opera.core.systems.scope.services.desktop.DesktopWindowManager

SERVICE_NAME

Constructor Summary

Constructors

Constructor and Description
ScopeDesktopWindowManager(ScopeServices services)

Method Summary

Methods

Modifier and Type	Method and Description
int	getActiveQuickWindowId() Gets id of active window.
List<DesktopWmProtos.DesktopWindowInfo>	getDesktopWindowInfoList()
int	getOpenQuickWindowCount() Gets number of open windows.
QuickMenu	getQuickMenu(String menuName) Gets the menu with name name.
QuickMenu	getQuickMenu(String menuName, int windowId)
QuickMenuItem	getQuickMenuItemByAccKey(String key, String menuName) Gets the menu item with the given accelerator key in the menu with name menuName.
QuickMenuItem	getQuickMenuItemByAction(String action) Gets the menu with the action specified, if any.
QuickMenuItem	getQuickMenuItemByName(String name)
QuickMenuItem	getQuickMenuItemByName(String name, int window_id)
QuickMenuItem	getQuickMenuItemByPosition(int row, String menuName) Gets the menu item with the given position in the menu with name menuName.
QuickMenuItem	getQuickMenuItemByShortcut(String shortcut) Gets the Menu item with the given shortcut.
QuickMenuItem	getQuickMenuItemBySubmenu(String submenu) Gets the menu item that opens the sub-menu.
QuickMenuItem	getQuickMenuItemByText(String text) Gets the menu with the text specified, if any.
List<QuickMenuItem>	getQuickMenuItemList()
List<QuickMenu>	getQuickMenuList()
QuickWidget	getQuickWidget(DesktopWmProtos.QuickWidgetInfo.QuickWidgetType type, int windowId, DesktopWmProtos.QuickWidgetSearch.QuickWidgetSearchType property, String value) Gets a QuickWidget based on a specific property.
QuickWidget	getQuickWidget(DesktopWmProtos.QuickWidgetInfo.QuickWidgetType type, int windowId, DesktopWmProtos.QuickWidgetSearch.QuickWidgetSearchType property, String value, String parentName) Gets the quick widget in a specified window based on a specific property and its parent widgets name.
QuickWidget	getQuickWidgetByPos(DesktopWmProtos.QuickWidgetInfo.QuickWidgetType type, int id, int row, int column) Gets the quick widget based on its position.
QuickWidget	getQuickWidgetByPos(DesktopWmProtos.QuickWidgetInfo.QuickWidgetType type, int windowId, int row, int column, String parentName) Gets the quick widget based on its position and its parent widgets name.
List<QuickWidget>	getQuickWidgetList(int windowId) Gets list of all QuickWidgets in the window.
QuickWindow	getQuickWindow(DesktopWmProtos.QuickWidgetSearch.QuickWidgetSearchType property, String value) Gets the quick window based on a specific property.
QuickWindow	getQuickWindowById(int windowId) Gets the quick window with the given window id.
QuickWindow	getQuickWindowByName(String name) Gets the window with name name.
int	getQuickWindowID(String name) Gets window id of window with the given name.
List<QuickWindow>	getQuickWindowList() Gets a list of all open windows.
String	getQuickWindowName(int windowId) Gets the name of the window with windowId.
void	init() Does initialization necessary to set up the service.
void	pressQuickMenuItem(String menuItemText, boolean popMenu)

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

Constructor Detail

ScopeDesktopWindowManager

public ScopeDesktopWindowManager(ScopeServices services)

Method Detail

init

public void init()

Description copied from interface: DesktopWindowManager

Does initialization necessary to set up the service.

Specified by:

init in interface Service

Specified by:

init in interface DesktopWindowManager

getActiveQuickWindowId

public int getActiveQuickWindowId()

Description copied from interface: DesktopWindowManager

Gets id of active window.

Specified by:

getActiveQuickWindowId in interface DesktopWindowManager

Returns:

id of active window

getOpenQuickWindowCount

public int getOpenQuickWindowCount()

Description copied from interface: DesktopWindowManager

Gets number of open windows.

Specified by:

getOpenQuickWindowCount in interface DesktopWindowManager

Returns:

number of open windows

getQuickWindow

public QuickWindow getQuickWindow(DesktopWmProtos.QuickWidgetSearch.QuickWidgetSearchType property,
                         String value)

Description copied from interface: DesktopWindowManager

Gets the quick window based on a specific property.

Specified by:

getQuickWindow in interface DesktopWindowManager

Parameters:

property - - property to search by

value - - value of property given

Returns:

QuickWindow matching the parameters, or null if no such widget

getQuickWindowList

public List<QuickWindow> getQuickWindowList()

Description copied from interface: DesktopWindowManager

Gets a list of all open windows.

Specified by:

getQuickWindowList in interface DesktopWindowManager

Returns:

list of all open windows

getDesktopWindowInfoList

public List<DesktopWmProtos.DesktopWindowInfo> getDesktopWindowInfoList()

getQuickWindowID

public int getQuickWindowID(String name)

Description copied from interface: DesktopWindowManager

Gets window id of window with the given name.

Specified by:

getQuickWindowID in interface DesktopWindowManager

Parameters:

name - window name

Returns:

id of window with the given name

getQuickWindowByName

public QuickWindow getQuickWindowByName(String name)

Description copied from interface: DesktopWindowManager

Gets the window with name name.

Specified by:

getQuickWindowByName in interface DesktopWindowManager

Parameters:

name - window name

Returns:

QuickWindow

getQuickWindowById

public QuickWindow getQuickWindowById(int windowId)

Description copied from interface: DesktopWindowManager

Gets the quick window with the given window id.

Specified by:

getQuickWindowById in interface DesktopWindowManager

Parameters:

windowId - id of the window

Returns:

QuickWindow with id windowId, if any, else null.

getQuickWindowName

public String getQuickWindowName(int windowId)

Description copied from interface: DesktopWindowManager

Gets the name of the window with windowId.

Specified by:

getQuickWindowName in interface DesktopWindowManager

Parameters:

windowId - id of window

Returns:

name of the window

getQuickWidget

public QuickWidget getQuickWidget(DesktopWmProtos.QuickWidgetInfo.QuickWidgetType type,
                         int windowId,
                         DesktopWmProtos.QuickWidgetSearch.QuickWidgetSearchType property,
                         String value)

Description copied from interface: DesktopWindowManager

Gets a QuickWidget based on a specific property.

Specified by:

getQuickWidget in interface DesktopWindowManager

Parameters:

type - what type

windowId - window id of the window containing the widget

property - property specified for the search

value - value of property given

Returns:

QuickWidget matching the property, or null if no such widget

getQuickWidget

public QuickWidget getQuickWidget(DesktopWmProtos.QuickWidgetInfo.QuickWidgetType type,
                         int windowId,
                         DesktopWmProtos.QuickWidgetSearch.QuickWidgetSearchType property,
                         String value,
                         String parentName)

Description copied from interface: DesktopWindowManager

Gets the quick widget in a specified window based on a specific property and its parent widgets name.

Specified by:

getQuickWidget in interface DesktopWindowManager

Parameters:

type - what type

windowId - window id of the window containing the widget

property - property specified for the search

value - value of property given

parentName - Name of the widgets parent widget

Returns:

QuickWidget matching the property, or null if no such widget

getQuickWidgetByPos

public QuickWidget getQuickWidgetByPos(DesktopWmProtos.QuickWidgetInfo.QuickWidgetType type,
                              int id,
                              int row,
                              int column)

Description copied from interface: DesktopWindowManager

Gets the quick widget based on its position.

Specified by:

getQuickWidgetByPos in interface DesktopWindowManager

Parameters:

type - what type

id - window id of the window containing the widget

row - row of the widget

column - column of the widget

Returns:

QuickWidget matching the parameters, or null if no such widget

getQuickWidgetByPos

public QuickWidget getQuickWidgetByPos(DesktopWmProtos.QuickWidgetInfo.QuickWidgetType type,
                              int windowId,
                              int row,
                              int column,
                              String parentName)

Description copied from interface: DesktopWindowManager

Gets the quick widget based on its position and its parent widgets name.

Specified by:

getQuickWidgetByPos in interface DesktopWindowManager

Parameters:

type - what type

windowId - window id of the window containing the widget

row - row of the widget

column - column of the widget

parentName - Name of the widgets parent widget

Returns:

QuickWidget matching the parameters, or null if no such widget

getQuickWidgetList

public List<QuickWidget> getQuickWidgetList(int windowId)

Description copied from interface: DesktopWindowManager

Gets list of all QuickWidgets in the window.

Specified by:

getQuickWidgetList in interface DesktopWindowManager

Parameters:

windowId - id of window

Returns:

list of QuickWidgets in the window given by id id

getQuickMenu

public QuickMenu getQuickMenu(String menuName)

Description copied from interface: DesktopWindowManager

Gets the menu with name name.

Specified by:

getQuickMenu in interface DesktopWindowManager

Parameters:

menuName - the menu's name

Returns:

QuickMenu

getQuickMenuList

public List<QuickMenu> getQuickMenuList()

Specified by:

getQuickMenuList in interface DesktopWindowManager

Returns:

list of all menus that are open (including menu bar(s))

getQuickMenuItemList

public List<QuickMenuItem> getQuickMenuItemList()

Specified by:

getQuickMenuItemList in interface DesktopWindowManager

Returns:

list containing all menu items in open menus (including menu bar(s))

pressQuickMenuItem

public void pressQuickMenuItem(String menuItemText,
                      boolean popMenu)

Specified by:

pressQuickMenuItem in interface DesktopWindowManager

getQuickMenuItemByAction

public QuickMenuItem getQuickMenuItemByAction(String action)

Description copied from interface: DesktopWindowManager

Gets the menu with the action specified, if any.

Specified by:

getQuickMenuItemByAction in interface DesktopWindowManager

Parameters:

action - of the menu item to search for

Returns:

QuickMenuItem with action, or null if the item doesn't exist

getQuickMenuItemBySubmenu

public QuickMenuItem getQuickMenuItemBySubmenu(String submenu)

Description copied from interface: DesktopWindowManager

Gets the menu item that opens the sub-menu.

Specified by:

getQuickMenuItemBySubmenu in interface DesktopWindowManager

Parameters:

submenu - the name of the sub-menu the menu item opens when its selected/clicked

Returns:

QuickMenuItem or null if the item doesn't exist

getQuickMenuItemByText

public QuickMenuItem getQuickMenuItemByText(String text)

Description copied from interface: DesktopWindowManager

Gets the menu with the text specified, if any.

Specified by:

getQuickMenuItemByText in interface DesktopWindowManager

Parameters:

text - of the menu item to search for

Returns:

QuickMenuItem with the given text, or null if no such item exists

getQuickMenuItemByAccKey

public QuickMenuItem getQuickMenuItemByAccKey(String key,
                                     String menuName)

Description copied from interface: DesktopWindowManager

Gets the menu item with the given accelerator key in the menu with name menuName.

Specified by:

getQuickMenuItemByAccKey in interface DesktopWindowManager

Parameters:

key - the shortcut key of the menu item to search for (the character that's underlined/marked in the menu item text)

menuName - name of the menu of the menu item

Returns:

QuickMenuItem or null if the item doesn't exist

getQuickMenuItemByShortcut

public QuickMenuItem getQuickMenuItemByShortcut(String shortcut)

Description copied from interface: DesktopWindowManager

Gets the Menu item with the given shortcut.

Specified by:

getQuickMenuItemByShortcut in interface DesktopWindowManager

Parameters:

shortcut - string representation of the shortcut of the menuitem (i.e. "Ctrl+O")

Returns:

QuickMenuItem, or null if the item doesnt exist

getQuickMenuItemByPosition

public QuickMenuItem getQuickMenuItemByPosition(int row,
                                       String menuName)

Description copied from interface: DesktopWindowManager

Gets the menu item with the given position in the menu with name menuName.

Specified by:

getQuickMenuItemByPosition in interface DesktopWindowManager

Parameters:

row - the row of the item, counting from zero, and including both normal items and menu separators

menuName - name of the menu to lookup the menu item in

Returns:

QuickMenuItem, or null if the item doesn't exist

getQuickMenuItemByName

public QuickMenuItem getQuickMenuItemByName(String name)

Specified by:

getQuickMenuItemByName in interface DesktopWindowManager

Parameters:

name - name of the item. This is either the name of the action the item executes when selected The name of the sub-menu the item opens when selected "Separator" for items that are separators

Returns:

the menu item

getQuickMenu

public QuickMenu getQuickMenu(String menuName,
                     int windowId)

Specified by:

getQuickMenu in interface DesktopWindowManager

Parameters:

menuName - name of the menu (as specified in standard_menu.ini)

windowId - id of the window the menu is attached to (note: only makes sense for menu bar)

Returns:

QuickMenu with name menuName in windowId if it exists, else null

getQuickMenuItemByName

public QuickMenuItem getQuickMenuItemByName(String name,
                                   int window_id)

Specified by:

getQuickMenuItemByName in interface DesktopWindowManager

Parameters:

name - Name of the menuItem

window_id - windowId of the window the menu of the item is in (note: only makes sense for menu bar items)

Returns:

the menu item