org.eclipse.tptp.test.auto.gui.internal.commands
Interface IMacroCommand

All Superinterfaces:

IMacroInstruction, IPlayable, IWritable

All Known Implementing Classes:

AbstractMacroCommand

public interface IMacroCommand

extends IMacroInstruction

Represents a macro command that can be included as part of the macro script or played back to perform a UI interaction.

Method Summary

java.lang.String	getDescriptiveField() Returns the descriptive field of this command.
MacroCommandShell	getParent() Returns the parent of this command.
java.lang.String	getType() Returns the type of this command
boolean	isRepeatRedundant() Returns false if executing this command just after it has already been executed will have a different output.
boolean	mergeEvent(org.eclipse.swt.widgets.Event e) If this command occurs consecutively, then this method gives this command a chance to merge mutliple commands together to reduce the overhead.
void	processEvent(org.eclipse.swt.widgets.Event event) Allows this command to process the corresponding event.
void	setDescriptiveField(java.lang.String descriptiveField) Sets the descriptive field of this command.
void	setParent(MacroCommandShell parent) Sets the parent of this command.

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

getCorrespondingObject, getStartLine, getStopLine, getWidgetId, load, setCorrespondingObject, setWidgetId

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

getType

public java.lang.String getType()

Returns the type of this command

Returns:

The type

processEvent

public void processEvent(org.eclipse.swt.widgets.Event event)

Allows this command to process the corresponding event.

Parameters:

event - The event that awaits processing

mergeEvent

public boolean mergeEvent(org.eclipse.swt.widgets.Event e)

If this command occurs consecutively, then this method gives this command a chance to merge mutliple commands together to reduce the overhead.

Returns:

true if the command is merged; false otherwise.

getDescriptiveField

public java.lang.String getDescriptiveField()

Returns the descriptive field of this command. The descriptive field is a human readable label that allows users to easily identify the purpose of this command.

Returns:

The descriptive field

setDescriptiveField

public void setDescriptiveField(java.lang.String descriptiveField)

Sets the descriptive field of this command. The descriptive field is a human readable label that allows users to easily identify the purpose of this command.

Parameters:

descriptiveField - The descriptive field

getParent

public MacroCommandShell getParent()

Returns the parent of this command.

Returns:

The parent

setParent

public void setParent(MacroCommandShell parent)

Sets the parent of this command.

Parameters:

parent - The parent

isRepeatRedundant

public boolean isRepeatRedundant()

Returns false if executing this command just after it has already been executed will have a different output. (e.g. Two focus commands that are identical are redundant but two button selections are not); otherwise true should be returned.

Returns:

A flag indicating if repeats of this command are redundant.