com.tplan.robot.scripting

Interface DocumentWrapper

All Superinterfaces:

TestWrapper

public interface DocumentWrapper
extends TestWrapper

Document wrapper encapsulates a styled document with a test script or its part specified by a start and end document elements.

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

Field Summary

Fields inherited from interface com.tplan.robot.scripting.TestWrapper

WRAPPER_TYPE_BLOCK, WRAPPER_TYPE_INCLUDE, WRAPPER_TYPE_JAVA, WRAPPER_TYPE_PROCEDURE, WRAPPER_TYPE_RUN, WRAPPER_TYPE_SCRIPT, WRAPPER_TYPE_UNKNOWN

Method Summary

Modifier and Type	Method and Description
boolean	canPause()
void	exit()
int	getElementIndex(Element e) Get index of an element in the DOM (Document Object Model).
Map	getLocalVariables()
Element	getNextElement(Element element, boolean validationMode, ScriptingContext context) Get an element which follows the argument one in the DOM (Document Object Model).
File	getScriptFile()
Element	getStartElement() Get the the first document element (i.e.
Object	getVariable(String name)
boolean	isExecutionAllowed()
boolean	isExit()
boolean	isSelectionMode() This method should return false if whole document content is to be executed or validated.
boolean	isWithinSelection(Element e, boolean validationMode, ScriptingContext context) Find out if an element is within execution selection, i.e.
void	setLocalVariables(Map table)
void	setParentWrapper(DocumentWrapper parentWrapper)
void	setVariable(ScriptingContext ctx, String name, Object value)

Methods inherited from interface com.tplan.robot.scripting.TestWrapper

getDocument, getLineNumber, getParentWrapper, getTestSource, getWrapperType, setDocument

Method Detail

isSelectionMode

boolean isSelectionMode()

This method should return false if whole document content is to be executed or validated. A value of true indicates that this class wraps just a part of the document specified by the start and end elements.

Returns:

false if whole document content is to be executed, true otherwise.

getStartElement

Element getStartElement()

Get the the first document element (i.e. line of text) to be executed.

Returns:

the first element to be executed.

isWithinSelection

boolean isWithinSelection(Element e,
                          boolean validationMode,
                          ScriptingContext context)

Find out if an element is within execution selection, i.e. if it is to be executed.

Parameters:

e - a document element. Each element represents a single line of text in the document.

validationMode - true indicates that we are just validating (compiling) the code, false means that we are executing it.

context - execution or validation context.

Returns:

true if the element is to be executed, false if not.

getNextElement

Element getNextElement(Element element,
                       boolean validationMode,
                       ScriptingContext context)

Get an element which follows the argument one in the DOM (Document Object Model). Most implementations in fact return the next line of the document.

Parameters:

element - a document element.

validationMode - true indicates that we are just validating (compiling) the code, false means that we are executing it.

context - execution or validation context.

Returns:

next element defined in the styled document or null if end of the document is reached.

getElementIndex

int getElementIndex(Element e)

Get index of an element in the DOM (Document Object Model). Each StyledDocument instance has a root element which contains an array of Element instances. One Element instance represents a line of text. In other words this method actually returns index of a line of text in the document.

Parameters:

e - a document element.

Returns:

index of the element in the DOM or -1 if the element is not found.

setParentWrapper

void setParentWrapper(DocumentWrapper parentWrapper)

setVariable

void setVariable(ScriptingContext ctx,
                 String name,
                 Object value)

getVariable

Object getVariable(String name)

getLocalVariables

Map getLocalVariables()

setLocalVariables

void setLocalVariables(Map table)

isExecutionAllowed

boolean isExecutionAllowed()

canPause

boolean canPause()

exit

void exit()

isExit

boolean isExit()

getScriptFile

File getScriptFile()

Specified by:

getScriptFile in interface TestWrapper