Skip navigation links
A B C D E F G I M N O P R S T U W 

A

addWord(String, IToken) - Method in class org.eclipse.jface.text.rules.WordRule
Adds a word and the token to be returned if it is detected.

B

BufferedDocumentScanner - Class in org.eclipse.jface.text.rules
A buffered document scanner.
BufferedDocumentScanner(int) - Constructor for class org.eclipse.jface.text.rules.BufferedDocumentScanner
Creates a new buffered document scanner.
BufferedRuleBasedScanner - Class in org.eclipse.jface.text.rules
A buffered rule based scanner.
BufferedRuleBasedScanner() - Constructor for class org.eclipse.jface.text.rules.BufferedRuleBasedScanner
Creates a new buffered rule based scanner which does not have any rule and a default buffer size of 500 characters.
BufferedRuleBasedScanner(int) - Constructor for class org.eclipse.jface.text.rules.BufferedRuleBasedScanner
Creates a new buffered rule based scanner which does not have any rule.

C

checkInitialization() - Method in class org.eclipse.jface.text.rules.FastPartitioner
Calls FastPartitioner.initialize() if the receiver is not yet initialized.
clearPositionCache() - Method in class org.eclipse.jface.text.rules.FastPartitioner
Clears the position cache.
computePartitioning(int, int) - Method in class org.eclipse.jface.text.rules.FastPartitioner
 
computePartitioning(int, int, boolean) - Method in class org.eclipse.jface.text.rules.FastPartitioner
May be replaced or extended by subclasses.
connect(IDocument) - Method in class org.eclipse.jface.text.rules.FastPartitioner
 
connect(IDocument, boolean) - Method in class org.eclipse.jface.text.rules.FastPartitioner
May be extended by subclasses.

D

disconnect() - Method in class org.eclipse.jface.text.rules.FastPartitioner
May be extended by subclasses.
documentAboutToBeChanged(DocumentEvent) - Method in class org.eclipse.jface.text.rules.FastPartitioner
May be extended by subclasses.
documentChanged(DocumentEvent) - Method in class org.eclipse.jface.text.rules.FastPartitioner
 
documentChanged2(DocumentEvent) - Method in class org.eclipse.jface.text.rules.FastPartitioner
May be extended by subclasses.
doEvaluate(ICharacterScanner) - Method in class org.eclipse.jface.text.rules.PatternRule
Evaluates this rules without considering any column constraints.
doEvaluate(ICharacterScanner, boolean) - Method in class org.eclipse.jface.text.rules.PatternRule
Evaluates this rules without considering any column constraints.

E

endSequenceDetected(ICharacterScanner) - Method in class org.eclipse.jface.text.rules.PatternRule
Returns whether the end sequence was detected.
EOF - Static variable in interface org.eclipse.jface.text.rules.ICharacterScanner
The value returned when this scanner has read EOF.
EOF - Static variable in class org.eclipse.jface.text.rules.Token
Standard token: End Of File.
evaluate(ICharacterScanner) - Method in interface org.eclipse.jface.text.rules.IRule
Evaluates the rule by examining the characters available from the provided character scanner.
evaluate(ICharacterScanner) - Method in class org.eclipse.jface.text.rules.PatternRule
 
evaluate(ICharacterScanner) - Method in class org.eclipse.jface.text.rules.WhitespaceRule
Evaluates the rule by examining the characters available from the provided character scanner.
evaluate(ICharacterScanner) - Method in class org.eclipse.jface.text.rules.WordRule
 
evaluate(ICharacterScanner, boolean) - Method in interface org.eclipse.jface.text.rules.IPredicateRule
Evaluates the rule by examining the characters available from the provided character scanner.
evaluate(ICharacterScanner, boolean) - Method in class org.eclipse.jface.text.rules.PatternRule
 

F

