| org.eclipse.jface.text.IDocumentExtension3
All known Subclasses: org.eclipse.jface.text.AbstractDocument,
| Method Summary | |
| ITypedRegion[] | computePartitioning(String partitioning, int offset, int length, boolean includeZeroLengthPartitions)
Computes the partitioning of the given document range based on the given
partitioning type.
If includeZeroLengthPartitions is true, a
zero-length partition of an open partition type (usually the default
partition) is included between two closed partitions. | | String | getContentType(String partitioning, int offset, boolean preferOpenPartitions)
Returns the type of the document partition containing the given offset
for the given partitioning. | | IDocumentPartitioner | getDocumentPartitioner(String partitioning)
Returns the partitioner for the given partitioning or null if
no partitioner is registered. | | String[] | getLegalContentTypes(String partitioning)
Returns the set of legal content types of document partitions for the given partitioning
This set can be empty. | | ITypedRegion | getPartition(String partitioning, int offset, boolean preferOpenPartitions)
Returns the document partition of the given partitioning in which the
given offset is located.
If preferOpenPartitions is true,
precedence is given to an open partition ending at offset
over a delimited partition starting at offset. | | String[] | getPartitionings()
Returns the existing partitionings for this document. | | void | setDocumentPartitioner(String partitioning, IDocumentPartitioner partitioner)
Sets this document's partitioner. |
| DEFAULT_PARTITIONING | | final static String DEFAULT_PARTITIONING(Code) | | The identifier of the default partitioning.
|
| computePartitioning | | ITypedRegion[] computePartitioning(String partitioning, int offset, int length, boolean includeZeroLengthPartitions) throws BadLocationException, BadPartitioningException(Code) | | Computes the partitioning of the given document range based on the given
partitioning type.
If includeZeroLengthPartitions is true, a
zero-length partition of an open partition type (usually the default
partition) is included between two closed partitions. If it is
false, no zero-length partitions are included.
This is only supported if the connected IDocumentPartitioner
supports it, i.e. implements IDocumentPartitionerExtension2.
Otherwise, includeZeroLengthPartitions is ignored.
Parameters:
partitioning - the document's partitioning type
Parameters:
offset - the document offset at which the range starts
Parameters:
length - the length of the document range
Parameters:
includeZeroLengthPartitions - true if zero-lengthpartitions should be returned as part of the computed partitioning a specification of the range's partitioning
exception:
BadLocationException - if the range is invalid in this document$
exception:
BadPartitioningException - if partitioning is invalid for this document |
| getContentType | | String getContentType(String partitioning, int offset, boolean preferOpenPartitions) throws BadLocationException, BadPartitioningException(Code) | | Returns the type of the document partition containing the given offset
for the given partitioning. This is a convenience method for
getPartition(partitioning, offset, boolean).getType().
If preferOpenPartitions is true,
precedence is given to an open partition ending at offset
over a delimited partition starting at offset. If it is
false, precedence is given to the partition that does not
end at offset.
This is only supported if the connected IDocumentPartitioner
supports it, i.e. implements IDocumentPartitionerExtension2.
Otherwise, preferOpenPartitions is ignored.
Parameters:
partitioning - the partitioning
Parameters:
offset - the document offset
Parameters:
preferOpenPartitions - true if precedence should begiven to a open partition ending at offset over aclosed partition starting at offset the partition type
exception:
BadLocationException - if offset is invalid in this document
exception:
BadPartitioningException - if partitioning is invalid for this document |
| getDocumentPartitioner | | IDocumentPartitioner getDocumentPartitioner(String partitioning)(Code) | | Returns the partitioner for the given partitioning or null if
no partitioner is registered.
Parameters:
partitioning - the partitioning for which to set the partitioner the partitioner for the given partitioning |
| getLegalContentTypes | | String[] getLegalContentTypes(String partitioning) throws BadPartitioningException(Code) | | Returns the set of legal content types of document partitions for the given partitioning
This set can be empty. The set can contain more content types than contained by the
result of getPartitioning(partitioning, 0, getLength()).
Parameters:
partitioning - the partitioning for which to return the legal content types the set of legal content types
exception:
BadPartitioningException - if partitioning is invalid for this document |
| getPartition | | ITypedRegion getPartition(String partitioning, int offset, boolean preferOpenPartitions) throws BadLocationException, BadPartitioningException(Code) | | Returns the document partition of the given partitioning in which the
given offset is located.
If preferOpenPartitions is true,
precedence is given to an open partition ending at offset
over a delimited partition starting at offset. If it is
false, precedence is given to the partition that does not
end at offset.
This is only supported if the connected IDocumentPartitioner
supports it, i.e. implements IDocumentPartitionerExtension2.
Otherwise, preferOpenPartitions is ignored.
Parameters:
partitioning - the partitioning
Parameters:
offset - the document offset
Parameters:
preferOpenPartitions - true if precedence should begiven to a open partition ending at offset over aclosed partition starting at offset a specification of the partition
exception:
BadLocationException - if offset is invalid in this document
exception:
BadPartitioningException - if partitioning is invalid for this document |
| getPartitionings | | String[] getPartitionings()(Code) | | Returns the existing partitionings for this document. This includes
the default partitioning.
the existing partitionings for this document |
| setDocumentPartitioner | | void setDocumentPartitioner(String partitioning, IDocumentPartitioner partitioner)(Code) | | Sets this document's partitioner. The caller of this method is responsible for
disconnecting the document's old partitioner from the document and to
connect the new partitioner to the document. Informs all document partitioning
listeners about this change.
Parameters:
partitioning - the partitioning for which to set the partitioner
Parameters:
partitioner - the document's new partitioner
See Also: IDocumentPartitioningListener |
|
|