org.jeditor.core

Class Word

java.lang.Object

org.jeditor.core.Word

public class Word
extends java.lang.Object

Represents a word and context of one Token in a Syntax.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getContext() Return the context.
int	getContextOffset() Return the context offset.
SyntaxDocument	getDocument() Return the document.
Word	getNextWord(boolean crossLineBoundaries) Return the next word.
Word	getPreviousWord(boolean crossLineBoundaries) Return the previous word.
Token	getToken() Return the Token.
java.lang.String	getWord() Return the word.
int	getWordLength() Return the word length.
int	getWordOffset() Return the word offset.
boolean	isEndOfLine() Return true if the word is at the end of a line.
boolean	isStartOfLine() Return true if the word is at the start of a line.

Methods inherited from class java.lang.Object

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

Method Detail

getDocument

public SyntaxDocument getDocument()

Return the document.

Returns:

the document

getContextOffset

public int getContextOffset()

Return the context offset. It is the index of the first character of the Token.

Returns:

the context offset

getWordOffset

public int getWordOffset()

Return the word offset. It is the index of the first character of the Word.

Returns:

the word offset

getWordLength

public int getWordLength()

Return the word length.

Returns:

the word length

getToken

public Token getToken()

Return the Token.

Returns:

the Token

getContext

public java.lang.String getContext()

Return the context. It is the whole text corresponding with the Token.

Returns:

the context

getWord

public java.lang.String getWord()

Return the word. It is the word at the offset.

Returns:

the word

isStartOfLine

public boolean isStartOfLine()

Return true if the word is at the start of a line.

Returns:

true if the word is at the start of a line

isEndOfLine

public boolean isEndOfLine()

Return true if the word is at the end of a line.

Returns:

true if the word is at the end of a line

getPreviousWord

public Word getPreviousWord(boolean crossLineBoundaries)

Return the previous word.

Parameters:

crossLineBoundaries - true if line boundaries can be crossed

Returns:

the previous word

getNextWord

public Word getNextWord(boolean crossLineBoundaries)

Return the next word.

Parameters:

crossLineBoundaries - true if line boundaries can be crossed

Returns:

the next word