|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.text.rules.RuleBasedPartitioner
FastPartitioner
instead
A standard implementation of a syntax driven document partitioner. It uses a rule based scanner to scan the document and to determine the document's partitioning. The tokens returned by the rules the scanner is configured with are supposed to return the partition type as their data. The partitioner remembers the document's partitions in the document itself rather than maintaining its own data structure.
IRule
,
RuleBasedScanner
Field Summary | |
---|---|
static String |
CONTENT_TYPES_CATEGORY
Deprecated. As of 3.0, use getManagingPositionCategories() . |
protected int |
fDeleteOffset
Deprecated. The offset at which a partition has been deleted |
protected IDocument |
fDocument
Deprecated. The partitioner's document |
protected int |
fEndOffset
Deprecated. The offset at which the last changed partition ends |
protected String[] |
fLegalContentTypes
Deprecated. The legal content types of this partitioner |
protected DefaultPositionUpdater |
fPositionUpdater
Deprecated. The position updater used to for the default updating of partitions |
protected int |
fPreviousDocumentLength
Deprecated. The document length before a document change occurred |
protected RuleBasedScanner |
fScanner
Deprecated. The partitioner's scanner |
protected int |
fStartOffset
Deprecated. The offset at which the first changed partition starts |
Constructor Summary | |
---|---|
RuleBasedPartitioner(RuleBasedScanner scanner,
String[] legalContentTypes)
Deprecated. Creates a new partitioner that uses the given scanner and may return partitions of the given legal content types. |
Method Summary | |
---|---|
ITypedRegion[] |
computePartitioning(int offset,
int length)
Deprecated. Returns the partitioning of the given range of the connected document. |
ITypedRegion[] |
computePartitioning(int offset,
int length,
boolean includeZeroLengthPartitions)
Deprecated. Returns the partitioning of the given range of the connected document. |
void |
connect(IDocument document)
Deprecated. Connects the partitioner to a document. |
void |
disconnect()
Deprecated. Disconnects the partitioner from the document it is connected to. |
void |
documentAboutToBeChanged(DocumentEvent e)
Deprecated. Informs about a forthcoming document change. |
boolean |
documentChanged(DocumentEvent e)
Deprecated. The document has been changed. |
IRegion |
documentChanged2(DocumentEvent e)
Deprecated. The document has been changed. |
protected TypedPosition |
findClosestPosition(int offset)
Deprecated. Returns the position in the partitoner's position category which is close to the given offset. |
String |
getContentType(int offset)
Deprecated. Returns the content type of the partition containing the given offset in the connected document. |
String |
getContentType(int offset,
boolean preferOpenPartitions)
Deprecated. Returns the content type of the partition containing the given offset in the connected document. |
String[] |
getLegalContentTypes()
Deprecated. Returns the set of all legal content types of this partitioner. |
String[] |
getManagingPositionCategories()
Deprecated. Returns the position categories that this partitioners uses in order to manage the partitioning information of the documents. |
ITypedRegion |
getPartition(int offset)
Deprecated. Returns the partition containing the given offset of the connected document. |
ITypedRegion |
getPartition(int offset,
boolean preferOpenPartitions)
Deprecated. Returns the partition containing the given offset of the connected document. |
protected String |
getTokenContentType(IToken token)
Deprecated. Returns a content type encoded in the given token. |
protected void |
initialize()
Deprecated. Performs the initial partitioning of the partitioner's document. |
protected boolean |
isSupportedContentType(String contentType)
Deprecated. Returns whether the given type is one of the legal content types. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String CONTENT_TYPES_CATEGORY
getManagingPositionCategories()
.
protected RuleBasedScanner fScanner
protected String[] fLegalContentTypes
protected IDocument fDocument
protected int fPreviousDocumentLength
protected DefaultPositionUpdater fPositionUpdater
protected int fStartOffset
protected int fEndOffset
protected int fDeleteOffset
Constructor Detail |
public RuleBasedPartitioner(RuleBasedScanner scanner, String[] legalContentTypes)
scanner
- the scanner this partitioner is supposed to uselegalContentTypes
- the legal content types of this partitionerMethod Detail |
public String[] getManagingPositionCategories()
IDocumentPartitionerExtension2
null
if
no position category is used.
getManagingPositionCategories
in interface IDocumentPartitionerExtension2
null
public void connect(IDocument document)
IDocumentPartitioner
The caller of this method must ensure that this partitioner is also set as the document's document partitioner.
This method has been replaced with IDocumentPartitionerExtension3.connect(IDocument, boolean)
.
Implementers should default a call connect(document)
to
connect(document, false)
in order to sustain the same semantics.
connect
in interface IDocumentPartitioner
document
- the document to be connected toprotected void initialize()
public void disconnect()
IDocumentPartitioner
The caller of this method should also must ensure that this partitioner is no longer the document's partitioner.
disconnect
in interface IDocumentPartitioner
public void documentAboutToBeChanged(DocumentEvent e)
IDocumentPartitioner
documentAboutToBeChanged
in interface IDocumentPartitioner
e
- the event describing the forthcoming changepublic boolean documentChanged(DocumentEvent e)
IDocumentPartitioner
This method has been replaced by IDocumentPartitionerExtension.documentChanged2(DocumentEvent)
.
documentChanged
in interface IDocumentPartitioner
e
- the event describing the document change
true
if partitioning changedpublic IRegion documentChanged2(DocumentEvent e)
IDocumentPartitionerExtension
null
if the partitioning did not change.
Will be called by the connected document and is not intended to be used by clients other than the connected document.
Replaces IDocumentPartitioner.documentChanged(DocumentEvent)
.
documentChanged2
in interface IDocumentPartitionerExtension
e
- the event describing the document change
null
protected TypedPosition findClosestPosition(int offset)
offset
- the offset for which to search the closest position
public String getContentType(int offset)
IDocumentPartitioner
Use IDocumentPartitionerExtension2.getContentType(int, boolean)
when
zero-length partitions are supported. In that case this method is
equivalent:
IDocumentPartitionerExtension2 extension= (IDocumentPartitionerExtension2) partitioner; return extension.getContentType(offset, false);
getContentType
in interface IDocumentPartitioner
offset
- the offset in the connected document
public ITypedRegion getPartition(int offset)
IDocumentPartitioner
Use IDocumentPartitionerExtension2.getPartition(int, boolean)
when
zero-length partitions are supported. In that case this method is
equivalent:
IDocumentPartitionerExtension2 extension= (IDocumentPartitionerExtension2) partitioner; return extension.getPartition(offset, false);
getPartition
in interface IDocumentPartitioner
offset
- the offset for which to determine the partition
public ITypedRegion[] computePartitioning(int offset, int length)
IDocumentPartitioner
Use IDocumentPartitionerExtension2.computePartitioning(int, int, boolean)
when
zero-length partitions are supported. In that case this method is
equivalent:
IDocumentPartitionerExtension2 extension= (IDocumentPartitionerExtension2) partitioner; return extension.computePartitioning(offset, length, false);
computePartitioning
in interface IDocumentPartitioner
offset
- the offset of the range of interestlength
- the length of the range of interest
public String[] getLegalContentTypes()
IDocumentPartitioner
getLegalContentTypes
in interface IDocumentPartitioner
protected boolean isSupportedContentType(String contentType)
contentType
- the content type to check
true
if the content type is a legal content typeprotected String getTokenContentType(IToken token)
null
and a string it is assumed that
it is the encoded content type.
token
- the token whose content type is to be determined
public String getContentType(int offset, boolean preferOpenPartitions)
IDocumentPartitionerExtension2
If preferOpenPartitions
is true
,
precedence is given to an open partition ending at offset
over a delimited partition starting at offset
.
This method replaces IDocumentPartitioner.getContentType(int)
and
behaves like it when prepreferOpenPartitions
is
false
, i.e. precedence is always given to the partition
that does not end at offset
.
getContentType
in interface IDocumentPartitionerExtension2
offset
- the offset in the connected documentpreferOpenPartitions
- true
if precedence should be
given to a open partition ending at offset
over
a delimited partition starting at offset
public ITypedRegion getPartition(int offset, boolean preferOpenPartitions)
IDocumentPartitionerExtension2
If preferOpenPartitions
is true
,
precedence is given to an open partition ending at offset
over a delimited partition starting at offset
.
This method replaces IDocumentPartitioner.getPartition(int)
and
behaves like it when false
, i.e. precedence is always given to the partition that does not
end at offset
.
getPartition
in interface IDocumentPartitionerExtension2
offset
- the offset for which to determine the partitionpreferOpenPartitions
- true
if precedence should be
given to a open partition ending at offset
over
a delimited partition starting at offset
public ITypedRegion[] computePartitioning(int offset, int length, boolean includeZeroLengthPartitions)
IDocumentPartitionerExtension2
If includeZeroLengthPartitions
is true
, a
zero-length partition of an open partition type (usually the default
partition) is included between two delimited partitions. If it is
false
, no zero-length partitions are included.
This method replaces
IDocumentPartitioner.computePartitioning(int, int)
and behaves
like it when includeZeroLengthPartitions
is
false
.
computePartitioning
in interface IDocumentPartitionerExtension2
offset
- the offset of the range of interestlength
- the length of the range of interestincludeZeroLengthPartitions
- true
if zero-length
partitions should be returned as part of the computed
partitioning
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.