com.tplan.robot.scripting.interpret

Interface TestScriptDocument

All Known Implementing Classes:

AbstractTestScriptDocument

public interface TestScriptDocument

Interface declaring common methods of documents holding test script code (typically custom classes extending DefaultStyledDocument).

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

Method Summary

Modifier and Type	Method and Description
String	getIndentUnit() Get a single indent unit, for example a sequence of three spaces.
String	getSampleScriptText() Get the sample script text.
String	getSuggestedIndent(int offset) Get suggested indent for the element at the specified offset.The method should return a sequence of white characters (spaces) which should precede any code inserted into the line.
boolean	isAutoIndentEnabled() Find out if auto indent is enabled.
boolean	isBlockEnd(String insertedString) Find out whether the inserted string represents end of a code block or not.
void	resetStyles(int offs, int len)
void	resetStyles(UserConfiguration cfg)
void	setAutoIndentEnabled(boolean enabled) Enable or disable auto indenting.
boolean	supportsAutoIndent() Find out whether the document supports auto indenting.

Method Detail

supportsAutoIndent

boolean supportsAutoIndent()

Find out whether the document supports auto indenting. If the method returns true the document must support the following actions:

• When a new line is inserted (typically when used presses Enter in the editor) the document must automatically indent the caret to meet the code structure level.
• When a block end is detected (for example when user presses '}' or inserts a line starting with '}' the user must remove any excessive indent to reflect the code structure level.

Returns:

true if auto indenting is supported, false if not.

setAutoIndentEnabled

void setAutoIndentEnabled(boolean enabled)

Enable or disable auto indenting. The document should start initially with the auto indenting functionality on. This is intended to allow outside classes to switch off auto indenting temporarily, for example when a larger code block is being inserted into the document.

Parameters:

enabled - true enables auto indenting, false disables.

isAutoIndentEnabled

boolean isAutoIndentEnabled()

Find out if auto indent is enabled.

Returns:

true if auto indenting is enabled, false if not.

getIndentUnit

String getIndentUnit()

Get a single indent unit, for example a sequence of three spaces.

Returns:

indent unit.

getSuggestedIndent

String getSuggestedIndent(int offset)
                   throws BadLocationException

Get suggested indent for the element at the specified offset.The method should return a sequence of white characters (spaces) which should precede any code inserted into the line.

Parameters:

offset - a position in the document.

Returns:

suggested indent string.

Throws:

BadLocationException - if the offset is out of the document bounds.

isBlockEnd

boolean isBlockEnd(String insertedString)

Find out whether the inserted string represents end of a code block or not. * For both the scripting language and Java, an end block is any string starting with '}'.

Parameters:

insertedString - the string which is about to be inserted.

Returns:

true if the string is a block end, false if not.

getSampleScriptText

String getSampleScriptText()

Get the sample script text. This is used to demonstrate style settings in the Preferences window on a real code example. The code should not be longer than 3-4 lines.

Returns:

sample script code.

resetStyles

void resetStyles(UserConfiguration cfg)

resetStyles

void resetStyles(int offs,
                 int len)