org.eclipse.tptp.test.auto.gui.internal.commands
Class CheckCommand

java.lang.Object
  org.eclipse.tptp.test.auto.gui.internal.macro.AbstractMacroInstruction
      org.eclipse.tptp.test.auto.gui.internal.commands.AbstractMacroCommand
          org.eclipse.tptp.test.auto.gui.internal.commands.AbstractStructuredCommand
              org.eclipse.tptp.test.auto.gui.internal.commands.ToggleStructuredCommand
                  org.eclipse.tptp.test.auto.gui.internal.commands.CheckCommand

All Implemented Interfaces:

IMacroCommand, IMacroInstruction, IPlayable, IWritable

public class CheckCommand
extends ToggleStructuredCommand

Field Summary

static java.lang.String

TYPE

Fields inherited from class org.eclipse.tptp.test.auto.gui.internal.commands.ToggleStructuredCommand

itemState

Fields inherited from class org.eclipse.tptp.test.auto.gui.internal.commands.AbstractStructuredCommand

items

Fields inherited from class org.eclipse.tptp.test.auto.gui.internal.commands.AbstractMacroCommand

DESCRIPTIVE_FIELD_BOUND

Constructor Summary

CheckCommand(MacroCommandShell parent, WidgetIdentifier wid)

Method Summary

boolean	getItemState(org.eclipse.swt.widgets.Widget item) Returns the state of the item (e.g. whether it is check/unchecked, expanded/ collapsed, and etc...)
java.lang.String	getType() Returns the type of this command
protected void	playStructuredCommand(org.eclipse.swt.widgets.Widget widget, java.lang.Object[] matches) Used to play the structured command collectively for all the discovered matches.
protected void	playStructuredCommandForFoundMatch(org.eclipse.swt.widgets.Widget widget, java.lang.Object match) Some events require to be played as matches are discovered.
void	processEvent(org.eclipse.swt.widgets.Event event) Allows this command to process the corresponding event.

Methods inherited from class org.eclipse.tptp.test.auto.gui.internal.commands.ToggleStructuredCommand

equals, getValue, load, mergeEvent, writeAdditionalAttributes

Methods inherited from class org.eclipse.tptp.test.auto.gui.internal.commands.AbstractStructuredCommand

findMatches, findObjectId, getCorrespondingObject, getItemAttributes, getItemAttributes, getItems, getItemsForEvent, playback, write

Methods inherited from class org.eclipse.tptp.test.auto.gui.internal.commands.AbstractMacroCommand

findDescriptiveField, findDescriptiveField, getDescriptiveField, getObjectClassName, getParent, getText, getTimeDifference, isRepeatRedundant, setDescriptiveField, setParent, setTimeDifference, toString, write, writeFinish, writeStart

Methods inherited from class org.eclipse.tptp.test.auto.gui.internal.macro.AbstractMacroInstruction

bindSourceLocation, getStartLine, getStopLine, getWidgetId, setCorrespondingObject, setWidgetId

Methods inherited from class java.lang.Object

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

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

getStartLine, getStopLine, getWidgetId, setCorrespondingObject, setWidgetId

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

Constructor Detail

CheckCommand

public CheckCommand(MacroCommandShell parent,
                    WidgetIdentifier wid)

Parameters:

wid -

Method Detail

getType

public java.lang.String getType()

Description copied from interface: IMacroCommand

Returns the type of this command

Returns:

The type

processEvent

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

Description copied from interface: IMacroCommand

Allows this command to process the corresponding event.

Specified by:

processEvent in interface IMacroCommand

Overrides:

processEvent in class AbstractStructuredCommand

Parameters:

event - The event that awaits processing

See Also:

IMacroCommand.processEvent(org.eclipse.swt.widgets.Event)

getItemState

public boolean getItemState(org.eclipse.swt.widgets.Widget item)

Description copied from class: ToggleStructuredCommand

Returns the state of the item (e.g. whether it is check/unchecked, expanded/ collapsed, and etc...)

Specified by:

getItemState in class ToggleStructuredCommand

Parameters:

item - The item for which its state is being queried

Returns:

The state of the item

playStructuredCommand

protected void playStructuredCommand(org.eclipse.swt.widgets.Widget widget,
                                     java.lang.Object[] matches)

Description copied from class: AbstractStructuredCommand

Used to play the structured command collectively for all the discovered matches.

Specified by:

playStructuredCommand in class AbstractStructuredCommand

Parameters:

widget - The widget

matches - The matches discovered

playStructuredCommandForFoundMatch

protected void playStructuredCommandForFoundMatch(org.eclipse.swt.widgets.Widget widget,
                                                  java.lang.Object match)

Description copied from class: AbstractStructuredCommand

Some events require to be played as matches are discovered. (e.g. an expansion command requires to be played for each discovered item in order for successive children to be found) It's recommended that either playStructuredCommandForFoundMatch or playStructuredCommand be implemented by clients, eventhough both methods will be invoked.

Specified by:

playStructuredCommandForFoundMatch in class AbstractStructuredCommand

Parameters:

widget - The widget