org.eclipse.tptp.test.auto.gui.internal.core
Interface IMacroInstruction

All Superinterfaces:

IPlayable, IWritable

All Known Subinterfaces:

IMacroCommand

All Known Implementing Classes:

AbstractMacroCommand, AbstractMacroInstruction

public interface IMacroInstruction

extends IWritable, IPlayable

Represents a macro instruction. The instruction is expected to both be writable and playable.

Method Summary

IUIObject	getCorrespondingObject() Returns the corresponding IUIObject of this macro instruction.
int	getStartLine() Returns the starting line number of this macro instruction in the macro script that it belongs to.
int	getStopLine() Returns the last line number of this macro instruction in the macro script that it belongs to.
WidgetIdentifier	getWidgetId() Returns the corresponding widget id of this instruction
void	load(org.w3c.dom.Node node, java.util.Hashtable lineTable) Invoked to load the macro instruction based on its corresponding XML node.
void	setCorrespondingObject(IUIObject uiObject) Sets the UI object for this macro instruction.
void	setWidgetId(WidgetIdentifier widgetIdentifier) Sets the widget identifier for this macro instruction

Methods inherited from interface org.eclipse.tptp.test.auto.gui.internal.core.IWritable

write, writeFinish, writeStart

Methods inherited from interface org.eclipse.tptp.test.auto.gui.internal.core.IPlayable

playback

Method Detail

load

public void load(org.w3c.dom.Node node,
                 java.util.Hashtable lineTable)
          throws org.eclipse.core.runtime.CoreException

Invoked to load the macro instruction based on its corresponding XML node.

Parameters:

node - The XML node representing this macro instruction

lineTable - Contains line level information

Throws:

org.eclipse.core.runtime.CoreException - In case of an unexpected error

getWidgetId

public WidgetIdentifier getWidgetId()

Returns the corresponding widget id of this instruction

Returns:

The widget id

setWidgetId

public void setWidgetId(WidgetIdentifier widgetIdentifier)

Sets the widget identifier for this macro instruction

Returns:

widgetIdentifier The widget identifier

getCorrespondingObject

public IUIObject getCorrespondingObject()

Returns the corresponding IUIObject of this macro instruction. If an object is not supported then null will be returned.

Returns:

The corresponding object of this instruction

setCorrespondingObject

public void setCorrespondingObject(IUIObject uiObject)

Sets the UI object for this macro instruction.

Parameters:

uiObject - The corresponding object

getStartLine

public int getStartLine()

Returns the starting line number of this macro instruction in the macro script that it belongs to.

Returns:

The starting line

getStopLine

public int getStopLine()

Returns the last line number of this macro instruction in the macro script that it belongs to.

Returns:

The last line