|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.eclipse.compare.CompareUI
The class CompareUI
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.
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.
Field Summary | |
static String |
COMPARE_VIEWER_TITLE
Name of the title property of a compare viewer. |
static ImageDescriptor |
DESC_CTOOL_NEXT
Image descriptor for the normal icon of the 'Next' tool bar button. |
static ImageDescriptor |
DESC_CTOOL_PREV
Image descriptor for the normal icon of the 'Previous' tool bar button. |
static ImageDescriptor |
DESC_DTOOL_NEXT
Image descriptor for the disabled icon of the 'Next' tool bar button. |
static ImageDescriptor |
DESC_DTOOL_PREV
Image descriptor for the disabled icon of the 'Previous' tool bar button. |
static ImageDescriptor |
DESC_ETOOL_NEXT
Image descriptor for the roll-over icon of the 'Next' tool bar button. |
static ImageDescriptor |
DESC_ETOOL_PREV
Image descriptor for the roll-over icon of the 'Previous' tool bar button. |
static String |
PLUGIN_ID
Compare Plug-in ID (value "org.eclipse.compare" ). |
Method Summary | |
static void |
addStructureViewerAlias(String type,
String alias)
Adds an alias for the given type. |
static void |
disposeOnShutdown(Image image)
Registers the given image for being disposed when this plug-in is shutdown. |
static Viewer |
findContentViewer(Viewer oldViewer,
ICompareInput input,
Composite parent,
CompareConfiguration configuration)
Returns a content compare viewer based on an old viewer and an input object. |
static Viewer |
findStructureViewer(Viewer oldViewer,
ICompareInput input,
Composite parent,
CompareConfiguration configuration)
Returns a structure compare viewer based on an old viewer and an input object. |
static Image |
getImage(IAdaptable adaptable)
Returns a shared image for the given adaptable. |
static Image |
getImage(String type)
Returns a shared image for the given type, or a generic image if none has been registered for the given type. |
static AbstractUIPlugin |
getPlugin()
|
static ResourceBundle |
getResourceBundle()
Returns this plug-in's resource bundle. |
static void |
openCompareDialog(CompareEditorInput input)
Performs the comparison described by the given input and opens a modal compare dialog on the result. |
static void |
openCompareEditor(CompareEditorInput input)
Performs the comparison described by the given input and opens a compare editor on the result. |
static void |
registerImageDescriptor(String type,
ImageDescriptor descriptor)
Registers an image descriptor for the given type. |
static void |
removeAllStructureViewerAliases(String type)
Remove all aliases for the given type. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String PLUGIN_ID
"org.eclipse.compare"
).
public static final ImageDescriptor DESC_DTOOL_NEXT
public static final ImageDescriptor DESC_CTOOL_NEXT
public static final ImageDescriptor DESC_ETOOL_NEXT
public static final ImageDescriptor DESC_DTOOL_PREV
public static final ImageDescriptor DESC_CTOOL_PREV
public static final ImageDescriptor DESC_ETOOL_PREV
public static final String COMPARE_VIEWER_TITLE
Method Detail |
public static AbstractUIPlugin getPlugin()
public static ResourceBundle getResourceBundle()
public static void openCompareEditor(CompareEditorInput input)
input
- the input on which to open the compare editorpublic static void openCompareDialog(CompareEditorInput input)
input
- the input on which to open the compare dialogpublic static void registerImageDescriptor(String type, ImageDescriptor descriptor)
type
- the typedescriptor
- the image descriptorpublic static Image getImage(String type)
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.
type
- the type
public static void disposeOnShutdown(Image image)
image
- the image to register for disposalpublic static Image getImage(IAdaptable adaptable)
IWorkbenchAdapter.getImageDescriptor
, which it
uses to create an image if it does not already have one.
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.
adaptable
- the adaptable for which to find an image
public static Viewer findStructureViewer(Viewer oldViewer, ICompareInput input, Composite parent, CompareConfiguration configuration)
null
is returned.
oldViewer
- a new viewer is only created if this old viewer cannot show the given inputinput
- the input object for which to find a structure viewerparent
- the SWT parent composite under which the new viewer is createdconfiguration
- a configuration which is passed to a newly created viewer
null
public static Viewer findContentViewer(Viewer oldViewer, ICompareInput input, Composite parent, CompareConfiguration configuration)
null
is returned.
oldViewer
- a new viewer is only created if this old viewer cannot show the given inputinput
- the input object for which to find a content viewerparent
- the SWT parent composite under which the new viewer is createdconfiguration
- a configuration which is passed to a newly created viewer
null
public static void addStructureViewerAlias(String type, String alias)
findStructureViewer
treat alias as a synonym for type and return the same viewer.
Note: this method is for internal use only. Clients should not call this method.
type
- a type name for which a viewer has been registeredalias
- a type name which should be treated as a synonym of typepublic static void removeAllStructureViewerAliases(String type)
Note: this method is for internal use only. Clients should not call this method.
type
- the type name for which all synonymes are removed.
|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |