com.tplan.robot.util

Class DocumentUtils

java.lang.Object

com.tplan.robot.util.DocumentUtils

public class DocumentUtils
extends Object

Static utility methods related to styled documents.

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

Constructor Summary

Constructors

Constructor and Description
DocumentUtils()

Method Summary

Modifier and Type	Method and Description
static void	analyzeEditorDocument(JTextPane ed, boolean showFullStructure)
static String	createIndent(int level, String indentElement)
static List	findElements(Document doc, String pattern)
static Element	getCommandElementPriorTo(Document doc, int offset)
static String	getCommandForMap(String command, LinkedHashMap<String,Object> t)
static String	getCommandForValueMap(List v, Map t)
static Element	getElementAfter(Element el)
static Element	getElementForLine(Document doc, int lineNumber, Element e)
static Element	getElementForOffset(Document doc, int offset)
static Element	getElementPriorTo(Document doc, int offset)
static String	getElementText(Element e) Get element text in a thread safe mode.
static String	getElementText(Element e, boolean stripNewLines) Get element text in a thread safe mode.
static int	getLineForOffset(Document doc, int offset)
static int	getOffsetForLine(Document doc, int line)
static int	getOffsetForLine(Document doc, int line, int column)
static int	getTextStart(Element e) Get the text offset, i.e.
static Map	getTokens(Element e, List v)
static String	indentToRight(StyledDocument doc, String indentElement, int[] offsets)
static boolean	isComment(Element e)
static boolean	isComment(String text)
static void	printWithOffset(Document doc, int offset)
static void	updateCommand(Element e, Map valueMap)

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentUtils

public DocumentUtils()

Method Detail

isComment

public static boolean isComment(Element e)

isComment

public static boolean isComment(String text)

getElementText

public static String getElementText(Element e)

Get element text in a thread safe mode.

Parameters:

e - a document element.

Returns:

the text without the new line characters.

getElementText

public static String getElementText(Element e,
                                    boolean stripNewLines)
                             throws BadLocationException

Get element text in a thread safe mode.

Parameters:

e - a document element.

stripNewLines - true will remove all new line characters from the resulting text.

Returns:

the text without the new line characters.

Throws:

BadLocationException - on an error to read text from the specified element.

getElementPriorTo

public static Element getElementPriorTo(Document doc,
                                        int offset)

getElementAfter

public static Element getElementAfter(Element el)

getCommandElementPriorTo

public static Element getCommandElementPriorTo(Document doc,
                                               int offset)

analyzeEditorDocument

public static void analyzeEditorDocument(JTextPane ed,
                                         boolean showFullStructure)

getTokens

public static Map getTokens(Element e,
                            List v)

getCommandForValueMap

public static String getCommandForValueMap(List v,
                                           Map t)

getCommandForMap

public static String getCommandForMap(String command,
                                      LinkedHashMap<String,Object> t)

updateCommand

public static void updateCommand(Element e,
                                 Map valueMap)
                          throws BadLocationException

Throws:

BadLocationException

findElements

public static List findElements(Document doc,
                                String pattern)

getLineForOffset

public static int getLineForOffset(Document doc,
                                   int offset)

getOffsetForLine

public static int getOffsetForLine(Document doc,
                                   int line)

getOffsetForLine

public static int getOffsetForLine(Document doc,
                                   int line,
                                   int column)

createIndent

public static String createIndent(int level,
                                  String indentElement)

getElementForLine

public static Element getElementForLine(Document doc,
                                        int lineNumber,
                                        Element e)

getElementForOffset

public static Element getElementForOffset(Document doc,
                                          int offset)

indentToRight

public static String indentToRight(StyledDocument doc,
                                   String indentElement,
                                   int[] offsets)

printWithOffset

public static void printWithOffset(Document doc,
                                   int offset)
                            throws BadLocationException

Throws:

BadLocationException

getTextStart

public static int getTextStart(Element e)

Get the text offset, i.e. offset of the first non-white character in the element.

Parameters:

e - a document element.

Returns:

the offset the text starts at.

Since:

7.0