|
Added
Link Here
|
| 1 |
/******************************************************************************* |
| 2 |
* Copyright (c) 2004, 2008 Mylyn project committers 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 |
|
| 9 |
package org.eclipse.mylyn.tasks.ui.wizards; |
| 10 |
|
| 11 |
import java.lang.reflect.InvocationTargetException; |
| 12 |
import java.util.ArrayList; |
| 13 |
import java.util.Collections; |
| 14 |
import java.util.Comparator; |
| 15 |
import java.util.List; |
| 16 |
|
| 17 |
import org.eclipse.core.runtime.IConfigurationElement; |
| 18 |
import org.eclipse.core.runtime.IExtension; |
| 19 |
import org.eclipse.core.runtime.IExtensionPoint; |
| 20 |
import org.eclipse.core.runtime.IExtensionRegistry; |
| 21 |
import org.eclipse.core.runtime.IProgressMonitor; |
| 22 |
import org.eclipse.core.runtime.IStatus; |
| 23 |
import org.eclipse.core.runtime.MultiStatus; |
| 24 |
import org.eclipse.core.runtime.Platform; |
| 25 |
import org.eclipse.core.runtime.Status; |
| 26 |
import org.eclipse.core.runtime.SubProgressMonitor; |
| 27 |
import org.eclipse.jface.dialogs.IMessageProvider; |
| 28 |
import org.eclipse.jface.layout.GridDataFactory; |
| 29 |
import org.eclipse.jface.operation.IRunnableWithProgress; |
| 30 |
import org.eclipse.jface.wizard.WizardPage; |
| 31 |
import org.eclipse.mylyn.commons.core.StatusHandler; |
| 32 |
import org.eclipse.mylyn.internal.tasks.ui.TasksUiPlugin; |
| 33 |
import org.eclipse.mylyn.tasks.core.TaskRepository; |
| 34 |
import org.eclipse.swt.SWT; |
| 35 |
import org.eclipse.swt.layout.GridLayout; |
| 36 |
import org.eclipse.swt.widgets.Composite; |
| 37 |
import org.eclipse.ui.forms.events.ExpansionAdapter; |
| 38 |
import org.eclipse.ui.forms.events.ExpansionEvent; |
| 39 |
import org.eclipse.ui.forms.widgets.ExpandableComposite; |
| 40 |
import org.eclipse.ui.forms.widgets.FormToolkit; |
| 41 |
|
| 42 |
/** |
| 43 |
* An abstract base class for repository settings page that supports the <code>taskRepositoryPageContribution</code> |
| 44 |
* extension point. |
| 45 |
* |
| 46 |
* {@link ITaskRepositoryPage} implementations are encouraged to extend {@link AbstractRepositorySettingsPage} if |
| 47 |
* possible as it provides a standard UI for managing server settings. |
| 48 |
* |
| 49 |
* @see AbstractRepositorySettingsPage |
| 50 |
* |
| 51 |
* @since 3.1 |
| 52 |
* |
| 53 |
* @author David Green |
| 54 |
*/ |
| 55 |
public abstract class AbstractExtensibleRepositorySettingsPage extends WizardPage implements ITaskRepositoryPage { |
| 56 |
|
| 57 |
private static final String KIND = "connectorKind"; |
| 58 |
|
| 59 |
private static final String TASK_REPOSITORY_PAGE_CONTRIBUTION = "taskRepositoryPageContribution"; |
| 60 |
|
| 61 |
private static final String TASK_REPOSITORY_PAGE_CONTRIBUTION_EXTENSION = "org.eclipse.mylyn.tasks.ui.taskRepositoryPageContribution"; |
| 62 |
|
| 63 |
private static final Comparator<AbstractTaskRepositoryPageContribution> CONTRIBUTION_COMPARATOR = new ContributionComparator(); |
| 64 |
|
| 65 |
protected final TaskRepository repository; |
| 66 |
|
| 67 |
private final List<AbstractTaskRepositoryPageContribution> contributions = new ArrayList<AbstractTaskRepositoryPageContribution>(); |
| 68 |
|
| 69 |
protected FormToolkit toolkit; |
| 70 |
|
| 71 |
protected Composite compositeContainer; |
| 72 |
|
| 73 |
private final AbstractTaskRepositoryPageContribution.Listener contributionListener = new AbstractTaskRepositoryPageContribution.Listener() { |
| 74 |
public void validationRequired(AbstractTaskRepositoryPageContribution contribution) { |
| 75 |
validatePageSettings(); |
| 76 |
} |
| 77 |
}; |
| 78 |
|
| 79 |
public AbstractExtensibleRepositorySettingsPage(String title, String description, TaskRepository repository) { |
| 80 |
super(title); |
| 81 |
if (repository != null && !repository.getConnectorKind().equals(getConnectorKind())) { |
| 82 |
throw new IllegalArgumentException(); |
| 83 |
} |
| 84 |
this.repository = repository; |
| 85 |
setTitle(title); |
| 86 |
setDescription(description); |
| 87 |
} |
| 88 |
|
| 89 |
/** |
| 90 |
* Get the kind of connector supported by this page. |
| 91 |
* |
| 92 |
* @return the kind of connector, never null |
| 93 |
*/ |
| 94 |
public abstract String getConnectorKind(); |
| 95 |
|
| 96 |
@Override |
| 97 |
public void dispose() { |
| 98 |
if (toolkit != null) { |
| 99 |
toolkit.dispose(); |
| 100 |
toolkit = null; |
| 101 |
} |
| 102 |
super.dispose(); |
| 103 |
} |
| 104 |
|
| 105 |
public void createControl(Composite parent) { |
| 106 |
toolkit = new FormToolkit(TasksUiPlugin.getDefault().getFormColors(parent.getDisplay())); |
| 107 |
|
| 108 |
compositeContainer = new Composite(parent, SWT.NULL); |
| 109 |
GridLayout layout = new GridLayout(1, true); |
| 110 |
compositeContainer.setLayout(layout); |
| 111 |
|
| 112 |
createContents(compositeContainer); |
| 113 |
|
| 114 |
setControl(compositeContainer); |
| 115 |
} |
| 116 |
|
| 117 |
/** |
| 118 |
* Create the contents of the page. Subclasses may override this method to change where the contributions are added. |
| 119 |
*/ |
| 120 |
protected void createContents(Composite parent) { |
| 121 |
createSettingControls(parent); |
| 122 |
|
| 123 |
addContributions(parent); |
| 124 |
} |
| 125 |
|
| 126 |
/** |
| 127 |
* create the controls of this page |
| 128 |
*/ |
| 129 |
protected abstract void createSettingControls(Composite parent); |
| 130 |
|
| 131 |
@Override |
| 132 |
public boolean isPageComplete() { |
| 133 |
return super.isPageComplete() && conributionsIsPageComplete(); |
| 134 |
} |
| 135 |
|
| 136 |
@Override |
| 137 |
public boolean canFlipToNextPage() { |
| 138 |
return super.canFlipToNextPage() && contributionsCanFlipToNextPage(); |
| 139 |
} |
| 140 |
|
| 141 |
private boolean contributionsCanFlipToNextPage() { |
| 142 |
for (AbstractTaskRepositoryPageContribution contribution : contributions) { |
| 143 |
if (!contribution.canFlipToNextPage()) { |
| 144 |
return false; |
| 145 |
} |
| 146 |
} |
| 147 |
return true; |
| 148 |
} |
| 149 |
|
| 150 |
private boolean conributionsIsPageComplete() { |
| 151 |
for (AbstractTaskRepositoryPageContribution contribution : contributions) { |
| 152 |
if (!contribution.isPageComplete()) { |
| 153 |
return false; |
| 154 |
} |
| 155 |
} |
| 156 |
return true; |
| 157 |
} |
| 158 |
|
| 159 |
/** |
| 160 |
* subclasses should only call this method if they override {@link #createContents(Composite)} |
| 161 |
* |
| 162 |
* @param parentControl |
| 163 |
* the container into which the contributions will create their UI |
| 164 |
*/ |
| 165 |
protected void addContributions(Composite parentControl) { |
| 166 |
contributions.clear(); |
| 167 |
contributions.addAll(findApplicableContributors()); |
| 168 |
|
| 169 |
if (!contributions.isEmpty()) { |
| 170 |
for (AbstractTaskRepositoryPageContribution contribution : contributions) { |
| 171 |
contribution.init(getConnectorKind(), repository); |
| 172 |
contribution.addListener(contributionListener); |
| 173 |
} |
| 174 |
|
| 175 |
Collections.sort(contributions, CONTRIBUTION_COMPARATOR); |
| 176 |
|
| 177 |
for (AbstractTaskRepositoryPageContribution contribution : contributions) { |
| 178 |
|
| 179 |
ExpandableComposite section = toolkit.createExpandableComposite(parentControl, |
| 180 |
ExpandableComposite.COMPACT | ExpandableComposite.TWISTIE | ExpandableComposite.TITLE_BAR); |
| 181 |
section.clientVerticalSpacing = 0; |
| 182 |
section.setBackground(parentControl.getBackground()); |
| 183 |
section.setFont(parentControl.getFont()); |
| 184 |
section.addExpansionListener(new ExpansionAdapter() { |
| 185 |
@Override |
| 186 |
public void expansionStateChanged(ExpansionEvent e) { |
| 187 |
getControl().getShell().pack(); |
| 188 |
} |
| 189 |
}); |
| 190 |
section.setText(contribution.getTitle()); |
| 191 |
section.setToolTipText(contribution.getDescription()); |
| 192 |
|
| 193 |
GridDataFactory.fillDefaults().grab(true, false).applyTo(section); |
| 194 |
|
| 195 |
Composite sectionContentsContainer = toolkit.createComposite(section); |
| 196 |
sectionContentsContainer.setBackground(parentControl.getBackground()); |
| 197 |
contribution.createControl(sectionContentsContainer, toolkit); |
| 198 |
|
| 199 |
section.setClient(sectionContentsContainer); |
| 200 |
} |
| 201 |
} |
| 202 |
} |
| 203 |
|
| 204 |
/** |
| 205 |
* Validate the settings of this page, not including contributions. This method should not be called directly by |
| 206 |
* page implementations. Implementations of this method must be capable of running in a non-UI thread. |
| 207 |
* |
| 208 |
* @return the status, or null if there are no messages. |
| 209 |
* |
| 210 |
* @see #validatePageSettings() |
| 211 |
*/ |
| 212 |
protected abstract IStatus validate(IProgressMonitor monitor); |
| 213 |
|
| 214 |
/** |
| 215 |
* Overriding methods should call <code>super.applyTo(repository)</code> |
| 216 |
*/ |
| 217 |
public void applyTo(TaskRepository repository) { |
| 218 |
applyContributionSettingsTo(repository); |
| 219 |
} |
| 220 |
|
| 221 |
private void applyContributionSettingsTo(TaskRepository repository) { |
| 222 |
for (AbstractTaskRepositoryPageContribution contribution : contributions) { |
| 223 |
contribution.applyTo(repository); |
| 224 |
} |
| 225 |
} |
| 226 |
|
| 227 |
/** |
| 228 |
* compute the validation |
| 229 |
* |
| 230 |
* @return a status if there is a message to display, otherwise null |
| 231 |
*/ |
| 232 |
private IStatus computeValidation(IProgressMonitor monitor) { |
| 233 |
int factor = 100; |
| 234 |
monitor.beginTask("Validating settings", (contributions.size() + 1) * factor); |
| 235 |
|
| 236 |
IStatus cumulativeResult = null; |
| 237 |
|
| 238 |
// validate the page |
| 239 |
{ |
| 240 |
SubProgressMonitor subMonitor = new SubProgressMonitor(monitor, factor); |
| 241 |
cumulativeResult = validate(subMonitor); |
| 242 |
subMonitor.done(); |
| 243 |
} |
| 244 |
|
| 245 |
// validate contributions |
| 246 |
for (AbstractTaskRepositoryPageContribution contribution : contributions) { |
| 247 |
SubProgressMonitor subMonitor = new SubProgressMonitor(monitor, factor); |
| 248 |
IStatus result = contribution.validate(subMonitor); |
| 249 |
if (result != null) { |
| 250 |
if (cumulativeResult == null) { |
| 251 |
cumulativeResult = result; |
| 252 |
} else if (cumulativeResult instanceof MultiStatus) { |
| 253 |
((MultiStatus) cumulativeResult).add(result); |
| 254 |
} else { |
| 255 |
cumulativeResult = new MultiStatus(cumulativeResult.getPlugin(), cumulativeResult.getCode(), |
| 256 |
new IStatus[] { cumulativeResult, result }, null, null); |
| 257 |
} |
| 258 |
} |
| 259 |
subMonitor.done(); |
| 260 |
} |
| 261 |
monitor.done(); |
| 262 |
return cumulativeResult; |
| 263 |
} |
| 264 |
|
| 265 |
/** |
| 266 |
* Validate all settings in the page including contributions. This method should be called whenever a setting is |
| 267 |
* changed on the page. |
| 268 |
* |
| 269 |
* The results of validation are applied and the buttons of the page are updated. |
| 270 |
* |
| 271 |
* @see #validate(IProgressMonitor) |
| 272 |
* @see #applyValidationResult(IStatus[]) |
| 273 |
*/ |
| 274 |
protected void validatePageSettings() { |
| 275 |
final Object[] result = new Object[1]; |
| 276 |
try { |
| 277 |
getWizard().getContainer().run(true, true, new IRunnableWithProgress() { |
| 278 |
public void run(IProgressMonitor monitor) throws InvocationTargetException, InterruptedException { |
| 279 |
result[0] = computeValidation(monitor); |
| 280 |
} |
| 281 |
}); |
| 282 |
} catch (InvocationTargetException e) { |
| 283 |
StatusHandler.fail(new Status(IStatus.ERROR, TasksUiPlugin.ID_PLUGIN, |
| 284 |
"Internal error validating repository", e.getCause())); |
| 285 |
return; |
| 286 |
} catch (InterruptedException e) { |
| 287 |
// canceled |
| 288 |
return; |
| 289 |
} |
| 290 |
applyValidationResult((IStatus[]) result[0]); |
| 291 |
getWizard().getContainer().updateButtons(); |
| 292 |
} |
| 293 |
|
| 294 |
/** |
| 295 |
* Apply the results of validation to the page. The implementation finds the most {@link IStatus#getSeverity() |
| 296 |
* severe} status and {@link #setMessage(String, int) applies the message} to the page. |
| 297 |
* |
| 298 |
* @param statuses |
| 299 |
* an array of statuses that indicate the result of validation, or null |
| 300 |
*/ |
| 301 |
protected void applyValidationResult(IStatus[] statuses) { |
| 302 |
if (statuses == null || statuses.length == 0) { |
| 303 |
setMessage(null, IMessageProvider.INFORMATION); |
| 304 |
setErrorMessage(null); |
| 305 |
} else { |
| 306 |
// find the most severe status |
| 307 |
IStatus status = statuses[0]; |
| 308 |
for (IStatus s : statuses) { |
| 309 |
if (status == null || s.getSeverity() > status.getSeverity()) { |
| 310 |
status = s; |
| 311 |
} |
| 312 |
} |
| 313 |
int messageType; |
| 314 |
switch (status.getSeverity()) { |
| 315 |
case IStatus.OK: |
| 316 |
case IStatus.INFO: |
| 317 |
messageType = IMessageProvider.INFORMATION; |
| 318 |
break; |
| 319 |
case IStatus.WARNING: |
| 320 |
messageType = IMessageProvider.WARNING; |
| 321 |
break; |
| 322 |
case IStatus.ERROR: |
| 323 |
default: |
| 324 |
messageType = IMessageProvider.ERROR; |
| 325 |
break; |
| 326 |
} |
| 327 |
setErrorMessage(null); |
| 328 |
setMessage(status.getMessage(), messageType); |
| 329 |
} |
| 330 |
} |
| 331 |
|
| 332 |
private List<AbstractTaskRepositoryPageContribution> findApplicableContributors() { |
| 333 |
List<AbstractTaskRepositoryPageContribution> contributors = new ArrayList<AbstractTaskRepositoryPageContribution>(); |
| 334 |
|
| 335 |
IExtensionRegistry registry = Platform.getExtensionRegistry(); |
| 336 |
|
| 337 |
IExtensionPoint editorExtensionPoint = registry.getExtensionPoint(TASK_REPOSITORY_PAGE_CONTRIBUTION_EXTENSION); |
| 338 |
IExtension[] editorExtensions = editorExtensionPoint.getExtensions(); |
| 339 |
for (IExtension extension : editorExtensions) { |
| 340 |
IConfigurationElement[] elements = extension.getConfigurationElements(); |
| 341 |
for (IConfigurationElement element : elements) { |
| 342 |
if (element.getName().equals(TASK_REPOSITORY_PAGE_CONTRIBUTION)) { |
| 343 |
String kind = element.getAttribute(KIND); |
| 344 |
if (kind == null || "".equals(kind) || getConnectorKind().equals(kind)) { |
| 345 |
try { |
| 346 |
Object contributor = element.createExecutableExtension("class"); |
| 347 |
contributors.add((AbstractTaskRepositoryPageContribution) contributor); |
| 348 |
} catch (Exception e) { |
| 349 |
StatusHandler.log(new Status(IStatus.ERROR, TasksUiPlugin.ID_PLUGIN, "Could not load " |
| 350 |
+ TASK_REPOSITORY_PAGE_CONTRIBUTION, e)); |
| 351 |
} |
| 352 |
} |
| 353 |
} |
| 354 |
} |
| 355 |
} |
| 356 |
|
| 357 |
return contributors; |
| 358 |
} |
| 359 |
|
| 360 |
private static class ContributionComparator implements Comparator<AbstractTaskRepositoryPageContribution> { |
| 361 |
|
| 362 |
public int compare(AbstractTaskRepositoryPageContribution o1, AbstractTaskRepositoryPageContribution o2) { |
| 363 |
if (o1 == o2) { |
| 364 |
return 0; |
| 365 |
} |
| 366 |
String s1 = o1.getTitle(); |
| 367 |
String s2 = o2.getTitle(); |
| 368 |
int i = s1.compareTo(s2); |
| 369 |
if (i == 0) { |
| 370 |
i = new Integer(System.identityHashCode(o1)).compareTo(System.identityHashCode(o2)); |
| 371 |
} |
| 372 |
return i; |
| 373 |
} |
| 374 |
|
| 375 |
} |
| 376 |
} |
