Package SpecificationThe 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.
A compare operation must be implemented as a subclass of CompareEditorInput. A CompareEditorInput runs a (potentially lengthy) compare operation under progress monitor control, creates a UI for drilling-down into the compare results, tracks the dirty state of the result in case of merge, and saves any changes that occured during a merge.
The NavigationAction is used to navigate (step) through the individual differences of a CompareEditorInput.
An instance of CompareConfiguration configures various UI aspects of compare/merge viewers like title labels and images, or whether a side of a merge viewer is editable. It is passed to the CompareEditorInput on creation.
When implementing a hierarchical compare operation as a subclass of
CompareEditorInput clients have to provide a tree of objects where each
node implements the interface
This interface is used by the hierarchical differencing engine
(org.eclipse.compare.structuremergeviewer.Differencer) to walk the tree.
In addition every leaf of the tree must implement the IStreamContentAccessor or IEncodedStreamContentAccessor interfaces in order to give the differencing engine access to its stream content and to its encoding (with IEncodedStreamContentAccessor).
The abstract class BufferedContent provides a default implementation for the IStreamContentAccessor and IContentChangeNotifier interfaces. Its subclass ResourceNode adds an implementation for the IStructureComparator and ITypedElement interfaces based on Eclipse workbench resources (org.eclipse.core.resources.IResource). It can be used without modification as the input to the differencing engine.
The ZipFileStructureCreator is an implementation of the org.eclipse.compare.structuremergeviewer.IStructureCreator interface and makes the contents of a zip archive available as a hierarchical structure of IStructureComparators which can be easily compared by the differencing engine (org.eclipse.compare.structuremergeviewer.Differencer). It is a good example for how to make structured files available to the hierarchical compare functionality of the Compare plugin.
The EditionSelectionDialog is a simple selection dialog where one input element can be compared against a list of historic variants (editions) of the same input element. The dialog can be used to implement functions like "Replace with Version" or "Replace with Edition" on workbench resources.
In addition it is possible to specify a subsection of the input element (e.g. a method in a Java source file) by means of a path. In this case the dialog compares only the subsection (as specified by the path) with the corresponding subsection in the list of editions. This functionality can be used to implement "Replace with Method Edition" for the Java language.
The EditionSelectionDialog requires that the editions implement the IStreamContentAccessor and IModificationDate interfaces. The HistoryItem is a convenience class that implements these interfaces for IFileState objects.
The CompareViewerPane is a convenience class which provides
a label and local toolbar for a compare viewer (or any other subclass of a
Its abstract subclass CompareViewerSwitchingPane supports dynamic viewer switching, that is the viewer installed in the pane is dynamically determined by the pane's input object. Both classes are useful if you want to use compare viewers outside the context of a compare editor, for example in a dialog or wizard.
A Splitter is an extension of a SashForm that supports nesting, maximizing of panes, and propagating the visibility state of panes.
The interface IStreamMerger defines a single operation for performing a three-way merge on three
input streams. The merged result is written to an output stream.
Clients must implement this interface when contributing new mergers to the
org.eclipse.compare.streamMergers extension point.
New IStreamMergers can be created for registered types with the createStreamMerger methods of CompareUI.
Interface Summary Interface Description ICompareContainerA compare container is used to represent any UI that can contain compare viewers. ICompareFilterA filter that can be applied during the comparison of documents that can be used to customize the detection of text differences via the compareFilter extension point. ICompareInputLabelProviderA label provider that provides the label and image for the left, right and ancestor sides for a compare input being shown in compare/merge viewers. ICompareNavigatorA
ICompareNavigatoris used to navigate through the individual differences of a
CompareEditorInputor another type of Compare container.
IContentChangeListeneris informed about content changes of a
IContentChangeNotifierInterface common to all objects that provide a means for registering for content change notification. IEditableContentCommon interface for objects with editable contents. IEditableContentExtensionExtends the
IEditableContentinterface to support validate edit.
IModificationDateCommon interface for objects with a modification date. INavigatableInterface that allow clients to navigate through the changes shown in a compare pane. IPropertyChangeNotifierInterface common to all objects that provide a means for registering for property change notification. IResourceProvider ISharedDocumentAdapterAn
ISharedDocumentAdapteris used to map an
ITypedElementto a shared document for the purposes of editing.
IStreamContentAccessorobject represents a set of bytes which can be accessed by means of a stream.
IStreamMerger Deprecated.Clients should use
ITypedElementInterface for getting the name, image, and type for an object. IViewerCreatorA factory object for
Class Summary Class Description BufferedContentAbstract implementation for a buffered
CompareConfigurationobject controls various UI aspects of compare/merge viewers like title labels and images, or whether a side of a merge viewer is editable.
CompareEditorInputA compare operation which can present its results in a special editor. CompareNavigatorSupports cross-pane navigation through the differences of a compare container. CompareUIThe class
CompareUIdefines the entry point to initiate a configurable compare operation on arbitrary resources.
CompareViewerPaneis a convenience class which installs a
CompareViewerPanethat supports dynamic viewer switching.
EditionSelectionDialog Deprecated.Use an
org.eclipse.team.ui.history.IHistoryPageSourcein conjunction with the
ITypedElementthat can be used as an input to a compare viewer or other places where an
NavigationActionis used to navigate through the individual differences of a
IResourcesso that it can be used as input for the differencing engine (interfaces
ITypedElement) and the
SharedDocumentAdapterAn implementation of
ISharedDocumentAdapterthat provides default behavior for the methods of that interface.
SplitterThe Splitter adds support for nesting to a SashForm. ZipFileStructureCreatorThis implementation of the
IStructureCreatorinterface makes the contents of a zip archive available as a hierarchical structure of