blob: fefed90957b6a6ec211bd7de524dcd247ed765fd (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
/*******************************************************************************
* 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.
* <p>
* Clients may implement this interface.
* </p>
* <p>
* In order to provided backward compatibility for clients of <code>IDocumentPartitioningListener</code>, extension
* interfaces are used to provide a means of evolution. The following extension interfaces
* exist:
* <ul>
* <li> {@link org.eclipse.jface.text.IDocumentPartitioningListenerExtension} since version 2.0 replacing the original
* notification mechanism.</li>
* <li> {@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}.</li>
* </ul>
* </p>
* @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.
* <p>
* In version 2.0 this method has been replaces by
* {@link IDocumentPartitioningListenerExtension#documentPartitioningChanged(IDocument, IRegion)}.
* <p>
* In version 3.0 this method has been replaces by
* {@link IDocumentPartitioningListenerExtension2#documentPartitioningChanged(DocumentPartitioningChangedEvent)}<p>
*
* @param document the document whose partitioning changed
*
* @see IDocumentPartitioningListenerExtension#documentPartitioningChanged(IDocument, IRegion)
* @see IDocumentPartitioningListenerExtension2#documentPartitioningChanged(DocumentPartitioningChangedEvent)
* @see IDocument#addDocumentPartitioningListener(IDocumentPartitioningListener)
*/
void documentPartitioningChanged(IDocument document);
}
|