FastPartitioner - Class in org.eclipse.jface.text.rules
A standard implementation of a document partitioner.
FastPartitioner(IPartitionTokenScanner, String[]) - Constructor for class org.eclipse.jface.text.rules.FastPartitioner
Creates a new partitioner that uses the given scanner and may return partitions of the given legal content types.
fBreaksOnEOF - Variable in class org.eclipse.jface.text.rules.PatternRule
Indicates whether end of file terminates the pattern
fBreaksOnEOL - Variable in class org.eclipse.jface.text.rules.PatternRule
Indicates whether end of line terminates the pattern
fColumn - Variable in class org.eclipse.jface.text.rules.PatternRule
The pattern's column constrain
fColumn - Variable in class org.eclipse.jface.text.rules.RuleBasedScanner
The cached column of the current scanner position
fColumn - Variable in class org.eclipse.jface.text.rules.WordRule
The column constraint.
fContentType - Variable in class org.eclipse.jface.text.rules.RuleBasedPartitionScanner
The content type of the partition in which to resume scanning.
fDefaultReturnToken - Variable in class org.eclipse.jface.text.rules.RuleBasedScanner
The token to be returned by default if no rule fires
fDefaultToken - Variable in class org.eclipse.jface.text.rules.WordRule
The default token to be returned on success and if nothing else has been specified.
fDeleteOffset - Variable in class org.eclipse.jface.text.rules.FastPartitioner
The offset at which a partition has been deleted
fDelimiters - Variable in class org.eclipse.jface.text.rules.RuleBasedScanner
The cached legal line delimiters of the document
fDetector - Variable in class org.eclipse.jface.text.rules.WhitespaceRule
The whitespace detector used by this rule
fDetector - Variable in class org.eclipse.jface.text.rules.WordRule
The word detector used by this rule.
fDocument - Variable in class org.eclipse.jface.text.rules.FastPartitioner
The partitioner's document
fDocument - Variable in class org.eclipse.jface.text.rules.RuleBasedScanner
The document to be scanned
fEndOffset - Variable in class org.eclipse.jface.text.rules.FastPartitioner
The offset at which the last changed partition ends
fEndSequence - Variable in class org.eclipse.jface.text.rules.PatternRule
The pattern's end sequence
fEscapeCharacter - Variable in class org.eclipse.jface.text.rules.PatternRule
The pattern's escape character
fEscapeContinuesLine - Variable in class org.eclipse.jface.text.rules.PatternRule
Indicates whether the escape character continues a line
findClosestPosition(int) - Method in class org.eclipse.jface.text.rules.FastPartitioner
Returns the position in the partitoner's position category which is close to the given offset.
fLegalContentTypes - Variable in class org.eclipse.jface.text.rules.FastPartitioner
The legal content types of this partitioner
flushRewriteSession() - Method in class org.eclipse.jface.text.rules.FastPartitioner
Flushes the active rewrite session.
fOffset - Variable in class org.eclipse.jface.text.rules.RuleBasedScanner
The offset of the next character to be read
fPartitionOffset - Variable in class org.eclipse.jface.text.rules.RuleBasedPartitionScanner
The offset of the partition inside which to resume.
fPositionUpdater - Variable in class org.eclipse.jface.text.rules.FastPartitioner
The position updater used to for the default updating of partitions
fPreviousDocumentLength - Variable in class org.eclipse.jface.text.rules.FastPartitioner
The document length before a document change occurred
fRangeEnd - Variable in class org.eclipse.jface.text.rules.RuleBasedScanner
The end offset of the range to be scanned
fRules - Variable in class org.eclipse.jface.text.rules.RuleBasedScanner
The list of rules of this scanner
fScanner - Variable in class org.eclipse.jface.text.rules.FastPartitioner
The partitioner's scanner
fStartOffset - Variable in class org.eclipse.jface.text.rules.FastPartitioner
The offset at which the first changed partition starts
fStartSequence - Variable in class org.eclipse.jface.text.rules.PatternRule
The pattern's start sequence
fToken - Variable in class org.eclipse.jface.text.rules.PatternRule
The token to be returned on success
fTokenOffset - Variable in class org.eclipse.jface.text.rules.RuleBasedScanner
The offset of the last read token
fWhitespaceToken - Variable in class org.eclipse.jface.text.rules.WhitespaceRule
The token returned for whitespace.
fWords - Variable in class org.eclipse.jface.text.rules.WordRule
The table of predefined words and token for this rule.

G

getActiveRewriteSession() - Method in class org.eclipse.jface.text.rules.FastPartitioner
May be extended by subclasses.
getColumn() - Method in class org.eclipse.jface.text.rules.BufferedDocumentScanner
 
getColumn() - Method in interface org.eclipse.jface.text.rules.ICharacterScanner
Returns the column of the character scanner.
getColumn() - Method in class org.eclipse.jface.text.rules.RuleBasedScanner
 
getContentType(int) - Method in class org.eclipse.jface.text.rules.FastPartitioner
May be replaced or extended by subclasses.
getContentType(int, boolean) - Method in class org.eclipse.jface.text.rules.FastPartitioner
May be replaced or extended by subclasses.
getData() - Method in interface org.eclipse.jface.text.rules.IToken
Return a data attached to this token.
getData() - Method in class org.eclipse.jface.text.rules.Token
 
