com.tplan.robot.scripting.interpret

Class AbstractTestScriptDocument

java.lang.Object

javax.swing.text.AbstractDocument

javax.swing.text.DefaultStyledDocument

com.tplan.robot.scripting.interpret.AbstractTestScriptDocument

All Implemented Interfaces:

TestScriptDocument, Serializable, Document, StyledDocument

public abstract class AbstractTestScriptDocument
extends DefaultStyledDocument
implements TestScriptDocument

Abstract test script document class which supports code auto indenting and formatting.

See Also:

Serialized Form

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

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.text.DefaultStyledDocument

DefaultStyledDocument.AttributeUndoableEdit, DefaultStyledDocument.ElementBuffer, DefaultStyledDocument.ElementSpec

Nested classes/interfaces inherited from class javax.swing.text.AbstractDocument

AbstractDocument.AbstractElement, AbstractDocument.AttributeContext, AbstractDocument.BranchElement, AbstractDocument.Content, AbstractDocument.DefaultDocumentEvent, AbstractDocument.ElementEdit, AbstractDocument.LeafElement

Field Summary

Fields inherited from class javax.swing.text.DefaultStyledDocument

BUFFER_SIZE_DEFAULT

Fields inherited from class javax.swing.text.AbstractDocument

BidiElementName, ContentElementName, ElementNameAttribute, ParagraphElementName, SectionElementName

Fields inherited from interface javax.swing.text.Document

StreamDescriptionProperty, TitleProperty

Constructor Summary

Constructors

Constructor and Description
AbstractTestScriptDocument()

Method Summary

Modifier and Type	Method and Description
Element	getDefaultRootElement() Gets the default root element (thread safe).
String	getIndentUnit() Get a single indent unit, for example a sequence of three spaces.
int	getLength() Returns the length of the data in a thread safe mode.This is the number of characters of content that represents the users data.
Element	getParagraphElement(int i) Get the paragraph element at the offset i (thread safe).
static String	getPreferredIndent() Get the indent element based on the parameters in the configuration.
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.
String	getText(int offset, int length) Gets a sequence of text from the document in a thread safe mode.
int	insertLineWithIndent(String line, int offset, boolean addNewLine, boolean remove)
void	insertString(int offs, String str, AttributeSet a)
boolean	isAutoIndentEnabled() Find out if auto indent is enabled.
void	setAutoIndentEnabled(boolean enabled) Enable or disable auto indenting.
static String	suggestIndent(StyledDocument doc, int offs)
boolean	supportsAutoIndent() Find out whether the document supports auto indenting.

Methods inherited from class javax.swing.text.DefaultStyledDocument

addDocumentListener, addStyle, getBackground, getCharacterElement, getFont, getForeground, getLogicalStyle, getStyle, getStyleNames, removeDocumentListener, removeElement, removeStyle, setCharacterAttributes, setLogicalStyle, setParagraphAttributes

Methods inherited from class javax.swing.text.AbstractDocument

addUndoableEditListener, createPosition, dump, getAsynchronousLoadPriority, getBidiRootElement, getDocumentFilter, getDocumentListeners, getDocumentProperties, getEndPosition, getListeners, getProperty, getRootElements, getStartPosition, getText, getUndoableEditListeners, putProperty, readLock, readUnlock, remove, removeUndoableEditListener, render, replace, setAsynchronousLoadPriority, setDocumentFilter, setDocumentProperties

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.tplan.robot.scripting.interpret.TestScriptDocument

getSampleScriptText, isBlockEnd, resetStyles, resetStyles

Methods inherited from interface javax.swing.text.Document

addUndoableEditListener, createPosition, getEndPosition, getProperty, getRootElements, getStartPosition, getText, putProperty, remove, removeUndoableEditListener, render

Constructor Detail

AbstractTestScriptDocument

public AbstractTestScriptDocument()

Method Detail

supportsAutoIndent

public boolean supportsAutoIndent()

Description copied from interface: TestScriptDocument

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.

Specified by:

supportsAutoIndent in interface TestScriptDocument

Returns:

true if auto indenting is supported, false if not.

setAutoIndentEnabled

public void setAutoIndentEnabled(boolean enabled)

Description copied from interface: TestScriptDocument

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.

Specified by:

setAutoIndentEnabled in interface TestScriptDocument

Parameters:

enabled - true enables auto indenting, false disables.

isAutoIndentEnabled

public boolean isAutoIndentEnabled()

Description copied from interface: TestScriptDocument

Find out if auto indent is enabled.

Specified by:

isAutoIndentEnabled in interface TestScriptDocument

Returns:

true if auto indenting is enabled, false if not.

getIndentUnit

public String getIndentUnit()

Description copied from interface: TestScriptDocument

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

Specified by:

getIndentUnit in interface TestScriptDocument

Returns:

indent unit.

getSuggestedIndent

public String getSuggestedIndent(int offset)
                          throws BadLocationException

Description copied from interface: TestScriptDocument

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.

Specified by:

getSuggestedIndent in interface TestScriptDocument

Parameters:

offset - a position in the document.

Returns:

suggested indent string.

Throws:

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

getParagraphElement

public Element getParagraphElement(int i)

Get the paragraph element at the offset i (thread safe).

Specified by:

getParagraphElement in interface StyledDocument

Overrides:

getParagraphElement in class DefaultStyledDocument

Parameters:

i - the starting offset >= 0

Returns:

the element

Since:

3.1.2

getDefaultRootElement

public Element getDefaultRootElement()

Gets the default root element (thread safe).

Specified by:

getDefaultRootElement in interface Document

Overrides:

getDefaultRootElement in class DefaultStyledDocument

Returns:

the root

Since:

3.1.2

getText

public String getText(int offset,
                      int length)
               throws BadLocationException

Gets a sequence of text from the document in a thread safe mode.

Specified by:

getText in interface Document

Overrides:

getText in class AbstractDocument

Parameters:

offset - the starting offset >= 0

length - the number of characters to retrieve >= 0

Returns:

the text

Throws:

BadLocationException - the range given includes a position that is not a valid position within the document

Since:

3.1.2

getLength

public int getLength()

Returns the length of the data in a thread safe mode.This is the number of characters of content that represents the users data.

Specified by:

getLength in interface Document

Overrides:

getLength in class AbstractDocument

Returns:

the length >= 0

Since:

3.1.2

insertString

public void insertString(int offs,
                         String str,
                         AttributeSet a)
                  throws BadLocationException

Specified by:

insertString in interface Document

Overrides:

insertString in class AbstractDocument

Throws:

BadLocationException

getPreferredIndent

public static String getPreferredIndent()

Get the indent element based on the parameters in the configuration.

Returns:

the indent the indent element.

suggestIndent

public static String suggestIndent(StyledDocument doc,
                                   int offs)
                            throws BadLocationException

Throws:

BadLocationException

insertLineWithIndent

public int insertLineWithIndent(String line,
                                int offset,
                                boolean addNewLine,
                                boolean remove)
                         throws BadLocationException

Throws:

BadLocationException