com.tplan.robot.scripting

Interface ContextualDescriptionCapable

All Known Implementing Classes:

AbstractCombinedCommand, AbstractCommandHandler

public interface ContextualDescriptionCapable

Methods of a test script element (a command, a structured block etc.) able to produce a description of what it does.

Since:

6.0

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Method Summary

Modifier and Type	Method and Description
String	getDescription(ScriptingContext ctx, List<String> parameters, Map<String,String> values) Get the element action description.
Icon	getIcon(String argument) Get the command icon.

Method Detail

getDescription

String getDescription(ScriptingContext ctx,
                      List<String> parameters,
                      Map<String,String> values)

Get the element action description. For example, the script command of "Wait 20s" may produce a description like "Wait for 20 seconds".

Parameters:

ctx - the script context.

parameters - list of parameters specified for the element.

values - map of parameter values.

Returns:

description of what the element performs when executed.

getIcon

Icon getIcon(String argument)

Get the command icon.

Parameters:

argument - optional argument for those commands that accept stable arguments. For example, for the "Mouse click" command the argument will be "click".

Returns:

the command icon or null;