getLegalContentTypes() - Method in class org.eclipse.jface.text.rules.FastPartitioner
May be replaced or extended by subclasses.
getLegalLineDelimiters() - Method in class org.eclipse.jface.text.rules.BufferedDocumentScanner
 
getLegalLineDelimiters() - Method in interface org.eclipse.jface.text.rules.ICharacterScanner
Provides rules access to the legal line delimiters.
getLegalLineDelimiters() - Method in class org.eclipse.jface.text.rules.RuleBasedScanner
 
getManagingPositionCategories() - Method in class org.eclipse.jface.text.rules.FastPartitioner
 
getPartition(int) - Method in class org.eclipse.jface.text.rules.FastPartitioner
May be replaced or extended by subclasses.
getPartition(int, boolean) - Method in class org.eclipse.jface.text.rules.FastPartitioner
May be replaced or extended by subclasses.
getPositions() - Method in class org.eclipse.jface.text.rules.FastPartitioner
Returns the partitioners positions.
getSuccessToken() - Method in interface org.eclipse.jface.text.rules.IPredicateRule
Returns the success token of this predicate rule.
getSuccessToken() - Method in class org.eclipse.jface.text.rules.PatternRule
 
getTokenContentType(IToken) - Method in class org.eclipse.jface.text.rules.FastPartitioner
Returns a content type encoded in the given token.
getTokenLength() - Method in interface org.eclipse.jface.text.rules.ITokenScanner
Returns the length of the last token read by this scanner.
getTokenLength() - Method in class org.eclipse.jface.text.rules.RuleBasedScanner
 
getTokenOffset() - Method in interface org.eclipse.jface.text.rules.ITokenScanner
Returns the offset of the last token read by this scanner.
getTokenOffset() - Method in class org.eclipse.jface.text.rules.RuleBasedScanner
 

I

ICharacterScanner - Interface in org.eclipse.jface.text.rules
Defines the interface of a character scanner used by rules.
initialize() - Method in class org.eclipse.jface.text.rules.FastPartitioner
Performs the initial partitioning of the partitioner's document.
IPartitionTokenScanner - Interface in org.eclipse.jface.text.rules
A partition token scanner returns tokens that represent partitions.
IPredicateRule - Interface in org.eclipse.jface.text.rules
Defines the interface for a rule used in the scanning of text for the purpose of document partitioning or text styling.
IRule - Interface in org.eclipse.jface.text.rules
Defines the interface for a rule used in the scanning of text for the purpose of document partitioning or text styling.
isEOF() - Method in interface org.eclipse.jface.text.rules.IToken
Return whether this token represents End Of File.
isEOF() - Method in class org.eclipse.jface.text.rules.Token
 
isOther() - Method in interface org.eclipse.jface.text.rules.IToken
Return whether this token is neither undefined, nor whitespace, nor EOF.
isOther() - Method in class org.eclipse.jface.text.rules.Token
 
isSupportedContentType(String) - Method in class org.eclipse.jface.text.rules.FastPartitioner
Returns whether the given type is one of the legal content types.
isUndefined() - Method in interface org.eclipse.jface.text.rules.IToken
Return whether this token is undefined.
isUndefined() - Method in class org.eclipse.jface.text.rules.Token
 
isWhitespace() - Method in interface org.eclipse.jface.text.rules.IToken
Return whether this token represents a whitespace.
isWhitespace() - Method in class org.eclipse.jface.text.rules.Token
 
isWhitespace(char) - Method in interface org.eclipse.jface.text.rules.IWhitespaceDetector
Returns whether the specified character is whitespace.
isWordPart(char) - Method in interface org.eclipse.jface.text.rules.IWordDetector
Returns whether the specified character is valid as a subsequent character in a word.
isWordStart(char) - Method in interface org.eclipse.jface.text.rules.IWordDetector
Returns whether the specified character is valid as the first character in a word.
IToken - Interface in org.eclipse.jface.text.rules
A token to be returned by a rule.
ITokenScanner - Interface in org.eclipse.jface.text.rules
A token scanner scans a range of a document and reports about the token it finds.
IWhitespaceDetector - Interface in org.eclipse.jface.text.rules
Defines the interface by which WhitespaceRule determines whether a given character is to be considered whitespace in the current context.
IWordDetector - Interface in org.eclipse.jface.text.rules
Defines the interface by which WordRule determines whether a given character is valid as part of a word in the current context.

M

