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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
/*******************************************************************************
* 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.jface.text;
import org.eclipse.swt.graphics.Point;
/**
* Extension interface for <code>ITextViewer</code>. Extends <code>ITextViewer</code> with
* <ul>
* <li> a replacement of the <code>ITextViewer.invalidateTextPresentation</code> method
* <li> a replacement of the <code>ITextViewer.setTextHover</code> method now accepting state masks
* </ul>
*
* @since 2.1
*/
public interface ITextViewerExtension2 {
/**
* The state mask of the default hover (value <code>0xff</code>).
*/
final int DEFAULT_HOVER_STATE_MASK= 0xff;
/**
* Invalidates the viewer's text presentation for the given range.
*
* @param offset the offset of the first character to be redrawn
* @param length the length of the range to be redrawn
*/
void invalidateTextPresentation(int offset, int length);
/**
* Sets this viewer's text hover for the given content type and the given state mask. If the given text hower
* is <code>null</code>, any hover installed for the given content type and state mask is uninstalled.
*
* @param textViewerHover the new hover or <code>null</code>
* @param contentType the type for which the hover is to be registered or unregistered
* @param stateMask the SWT event state mask; <code>DEFAULT_HOVER_STATE_MASK</code> indicates that
* the hover is installed as the default hover.
*/
void setTextHover(ITextHover textViewerHover, String contentType, int stateMask);
/**
* Removes all text hovers for the given content type.
* <p>
* Note: To remove a hover for a given content type and state mask
* use {@link #setTextHover(ITextHover, String, int)} with <code>null</code>
* as parameter for the text hover.
* </p>
* @param contentType the type for which all text hovers are to be unregistered
*/
void removeTextHovers(String contentType);
/**
* Returns the currently displayed text hover if any, <code>null</code> otherwise.
*/
ITextHover getCurrentTextHover();
/**
* Returns the location at which the most recent mouse hover event
* has been issued.
*
* @return the location of the most recent mouse hover event
*/
Point getHoverEventLocation();
/**
* Prepends the given auto edit strategy to the existing list of strategies for the
* specified content type. The strategies are called in the order in which they appear in the
* list of strategies.
*
* @param strategy the auto edit strategy
* @param contentType the content type
*/
void prependAutoEditStrategy(IAutoEditStrategy strategy, String contentType);
/**
* Removes the first occurrence of the given auto edit strategy in the list of strategies
* registered under the specified content type.
*
* @param strategy the auto edit strategy
* @param contentType the content type
*/
void removeAutoEditStrategy(IAutoEditStrategy strategy, String contentType);
/**
* Adds the given painter to this viewer.
*
* @param painter the painter to be added
*/
void addPainter(IPainter painter);
/**
* Removes the given painter from this viewer. If the painter has not been
* added to this viewer, this call is without effect.
*
* @param painter the painter to be removed
*/
void removePainter(IPainter painter);
}
|
