Uses of Interface org.netbeans.editor.TokenID (Editor Library) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.modules.editor.lib/1 1.14.0 3

PREV NEXT

FRAMES NO FRAMES

Uses of Interface
org.netbeans.editor.TokenID

Packages that use TokenID
org.netbeans.editor
org.netbeans.editor.ext	Completion Design View

Uses of TokenID in org.netbeans.editor

Subinterfaces of TokenID in org.netbeans.editor

interface ImageTokenID
Token-id with the fixed token image.

Subinterfaces of TokenID in org.netbeans.editor
`interface`	`ImageTokenID` Token-id with the fixed token image.

Classes in org.netbeans.editor that implement TokenID

class BaseImageTokenID
Token-id with the fixed token image.

class BaseTokenID
Base implementation of the token-id.

Classes in org.netbeans.editor that implement TokenID
`class`	`BaseImageTokenID` Token-id with the fixed token image.
`class`	`BaseTokenID` Base implementation of the token-id.

Fields in org.netbeans.editor declared as TokenID

protected TokenID Syntax.supposedTokenID
This variable can be populated by the parseToken() method in case the user types an errorneous construction but it's clear what correct token he meant to write.

Fields in org.netbeans.editor declared as TokenID
`protected TokenID`	`Syntax.supposedTokenID` This variable can be populated by the parseToken() method in case the user types an errorneous construction but it's clear what correct token he meant to write.

Methods in org.netbeans.editor that return TokenID

TokenID SyntaxUpdateTokens.TokenInfo.getID()


TokenID Syntax.getSupposedTokenID()


TokenID TokenItem.getTokenID()
          Get the token-id of this token-item

TokenID TokenItem.AbstractItem.getTokenID()


TokenID TokenItem.FilterItem.getTokenID()


TokenID DrawContext.getTokenID()
          Get token type number according to the appropriate syntax scanner

TokenID[] TokenContext.getTokenIDs()
          Get the token-ids that belong to this token-context.

TokenID Syntax.nextToken()
          Function that should be called externally to scan the text.

protected TokenID Syntax.parseToken()
          This is core function of analyzer and it returns either the token-id or null to indicate that the end of buffer was found.

Methods in org.netbeans.editor that return TokenID
`TokenID`	`SyntaxUpdateTokens.TokenInfo.getID()`
`TokenID`	`Syntax.getSupposedTokenID()`
`TokenID`	`TokenItem.getTokenID()` Get the token-id of this token-item
`TokenID`	`TokenItem.AbstractItem.getTokenID()`
`TokenID`	`TokenItem.FilterItem.getTokenID()`
`TokenID`	`DrawContext.getTokenID()` Get token type number according to the appropriate syntax scanner
`TokenID[]`	`TokenContext.getTokenIDs()` Get the token-ids that belong to this token-context.
`TokenID`	`Syntax.nextToken()` Function that should be called externally to scan the text.
`protected TokenID`	`Syntax.parseToken()` This is core function of analyzer and it returns either the token-id or null to indicate that the end of buffer was found.

Methods in org.netbeans.editor with parameters of type TokenID

protected void TokenContext.addTokenID(TokenID tokenID)
          Add token-id to the set of token-ids that belong to this context.

int[] SyntaxSupport.getTokenBlocks(int startPos, int endPos, TokenID[] tokenIDArray)
          Get position pairs covering the blocks that include only the tokens from the given token array.

abstract void SyntaxUpdateTokens.syntaxUpdateToken(TokenID id, TokenContextPath contextPath, int offset, int length)
          Notification that a token was found during updating of lexical states.

boolean TokenProcessor.token(TokenID tokenID, TokenContextPath tokenContextPath, int tokenBufferOffset, int tokenLength)
          Notify that the token was found.

Methods in org.netbeans.editor with parameters of type TokenID
`protected void`	`TokenContext.addTokenID(TokenID tokenID)` Add token-id to the set of token-ids that belong to this context.
`int[]`	`SyntaxSupport.getTokenBlocks(int startPos, int endPos, TokenID[] tokenIDArray)` Get position pairs covering the blocks that include only the tokens from the given token array.
`abstract void`	`SyntaxUpdateTokens.syntaxUpdateToken(TokenID id, TokenContextPath contextPath, int offset, int length)` Notification that a token was found during updating of lexical states.
`boolean`	`TokenProcessor.token(TokenID tokenID, TokenContextPath tokenContextPath, int tokenBufferOffset, int tokenLength)` Notify that the token was found.

