blob: b137ebe4ebae5ab742cf0406313a0fa1bfd6659f (
plain) (
blame)
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
|
/*******************************************************************************
* Copyright (c) 2000, 2005 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.internal.ui.synchronize;
import org.eclipse.core.runtime.Assert;
import org.eclipse.jface.viewers.StructuredViewer;
import org.eclipse.team.ui.synchronize.ISynchronizePageConfiguration;
import org.eclipse.ui.IActionBars;
/**
* Abstract superclass for viewer advisors
*/
public abstract class AbstractViewerAdvisor {
private ISynchronizePageConfiguration configuration;
private StructuredViewer viewer;
public AbstractViewerAdvisor(ISynchronizePageConfiguration configuration) {
this.configuration = configuration;
configuration.setProperty(SynchronizePageConfiguration.P_ADVISOR, this);
}
public ISynchronizePageConfiguration getConfiguration() {
return configuration;
}
/**
* Install a viewer to be configured with this advisor. An advisor can only be installed with
* one viewer at a time. When this method completes the viewer is considered initialized and
* can be shown to the user.
* @param viewer the viewer being installed
*/
protected void initializeViewer(final StructuredViewer viewer) {
Assert.isTrue(this.viewer == null, "Can only be initialized once."); //$NON-NLS-1$
Assert.isTrue(validateViewer(viewer));
this.viewer = viewer;
}
/**
* Subclasses can validate that the viewer being initialized with this advisor
* is of the correct type.
*
* @param viewer the viewer to validate
* @return <code>true</code> if the viewer is valid, <code>false</code> otherwise.
*/
protected boolean validateViewer(StructuredViewer viewer) {
return true;
}
/**
* Returns the viewer configured by this advisor.
*
* @return the viewer configured by this advisor.
*/
public StructuredViewer getViewer() {
return viewer;
}
public abstract void setActionBars(IActionBars actionBars);
}
|
