Package org.eclipse.jface.text.rules
Interface IPartitionTokenScanner
- All Superinterfaces:
ITokenScanner
- All Known Implementing Classes:
RuleBasedPartitionScanner
A partition token scanner returns tokens that represent partitions. For that reason,
a partition token scanner is vulnerable in respect to the document offset it starts
scanning. In a simple case, a partition token scanner must always start at a partition
boundary. A partition token scanner can also start in the middle of a partition,
if it knows the type of the partition.
Originally since 2.0, but moved to org.eclipse.text in 3.14
- Since:
- 3.14
-
Method Summary
Modifier and TypeMethodDescriptionvoid
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.Methods inherited from interface org.eclipse.jface.text.rules.ITokenScanner
getTokenLength, getTokenOffset, nextToken, setRange
-
Method Details
-
setPartialRange
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. The range may not only contain complete partitions but starts at the beginning of a line in the middle of a partition of the given content type. This requires that a partition delimiter can not contain a line delimiter.- Parameters:
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 starts
-