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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
/*******************************************************************************
* Copyright (c) 2000, 2004 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.team.internal.ui.synchronize;
import java.util.*;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.jface.action.*;
import org.eclipse.jface.util.IPropertyChangeListener;
import org.eclipse.jface.util.PropertyChangeEvent;
import org.eclipse.jface.viewers.*;
import org.eclipse.team.internal.ui.Policy;
import org.eclipse.team.ui.synchronize.*;
import org.eclipse.ui.IActionBars;
/**
* Manages the models that can be displayed by a synchronize page
*/
public abstract class SynchronizeModelManager extends SynchronizePageActionGroup {
private ISynchronizeModelProvider modelProvider;
private List toggleModelProviderActions;
private ISynchronizePageConfiguration configuration;
private StructuredViewerAdvisor advisor;
/**
* Action that allows changing the model providers supported by this advisor.
*/
private class ToggleModelProviderAction extends Action implements IPropertyChangeListener {
private ISynchronizeModelProviderDescriptor descriptor;
protected ToggleModelProviderAction(ISynchronizeModelProviderDescriptor descriptor) {
super(descriptor.getName(), Action.AS_RADIO_BUTTON);
setImageDescriptor(descriptor.getImageDescriptor());
setToolTipText(descriptor.getName());
this.descriptor = descriptor;
update();
configuration.addPropertyChangeListener(this);
}
public void run() {
ISynchronizeModelProvider mp = getActiveModelProvider();
IStructuredSelection selection = null;
if(mp != null) {
if(mp.getDescriptor().getId().equals(descriptor.getId())) return;
selection = (IStructuredSelection)configuration.getSite().getSelectionProvider().getSelection();
}
internalPrepareInput(descriptor.getId(), null);
setInput();
if(selection != null) {
setSelection(selection.toArray(), true);
}
}
public void update() {
ISynchronizeModelProvider mp = getActiveModelProvider();
if(mp != null) {
setChecked(mp.getDescriptor().getId().equals(descriptor.getId()));
}
}
/* (non-Javadoc)
* @see org.eclipse.jface.util.IPropertyChangeListener#propertyChange(org.eclipse.jface.util.PropertyChangeEvent)
*/
public void propertyChange(PropertyChangeEvent event) {
if (event.getProperty().equals(SynchronizePageConfiguration.P_MODEL)) {
update();
}
}
}
public SynchronizeModelManager(StructuredViewerAdvisor advisor, ISynchronizePageConfiguration configuration) {
this.advisor = advisor;
this.configuration = configuration;
configuration.addActionContribution(this);
}
/**
* Return the list of supported model providers for this advisor.
* @param viewer
* @return
*/
protected abstract ISynchronizeModelProviderDescriptor[] getSupportedModelProviders();
/**
* Get the model provider that will be used to create the input
* for the adviser's viewer.
* @return the model provider
*/
protected abstract ISynchronizeModelProvider createModelProvider(String id);
protected ISynchronizeModelProvider getActiveModelProvider() {
return modelProvider;
}
protected Object internalPrepareInput(String id, IProgressMonitor monitor) {
if(modelProvider != null) {
modelProvider.dispose();
}
modelProvider = createModelProvider(id);
return modelProvider.prepareInput(monitor);
}
/**
* Gets a new selection that contains the view model objects that
* correspond to the given objects. The advisor will try and
* convert the objects into the appropriate viewer objects.
* This is required because the model provider controls the actual
* model elements in the viewer and must be consulted in order to
* understand what objects can be selected in the viewer.
* <p>
* This method does not affect the selection of the viewer itself.
* It's main purpose is for testing and should not be used by other
* clients.
* </p>
* @param object the objects to select
* @return a selection corresponding to the given objects
*/
public ISelection getSelection(Object[] objects) {
if (modelProvider != null) {
Object[] viewerObjects = new Object[objects.length];
for (int i = 0; i < objects.length; i++) {
viewerObjects[i] = modelProvider.getMapping(objects[i]);
}
return new StructuredSelection(viewerObjects);
} else {
return StructuredSelection.EMPTY;
}
}
/**
* Sets a new selection for this viewer and optionally makes it visible. The advisor will try and
* convert the objects into the appropriate viewer objects. This is required because the model
* provider controls the actual model elements in the viewer and must be consulted in order to
* understand what objects can be selected in the viewer.
*
* @param object the objects to select
* @param reveal <code>true</code> if the selection is to be made visible, and
* <code>false</code> otherwise
*/
protected void setSelection(Object[] objects, boolean reveal) {
ISelection selection = getSelection(objects);
if (!selection.isEmpty()) {
advisor.setSelection(selection, reveal);
}
}
/* (non-Javadoc)
* @see org.eclipse.team.ui.synchronize.IActionContribution#initialize(org.eclipse.team.ui.synchronize.ISynchronizePageConfiguration)
*/
public void initialize(ISynchronizePageConfiguration configuration) {
super.initialize(configuration);
ISynchronizeModelProviderDescriptor[] providers = getSupportedModelProviders();
// We only need switching of layouts if there is more than one model provider
if (providers.length > 1) {
toggleModelProviderActions = new ArrayList();
for (int i = 0; i < providers.length; i++) {
final ISynchronizeModelProviderDescriptor provider = providers[i];
toggleModelProviderActions.add(new ToggleModelProviderAction(provider));
}
}
// The input may of been set already. In that case, don't change it and
// simply assign it to the view.
if(modelProvider == null) {
internalPrepareInput(null, null);
}
setInput();
}
/**
* Set the input of the viewer
*/
protected void setInput() {
configuration.setProperty(SynchronizePageConfiguration.P_MODEL, modelProvider.getModelRoot());
advisor.setInput(modelProvider);
}
/* (non-Javadoc)
* @see org.eclipse.team.ui.synchronize.IActionContribution#setActionBars(org.eclipse.ui.IActionBars)
*/
public void fillActionBars(IActionBars actionBars) {
if (toggleModelProviderActions == null) return;
IToolBarManager toolbar = actionBars.getToolBarManager();
IMenuManager menu = actionBars.getMenuManager();
IContributionItem group = findGroup(menu, ISynchronizePageConfiguration.LAYOUT_GROUP);
if(menu != null && group != null) {
MenuManager layout = new MenuManager(Policy.bind("action.layout.label")); //$NON-NLS-1$
menu.appendToGroup(group.getId(), layout);
appendToMenu(null, layout);
} else if(toolbar != null) {
group = findGroup(toolbar, ISynchronizePageConfiguration.LAYOUT_GROUP);
if (group != null) {
appendToMenu(group.getId(), toolbar);
}
}
}
private void appendToMenu(String groupId, IContributionManager menu) {
for (Iterator iter = toggleModelProviderActions.iterator(); iter.hasNext();) {
if (groupId == null) {
menu.add((Action) iter.next());
} else {
menu.appendToGroup(groupId, (Action) iter.next());
}
}
}
/* (non-Javadoc)
* @see org.eclipse.team.ui.synchronize.IActionContribution#dispose()
*/
public void dispose() {
if(modelProvider != null) {
modelProvider.dispose();
}
super.dispose();
}
/**
* @return Returns the configuration.
*/
public ISynchronizePageConfiguration getConfiguration() {
return configuration;
}
}
|