MultiLineRule - Class in org.eclipse.jface.text.rules
A rule for detecting patterns which begin with a given sequence and may end with a given sequence thereby spanning multiple lines.
MultiLineRule(String, String, IToken) - Constructor for class org.eclipse.jface.text.rules.MultiLineRule
Creates a rule for the given starting and ending sequence which, if detected, will return the specified token.
MultiLineRule(String, String, IToken, char) - Constructor for class org.eclipse.jface.text.rules.MultiLineRule
Creates a rule for the given starting and ending sequence which, if detected, will return the specific token.
MultiLineRule(String, String, IToken, char, boolean) - Constructor for class org.eclipse.jface.text.rules.MultiLineRule
Creates a rule for the given starting and ending sequence which, if detected, will return the specific token.

N

nextToken() - Method in interface org.eclipse.jface.text.rules.ITokenScanner
Returns the next token in the document.
nextToken() - Method in class org.eclipse.jface.text.rules.RuleBasedPartitionScanner
 
nextToken() - Method in class org.eclipse.jface.text.rules.RuleBasedScanner
 

O

org.eclipse.jface.text.rules - package org.eclipse.jface.text.rules
 
OTHER - Static variable in class org.eclipse.jface.text.rules.Token
Deprecated.
will be removed

P

PatternRule - Class in org.eclipse.jface.text.rules
Standard implementation of IPredicateRule.
PatternRule(String, String, IToken, char, boolean) - Constructor for class org.eclipse.jface.text.rules.PatternRule
Creates a rule for the given starting and ending sequence.
PatternRule(String, String, IToken, char, boolean, boolean) - Constructor for class org.eclipse.jface.text.rules.PatternRule
Creates a rule for the given starting and ending sequence.
PatternRule(String, String, IToken, char, boolean, boolean, boolean) - Constructor for class org.eclipse.jface.text.rules.PatternRule
Creates a rule for the given starting and ending sequence.

R

read() - Method in class org.eclipse.jface.text.rules.BufferedDocumentScanner
 
read() - Method in class org.eclipse.jface.text.rules.BufferedRuleBasedScanner
 
read() - Method in interface org.eclipse.jface.text.rules.ICharacterScanner
Returns the next character or EOF if end of file has been reached
read() - Method in class org.eclipse.jface.text.rules.RuleBasedScanner
 
RuleBasedPartitionScanner - Class in org.eclipse.jface.text.rules
Scanner that exclusively uses predicate rules.
RuleBasedPartitionScanner() - Constructor for class org.eclipse.jface.text.rules.RuleBasedPartitionScanner
 
RuleBasedScanner - Class in org.eclipse.jface.text.rules
A generic scanner which can be "programmed" with a sequence of rules.
RuleBasedScanner() - Constructor for class org.eclipse.jface.text.rules.RuleBasedScanner
Creates a new rule based scanner which does not have any rule.

S

sequenceDetected(ICharacterScanner, char[], boolean) - Method in class org.eclipse.jface.text.rules.PatternRule
Returns whether the next characters to be read by the character scanner are an exact match with the given sequence.
setBufferSize(int) - Method in class org.eclipse.jface.text.rules.BufferedRuleBasedScanner
Sets the buffer to the given number of characters.
setColumnConstraint(int) - Method in class org.eclipse.jface.text.rules.PatternRule
Sets a column constraint for this rule.
setColumnConstraint(int) - Method in class org.eclipse.jface.text.rules.WordRule
Sets a column constraint for this rule.
setData(Object) - Method in class org.eclipse.jface.text.rules.Token
Re-initializes the data of this token.
setDefaultReturnToken(IToken) - Method in class org.eclipse.jface.text.rules.RuleBasedScanner
Configures the scanner's default return token.
setPartialRange(IDocument, int, int, String, int) - Method in interface org.eclipse.jface.text.rules.IPartitionTokenScanner
Configures the scanner by providing access to the document range that should be scanned.
setPartialRange(IDocument, int, int, String, int) - Method in class org.eclipse.jface.text.rules.RuleBasedPartitionScanner
Configures the scanner by providing access to the document range that should be scanned.
setPredicateRules(IPredicateRule[]) - Method in class org.eclipse.jface.text.rules.RuleBasedPartitionScanner
 
setRange(IDocument, int, int) - Method in class org.eclipse.jface.text.rules.BufferedDocumentScanner
Configures the scanner by providing access to the document range over which to scan.
setRange(IDocument, int, int) - Method in class org.eclipse.jface.text.rules.BufferedRuleBasedScanner
 
setRange(IDocument, int, int) - Method in interface org.eclipse.jface.text.rules.ITokenScanner
Configures the scanner by providing access to the document range that should be scanned.
setRange(IDocument, int, int) - Method in class org.eclipse.jface.text.rules.RuleBasedPartitionScanner
 
