blob: 91e8eed22993a5e11c8abda5cb95a1a5bf0130d5 (
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
|
/*******************************************************************************
* 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.source.projection;
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.IRegion;
/**
* An <code>IProjectionPosition</code> is a position that is associated with a
* <code>ProjectionAnnotation</code> and that is able to compute its collapsed
* regions. That is, if a <code>Position</code> implements this interface,
* <code>ProjectionViewer</code> will delegate to the
* {@link #computeProjectionRegions(IDocument) computeProjectionRegions} method
* when determining the document regions that should be collapsed for a certain
* <code>ProjectionAnnotation</code>.
*
* @since 3.1
*/
public interface IProjectionPosition {
/**
* Returns an array of regions that should be collapsed when the annotation
* belonging to this position is collapsed. May return null instead of
* an empty array.
*
* @param document the document that this position is attached to
* @return the foldable regions for this position
* @throws BadLocationException if accessing the document fails
*/
IRegion[] computeProjectionRegions(IDocument document) throws BadLocationException;
/**
* Returns the offset of the caption (the anchor region) of this projection
* position. The returned offset is relative to the receivers offset into
* the document.
*
* @param document the document that this position is attached to
* @return the caption offset relative to the position's offset
* @throws BadLocationException if accessing the document fails
*/
int computeCaptionOffset(IDocument document) throws BadLocationException;
}
|
