|
Eclipse Platform Release 3.7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.text.rules.RuleBasedScanner
org.eclipse.jface.text.rules.BufferedRuleBasedScanner
org.eclipse.jface.text.rules.RuleBasedPartitionScanner
public class RuleBasedPartitionScanner
Scanner that exclusively uses predicate rules.
If a partial range is set (see setPartialRange(IDocument, int, int, String, int)
with
content type that is not null
then this scanner will first try the rules that match
the given content type.
Field Summary | |
---|---|
protected String |
fContentType
The content type of the partition in which to resume scanning. |
protected int |
fPartitionOffset
The offset of the partition inside which to resume. |
Fields inherited from class org.eclipse.jface.text.rules.RuleBasedScanner |
---|
fColumn, fDefaultReturnToken, fDelimiters, fDocument, fOffset, fRangeEnd, fRules, fTokenOffset, UNDEFINED |
Fields inherited from interface org.eclipse.jface.text.rules.ICharacterScanner |
---|
EOF |
Constructor Summary | |
---|---|
RuleBasedPartitionScanner()
|
Method Summary | |
---|---|
IToken |
nextToken()
Returns the next token in the document. |
void |
setPartialRange(IDocument document,
int offset,
int length,
String contentType,
int partitionOffset)
Configures the scanner by providing access to the document range that should be scanned. If the given content type is not null then this scanner will first try the rules
that match the given content type. |
void |
setPredicateRules(IPredicateRule[] rules)
|
void |
setRange(IDocument document,
int offset,
int length)
Configures the scanner by providing access to the document range that should be scanned. |
void |
setRules(IRule[] rules)
Disallow setting the rules since this scanner exclusively uses predicate rules. |
Methods inherited from class org.eclipse.jface.text.rules.BufferedRuleBasedScanner |
---|
read, setBufferSize, unread |
Methods inherited from class org.eclipse.jface.text.rules.RuleBasedScanner |
---|
getColumn, getLegalLineDelimiters, getTokenLength, getTokenOffset, setDefaultReturnToken |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.eclipse.jface.text.rules.ITokenScanner |
---|
getTokenLength, getTokenOffset |
Field Detail |
---|
protected String fContentType
protected int fPartitionOffset
Constructor Detail |
---|
public RuleBasedPartitionScanner()
Method Detail |
---|
public void setRules(IRule[] rules)
setRules
in class RuleBasedScanner
rules
- the sequence of rules controlling this scannerpublic void setPredicateRules(IPredicateRule[] rules)
public void setRange(IDocument document, int offset, int length)
ITokenScanner
setRange
in interface ITokenScanner
setRange
in class BufferedRuleBasedScanner
document
- the document to scanoffset
- the offset of the document range to scanlength
- the length of the document range to scanpublic void setPartialRange(IDocument document, int offset, int length, String contentType, int partitionOffset)
If the given content type is not null
then this scanner will first try the rules
that match the given content type.
setPartialRange
in interface IPartitionTokenScanner
document
- the document to scanoffset
- the offset of the document range to scanlength
- the length of the document range to scancontentType
- the content type at the given offsetpartitionOffset
- the offset at which the partition of the given offset startspublic IToken nextToken()
ITokenScanner
nextToken
in interface ITokenScanner
nextToken
in class RuleBasedScanner
|
Eclipse Platform Release 3.7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2011. All rights reserved.