setRange(IDocument, int, int) - Method in class org.eclipse.jface.text.rules.RuleBasedScanner
 
setRules(IRule[]) - Method in class org.eclipse.jface.text.rules.RuleBasedPartitionScanner
Disallow setting the rules since this scanner exclusively uses predicate rules.
setRules(IRule[]) - Method in class org.eclipse.jface.text.rules.RuleBasedScanner
Configures the scanner with the given sequence of rules.
SingleLineRule - Class in org.eclipse.jface.text.rules
A specific configuration of pattern rule whereby the pattern begins with a specific sequence and may end with a specific sequence, but will not span more than a single line.
SingleLineRule(String, String, IToken) - Constructor for class org.eclipse.jface.text.rules.SingleLineRule
Creates a rule for the given starting and ending sequence which, if detected, will return the specified token.
SingleLineRule(String, String, IToken, char) - Constructor for class org.eclipse.jface.text.rules.SingleLineRule
Creates a rule for the given starting and ending sequence which, if detected, will return the specified token.
SingleLineRule(String, String, IToken, char, boolean) - Constructor for class org.eclipse.jface.text.rules.SingleLineRule
Creates a rule for the given starting and ending sequence which, if detected, will return the specified token.
SingleLineRule(String, String, IToken, char, boolean, boolean) - Constructor for class org.eclipse.jface.text.rules.SingleLineRule
Creates a rule for the given starting and ending sequence which, if detected, will return the specified token.
startRewriteSession(DocumentRewriteSession) - Method in class org.eclipse.jface.text.rules.FastPartitioner
 
stopRewriteSession(DocumentRewriteSession) - Method in class org.eclipse.jface.text.rules.FastPartitioner
May be extended by subclasses.

T

Token - Class in org.eclipse.jface.text.rules
Standard implementation of IToken.
Token(Object) - Constructor for class org.eclipse.jface.text.rules.Token
Creates a new token which represents neither undefined, whitespace, nor EOF.

U

UNDEFINED - Static variable in class org.eclipse.jface.text.rules.PatternRule
Internal setting for the un-initialized column constraint
UNDEFINED - Static variable in class org.eclipse.jface.text.rules.RuleBasedScanner
Internal setting for the un-initialized column cache.
UNDEFINED - Static variable in class org.eclipse.jface.text.rules.Token
Standard token: Undefined.
UNDEFINED - Static variable in class org.eclipse.jface.text.rules.WordRule
Internal setting for the un-initialized column constraint.
unread() - Method in class org.eclipse.jface.text.rules.BufferedDocumentScanner
 
unread() - Method in class org.eclipse.jface.text.rules.BufferedRuleBasedScanner
 
unread() - Method in interface org.eclipse.jface.text.rules.ICharacterScanner
Rewinds the scanner before the last read character.
unread() - Method in class org.eclipse.jface.text.rules.RuleBasedScanner
 
unreadBuffer(ICharacterScanner) - Method in class org.eclipse.jface.text.rules.WordRule
Returns the characters in the buffer to the scanner.

W

WHITESPACE - Static variable in class org.eclipse.jface.text.rules.Token
Standard token: Whitespace.
WhitespaceRule - Class in org.eclipse.jface.text.rules
An implementation of IRule capable of detecting whitespace.
WhitespaceRule(IWhitespaceDetector) - Constructor for class org.eclipse.jface.text.rules.WhitespaceRule
Creates a rule which, with the help of an whitespace detector, will return Token.WHITESPACE when a whitespace is detected.
WhitespaceRule(IWhitespaceDetector, IToken) - Constructor for class org.eclipse.jface.text.rules.WhitespaceRule
Creates a rule which, with the help of an whitespace detector, will return the given whitespace token when a whitespace is detected.
WordRule - Class in org.eclipse.jface.text.rules
An implementation of IRule capable of detecting words.
WordRule(IWordDetector) - Constructor for class org.eclipse.jface.text.rules.WordRule
Creates a rule which, with the help of an word detector, will return the token associated with the detected word.
WordRule(IWordDetector, IToken) - Constructor for class org.eclipse.jface.text.rules.WordRule
Creates a rule which, with the help of a word detector, will return the token associated with the detected word.
WordRule(IWordDetector, IToken, boolean) - Constructor for class org.eclipse.jface.text.rules.WordRule
Creates a rule which, with the help of a word detector, will return the token associated with the detected word.
A B C D E F G I M N O P R S T U W 
Skip navigation links