org.eclipse.tptp.test.auto.gui.internal.macro
Class AbstractMacroInstruction

java.lang.Object
  org.eclipse.tptp.test.auto.gui.internal.macro.AbstractMacroInstruction

All Implemented Interfaces:

IMacroInstruction, IPlayable, IWritable

Direct Known Subclasses:

AbstractMacroCommand, MacroCommandShell

public abstract class AbstractMacroInstruction

extends java.lang.Object

implements IMacroInstruction

Provides an abstract implementation of IMacroInstruction. Contributors can subclass AbstractMacroInstruction or provide a direct implementaion of IMacroInstruction.

Constructor Summary

AbstractMacroInstruction()

Method Summary

protected void	bindSourceLocation(org.w3c.dom.Node node, java.util.Map lineTable) Binds the line details with this macro instruction
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 class java.lang.Object

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

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

Constructor Detail

AbstractMacroInstruction

public AbstractMacroInstruction()

Method Detail

load

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

Description copied from interface: IMacroInstruction

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

Specified by:

load in interface IMacroInstruction

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

See Also:

IMacroInstruction.load(org.w3c.dom.Node, java.util.Hashtable)

bindSourceLocation

protected void bindSourceLocation(org.w3c.dom.Node node,
                                  java.util.Map lineTable)

Binds the line details with this macro instruction

Parameters:

node - The node of this instruction

lineTable - The line level information

getStartLine

public int getStartLine()

Description copied from interface: IMacroInstruction

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

Specified by:

getStartLine in interface IMacroInstruction

Returns:

The starting line

See Also:

IMacroInstruction.getStartLine()

getStopLine

public int getStopLine()

Description copied from interface: IMacroInstruction

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

Specified by:

getStopLine in interface IMacroInstruction

Returns:

The last line

See Also:

IMacroInstruction.getStopLine()

getCorrespondingObject

public IUIObject getCorrespondingObject()

Description copied from interface: IMacroInstruction

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

Specified by:

getCorrespondingObject in interface IMacroInstruction

Returns:

The corresponding object of this instruction

See Also:

IMacroInstruction.getCorrespondingObject()

setCorrespondingObject

public void setCorrespondingObject(IUIObject uiObject)

Description copied from interface: IMacroInstruction

Sets the UI object for this macro instruction.

Specified by:

setCorrespondingObject in interface IMacroInstruction

Parameters:

uiObject - The corresponding object

See Also:

IMacroInstruction.setCorrespondingObject(org.eclipse.tptp.test.auto.gui.internal.core.IUIObject)

getWidgetId

public WidgetIdentifier getWidgetId()

Description copied from interface: IMacroInstruction

Returns the corresponding widget id of this instruction

Specified by:

getWidgetId in interface IMacroInstruction

Returns:

The widget id

See Also:

IMacroInstruction.getWidgetId()

setWidgetId

public void setWidgetId(WidgetIdentifier widgetIdentifier)

Description copied from interface: IMacroInstruction

Sets the widget identifier for this macro instruction

Specified by:

setWidgetId in interface IMacroInstruction

Returns:

widgetIdentifier The widget identifier

See Also:

IMacroInstruction.setWidgetId(org.eclipse.tptp.test.auto.gui.internal.core.WidgetIdentifier)