org.eclipse.jface.text.IDocumentPartitioningListener Maven / Gradle / Ivy
The newest version!
/*******************************************************************************
* 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;
/**
* Interface of objects which are interested in getting informed
* about changes of a document's partitioning.
*
* Clients may implement this interface.
*
*
* In order to provided backward compatibility for clients of IDocumentPartitioningListener
, extension
* interfaces are used to provide a means of evolution. The following extension interfaces
* exist:
*
*
* - {@link org.eclipse.jface.text.IDocumentPartitioningListenerExtension} since version 2.0 replacing the original
* notification mechanism.
* - {@link org.eclipse.jface.text.IDocumentPartitioningListenerExtension2} since version 3.0 replacing all previous
* notification mechanisms. Thus, implementers up-to-date with version 3.0 do not have to implement
* {@link org.eclipse.jface.text.IDocumentPartitioningListenerExtension}.
*
* @see org.eclipse.jface.text.IDocumentPartitioningListenerExtension
* @see org.eclipse.jface.text.IDocumentPartitioningListenerExtension2
* @see org.eclipse.jface.text.IDocument
* @see org.eclipse.jface.text.IDocumentPartitioner
*/
public interface IDocumentPartitioningListener {
/**
* The partitioning of the given document changed.
*
* In version 2.0 this method has been replaces by
* {@link IDocumentPartitioningListenerExtension#documentPartitioningChanged(IDocument, IRegion)}.
*
*
* In version 3.0 this method has been replaces by
* {@link IDocumentPartitioningListenerExtension2#documentPartitioningChanged(DocumentPartitioningChangedEvent)}
*
* @param document the document whose partitioning changed
*
* @see IDocumentPartitioningListenerExtension#documentPartitioningChanged(IDocument, IRegion)
* @see IDocumentPartitioningListenerExtension2#documentPartitioningChanged(DocumentPartitioningChangedEvent)
* @see IDocument#addDocumentPartitioningListener(IDocumentPartitioningListener)
*/
void documentPartitioningChanged(IDocument document);
}