org.fife.ui.rsyntaxtextarea.modes
Class AbstractMarkupTokenMaker

java.lang.Object
  org.fife.ui.rsyntaxtextarea.AbstractJFlexTokenMaker
      org.fife.ui.rsyntaxtextarea.modes.AbstractMarkupTokenMaker

All Implemented Interfaces:

TokenMaker

Direct Known Subclasses:

BBCodeTokenMaker, HTMLTokenMaker, JSPTokenMaker, MxmlTokenMaker, PHPTokenMaker, XMLTokenMaker

public abstract class AbstractMarkupTokenMaker
extends AbstractJFlexTokenMaker

Base class for token makers for markup languages.

Version:

1.0

Author:

Robert Futrell

Field Summary

protected Token	currentToken Used in the creation of the linked list.
protected Token	firstToken The first token in the returned linked list.
protected Token	previousToken Used in the creation of the linked list.

Fields inherited from class org.fife.ui.rsyntaxtextarea.AbstractJFlexTokenMaker

offsetShift, s, start

Constructor Summary

AbstractMarkupTokenMaker()

Method Summary

void	addNullToken() Adds a null token to the end of the current linked list of tokens.
void	addToken(char[] array, int start, int end, int tokenType, int startOffset) Adds the token specified to the current linked list of tokens.
void	addToken(char[] array, int start, int end, int tokenType, int startOffset, boolean hyperlink) Adds the token specified to the current linked list of tokens.
void	addToken(Segment segment, int start, int end, int tokenType, int startOffset) Adds the token specified to the current linked list of tokens.
abstract boolean	getCompleteCloseTags() Returns whether markup close tags should be completed.
boolean	getCurlyBracesDenoteCodeBlocks() Returns whether this programming language uses curly braces ('{' and '}') to denote code blocks.
Action	getInsertBreakAction() Returns an action to handle "insert break" key presses (i.e.
int	getLastTokenTypeOnLine(Segment text, int initialTokenType) Returns the last token on this line's type if the token is "unfinished", or TokenTypes.NULL if it was finished.
String[]	getLineCommentStartAndEnd() Returns the text to place at the beginning and end of a line to "comment" it in a this programming language.
boolean	getMarkOccurrencesOfTokenType(int type) Returns whether tokens of the specified type should have "mark occurrences" enabled for the current programming language.
boolean	getShouldIndentNextLineAfter(Token token) The default implementation returns false always.
boolean	isMarkupLanguage() Overridden to return true.
boolean	isWhitespaceVisible() Returns whether whitespace is visible.
protected void	resetTokenList() Deletes the linked list of tokens so we can begin anew.
void	setWhitespaceVisible(boolean visible) Sets whether tokens are generated that "show" whitespace.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fife.ui.rsyntaxtextarea.TokenMaker

getTokenList

Field Detail

firstToken

protected Token firstToken

The first token in the returned linked list.

currentToken

protected Token currentToken

Used in the creation of the linked list.

previousToken

protected Token previousToken

Used in the creation of the linked list.

Constructor Detail

AbstractMarkupTokenMaker

public AbstractMarkupTokenMaker()

Method Detail

getCompleteCloseTags

public abstract boolean getCompleteCloseTags()

Returns whether markup close tags should be completed.

Returns:

Whether closing markup tags are to be completed.

getLineCommentStartAndEnd

public String[] getLineCommentStartAndEnd()

Returns the text to place at the beginning and end of a line to "comment" it in a this programming language.

Specified by:

getLineCommentStartAndEnd in interface TokenMaker

Returns:

The start and end strings to add to a line to "comment" it out.

isMarkupLanguage

public final boolean isMarkupLanguage()

Overridden to return true.

Specified by:

isMarkupLanguage in interface TokenMaker

Returns:

true always.

addNullToken

public void addNullToken()

Adds a null token to the end of the current linked list of tokens. This should be put at the end of the linked list whenever the last token on the current line is NOT a multi-line token.

Specified by:

addNullToken in interface TokenMaker

addToken

public void addToken(Segment segment,
                     int start,
                     int end,
                     int tokenType,
                     int startOffset)

Adds the token specified to the current linked list of tokens.

Parameters:

segment - Segment to get text from.

start - Start offset in segment of token.

end - End offset in segment of token.

tokenType - The token's type.

startOffset - The offset in the document at which this token occurs.

addToken

public void addToken(char[] array,
                     int start,
                     int end,
                     int tokenType,
                     int startOffset)

Adds the token specified to the current linked list of tokens.

Specified by:

addToken in interface TokenMaker

Parameters:

array - The character array from which to get the text.

start - Start offset in segment of token.

end - End offset in segment of token.

tokenType - The token's type.

startOffset - The offset in the document at which this token occurs.

addToken

public void addToken(char[] array,
                     int start,
                     int end,
                     int tokenType,
                     int startOffset,
                     boolean hyperlink)

Adds the token specified to the current linked list of tokens.

Parameters:

array - The character array.

start - The starting offset in the array.

end - The ending offset in the array.

tokenType - The token's type.

startOffset - The offset in the document at which this token occurs.

hyperlink - Whether this token is a hyperlink.

getCurlyBracesDenoteCodeBlocks

public boolean getCurlyBracesDenoteCodeBlocks()

Returns whether this programming language uses curly braces ('{' and '}') to denote code blocks.

The default implementation returns false; subclasses can override this method if necessary.

Specified by:

getCurlyBracesDenoteCodeBlocks in interface TokenMaker

Returns:

Whether curly braces denote code blocks.

getInsertBreakAction

public Action getInsertBreakAction()

Returns an action to handle "insert break" key presses (i.e. Enter). The default implementation returns null. Subclasses can override.

Specified by:

getInsertBreakAction in interface TokenMaker

Returns:

The default implementation always returns null.

getLastTokenTypeOnLine

public int getLastTokenTypeOnLine(Segment text,
                                  int initialTokenType)

Returns the last token on this line's type if the token is "unfinished", or TokenTypes.NULL if it was finished. For example, if C-style syntax highlighting is being implemented, and text contained a line of code that contained the beginning of a comment but no end-comment marker ("*\/"), then this method would return TokenTypes.COMMENT_MULTILINE for that line. This is useful for doing syntax highlighting.

Specified by:

getLastTokenTypeOnLine in interface TokenMaker

Parameters:

text - The line of tokens to examine.

initialTokenType - The token type to start with (i.e., the value of getLastTokenTypeOnLine for the line before text).

Returns:

The last token on this line's type, or TokenTypes.NULL if the line was completed.

getMarkOccurrencesOfTokenType

public boolean getMarkOccurrencesOfTokenType(int type)

Returns whether tokens of the specified type should have "mark occurrences" enabled for the current programming language. The default implementation returns true if type is TokenTypes.IDENTIFIER. Subclasses can override this method to support other token types, such as TokenTypes.VARIABLE.

Specified by:

getMarkOccurrencesOfTokenType in interface TokenMaker

Parameters:

type - The token type.

Returns:

Whether tokens of this type should have "mark occurrences" enabled.

getShouldIndentNextLineAfter

public boolean getShouldIndentNextLineAfter(Token token)

The default implementation returns false always. Languages that wish to better support auto-indentation can override this method.

Specified by:

getShouldIndentNextLineAfter in interface TokenMaker

Parameters:

token - The token the previous line ends with.

Returns:

Whether the next line should be indented.

isWhitespaceVisible

public boolean isWhitespaceVisible()

Returns whether whitespace is visible.

Specified by:

isWhitespaceVisible in interface TokenMaker

Returns:

Whether whitespace is visible.

See Also:

TokenMaker.setWhitespaceVisible(boolean)

resetTokenList

protected void resetTokenList()

Deletes the linked list of tokens so we can begin anew. This should never have to be called by the programmer, as it is automatically called whenever the user calls getLastTokenTypeOnLine(Segment, int) or TokenMaker.getTokenList(Segment, int, int).

setWhitespaceVisible

public void setWhitespaceVisible(boolean visible)

Sets whether tokens are generated that "show" whitespace.

Specified by:

setWhitespaceVisible in interface TokenMaker

Parameters:

visible - Whether whitespace should be visible.

See Also:

TokenMaker.isWhitespaceVisible()