Constructors in org.netbeans.editor with parameters of type TokenID

SyntaxUpdateTokens.TokenInfo(TokenID id, TokenContextPath contextPath, int offset, int length)

TokenItem.AbstractItem(TokenID tokenID, TokenContextPath tokenContextPath, int offset, String image)

Constructors in org.netbeans.editor with parameters of type TokenID
`SyntaxUpdateTokens.TokenInfo(TokenID id, TokenContextPath contextPath, int offset, int length)`
`TokenItem.AbstractItem(TokenID tokenID, TokenContextPath tokenContextPath, int offset, String image)`

Uses of TokenID in org.netbeans.editor.ext

Methods in org.netbeans.editor.ext that return TokenID

protected TokenID[] ExtSyntaxSupport.getBracketSkipTokens()
          Get the array of token IDs that should be skipped when searching for matching bracket.

TokenID[] ExtSyntaxSupport.getCommentTokens()
          Get the array of token IDs that denote the comments.

TokenID ExtSyntaxSupport.getTokenID(int offset)
          Gets the token-id of the token at the given position.

TokenID FormatSupport.getValidWhitespaceTokenID()
          Get the valid whitespace token-id by calling getWhitespaceTokenID().

TokenID FormatSupport.getWhitespaceTokenID()
          Get the token-id that should be assigned to the token that consists of the indentation whitespace only.

Methods in org.netbeans.editor.ext that return TokenID
`protected TokenID[]`	`ExtSyntaxSupport.getBracketSkipTokens()` Get the array of token IDs that should be skipped when searching for matching bracket.
`TokenID[]`	`ExtSyntaxSupport.getCommentTokens()` Get the array of token IDs that denote the comments.
`TokenID`	`ExtSyntaxSupport.getTokenID(int offset)` Gets the token-id of the token at the given position.
`TokenID`	`FormatSupport.getValidWhitespaceTokenID()` Get the valid whitespace token-id by calling `getWhitespaceTokenID()`.
`TokenID`	`FormatSupport.getWhitespaceTokenID()` Get the token-id that should be assigned to the token that consists of the indentation whitespace only.

Methods in org.netbeans.editor.ext with parameters of type TokenID

TokenItem ExtFormatSupport.findAnyToken(TokenItem startToken, TokenItem limitToken, TokenID[] tokenIDArray, TokenContextPath tokenContextPath, boolean backward)
          Search for any of the image tokens from the given array and return if the token matches any item from the array.

TokenItem ExtFormatSupport.findMatchingToken(TokenItem startToken, TokenItem limitToken, TokenID matchTokenID, String matchTokenImage, boolean backward)
          This method can be used to find a matching brace token.

TokenItem ExtFormatSupport.findToken(TokenItem startToken, TokenItem limitToken, TokenID tokenID, TokenContextPath tokenContextPath, String tokenImage, boolean backward)
          Find the token either by token-id or token-text or both.

int ExtFormatSupport.getIndex(TokenItem token, TokenID[] tokenIDArray)
          Get the index of the token in the given token-id-and-text array or -1 if the token is not in the array.

TokenItem FormatWriter.insertToken(TokenItem beforeToken, TokenID tokenID, TokenContextPath tokenContextPath, String tokenImage)
          Create a new token-item and insert it before the token-item given as parameter.

TokenItem FormatSupport.insertToken(TokenItem beforeToken, TokenID tokenID, TokenContextPath tokenContextPath, String tokenImage)
          Delegation to the same method in format-writer.

boolean ExtSyntaxSupport.isWhitespaceToken(TokenID tokenID, char[] buffer, int offset, int tokenLength)


void FormatSupport.replaceToken(TokenItem originalToken, TokenID tokenID, TokenContextPath tokenContextPath, String tokenImage)
          Replace the given token with the new token.

