| Home >> All >> org >> eclipse >> [ compare Javadoc ] |
• org.eclipse.compare: Javadoc index of package org.eclipse.compare.
Package Samples:
• org.eclipse.compare.structuremergeviewer
• org.eclipse.compare.rangedifferencer
• org.eclipse.compare.internal.patch
• org.eclipse.compare.internal.merge
• org.eclipse.compare.internal
• org.eclipse.compare.contentmergeviewer
Classes:
• CompareEditorInput: A compare operation which can present its results in a special editor. Running the compare operation and presentating the results in a compare editor are combined in one class because it allows a client to keep the implementation all in one place while separating it from the innards of a specific UI implementation of compare/merge. A CompareEditorInput defines methods for the following sequence steps: running a lengthy compare operation under progress monitor control, creating a UI for displaying the model and initializing the some widgets with the compare result, tracking the dirty state of the ...
• TextMergeViewer: A text merge viewer uses the RangeDifferencer to perform a textual, line-by-line comparison of two (or three) input documents. It is based on the ContentMergeViewer and uses TextViewer s to implement the ancestor, left, and right content areas. In the three-way compare case ranges of differing lines are highlighted and framed with different colors to show whether the difference is an incoming, outgoing, or conflicting change. The TextMergeViewer supports the notion of a current "differing range" and provides toolbar buttons to navigate from one range to the next (or previous). If there is a current ...
• Differencer: A generic two-way or three-way differencing engine. The engine is used by calling one of the findDifferences methods and passing in the objects to compare. The engine calls the following methods on the input objects to perform the compare: getChildren : for enumerating the children of an object (if any), contentsEqual : for comparing the content of leaf objects, that is, objects without children, visit : for every pair of compared object the compare result is passed in. Clients may use as is, or subclass to provide a custom implementation for the three hooks. However the default implementation ...
• EditionSelectionDialog: A 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 "Compare/Replace with Version" or "Compare/Replace from Local History" on workspace 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. Only those editions are shown where the subsection differs from ...
• IStructureCreator: Interface used to create a hierarchical structure of IStructureComparator s for a given input object. In addition, it provides methods for locating a path in the hierarchical structure and to map a node of this structure back to the corresponding input object. Structure creators are used in the following contexts: the StructureDiffViewer uses an IStructureCreator to build two (or three) tree structures of its input elements (method getStructure ). These trees are then compared with each other by means of the differencing engine and displayed with the DiffTreeViewer , the ReplaceWithEditionDialog ...
• ICompareInput: Interface for objects used as input to a two-way or three-way compare viewer. It defines API for accessing the three sides for the compare, and a name and image which is used when displaying the three way input in the UI, for example, in a title bar. Note: at most two sides of an ICompareInput can be null , (as it is normal for additions or deletions) but not all three. ICompareInput provides methods for registering ICompareInputChangeListener s that get informed if one (or more) of the three sides of an ICompareInput object changes its value. For example when accepting an incoming addition the ...
• ContentMergeViewer: An abstract compare and merge viewer with two side-by-side content areas and an optional content area for the ancestor. The implementation makes no assumptions about the content type. ContentMergeViewer implements the overall layout and defines hooks so that subclasses can easily provide an implementation for a specific content type, implements the UI for making the areas resizable, has an action for controlling whether the ancestor area is visible or not, has actions for copying one side of the input to the other side, tracks the dirty state of the left and right sides and send out notification ...
• RangeDifferencer: A RangeDifferencer finds the differences between two or three IRangeComparator s. To use the differencer, clients provide an IRangeComparator that breaks their input data into a sequence of comparable entities. The differencer returns the differences among these sequences as an array of RangeDifference objects ( findDifferences methods). Every RangeDifference represents a single kind of difference and the corresponding ranges of the underlying comparable entities in the left, right, and optionally ancestor sides. Alternatively, the findRanges methods not only return objects for the differing ranges ...
• ITokenComparator: For performing a so-called "token compare" on a line of text. This interface extends the IRangeComparator interface so that it can be used by the TextMergeViewer . TextMergeViewer activates the token compare when navigating into a range of differing lines. At first the lines are selected as a block. When navigating into this block the token compare shows for every line the differing token by selecting them. TextMergeViewer 's default token comparator works on characters separated by whitespace. If a different strategy is needed (for example, to use Java tokens in a Java-aware merge viewer), clients ...
• CompareConfiguration: A CompareConfiguration object controls various UI aspects of compare/merge viewers like title labels and images, or whether a side of a merge viewer is editable. In addition to these fixed properties ICompareConfiguration provides API for an open ended set of properties. Different viewers which share the same configuration can communicate via this mechanism. E.g. if a compare editor has a button for controlling whether compare viewers ignore white space, the button would trigger a change of the boolean IGNORE_WHITESPACE property and all interested viewers would receive notification. Suitable default ...
• IDiffElement: An IDiffElement is used in the DiffTreeViewer to display the kind of change detected as the result of a two-way or three-way compare. The base interface ITypedElement provides a name, a type, and an image. IDiffElement adds API for maintaining a parent relationship. DiffTreeViewer works on a tree of IDiffElements . Leaf elements must implement the IDiffElement interface, inner nodes the IDiffContainer interface. IDiffElement s are typically created as the result of performing a compare with the Differencer . Clients may implement this interface, or use one of the standard implementations, DiffElement ...
• DocumentRangeNode: A document range node represents a structural element when performing a structure compare of documents. DocumentRangeNodes are created while parsing the document and represent a semantic entity (e.g. a Java class or method). As a consequence of the parsing a DocumentRangeNode maps to a range of characters in the document. Since a DocumentRangeNode implements the IStructureComparator and IStreamContentAccessor interfaces it can be used as input to the differencing engine. This makes it possible to perform a structural diff on a document and have the nodes and leaves of the compare easily map to ...
• RangeDifference: Description of a change between two or three ranges of comparable entities. RangeDifference objects are the elements of a compare result returned from the RangeDifferencer find* methods. Clients use these objects as they are returned from the differencer. This class is not intended to be instantiated or subclassed. Note: A range in the RangeDifference object is given as a start index and length in terms of comparable entities. However, these entity indices and counts are not necessarily character positions. For example, if an entity represents a line in a document, the start index would be a line ...
• IRangeComparator: For breaking an object to compare into a sequence of comparable entities. It is used by RangeDifferencer to find longest sequences of matching and non-matching ranges. For example, to compare two text documents and find longest common sequences of matching and non-matching lines, the implementation must break the document into lines. getRangeCount would return the number of lines in the document, and rangesEqual would compare a specified line given with one in another IRangeComparator . Clients should implement this interface; there is no standard implementation.
• ICompareInputChangeListener: Listener that gets informed if one (or more) of the three sides of an ICompareInput object changes its value. For example when accepting an incoming addition the (non-null) left side of an ICompareInput is copied to the right side (which was null ). This triggers a call to compareInputChanged of registered ICompareInputChangeListener . Note however, that listener are not informed if the content of one of the sides changes. Clients may implement this interface. It is also implemented by viewers that take an ICompareInput as input.
• BufferedContent: Abstract implementation for a buffered IStreamContentAccessor . Subclasses must implement the createStream method to connect the buffered content with a streamable source (e.g., a file). As long as the contents of BufferedContent is only retrieved as an input stream (by means of getContents ) and the BufferedContent is not modified (with setContent ) no buffering takes place. Buffering starts when either method getContent or setContent is called.
• CompareUIPlugin: The Compare UI plug-in 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. This class is the plug-in runtime class for the "org.eclipse.compare" plug-in.
• DiffNode: Diff node are used as the compare result of the differencing engine. Since it implements the ITypedElement and ICompareInput interfaces it can be used directly to display the compare result in a DiffTreeViewer and as the input to any other compare/merge viewer. DiffNode s are typically created as the result of performing a compare with the Differencer . Clients typically use this class as is, but may subclass if required.
• 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.
• IEditableContent: Common interface for objects with editable contents. Typically it is implemented by objects that also implement the IStreamContentAccessor interface. Clients may implement this interface. Note that implementing IEditableContent does not automatically mean that it is editable. An object is only editable if it implements IEditableContent and the isEditable method returns true .
• CompareViewerPane: A CompareViewerPane is a convenience class which installs a CLabel and a Toolbar in a ViewForm . Double clicking onto the CompareViewerPane 's title bar maximizes the CompareViewerPane to the size of an enclosing Splitter (if there is one). If more Splitters are nested maximizing walks up and maximizes to the outermost Splitter .
• IDiffContainer: IDiffContainer is a IDiffElement with children. IDiffContainer are the inner nodes displayed by the DiffTreeViewer . IDiffContainer are typically created as the result of performing a compare with the Differencer . Clients may implement this interface, or use one of the standard implementations, DiffContainer or DiffNode .
• ICompareNavigator: A ICompareNavigator is used to navigate through the individual differences of a CompareEditorInput . Please note: the following might change before the final release of Eclipse 3.0. You can retrieve an object implementing the ICompareNavigator from a CompareEditorInput by calling getAdapter(ICompareNavigator) on the CompareEditorInput .
• ResourceNode: A ResourceNode wrappers an IResources so that it can be used as input for the differencing engine (interfaces IStructureComparator and ITypedElement ) and the ReplaceWithEditionDialog (interfaces ITypedElement and IModificationDate ). Clients may instantiate this class; it is not intended to be subclassed.
• CompareViewerSwitchingPane: A custom CompareViewerPane that supports dynamic viewer switching. Clients must implement the viewer switching strategy by implementing the getViewer(Viewer, Object) method. If a property with the name CompareUI.COMPARE_VIEWER_TITLE is set on the top level SWT control of a viewer, it is used as a title in the CompareViewerPane 's title bar.
| Home | Contact Us | Privacy Policy | Terms of Service |