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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
/*******************************************************************************
* Copyright (c) 2009 Wind River Systems and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Wind River Systems - initial API and implementation
*******************************************************************************/
package org.eclipse.debug.internal.ui.viewers.model;
import org.eclipse.debug.internal.ui.viewers.model.provisional.IModelChangedListener;
import org.eclipse.debug.internal.ui.viewers.model.provisional.IModelDelta;
import org.eclipse.debug.internal.ui.viewers.model.provisional.IPresentationContext;
import org.eclipse.debug.internal.ui.viewers.model.provisional.IViewerUpdateListener;
import org.eclipse.debug.internal.ui.viewers.model.provisional.ModelDelta;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.jface.viewers.ISelectionProvider;
import org.eclipse.jface.viewers.TreePath;
import org.eclipse.jface.viewers.ViewerLabel;
import org.eclipse.swt.widgets.Display;
/**
* Interface of an tree model viewer. It declares the common methods for the
* JFace-based {@link TreeModelViewer} and the UI-less
* {@link VirtualTreeModelViewer}.
*
* @since 3.5
*/
public interface ITreeModelViewer extends ISelectionProvider {
/**
* Constant indicating that all levels of the tree should be expanded or
* collapsed.
*
* @see #setAutoExpandLevel(int)
* @see #getAutoExpandLevel()
*/
public static final int ALL_LEVELS = -1;
/**
* Returns the Display object that this viewer is in. The
* display object can be used by clients to access the display thread
* to call the viewer methods.
*/
public Display getDisplay();
/**
* Returns this viewer's presentation context.
*
* @return presentation context
*/
public IPresentationContext getPresentationContext();
/**
* Returns the current input of this viewer, or <code>null</code>
* if none. The viewer's input provides the "model" for the viewer's
* content.
*/
public Object getInput();
/**
* Sets the input of this viewer. Setting the input resets the
* viewer's contents and triggers an update starting at the input
* element.
* @param object Input element, or <code>null</code> if none.
*/
public void setInput(Object object);
/**
* Returns the current selection in viewer.
*/
public ISelection getSelection();
/**
* Sets a new selection for this viewer and optionally makes it visible.
*
* @param selection the new selection
* @param reveal <code>true</code> if the selection is to be made
* visible, and <code>false</code> otherwise
* @param force <code>true</code> if the selection should override the
* model selection policy
*/
public void setSelection(ISelection selection, boolean reveal, boolean force);
/**
* Returns the auto-expand level.
*
* @return non-negative level, or <code>ALL_LEVELS</code> if all levels of
* the tree are expanded automatically
* @see #setAutoExpandLevel
*/
public int getAutoExpandLevel();
/**
* Sets the auto-expand level to be used when the input of the viewer is set
* using {@link #setInput(Object)}. The value 0 means that there is no
* auto-expand; 1 means that the invisible root element is expanded (since
* most concrete implementations do not show the root element, there is usually
* no practical difference between using the values 0 and 1); 2 means that
* top-level elements are expanded, but not their children; 3 means that
* top-level elements are expanded, and their children, but not
* grandchildren; and so on.
* <p>
* The value <code>ALL_LEVELS</code> means that all subtrees should be
* expanded.
* </p>
*
* @param level
* non-negative level, or <code>ALL_LEVELS</code> to expand all
* levels of the tree
*/
public void setAutoExpandLevel(int level);
/**
* Returns the label data for the given element and for the given column,
* Returns <code>null</code> if the given element is not found or is not
* materialized in the virtual viewer. Clients may listen to label update
* events to be notified when element labels are updated.
*
* @param path Path of the element.
* @param columnIdx ID of the column for which to return the label data.
* @return Label object containing the label information. Can be
* <code>null</code> if the given element is not found or is not
* materialized in the virtual viewer.
*/
public ViewerLabel getElementLabel(TreePath path, String columnId);
/**
* Registers the specified listener for view update notifications.
*/
public void addViewerUpdateListener(IViewerUpdateListener listener);
/**
* Removes the specified listener from update notifications.
*/
public void removeViewerUpdateListener(IViewerUpdateListener listener);
/**
* Registers the specified listener for view label update notifications.
*/
public void addLabelUpdateListener(ILabelUpdateListener listener);
/**
* Removes the specified listener from view label update notifications.
*/
public void removeLabelUpdateListener(ILabelUpdateListener listener);
/**
* Registers the given listener for model delta notification.
* This listener is called immediately after the viewer processes
* the delta.
*/
public void addModelChangedListener(IModelChangedListener listener);
/**
* Removes the given listener from model delta notification.
*/
public void removeModelChangedListener(IModelChangedListener listener);
/**
* Writes state information into a delta for the sub-tree at the given
* path. It adds delta nodes and IModelDelta.EXPAND and IModelDelta.SELECT
* as it parses the sub-tree.
* @param path Path where to start saving the state.
* @param delta The delta where the state is to be saved.
* @param flagsToSave The flags to preserve during the state save. The
* supported flags are <code>IModelDelta.SELECT</code>,
* <code>IModelDelta.EXPAND</code>, <code>IModelDelta.COLLAPSE</code>.
*
* @since 3.6
*/
public void saveElementState(TreePath path, ModelDelta delta, int flagsToSave);
/**
* Causes the viewer to process the given delta as if it came from a
* model proxy. This method is intended to be used to restore state
* saved using {@link #saveElementState(TreePath, ModelDelta)}.
*
* @param delta Delta to process.
*/
public void updateViewer(IModelDelta delta);
}
|
