org.eclipse.compare
Class CompareUI

java.lang.Object
  |
  +--org.eclipse.compare.CompareUI

public final class CompareUI

extends Object

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

PLUGIN_ID

public static final String PLUGIN_ID

Compare Plug-in ID (value "org.eclipse.compare").

Since:

2.0

See Also:

Constant Field Values

DESC_DTOOL_NEXT

public static final ImageDescriptor DESC_DTOOL_NEXT

Image descriptor for the disabled icon of the 'Next' tool bar button.

Since:

2.0

DESC_CTOOL_NEXT

public static final ImageDescriptor DESC_CTOOL_NEXT

Image descriptor for the normal icon of the 'Next' tool bar button.

Since:

2.0

DESC_ETOOL_NEXT

public static final ImageDescriptor DESC_ETOOL_NEXT

Image descriptor for the roll-over icon of the 'Next' tool bar button.

Since:

2.0

DESC_DTOOL_PREV

public static final ImageDescriptor DESC_DTOOL_PREV

Image descriptor for the disabled icon of the 'Previous' tool bar button.

Since:

2.0

DESC_CTOOL_PREV

public static final ImageDescriptor DESC_CTOOL_PREV

Image descriptor for the normal icon of the 'Previous' tool bar button.

Since:

2.0

DESC_ETOOL_PREV

public static final ImageDescriptor DESC_ETOOL_PREV

Image descriptor for the roll-over icon of the 'Previous' tool bar button.

Since:

2.0

COMPARE_VIEWER_TITLE

public static final String COMPARE_VIEWER_TITLE

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.

See Also:

Constant Field Values

Method Detail

getPlugin

public static AbstractUIPlugin getPlugin()

getResourceBundle

public static ResourceBundle getResourceBundle()

Returns this plug-in's resource bundle.

Returns:

the plugin's resource bundle

openCompareEditor

public static void openCompareEditor(CompareEditorInput input)

Performs the comparison described by the given input and opens a compare editor on the result.

Parameters:

input - the input on which to open the compare editor

openCompareDialog

public static void openCompareDialog(CompareEditorInput input)

Performs the comparison described by the given input and opens a modal compare dialog on the result.

Parameters:

input - the input on which to open the compare dialog

registerImageDescriptor

public static void registerImageDescriptor(String type,
                                           ImageDescriptor descriptor)

Registers an image descriptor for the given type.

Parameters:

type - the type

descriptor - the image descriptor

getImage

public 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.

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.

Parameters:

type - the type

Returns:

the image

disposeOnShutdown

public static void disposeOnShutdown(Image image)

Registers the given image for being disposed when this plug-in is shutdown.

Parameters:

image - the image to register for disposal

getImage

public static Image getImage(IAdaptable adaptable)

Returns a shared image for the given adaptable. This convenience method queries the given adaptable for its 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.

Parameters:

adaptable - the adaptable for which to find an image

Returns:

an image

findStructureViewer

public 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. 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 null is returned.

Parameters:

oldViewer - a new viewer is only created if this old viewer cannot show the given input

input - the input object for which to find a structure viewer

parent - the SWT parent composite under which the new viewer is created

configuration - a configuration which is passed to a newly created viewer

Returns:

the compare viewer which is suitable for the given input object or null

findContentViewer

public 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. 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 null is returned.

Parameters:

oldViewer - a new viewer is only created if this old viewer cannot show the given input

input - the input object for which to find a content viewer

parent - the SWT parent composite under which the new viewer is created

configuration - a configuration which is passed to a newly created viewer

Returns:

the compare viewer which is suitable for the given input object or null

addStructureViewerAlias

public static void addStructureViewerAlias(String type,
                                           String alias)

Adds an alias for the given type. Subsequent calls to 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.

Parameters:

type - a type name for which a viewer has been registered

alias - a type name which should be treated as a synonym of type

Since:

2.0

removeAllStructureViewerAliases

public static void removeAllStructureViewerAliases(String type)

Remove all aliases for the given type. This method does not affect the initial binding between type and viewer. If no aliases exist for the given type this method does nothing.

Note: this method is for internal use only. Clients should not call this method.

Parameters:

type - the type name for which all synonymes are removed.

Since:

2.0