Class AbstractMarkupTokenMaker

java.lang.Object

org.fife.ui.rsyntaxtextarea.TokenMakerBase

org.fife.ui.rsyntaxtextarea.AbstractJFlexTokenMaker

org.fife.ui.rsyntaxtextarea.modes.AbstractMarkupTokenMaker

All Implemented Interfaces:

TokenMaker

Direct Known Subclasses:

BBCodeTokenMaker, HandlebarsTokenMaker, HTMLTokenMaker, JSPTokenMaker, MarkdownTokenMaker, MxmlTokenMaker, PHPTokenMaker, XMLTokenMaker

public abstract class AbstractMarkupTokenMaker
extends AbstractJFlexTokenMaker

Base class for token makers for markup languages.

Version:

1.0

Field Summary

Fields inherited from class AbstractJFlexTokenMaker

offsetShift, s, start

Fields inherited from class TokenMakerBase

currentToken, firstToken, previousToken

Constructor Summary

Constructors

Constructor	Description
AbstractMarkupTokenMaker()

Method Summary

Modifier and Type	Method	Description
abstract boolean	getCompleteCloseTags()	Returns whether markup close tags should be completed.
String[]	getLineCommentStartAndEnd(int languageIndex)	Returns the text to place at the beginning and end of a line to "comment" it in this programming language.
final boolean	isMarkupLanguage()	Overridden to return true.

Methods inherited from class AbstractJFlexTokenMaker

yybegin, yybegin, yyclose, yytext

Methods inherited from class TokenMakerBase

addNullToken, addToken, addToken, addToken, createOccurrenceMarker, getClosestStandardTokenTypeForInternalType, getCurlyBracesDenoteCodeBlocks, getInsertBreakAction, getLanguageIndex, getLastTokenTypeOnLine, getMarkOccurrencesOfTokenType, getNoTokensIdentifiedYet, getOccurrenceMarker, getShouldIndentNextLineAfter, isIdentifierChar, resetTokenList, setLanguageIndex

Methods inherited from class Object

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

Methods inherited from interface TokenMaker

getTokenList

Constructor Details

AbstractMarkupTokenMaker

public AbstractMarkupTokenMaker()

Method Details

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(int languageIndex)

Description copied from interface: TokenMaker

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

Specified by:

getLineCommentStartAndEnd in interface TokenMaker

Overrides:

getLineCommentStartAndEnd in class TokenMakerBase

Parameters:

languageIndex - The language index at the offset in question. Since some TokenMakers effectively have nested languages (such as JavaScript in HTML), this parameter tells the TokenMaker what sub-language to look at.

Returns:

The start and end strings to add to a line to "comment" it out. A null value for either means there is no string to add for that part. A value of null for the array means this language does not support commenting/uncommenting lines.

isMarkupLanguage

public final boolean isMarkupLanguage()

Overridden to return true.

Specified by:

isMarkupLanguage in interface TokenMaker

Overrides:

isMarkupLanguage in class TokenMakerBase

Returns:

true always.