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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
|
/*******************************************************************************
* 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 Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.team.ui.synchronize;
import java.lang.reflect.InvocationTargetException;
import java.util.ArrayList;
import java.util.List;
import org.eclipse.compare.structuremergeviewer.IDiffElement;
import org.eclipse.jface.viewers.*;
import org.eclipse.swt.events.DisposeEvent;
import org.eclipse.swt.events.DisposeListener;
import org.eclipse.team.core.synchronize.*;
import org.eclipse.team.internal.ui.Utils;
import org.eclipse.team.internal.ui.synchronize.SyncInfoModelElement;
import org.eclipse.ui.actions.BaseSelectionListenerAction;
import org.eclipse.ui.ide.IDE;
/**
* This action provides utilities for performing operations on selections that
* contain {@link org.eclipse.team.ui.synchronize.ISynchronizeModelElement}
* instances. Subclasses can use this support to filter the selection in order
* to determine action enablement and generate the input for a
* {@link SynchronizeModelOperation}.
*
* @see SyncInfo
* @see SyncInfoSet
* @see SynchronizeModelOperation
* @since 3.0
*/
public abstract class SynchronizeModelAction extends BaseSelectionListenerAction {
private ISynchronizePageConfiguration configuration;
/**
* Create an action with the given text and configuration. By default,
* the action registers for selection change with the selection provider
* from the configuration's site.
*
* @param text the action's text
* @param configuration the actions synchronize page configuration
*/
protected SynchronizeModelAction(String text, ISynchronizePageConfiguration configuration) {
this(text, configuration, configuration.getSite().getSelectionProvider());
}
/**
* Create an action with the given text and configuration. By default,
* the action registers for selection change with the given selection provider.
*
* @param text the action's text
* @param configuration the actions synchronize page configuration
* @param selectionProvider a selection provider
*/
protected SynchronizeModelAction(String text, ISynchronizePageConfiguration configuration, ISelectionProvider selectionProvider) {
super(text);
this.configuration = configuration;
initialize(configuration, selectionProvider);
}
/**
* Method invoked from the constructor.
* The default implementation registers the action as a selection change
* listener. Subclasses may override.
*
* @param configuration the synchronize page configuration
* @param selectionProvider a selection provider
*/
protected void initialize(final ISynchronizePageConfiguration configuration, final ISelectionProvider selectionProvider) {
selectionProvider.addSelectionChangedListener(this);
configuration.getPage().getViewer().getControl().addDisposeListener(new DisposeListener() {
public void widgetDisposed(DisposeEvent e) {
selectionProvider.removeSelectionChangedListener(SynchronizeModelAction.this);
}
});
}
/* (non-Javadoc)
* @see org.eclipse.jface.action.Action#run()
*/
public void run() {
if(needsToSaveDirtyEditors()) {
if(!saveAllEditors(confirmSaveOfDirtyEditor())) {
return;
}
}
try {
runOperation();
} catch (InvocationTargetException e) {
handle(e);
} catch (InterruptedException e) {
handle(e);
}
}
/**
* Create aand run the operation for this action. By default, the operation is created
* by calling <code>getSubscriberOperation</code> and then run. Subclasses may
* override.
*
* @throws InvocationTargetException
* @throws InterruptedException
* @since 3.1
*/
protected void runOperation() throws InvocationTargetException, InterruptedException {
getSubscriberOperation(configuration, getFilteredDiffElements()).run();
}
/**
* Return whether dirty editor should be saved before this action is run.
* Default is <code>true</code>.
*
* @return whether dirty editor should be saved before this action is run
*/
protected boolean needsToSaveDirtyEditors() {
return true;
}
/**
* Returns whether the user should be prompted to save dirty editors. The
* default is <code>true</code>.
*
* @return whether the user should be prompted to save dirty editors
*/
protected boolean confirmSaveOfDirtyEditor() {
return true;
}
/**
* Return the subscriber operation associated with this action. This
* operation will be run when the action is run. Subclass may implement this
* method and provide an operation subclass or may override the
* <code>run(IAction)</code> method directly if they choose not to
* implement a <code>SynchronizeModelOperation</code>.
*
* @param configuration the synchronize page configuration for the page to
* which this action is associated
* @param elements the selected diff element for which this action is
* enabled.
* @return the subscriber operation to be run by this action.
*/
protected abstract SynchronizeModelOperation getSubscriberOperation(ISynchronizePageConfiguration configuration, IDiffElement[] elements);
/**
* Generic error handling code that uses an error dialog to show the error
* to the user. Subclasses can use this method and/or override it.
*
* @param e the exception that occurred.
*/
protected void handle(Exception e) {
Utils.handle(e);
}
/* (non-Javadoc)
* @see org.eclipse.ui.actions.BaseSelectionListenerAction#updateSelection(org.eclipse.jface.viewers.IStructuredSelection)
*/
protected boolean updateSelection(IStructuredSelection selection) {
super.updateSelection(selection);
return isEnabledForSelection(selection);
}
private boolean isEnabledForSelection(IStructuredSelection selection) {
return Utils.hasMatchingDescendant(selection, getSyncInfoFilter());
}
/**
* This method returns all instances of IDiffElement that are in the current
* selection.
*
* @return the selected elements
*/
protected final IDiffElement[] getSelectedDiffElements() {
return Utils.getDiffNodes(getStructuredSelection().toArray());
}
/**
* Filter uses to filter the user selection to contain only those elements
* for which this action is enabled. Default filter includes all out-of-sync
* elements in the current selection. Subsclasses may override.
*
* @return a sync info filter which selects all out-of-sync resources.
*/
protected FastSyncInfoFilter getSyncInfoFilter() {
return new FastSyncInfoFilter();
}
/**
* Return the selected diff element for which this action is enabled.
* @return the list of selected diff elements for which this action is
* enabled.
*/
protected final IDiffElement[] getFilteredDiffElements() {
IDiffElement[] elements = getSelectedDiffElements();
List filtered = new ArrayList();
for (int i = 0; i < elements.length; i++) {
IDiffElement e = elements[i];
if (e instanceof SyncInfoModelElement) {
SyncInfo info = ((SyncInfoModelElement) e).getSyncInfo();
if (info != null && getSyncInfoFilter().select(info)) {
filtered.add(e);
}
}
}
return (IDiffElement[]) filtered.toArray(new IDiffElement[filtered.size()]);
}
/**
* Set the selection of this action to the given selection
*
* @param selection the selection
*/
public void selectionChanged(ISelection selection) {
if (selection instanceof IStructuredSelection) {
super.selectionChanged((IStructuredSelection)selection);
} else {
super.selectionChanged(StructuredSelection.EMPTY);
}
}
/**
* Returns the configuration showing this action.
*
* @return the configuration showing this action.
*/
public ISynchronizePageConfiguration getConfiguration() {
return configuration;
}
/**
* Save all dirty editors in the workbench that are open on files that may
* be affected by this operation. Opens a dialog to prompt the user if
* <code>confirm</code> is true. Return true if successful. Return false
* if the user has cancelled the command. Must be called from the UI thread.
*
* @param confirm prompt the user if true
* @return boolean false if the operation was cancelled.
*/
public final boolean saveAllEditors(boolean confirm) {
return IDE.saveAllEditors(Utils.getResources(getFilteredDiffElements()), confirm);
}
}
|
