All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.eclipse.jface.text.IDocumentPartitionerExtension2 Maven / Gradle / Ivy

/*******************************************************************************
 * Copyright (c) 2000, 2005 IBM Corporation and others.
 *
 * This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License 2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/

package org.eclipse.jface.text;


/**
 * Extension interface for {@link org.eclipse.jface.text.IDocumentPartitioner}.
 * 

* Extends the original concept of a document partitioner to answer the position * categories that are used to manage the partitioning information. *

* This extension also introduces the concept of open and delimited partitions. * A delimited partition has a predefined textual token delimiting its start and * end, while an open partition can fill any space between two delimited * partitions. *

*

* An open partition of length zero can occur between two delimited partitions, * thus having the same offset as the following delimited partition. The * document start and end are considered to be delimiters of open partitions, * i.e. there may be a zero-length partition between the document start and a * delimited partition starting at offset 0. *

* * @since 3.0 */ public interface IDocumentPartitionerExtension2 { /** * Returns the position categories that this partitioners uses in order to manage * the partitioning information of the documents. Returns null if * no position category is used. * * @return the position categories used to manage partitioning information or null */ String[] getManagingPositionCategories(); /* zero-length partition support */ /** * Returns the content type of the partition containing the given offset in * the connected document. There must be a document connected to this * partitioner. *

* If preferOpenPartitions is true, * precedence is given to an open partition ending at offset * over a delimited partition starting at offset. *

* This method replaces {@link 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. *

* * @param offset the offset in the connected document * @param preferOpenPartitions true if precedence should be * given to a open partition ending at offset over * a delimited partition starting at offset * @return the content type of the offset's partition */ String getContentType(int offset, boolean preferOpenPartitions); /** * Returns the partition containing the given offset of the connected * document. There must be a document connected to this partitioner. *

* If preferOpenPartitions is true, * precedence is given to an open partition ending at offset * over a delimited partition starting at offset.

*

* This method replaces {@link IDocumentPartitioner#getPartition(int)}and * behaves like it when preferOpenPartitions is false * , i.e. precedence is always given to the partition that does not * end at offset. *

* * @param offset the offset for which to determine the partition * @param preferOpenPartitions true if precedence should be * given to a open partition ending at offset over * a delimited partition starting at offset * @return the partition containing the offset */ ITypedRegion getPartition(int offset, boolean preferOpenPartitions); /** * Returns the partitioning of the given range of the connected document. * There must be a document connected to this partitioner. *

* 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 * {@link IDocumentPartitioner#computePartitioning(int, int)}and behaves * like it when includeZeroLengthPartitions is * false. *

* * @param offset the offset of the range of interest * @param length the length of the range of interest * @param includeZeroLengthPartitions true if zero-length * partitions should be returned as part of the computed * partitioning * @return the partitioning of the range */ ITypedRegion[] computePartitioning(int offset, int length, boolean includeZeroLengthPartitions); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy