com.joc.jguii

Class ApplicationHandler

java.lang.Object

com.joc.jguii.ApplicationHandler

public class ApplicationHandler
extends java.lang.Object

Object for interacting with Applications.

Field Summary

Fields

Modifier and Type	Field and Description
private Application[]	appsList List of all Applications, obtained from config file.
private java.lang.String	config Path to and name of config file.
private int	currApp The window id of the currently focused Application.
private InteractionHandler	ih InputHandler to generate dummy input.
private java.lang.String	osName Operating system, not currently used.
private ConfigHandler	reader ConfigHandler to retrieve info from the config file.

Constructor Summary

Constructors

Constructor and Description
ApplicationHandler(java.lang.String config) Object for interacting with Applications.

Method Summary

Methods

Modifier and Type	Method and Description
void	close(int index) Closes the Application at the specified index.
void	close(java.lang.String name) Closes the Application with the specified name.
void	focus(int index) Focuses and raises the Application at index index.
void	focus(java.lang.String name) Focuses and raises the Application with name name.
private int	getCurrentApp(boolean check) Gets the id of the currently focused application.
private int	getWindowFocus() Gets the id of the currently focused application.
private void	initAppsList() Initialises all objects in appsList to null.
boolean	isApplication(java.lang.String name) Returns true if an Application with name name is specified in the config file.
boolean	isOpen(int index) True if specified Application is open.
boolean	isOpen(java.lang.String name) True if specified Application is open.
void	leftClick(java.lang.String pointName) Wrapper for the InteractionHandler method leftClick.
void	leftClickI(int pointIndex) Wrapper for the InteractionHandler method leftClick.
void	mouseWheelClick(java.lang.String pointName) Wrapper for the InteractionHandler method mouseWheelClick.
void	mouseWheelClickI(int pointIndex) Wrapper for the InteractionHandler method mouseWheelClick.
void	open(int index) Opens the Application at index index.
void	open(java.lang.String name) Opens application with name name.
void	pressDown() Wrapper for the InteractionHandler method pressDown.
void	pressLeft() Wrapper for the InteractionHandler method pressLeft.
void	pressRight() Wrapper for the InteractionHandler method pressRight.
void	pressUp() Wrapper for the InteractionHandler method pressUp.
void	rightClick(java.lang.String pointName) Wrapper for the InteractionHandler method rightClick.
void	rightClickI(int pointIndex) Wrapper for the InteractionHandler method rightClick.
void	typeInBox(java.lang.String pointName, java.lang.String t, boolean ret) Wrapper for the InteractionHandler method typeInArea.
void	typeInBoxI(int pointIndex, java.lang.String t, boolean ret) Wrapper for the InteractionHandler method typeInArea.
private int	windowSearch(java.lang.String search) Searches for a window with search in its title.

Methods inherited from class java.lang.Object

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

Field Detail

osName

private java.lang.String osName

Operating system, not currently used.

config

private java.lang.String config

Path to and name of config file.

reader

private ConfigHandler reader

ConfigHandler to retrieve info from the config file.

ih

private InteractionHandler ih

InputHandler to generate dummy input.

appsList

private Application[] appsList

List of all Applications, obtained from config file.

currApp

private int currApp

The window id of the currently focused Application.

Constructor Detail

ApplicationHandler

public ApplicationHandler(java.lang.String config)

Object for interacting with Applications.

Used for opening and controlling all Applications specified in config file.

Parameters:

config - Path to config file.

See Also:

ConfigHandler, Application

Method Detail

windowSearch

private int windowSearch(java.lang.String search)

Searches for a window with search in its title.

Native method to return the window id of a window that has the String search in its title.

Parameters:

search - The string to search for.

Returns:

The id of the window or -1 if none is found.

getWindowFocus

private int getWindowFocus()

Gets the id of the currently focused application.

Returns:

The window id of the currently focused application.

open

public void open(int index)

Opens the Application at index index.

If the specified Application is already open, it focuses it, otherwise it opens and focuses it.

Parameters:

index - Index of Application to be opened.

See Also:

open(String name)

open

public void open(java.lang.String name)

Opens application with name name.

Gets the index of the Application with name name and calls open(int index).

Parameters:

name - Name of Application to be opened.

See Also:

Application, open(int index)

focus

public void focus(int index)

Focuses and raises the Application at index index.

Parameters:

index - Index of Application to focus.

focus

public void focus(java.lang.String name)

