com.fr.design.gui.syntax.ui.rsyntaxtextarea.modes

类 WindowsBatchTokenMaker

java.lang.Object

com.fr.design.gui.syntax.ui.rsyntaxtextarea.AbstractTokenMaker

com.fr.design.gui.syntax.ui.rsyntaxtextarea.modes.WindowsBatchTokenMaker

所有已实现的接口:

TokenMaker

public class WindowsBatchTokenMaker
extends AbstractTokenMaker

A token maker that turns text into a linked list of Tokens for syntax highlighting Microsoft Windows batch files.

版本:

0.1

作者:

Robert Futrell

字段概要

字段

限定符和类型	字段和说明
protected TokenImpl	currentToken Used in the creation of the linked list.
protected TokenImpl	firstToken The first token in the returned linked list.
protected java.lang.String	operators
protected TokenImpl	previousToken Used in the creation of the linked list.

从类继承的字段 com.fr.design.gui.syntax.ui.rsyntaxtextarea.AbstractTokenMaker

wordsToHighlight

构造器概要

构造器

构造器和说明
WindowsBatchTokenMaker() Constructor.

方法概要

方法

限定符和类型	方法和说明
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(javax.swing.text.Segment segment, int start, int end, int tokenType, int startOffset) Checks the token to give it the exact ID it deserves before being passed up to the super method.
protected OccurrenceMarker	createOccurrenceMarker() Returns the occurrence marker to use for this token maker.
int	getClosestStandardTokenTypeForInternalType(int type) Returns the closest "standard" token type for a given "internal" token type (e.g. one whose value is < 0).
boolean	getCurlyBracesDenoteCodeBlocks() Returns whether this programming language uses curly braces ('{' and '}') to denote code blocks.
javax.swing.Action	getInsertBreakAction() Returns an action to handle "insert break" key presses (i.e.
int	getLastTokenTypeOnLine(javax.swing.text.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.
java.lang.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.
OccurrenceMarker	getOccurrenceMarker() Returns the object in charge of marking all occurrences of the token at the current caret position, if it is a relevant token.
boolean	getShouldIndentNextLineAfter(Token token) The default implementation returns false always.
Token	getTokenList(javax.swing.text.Segment text, int startTokenType, int startOffset) Returns a list of tokens representing the given text.
TokenMap	getWordsToHighlight() Returns the words to highlight for Windows batch files.
boolean	isMarkupLanguage() The default implementation returns false always.
protected void	resetTokenList() Deletes the linked list of tokens so we can begin anew.
void	setLanguageIndex(int languageIndex) Sets the language index to assign to tokens moving forward.

从类继承的方法 com.fr.design.gui.syntax.ui.rsyntaxtextarea.AbstractTokenMaker

removeLastToken

从类继承的方法 java.lang.Object

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

字段详细资料

operators

protected final java.lang.String operators

另请参阅:

常量字段值

firstToken

protected TokenImpl firstToken

The first token in the returned linked list.

currentToken

protected TokenImpl currentToken

Used in the creation of the linked list.

previousToken

protected TokenImpl previousToken

Used in the creation of the linked list.

构造器详细资料

WindowsBatchTokenMaker

public WindowsBatchTokenMaker()

Constructor.

方法详细资料

addToken

public void addToken(javax.swing.text.Segment segment,
            int start,
            int end,
            int tokenType,
            int startOffset)

Checks the token to give it the exact ID it deserves before being passed up to the super method.

参数:

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 the token occurs.

getLineCommentStartAndEnd

public java.lang.String[] getLineCommentStartAndEnd()

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

指定者:

getLineCommentStartAndEnd 在接口中 TokenMaker

返回:

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

getMarkOccurrencesOfTokenType

public boolean getMarkOccurrencesOfTokenType(int type)

Returns whether tokens of the specified type should have "mark occurrences" enabled for the current programming language.

指定者:

getMarkOccurrencesOfTokenType 在接口中 TokenMaker

参数:

type - The token type.

返回:

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

getWordsToHighlight

public TokenMap getWordsToHighlight()

Returns the words to highlight for Windows batch files.

指定者:

getWordsToHighlight 在类中 AbstractTokenMaker

返回:

A TokenMap containing the words to highlight for Windows batch files.

另请参阅:

AbstractTokenMaker.getWordsToHighlight()

getTokenList

public Token getTokenList(javax.swing.text.Segment text,
                 int startTokenType,
                 int startOffset)

Returns a list of tokens representing the given text.

参数:

text - The text to break into tokens.

startTokenType - The token with which to start tokenizing.

startOffset - The offset at which the line of tokens begins.

返回:

A linked list of tokens representing text.

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.

指定者:

addNullToken 在接口中 TokenMaker

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.

指定者:

addToken 在接口中 TokenMaker

参数:

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.

参数:

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.

createOccurrenceMarker

protected OccurrenceMarker createOccurrenceMarker()

Returns the occurrence marker to use for this token maker. Subclasses can override to use different implementations.

返回:

The occurrence marker to use.

getClosestStandardTokenTypeForInternalType

public int getClosestStandardTokenTypeForInternalType(int type)

Returns the closest "standard" token type for a given "internal" token type (e.g. one whose value is < 0).

The default implementation returns type always, which denotes that a mapping from internal token types to standard token types is not defined; subclasses can override.

指定者:

getClosestStandardTokenTypeForInternalType 在接口中 TokenMaker

参数:

type - The token type.

返回:

The closest "standard" token type.

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.

指定者:

getCurlyBracesDenoteCodeBlocks 在接口中 TokenMaker

返回:

Whether curly braces denote code blocks.

getInsertBreakAction

public javax.swing.Action getInsertBreakAction()

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

指定者:

getInsertBreakAction 在接口中 TokenMaker

返回:

The default implementation always returns null.

getLastTokenTypeOnLine

public int getLastTokenTypeOnLine(javax.swing.text.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.

指定者:

getLastTokenTypeOnLine 在接口中 TokenMaker

参数:

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).

返回:

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

getOccurrenceMarker

public OccurrenceMarker getOccurrenceMarker()

Returns the object in charge of marking all occurrences of the token at the current caret position, if it is a relevant token. If null is returned, a default OccurrenceMarker is used.

指定者:

getOccurrenceMarker 在接口中 TokenMaker

返回:

The occurrence marker for this language, or null for none.

getShouldIndentNextLineAfter

public boolean getShouldIndentNextLineAfter(Token token)

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

指定者:

getShouldIndentNextLineAfter 在接口中 TokenMaker

参数:

token - The token the previous line ends with.

返回:

Whether the next line should be indented.

isMarkupLanguage

public boolean isMarkupLanguage()

The default implementation returns false always. Subclasses that are highlighting a markup language should override this method to return true.

指定者:

isMarkupLanguage 在接口中 TokenMaker

返回:

false always.

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).

setLanguageIndex

public void setLanguageIndex(int languageIndex)

Sets the language index to assign to tokens moving forward. This property is used to designate tokens as being in "secondary" languages (such as CSS or JavaScript in HTML).

参数:

languageIndex - The new language index. A value of 0 denotes the "main" language, any positive value denotes a specific secondary language. Negative values will be treated as 0.