Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Eclipse Platform Release 3.0
PREV NEXT | FRAMES NO FRAMES

## Uses of Interface
org.eclipse.jface.text.rules.IToken

Packages that use IToken
org.eclipse.jface.text.rules | Provides a framework for rule based text scanning and uses the framework to provide rule-driven default implementations of `IPresentationDamager`, `IPresentationRepairer` and `IDocumentPartitioner`.

Uses of IToken in org.eclipse.jface.text.rules

Classes in org.eclipse.jface.text.rules that implement IToken
`class` | `Token` Standard implementation of `IToken`.

Fields in org.eclipse.jface.text.rules declared as IToken
`protected IToken` | `WordRule.fDefaultToken` The default token to be returned on success and if nothing else has been specified.
`static IToken` | `Token.UNDEFINED` Standard token: Undefined.
`static IToken` | `Token.EOF` Standard token: End Of File.
`static IToken` | `Token.WHITESPACE` Standard token: Whitespace.
`static IToken` | `Token.OTHER` Deprecated. will be removed
`protected IToken` | `RuleBasedScanner.fDefaultReturnToken` The token to be returned by default if no rule fires
`protected IToken` | `PatternRule.fToken` The token to be returned on success
`protected IToken` | `NumberRule.fToken` The token to be returned when this rule is successful

Methods in org.eclipse.jface.text.rules that return IToken
`IToken` | `WordRule.evaluate(ICharacterScanner scanner)`
`IToken` | `WhitespaceRule.evaluate(ICharacterScanner scanner)`
`IToken` | `RuleBasedScanner.nextToken()`
`IToken` | `RuleBasedPartitionScanner.nextToken()`
`protected IToken` | `PatternRule.doEvaluate(ICharacterScanner scanner)` Evaluates this rules without considering any column constraints.
`protected IToken` | `PatternRule.doEvaluate(ICharacterScanner scanner, boolean resume)` Evaluates this rules without considering any column constraints.
`IToken` | `PatternRule.evaluate(ICharacterScanner scanner)`
`IToken` | `PatternRule.evaluate(ICharacterScanner scanner, boolean resume)`
`IToken` | `PatternRule.getSuccessToken()`
`IToken` | `NumberRule.evaluate(ICharacterScanner scanner)`
`IToken` | `ITokenScanner.nextToken()` Returns the next token in the document.
`IToken` | `IRule.evaluate(ICharacterScanner scanner)` Evaluates the rule by examining the characters available from the provided character scanner.
`IToken` | `IPredicateRule.getSuccessToken()` Returns the success token of this predicate rule.
`IToken` | `IPredicateRule.evaluate(ICharacterScanner scanner, boolean resume)` Evaluates the rule by examining the characters available from the provided character scanner.

Methods in org.eclipse.jface.text.rules with parameters of type IToken
`void` | `WordRule.addWord(String word, IToken token)` Adds a word and the token to be returned if it is detected.
`void` | `RuleBasedScanner.setDefaultReturnToken(IToken defaultReturnToken)` Configures the scanner's default return token.
`protected String` | `RuleBasedPartitioner.getTokenContentType(IToken token)` Deprecated. Returns a content type encoded in the given token.
`protected String` | `DefaultPartitioner.getTokenContentType(IToken token)` Returns a content type encoded in the given token.
`protected TextAttribute` | `DefaultDamagerRepairer.getTokenTextAttribute(IToken token)` Returns a text attribute encoded in the given token.

Constructors in org.eclipse.jface.text.rules with parameters of type IToken
`WordRule(IWordDetector detector, IToken defaultToken)` Creates a rule which, with the help of an word detector, will return the token associated with the detected word.
`WordPatternRule(IWordDetector detector, String startSequence, String endSequence, IToken token)` Creates a rule for the given starting and ending word pattern which, if detected, will return the specified token.
`WordPatternRule(IWordDetector detector, String startSequence, String endSequence, IToken token, char escapeCharacter)` /** Creates a rule for the given starting and ending word pattern which, if detected, will return the specified token.
`SingleLineRule(String startSequence, String endSequence, IToken token)` Creates a rule for the given starting and ending sequence which, if detected, will return the specified token.
`SingleLineRule(String startSequence, String endSequence, IToken token, char escapeCharacter)` Creates a rule for the given starting and ending sequence which, if detected, will return the specified token.
`SingleLineRule(String startSequence, String endSequence, IToken token, char escapeCharacter, boolean breaksOnEOF)` Creates a rule for the given starting and ending sequence which, if detected, will return the specified token.
`SingleLineRule(String startSequence, String endSequence, IToken token, char escapeCharacter, boolean breaksOnEOF, boolean escapeContinuesLine)` Creates a rule for the given starting and ending sequence which, if detected, will return the specified token.
`PatternRule(String startSequence, String endSequence, IToken token, char escapeCharacter, boolean breaksOnEOL)` Creates a rule for the given starting and ending sequence.
`PatternRule(String startSequence, String endSequence, IToken token, char escapeCharacter, boolean breaksOnEOL, boolean breaksOnEOF)` Creates a rule for the given starting and ending sequence.
`PatternRule(String startSequence, String endSequence, IToken token, char escapeCharacter, boolean breaksOnEOL, boolean breaksOnEOF, boolean escapeContinuesLine)` Creates a rule for the given starting and ending sequence.
`NumberRule(IToken token)` Creates a rule which will return the specified token when a numerical sequence is detected.
`MultiLineRule(String startSequence, String endSequence, IToken token)` Creates a rule for the given starting and ending sequence which, if detected, will return the specified token.
`MultiLineRule(String startSequence, String endSequence, IToken token, char escapeCharacter)` Creates a rule for the given starting and ending sequence which, if detected, will return the specific token.
`MultiLineRule(String startSequence, String endSequence, IToken token, char escapeCharacter, boolean breaksOnEOF)` Creates a rule for the given starting and ending sequence which, if detected, will return the specific token.
`EndOfLineRule(String startSequence, IToken token)` Creates a rule for the given starting sequence which, if detected, will return the specified token.
`EndOfLineRule(String startSequence, IToken token, char escapeCharacter)` Creates a rule for the given starting sequence which, if detected, will return the specified token.
`EndOfLineRule(String startSequence, IToken token, char escapeCharacter, boolean escapeContinuesLine)` Creates a rule for the given starting sequence which, if detected, will return the specified token.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Eclipse Platform Release 3.0
PREV NEXT | FRAMES NO FRAMES

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.