net.officefloor.demo.macro
Interface Macro

All Known Implementing Classes:

CommentMacro, DragMacro, InfoMacro, InputTextMacro, LeftClickMacro, MoveMouseMacro, PauseMacro, RightClickMacro, WaitMacro

public interface Macro

Provides wrapping of a possible action to record.

Author:

Daniel Sagenschneider

Method Summary

String	getConfigurationMemento() Obtains the configuration memento to reinitialise a new instance of this Macro.
String	getDisplayLabel() Obtains the label for displaying this Macro.
MacroTask[]	getMacroTasks() Obtains the listing of MacroTask instances.
Point	getStartingMouseLocation() Obtains the Point where the mouse cursor must be to start this Macro.
void	setConfigurationMemento(String memento) Initialises this Macro from the configuration memento.

Method Detail

setConfigurationMemento

void setConfigurationMemento(String memento)

Initialises this Macro from the configuration memento.

Parameters:

memento - Memento containing the configuration.

getConfigurationMemento

String getConfigurationMemento()

Obtains the configuration memento to reinitialise a new instance of this Macro.

Returns:

Configuration memento.

getDisplayLabel

String getDisplayLabel()

Obtains the label for displaying this Macro.

Returns:

Label for displaying this Macro. May return null for label based on type.

getStartingMouseLocation

Point getStartingMouseLocation()

Obtains the Point where the mouse cursor must be to start this Macro.

This allows for visually moving the mouse to this location before running this Macro.

Returns:

Point where the mouse cursor must be to start this Macro. null indicates non-mouse Macro (typically keyboard entry).

getMacroTasks

MacroTask[] getMacroTasks()

Obtains the listing of MacroTask instances.

Returns:

Listing of MacroTask instances.