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
|
/*
* (c) Copyright IBM Corp. 2000, 2001.
* All Rights Reserved.
*/
package org.eclipse.compare;
import java.util.ResourceBundle;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.jface.viewers.Viewer;
import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.ui.plugin.AbstractUIPlugin;
import org.eclipse.compare.internal.CompareUIPlugin;
import org.eclipse.compare.internal.IStructureCreatorDescriptor;
import org.eclipse.compare.structuremergeviewer.ICompareInput;
import org.eclipse.compare.structuremergeviewer.IStructureCreator;
/**
* The class <code>CompareUI</code> defines the entry point to initiate a configurable
* compare operation on arbitrary resources. The result of the compare
* is opened into a compare editor where the details can be browsed and
* edited in dynamically selected structure and content viewers.
* <p>
* The Compare UI provides a registry for content and structure compare viewers,
* which is initialized from extensions contributed to extension points
* declared by this plug-in.
*/
public final class CompareUI {
/**
* Compare Plug-in ID (value <code>"org.eclipse.compare"</code>).
* @since 2.0
*/
public static final String PLUGIN_ID= "org.eclipse.compare"; //$NON-NLS-1$
/** Image descriptors for the 'Next' tool bar button. */
public static final ImageDescriptor DESC_DTOOL_NEXT= CompareUIPlugin.getImageDescriptor(CompareUIPlugin.DTOOL_NEXT);
public static final ImageDescriptor DESC_CTOOL_NEXT= CompareUIPlugin.getImageDescriptor(CompareUIPlugin.CTOOL_NEXT);
public static final ImageDescriptor DESC_ETOOL_NEXT= CompareUIPlugin.getImageDescriptor(CompareUIPlugin.ETOOL_NEXT);
/** Image descriptors for the 'Previous' tool bar button. */
public static final ImageDescriptor DESC_DTOOL_PREV= CompareUIPlugin.getImageDescriptor(CompareUIPlugin.DTOOL_PREV);
public static final ImageDescriptor DESC_CTOOL_PREV= CompareUIPlugin.getImageDescriptor(CompareUIPlugin.CTOOL_PREV);
public static final ImageDescriptor DESC_ETOOL_PREV= CompareUIPlugin.getImageDescriptor(CompareUIPlugin.ETOOL_PREV);
/**
* Name of the title property of a compare viewer.
* If a property with this name is set
* on the top level SWT control of a viewer, it is used as a title in the pane's
* title bar.
*/
public static final String COMPARE_VIEWER_TITLE= "org.eclipse.compare.CompareUI.CompareViewerTitle"; //$NON-NLS-1$
/* (non Javadoc)
* non inatiatiable!
*/
private CompareUI() {
}
public static AbstractUIPlugin getPlugin() {
return CompareUIPlugin.getDefault();
}
/**
* Returns this plug-in's resource bundle.
*
* @return the plugin's resource bundle
*/
public static ResourceBundle getResourceBundle() {
return CompareUIPlugin.getResourceBundle();
}
/**
* Performs the comparison described by the given input and opens a
* compare editor on the result.
*
* @param input the input on which to open the compare editor
*/
public static void openCompareEditor(CompareEditorInput input) {
CompareUIPlugin plugin= CompareUIPlugin.getDefault();
if (plugin != null)
plugin.openCompareEditor(input);
}
/**
* Performs the comparison described by the given input and opens a
* modal compare dialog on the result.
*
* @param input the input on which to open the compare dialog
*/
public static void openCompareDialog(CompareEditorInput input) {
CompareUIPlugin plugin= CompareUIPlugin.getDefault();
if (plugin != null)
plugin.openCompareDialog(input);
}
/**
* Registers an image descriptor for the given type.
*
* @param type the type
* @param descriptor the image descriptor
*/
public static void registerImageDescriptor(String type, ImageDescriptor descriptor) {
CompareUIPlugin.registerImageDescriptor(type, descriptor);
}
/**
* Returns a shared image for the given type, or a generic image if none
* has been registered for the given type.
* <p>
* Note: Images returned from this method will be automatically disposed
* of when this plug-in shuts down. Callers must not dispose of these
* images themselves.
* </p>
*
* @param type the type
* @return the image
*/
public static Image getImage(String type) {
return CompareUIPlugin.getImage(type);
}
/**
* Registers the given image for being disposed when this plug-in is shutdown.
*
* @param image the image to register for disposal
*/
public static void disposeOnShutdown(Image image) {
CompareUIPlugin.disposeOnShutdown(image);
}
/**
* Returns a shared image for the given adaptable.
* This convenience method queries the given adaptable
* for its <code>IWorkbenchAdapter.getImageDescriptor</code>, which it
* uses to create an image if it does not already have one.
* <p>
* Note: Images returned from this method will be automatically disposed
* of when this plug-in shuts down. Callers must not dispose of these
* images themselves.
* </p>
*
* @param adaptable the adaptable for which to find an image
* @return an image
*/
public static Image getImage(IAdaptable adaptable) {
return CompareUIPlugin.getImage(adaptable);
}
/**
* Returns a structure compare viewer based on an old viewer and an input object.
* If the old viewer is suitable for showing the input, the old viewer
* is returned. Otherwise, the input's type is used to find a viewer descriptor in the registry
* which in turn is used to create a structure compare viewer under the given parent composite.
* If no viewer descriptor can be found <code>null</code> is returned.
*
* @param oldViewer a new viewer is only created if this old viewer cannot show the given input
* @param input the input object for which to find a structure viewer
* @param parent the SWT parent composite under which the new viewer is created
* @param configuration a configuration which is passed to a newly created viewer
* @return the compare viewer which is suitable for the given input object or <code>null</code>
*/
public static Viewer findStructureViewer(Viewer oldViewer, ICompareInput input, Composite parent,
CompareConfiguration configuration) {
return CompareUIPlugin.findStructureViewer(oldViewer, input, parent, configuration);
}
/**
* Returns a content compare viewer based on an old viewer and an input object.
* If the old viewer is suitable for showing the input the old viewer
* is returned. Otherwise the input's type is used to find a viewer descriptor in the registry
* which in turn is used to create a content compare viewer under the given parent composite.
* If no viewer descriptor can be found <code>null</code> is returned.
*
* @param oldViewer a new viewer is only created if this old viewer cannot show the given input
* @param input the input object for which to find a content viewer
* @param parent the SWT parent composite under which the new viewer is created
* @param configuration a configuration which is passed to a newly created viewer
* @return the compare viewer which is suitable for the given input object or <code>null</code>
*/
public static Viewer findContentViewer(Viewer oldViewer, ICompareInput input, Composite parent,
CompareConfiguration configuration) {
return CompareUIPlugin.findContentViewer(oldViewer, input, parent, configuration);
}
public static void addStructureViewerAlias(String type, String alias) {
CompareUIPlugin.addStructureViewerAlias(type, alias);
}
public static void removeAllStructureViewerAliases(String type) {
CompareUIPlugin.removeAllStructureViewerAliases(type);
}
}
|