Focuses and raises the Application with name name.

Gets the index of the Application with name name and calls focus(int index).

Parameters:

name - Name of Application to focus.

isOpen

public boolean isOpen(int index)

True if specified Application is open.

Parameters:

index - Index of Application to be checked.

Returns:

True if Application is open, false otherwise.

isOpen

public boolean isOpen(java.lang.String name)

True if specified Application is open.

Parameters:

name - Name of Application to be checked.

Returns:

True if Application is open, false otherwise.

close

public void close(int index)

Closes the Application at the specified index.

Parameters:

index - Index of Application to close.

close

public void close(java.lang.String name)

Closes the Application with the specified name.

Parameters:

name - Name of Application to close.

isApplication

public boolean isApplication(java.lang.String name)

Returns true if an Application with name name is specified in the config file.

Parameters:

name - Name of Application to search for .

Returns:

True if Application exists.

typeInBoxI

public void typeInBoxI(int pointIndex,
              java.lang.String t,
              boolean ret)

Wrapper for the InteractionHandler method typeInArea.

Parameters:

pointIndex - Point to click on.

t - Text to type.

ret - True if enter/return should be pressed after t is typed.

See Also:

InteractionHandler, InteractionHandler.typeInArea(java.awt.Point, String, boolean)

typeInBox

public void typeInBox(java.lang.String pointName,
             java.lang.String t,
             boolean ret)

Wrapper for the InteractionHandler method typeInArea.

Parameters:

pointName - Name of point to click on.

t - Text to type.

ret - True if enter/return should be pressed after t is typed.

See Also:

InteractionHandler, InteractionHandler.typeInArea(java.awt.Point, String, boolean)

leftClickI

public void leftClickI(int pointIndex)

Wrapper for the InteractionHandler method leftClick.

Parameters:

pointIndex - Point to click on.

See Also:

InteractionHandler, InteractionHandler.leftClick(java.awt.Point)

leftClick

public void leftClick(java.lang.String pointName)

Wrapper for the InteractionHandler method leftClick.

Parameters:

pointName - Name of point to click on.

See Also:

InteractionHandler, InteractionHandler.leftClick(java.awt.Point)

rightClickI

public void rightClickI(int pointIndex)

Wrapper for the InteractionHandler method rightClick.

Parameters:

pointIndex - Point to click on.

See Also:

InteractionHandler, InteractionHandler.rightClick(java.awt.Point)

rightClick

public void rightClick(java.lang.String pointName)

Wrapper for the InteractionHandler method rightClick.

Parameters:

pointName - Name of point to click on.

See Also:

InteractionHandler, InteractionHandler.rightClick(java.awt.Point)

mouseWheelClickI

public void mouseWheelClickI(int pointIndex)

Wrapper for the InteractionHandler method mouseWheelClick.

Parameters:

pointIndex - Point to click on.

See Also:

InteractionHandler, InteractionHandler.mouseWheelClick(java.awt.Point)

mouseWheelClick

public void mouseWheelClick(java.lang.String pointName)

Wrapper for the InteractionHandler method mouseWheelClick.

Parameters:

pointName - Name of point to click on.

See Also:

InteractionHandler, InteractionHandler.mouseWheelClick(java.awt.Point)

pressUp

public void pressUp()

Wrapper for the InteractionHandler method pressUp.

See Also:

InteractionHandler, InteractionHandler.pressUp()

pressDown

public void pressDown()

Wrapper for the InteractionHandler method pressDown.

See Also:

InteractionHandler, InteractionHandler.pressDown()

pressLeft

public void pressLeft()

Wrapper for the InteractionHandler method pressLeft.

See Also:

InteractionHandler, InteractionHandler.pressLeft()

pressRight

public void pressRight()

Wrapper for the InteractionHandler method pressRight.

See Also:

InteractionHandler, InteractionHandler.pressRight()

getCurrentApp

private int getCurrentApp(boolean check)

Gets the id of the currently focused application.

Gets the window id of the currently focused application. check should be true if the value retrieved is not expected to be different from currApp, that is, when no Application has been closed. If an Application has just been closed and currApp needs to be updated then check should be false. Returns the index of the focused Application or -1 if it's not specified in the config file.

Parameters:

check - True if the value of currApp is not expected to be different

Returns:

The index of the focused Application or -1 if it's not specified in config file

See Also:

Application, ApplicationHandler, currApp

initAppsList

private void initAppsList()

Initialises all objects in appsList to null.