TokenItem FormatWriter.splitEnd(TokenItem token, int endLength, TokenID newTokenID, TokenContextPath newTokenContextPath)
          Create the additional token from the text at the end of the given token.

TokenItem FormatSupport.splitEnd(TokenItem token, int endLength, TokenID newTokenID, TokenContextPath newTokenContextPath)


TokenItem FormatWriter.splitStart(TokenItem token, int startLength, TokenID newTokenID, TokenContextPath newTokenContextPath)
          Create the additional token from the text at the start of the given token.

TokenItem FormatSupport.splitStart(TokenItem token, int startLength, TokenID newTokenID, TokenContextPath newTokenContextPath)


boolean FormatSupport.tokenEquals(TokenItem compareToken, TokenID withTokenID)
          Compare token-id of the compare-token with the given token-id.

boolean FormatSupport.tokenEquals(TokenItem compareToken, TokenID withTokenID, TokenContextPath withTokenContextPath)
          Compare token-id of the compare-token with the given token-id and token-context-path.

boolean FormatSupport.tokenEquals(TokenItem compareToken, TokenID withTokenID, TokenContextPath withTokenContextPath, String withTokenImage)
          Compare token-id of the compare-token with the given token-id and given token-text.

Methods in org.netbeans.editor.ext with parameters of type TokenID
`TokenItem`	`ExtFormatSupport.findAnyToken(TokenItem startToken, TokenItem limitToken, TokenID[] tokenIDArray, TokenContextPath tokenContextPath, boolean backward)` Search for any of the image tokens from the given array and return if the token matches any item from the array.
`TokenItem`	`ExtFormatSupport.findMatchingToken(TokenItem startToken, TokenItem limitToken, TokenID matchTokenID, String matchTokenImage, boolean backward)` This method can be used to find a matching brace token.
`TokenItem`	`ExtFormatSupport.findToken(TokenItem startToken, TokenItem limitToken, TokenID tokenID, TokenContextPath tokenContextPath, String tokenImage, boolean backward)` Find the token either by token-id or token-text or both.
`int`	`ExtFormatSupport.getIndex(TokenItem token, TokenID[] tokenIDArray)` Get the index of the token in the given token-id-and-text array or -1 if the token is not in the array.
`TokenItem`	`FormatWriter.insertToken(TokenItem beforeToken, TokenID tokenID, TokenContextPath tokenContextPath, String tokenImage)` Create a new token-item and insert it before the token-item given as parameter.
`TokenItem`	`FormatSupport.insertToken(TokenItem beforeToken, TokenID tokenID, TokenContextPath tokenContextPath, String tokenImage)` Delegation to the same method in format-writer.
`boolean`	`ExtSyntaxSupport.isWhitespaceToken(TokenID tokenID, char[] buffer, int offset, int tokenLength)`
`void`	`FormatSupport.replaceToken(TokenItem originalToken, TokenID tokenID, TokenContextPath tokenContextPath, String tokenImage)` Replace the given token with the new token.
`TokenItem`	`FormatWriter.splitEnd(TokenItem token, int endLength, TokenID newTokenID, TokenContextPath newTokenContextPath)` Create the additional token from the text at the end of the given token.
`TokenItem`	`FormatSupport.splitEnd(TokenItem token, int endLength, TokenID newTokenID, TokenContextPath newTokenContextPath)`
`TokenItem`	`FormatWriter.splitStart(TokenItem token, int startLength, TokenID newTokenID, TokenContextPath newTokenContextPath)` Create the additional token from the text at the start of the given token.
`TokenItem`	`FormatSupport.splitStart(TokenItem token, int startLength, TokenID newTokenID, TokenContextPath newTokenContextPath)`
`boolean`	`FormatSupport.tokenEquals(TokenItem compareToken, TokenID withTokenID)` Compare token-id of the compare-token with the given token-id.
`boolean`	`FormatSupport.tokenEquals(TokenItem compareToken, TokenID withTokenID, TokenContextPath withTokenContextPath)` Compare token-id of the compare-token with the given token-id and token-context-path.
`boolean`	`FormatSupport.tokenEquals(TokenItem compareToken, TokenID withTokenID, TokenContextPath withTokenContextPath, String withTokenImage)` Compare token-id of the compare-token with the given token-id and given token-text.