Added
Link Here
|
1 |
/******************************************************************************* |
2 |
* Copyright (c) 2008 IBM Corporation and others. |
3 |
* All rights reserved. This program and the accompanying materials |
4 |
* are made available under the terms of the Eclipse Public License v1.0 |
5 |
* which accompanies this distribution, and is available at |
6 |
* http://www.eclipse.org/legal/epl-v10.html |
7 |
* |
8 |
* Contributors: |
9 |
* IBM Corporation - initial API and implementation |
10 |
******************************************************************************/ |
11 |
|
12 |
package org.eclipse.jface.databinding.dialog; |
13 |
|
14 |
import java.util.Iterator; |
15 |
|
16 |
import org.eclipse.core.databinding.AggregateValidationStatus; |
17 |
import org.eclipse.core.databinding.DataBindingContext; |
18 |
import org.eclipse.core.databinding.ValidationStatusProvider; |
19 |
import org.eclipse.core.databinding.observable.ChangeEvent; |
20 |
import org.eclipse.core.databinding.observable.IChangeListener; |
21 |
import org.eclipse.core.databinding.observable.IObservable; |
22 |
import org.eclipse.core.databinding.observable.list.IListChangeListener; |
23 |
import org.eclipse.core.databinding.observable.list.IObservableList; |
24 |
import org.eclipse.core.databinding.observable.list.ListChangeEvent; |
25 |
import org.eclipse.core.databinding.observable.list.ListDiff; |
26 |
import org.eclipse.core.databinding.observable.list.ListDiffEntry; |
27 |
import org.eclipse.core.databinding.observable.value.IObservableValue; |
28 |
import org.eclipse.core.databinding.observable.value.IValueChangeListener; |
29 |
import org.eclipse.core.databinding.observable.value.ValueChangeEvent; |
30 |
import org.eclipse.core.databinding.util.Policy; |
31 |
import org.eclipse.core.runtime.AssertionFailedException; |
32 |
import org.eclipse.core.runtime.IStatus; |
33 |
import org.eclipse.core.runtime.MultiStatus; |
34 |
import org.eclipse.core.runtime.Status; |
35 |
import org.eclipse.jface.dialogs.DialogPage; |
36 |
import org.eclipse.jface.dialogs.IMessageProvider; |
37 |
import org.eclipse.jface.wizard.WizardPage; |
38 |
|
39 |
/** |
40 |
* @since 3.3 |
41 |
* |
42 |
*/ |
43 |
public class DialogPageSupport { |
44 |
private DialogPage dialogPage; |
45 |
private DataBindingContext dbc; |
46 |
private IObservableValue aggregateStatus; |
47 |
private boolean uiChanged = false; |
48 |
private IChangeListener uiChangeListener = new IChangeListener() { |
49 |
public void handleChange(ChangeEvent event) { |
50 |
handleUIChanged(); |
51 |
} |
52 |
}; |
53 |
private IListChangeListener validationStatusProvidersListener = new IListChangeListener() { |
54 |
public void handleListChange(ListChangeEvent event) { |
55 |
ListDiff diff = event.diff; |
56 |
ListDiffEntry[] differences = diff.getDifferences(); |
57 |
for (int i = 0; i < differences.length; i++) { |
58 |
ListDiffEntry listDiffEntry = differences[i]; |
59 |
ValidationStatusProvider validationStatusProvider = (ValidationStatusProvider) listDiffEntry |
60 |
.getElement(); |
61 |
IObservableList targets = validationStatusProvider.getTargets(); |
62 |
if (listDiffEntry.isAddition()) { |
63 |
targets |
64 |
.addListChangeListener(validationStatusProviderTargetsListener); |
65 |
for (Iterator it = targets.iterator(); it.hasNext();) { |
66 |
((IObservable) it.next()) |
67 |
.addChangeListener(uiChangeListener); |
68 |
} |
69 |
} else { |
70 |
targets |
71 |
.removeListChangeListener(validationStatusProviderTargetsListener); |
72 |
for (Iterator it = targets.iterator(); it.hasNext();) { |
73 |
((IObservable) it.next()) |
74 |
.removeChangeListener(uiChangeListener); |
75 |
} |
76 |
} |
77 |
} |
78 |
} |
79 |
}; |
80 |
private IListChangeListener validationStatusProviderTargetsListener = new IListChangeListener() { |
81 |
public void handleListChange(ListChangeEvent event) { |
82 |
ListDiff diff = event.diff; |
83 |
ListDiffEntry[] differences = diff.getDifferences(); |
84 |
for (int i = 0; i < differences.length; i++) { |
85 |
ListDiffEntry listDiffEntry = differences[i]; |
86 |
IObservable target = (IObservable) listDiffEntry.getElement(); |
87 |
if (listDiffEntry.isAddition()) { |
88 |
target.addChangeListener(uiChangeListener); |
89 |
} else { |
90 |
target.removeChangeListener(uiChangeListener); |
91 |
} |
92 |
} |
93 |
} |
94 |
}; |
95 |
protected IStatus currentStatus; |
96 |
|
97 |
protected DialogPageSupport(DialogPage dialogPage, DataBindingContext dbc) { |
98 |
this.dialogPage = dialogPage; |
99 |
this.dbc = dbc; |
100 |
init(); |
101 |
} |
102 |
|
103 |
/** |
104 |
* Connect the validation result from the given data binding context to the |
105 |
* given wizard page. Upon creation, the wizard page support will use the |
106 |
* context's validation result to determine whether the page is complete. |
107 |
* The page's error message will not be set at this time ensuring that the |
108 |
* wizard page does not show an error right away. Upon any validation result |
109 |
* change, {@link WizardPage#setPageComplete(boolean)} will be called |
110 |
* reflecting the new validation result, and the wizard page's error message |
111 |
* will be updated according to the current validation result. |
112 |
* |
113 |
* @param wizardPage |
114 |
* @param dbc |
115 |
* @return an instance of WizardPageSupport |
116 |
*/ |
117 |
public static DialogPageSupport create(DialogPage wizardPage, |
118 |
DataBindingContext dbc) { |
119 |
return new DialogPageSupport(wizardPage, dbc); |
120 |
} |
121 |
|
122 |
protected DialogPage getDialogPage() { |
123 |
return dialogPage; |
124 |
} |
125 |
|
126 |
protected void init() { |
127 |
aggregateStatus = new AggregateValidationStatus(dbc |
128 |
.getValidationStatusProviders(), |
129 |
AggregateValidationStatus.MAX_SEVERITY); |
130 |
aggregateStatus.addValueChangeListener(new IValueChangeListener() { |
131 |
public void handleValueChange(ValueChangeEvent event) { |
132 |
|
133 |
currentStatus = (IStatus) event.diff.getNewValue(); |
134 |
handleStatusChanged(); |
135 |
} |
136 |
}); |
137 |
currentStatus = (IStatus) aggregateStatus.getValue(); |
138 |
handleStatusChanged(); |
139 |
dbc.getValidationStatusProviders().addListChangeListener( |
140 |
validationStatusProvidersListener); |
141 |
for (Iterator it = dbc.getValidationStatusProviders().iterator(); it |
142 |
.hasNext();) { |
143 |
ValidationStatusProvider validationStatusProvider = (ValidationStatusProvider) it |
144 |
.next(); |
145 |
IObservableList targets = validationStatusProvider.getTargets(); |
146 |
targets |
147 |
.addListChangeListener(validationStatusProviderTargetsListener); |
148 |
for (Iterator iter = targets.iterator(); iter.hasNext();) { |
149 |
((IObservable) iter.next()).addChangeListener(uiChangeListener); |
150 |
} |
151 |
} |
152 |
} |
153 |
|
154 |
protected void handleUIChanged() { |
155 |
uiChanged = true; |
156 |
if (currentStatus != null) { |
157 |
handleStatusChanged(); |
158 |
} |
159 |
dbc.getValidationStatusProviders().removeListChangeListener( |
160 |
validationStatusProvidersListener); |
161 |
for (Iterator it = dbc.getValidationStatusProviders().iterator(); it |
162 |
.hasNext();) { |
163 |
ValidationStatusProvider validationStatusProvider = (ValidationStatusProvider) it |
164 |
.next(); |
165 |
IObservableList targets = validationStatusProvider.getTargets(); |
166 |
targets |
167 |
.removeListChangeListener(validationStatusProviderTargetsListener); |
168 |
for (Iterator iter = targets.iterator(); iter.hasNext();) { |
169 |
((IObservable) iter.next()) |
170 |
.removeChangeListener(uiChangeListener); |
171 |
} |
172 |
} |
173 |
} |
174 |
|
175 |
protected void handleStatusChanged() { |
176 |
if (currentStatus != null |
177 |
&& currentStatus.getSeverity() == IStatus.ERROR) { |
178 |
dialogPage.setMessage(null); |
179 |
dialogPage.setErrorMessage(uiChanged ? currentStatus.getMessage() |
180 |
: null); |
181 |
if (currentStatusHasException()) { |
182 |
handleStatusException(); |
183 |
} |
184 |
} else if (currentStatus != null |
185 |
&& currentStatus.getSeverity() != IStatus.OK) { |
186 |
int severity = currentStatus.getSeverity(); |
187 |
int type; |
188 |
switch (severity) { |
189 |
case IStatus.OK: |
190 |
type = IMessageProvider.NONE; |
191 |
break; |
192 |
case IStatus.CANCEL: |
193 |
type = IMessageProvider.NONE; |
194 |
break; |
195 |
case IStatus.INFO: |
196 |
type = IMessageProvider.INFORMATION; |
197 |
break; |
198 |
case IStatus.WARNING: |
199 |
type = IMessageProvider.WARNING; |
200 |
break; |
201 |
case IStatus.ERROR: |
202 |
type = IMessageProvider.ERROR; |
203 |
break; |
204 |
default: |
205 |
throw new AssertionFailedException( |
206 |
"incomplete switch statement"); //$NON-NLS-1$ |
207 |
} |
208 |
dialogPage.setErrorMessage(null); |
209 |
dialogPage.setMessage(currentStatus.getMessage(), type); |
210 |
} else { |
211 |
dialogPage.setMessage(null); |
212 |
dialogPage.setErrorMessage(null); |
213 |
} |
214 |
} |
215 |
|
216 |
private boolean currentStatusHasException() { |
217 |
boolean hasException = false; |
218 |
if (currentStatus.getException() != null) { |
219 |
hasException = true; |
220 |
} |
221 |
if (currentStatus instanceof MultiStatus) { |
222 |
MultiStatus multiStatus = (MultiStatus) currentStatus; |
223 |
|
224 |
for (int i = 0; i < multiStatus.getChildren().length; i++) { |
225 |
IStatus status = multiStatus.getChildren()[i]; |
226 |
if (status.getException() != null) { |
227 |
hasException = true; |
228 |
break; |
229 |
} |
230 |
} |
231 |
} |
232 |
return hasException; |
233 |
} |
234 |
|
235 |
/** |
236 |
* This is called when a Override to provide custom exception handling and |
237 |
* reporting. |
238 |
*/ |
239 |
protected void handleStatusException() { |
240 |
if (currentStatus.getException() != null) { |
241 |
logThrowable(currentStatus.getException()); |
242 |
} else if (currentStatus instanceof MultiStatus) { |
243 |
MultiStatus multiStatus = (MultiStatus) currentStatus; |
244 |
for (int i = 0; i < multiStatus.getChildren().length; i++) { |
245 |
IStatus status = multiStatus.getChildren()[i]; |
246 |
if (status.getException() != null) { |
247 |
logThrowable(status.getException()); |
248 |
} |
249 |
} |
250 |
} |
251 |
} |
252 |
|
253 |
private void logThrowable(Throwable throwable) { |
254 |
Policy |
255 |
.getLog() |
256 |
.log( |
257 |
new Status( |
258 |
IStatus.ERROR, |
259 |
Policy.JFACE_DATABINDING, |
260 |
IStatus.OK, |
261 |
"Unhandled exception: " + throwable.getMessage(), throwable)); //$NON-NLS-1$ |
262 |
} |
263 |
|
264 |
/** |
265 |
* Disposes of this wizard page support object, removing any listeners it |
266 |
* may have attached. |
267 |
*/ |
268 |
public void dispose() { |
269 |
aggregateStatus.dispose(); |
270 |
if (!uiChanged) { |
271 |
for (Iterator it = dbc.getValidationStatusProviders().iterator(); it |
272 |
.hasNext();) { |
273 |
ValidationStatusProvider validationStatusProvider = (ValidationStatusProvider) it |
274 |
.next(); |
275 |
IObservableList targets = validationStatusProvider.getTargets(); |
276 |
targets |
277 |
.removeListChangeListener(validationStatusProviderTargetsListener); |
278 |
for (Iterator iter = targets.iterator(); iter.hasNext();) { |
279 |
((IObservable) iter.next()) |
280 |
.removeChangeListener(uiChangeListener); |
281 |
} |
282 |
} |
283 |
dbc.getValidationStatusProviders().removeListChangeListener( |
284 |
validationStatusProvidersListener); |
285 |
} |
286 |
aggregateStatus = null; |
287 |
dbc = null; |
288 |
uiChangeListener = null; |
289 |
validationStatusProvidersListener = null; |
290 |
validationStatusProviderTargetsListener = null; |
291 |
dialogPage = null; |
292 |
} |
293 |
|
294 |
} |