blob: 851749d796d4fc69a262b0ee8ba9f74745e5d4cf (
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
|
/*******************************************************************************
* Copyright (c) 2000, 2003 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/cpl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.compare.contentmergeviewer;
import org.eclipse.jface.text.Position;
import org.eclipse.jface.text.IDocument;
/**
* Defines a subrange in a document.
* <p>
* It is used by text viewers that can work on a subrange of a document. For example,
* a text viewer for Java compilation units might use this to restrict the view
* to a single method.
* </p>
* <p>
* Clients may implement this interface.
* </p>
*
* @see TextMergeViewer
* @see org.eclipse.compare.structuremergeviewer.DocumentRangeNode
*/
public interface IDocumentRange {
/**
* The position category typically used for an <code>IDocumentRange</code> position
* (value <code>"DocumentRangeCategory"</code>).
* @since 2.0
*/
public static final String RANGE_CATEGORY= "DocumentRangeCategory"; //$NON-NLS-1$
/**
* Returns the underlying document.
*
* @return the underlying document
*/
IDocument getDocument();
/**
* Returns a position that specifies a subrange in the underlying document,
* or <code>null</code> if this document range spans the whole underlying document.
*
* @return a position that specifies a subrange in the underlying document, or <code>null</code>
*/
Position getRange();
}
|