Class TextMergeViewer
- java.lang.Object
-
- org.eclipse.jface.viewers.Viewer
-
- org.eclipse.jface.viewers.ContentViewer
-
- org.eclipse.compare.contentmergeviewer.ContentMergeViewer
-
- org.eclipse.compare.contentmergeviewer.TextMergeViewer
-
- All Implemented Interfaces:
IFlushable,org.eclipse.compare.internal.IFlushable2,IPropertyChangeNotifier,IAdaptable,IInputProvider,IInputSelectionProvider,ISelectionProvider
public class TextMergeViewer extends ContentMergeViewer implements IAdaptable
A text merge viewer uses theRangeDifferencerto perform a textual, line-by-line comparison of two (or three) input documents. It is based on theContentMergeViewerand usesTextViewers 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
TextMergeViewersupports 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 "differing range" and the underlying document is editable the
TextMergeViewerenables actions in context menu and toolbar to copy a range from one side to the other side, thereby performing a merge operation.In addition to a line-by-line comparison the
TextMergeVieweruses a token based compare on differing lines. The token compare is activated 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.The
TextMergeViewer's default token compare works on characters separated by whitespace. If a different strategy is needed (for example, Java tokens in a Java-aware merge viewer), clients can create their own token comparators by implementing theITokenComparatorinterface and overriding theTextMergeViewer.createTokenComparatorfactory method).Access to the
TextMergeViewer's model is by means of anIMergeViewerContentProvider. ItsgetXContentmethods must return either anIDocument, anIDocumentRange, or anIStreamContentAccessor. In theIDocumentRangecase theTextMergeViewerworks on a subrange of a document. In theIStreamContentAccessorcase a document is created internally and initialized from the stream.A
TextMergeViewercan be used as is. However clients may subclass to customize the behavior. For example aMergeTextViewerfor Java would override theconfigureTextViewermethod to configure theTextViewerfor Java source code, thecreateTokenComparatormethod to create a Java specific tokenizer.In 3.5 a new API has been introduced to let clients provide their own source viewers implementation with an option to configure them basing on a corresponding editor input.
-
-
Field Summary
-
Fields inherited from class org.eclipse.jface.viewers.Viewer
WIDGET_DATA_KEY
-
-
Constructor Summary
Constructors Constructor Description TextMergeViewer(Composite parent, int style, CompareConfiguration configuration)Creates a text merge viewer under the given parent control.TextMergeViewer(Composite parent, CompareConfiguration configuration)Creates a text merge viewer under the given parent control.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidconfigureTextViewer(TextViewer textViewer)Configures the passed text viewer.protected voidcopy(boolean leftToRight)Copies the content of one side to the other side.protected ControlcreateCenterControl(Composite parent)Create the control that divides the left and right sides of the merge viewer.protected voidcreateControls(Composite composite)Creates the SWT controls for the ancestor, left, and right content areas of this compare viewer.protected SourceViewercreateSourceViewer(Composite parent, int textOrientation)Creates a new source viewer.protected ITokenComparatorcreateTokenComparator(String line)Creates anITokenComparatorwhich is used to show the intra line differences.protected voidcreateToolItems(ToolBarManager tbm)Contributes items to the givenToolBarManager.protected booleandoSave(Object newInput, Object oldInput)Overridden to prevent save confirmation if new input is sub document of current input.protected intfindInsertionPosition(char type, ICompareInput input)protected voidflushContent(Object oldInput, IProgressMonitor monitor)Flushes the modified content back to input elements via the content provider.<T> TgetAdapter(Class<T> adapter)Returns an object which is an instance of the given class associated with this object.protected intgetCenterWidth()Return the desired width of the center control.protected byte[]getContents(boolean left)Returns the contents of the underlying document as an array of bytes using the current workbench encoding.protected IDocumentPartitionergetDocumentPartitioner()Returns a document partitioner which is suitable for the underlying content type.protected StringgetDocumentPartitioning()Return the partitioning to which the partitioner returned fromgetDocumentPartitioner()is to be associated.protected IEditorInputgetEditorInput(ISourceViewer sourceViewer)Returns an editor input for the given source viewer.protected voidhandleCompareInputChange()Handle a change to the given input reported from anICompareInputChangeListener.protected voidhandleDispose(DisposeEvent event)Called on the viewer disposal.protected voidhandlePropertyChangeEvent(PropertyChangeEvent event)Callback that is invoked when a property in the compare configuration (ContentMergeViewer.getCompareConfiguration()changes.protected voidhandleResizeAncestor(int x, int y, int width, int height)Lays out the ancestor area of the compare viewer.protected voidhandleResizeLeftRight(int x, int y, int width1, int centerWidth, int width2, int height)Lays out the left and right areas of the compare viewer.protected booleanhandleSetFocus()Override to give focus to the pane that previously had focus or to a suitable default pane.voidinvalidateTextPresentation()Invalidates the current presentation by invalidating the three text viewers.protected booleanisEditorBacked(ITextViewer textViewer)Tells whether the given text viewer is backed by an editor.protected voidsetActionsActivated(SourceViewer sourceViewer, boolean state)Activates or deactivates actions of the given source viewer.voidsetBackgroundColor(RGB background)Sets the viewer's background color to the given RGB value.protected voidsetEditable(ISourceViewer sourceViewer, boolean state)Sets the editable state of the given source viewer.voidsetForegroundColor(RGB foreground)Sets the viewer's foreground color to the given RGB value.protected voidsetupDocument(IDocument document)Setup the given document for use with this viewer.protected voidupdateContent(Object ancestor, Object left, Object right)Initializes the controls of the three content areas with the given input objects.protected voidupdateHeader()Updates the headers of the three areas by querying the content provider for a name and image for the three sides of the input object.protected voidupdateToolItems()Updates the enabled state of the toolbar items.-
Methods inherited from class org.eclipse.compare.contentmergeviewer.ContentMergeViewer
addPropertyChangeListener, buildControl, flush, flushLeft, flushRight, getCenterControl, getCompareConfiguration, getControl, getResourceBundle, getSelection, getTitle, getToolBarManager, hookControl, inputChanged, internalIsLeftDirty, internalIsRightDirty, isAncestorVisible, isLeftDirty, isLeftEditable, isRightDirty, isRightEditable, isThreeWay, refresh, removePropertyChangeListener, save, setConfirmSave, setContentProvider, setLeftDirty, setRightDirty, setSelection
-
Methods inherited from class org.eclipse.jface.viewers.ContentViewer
getContentProvider, getInput, getLabelProvider, handleLabelProviderChanged, labelProviderChanged, setInput, setLabelProvider
-
Methods inherited from class org.eclipse.jface.viewers.Viewer
addHelpListener, addSelectionChangedListener, fireHelpRequested, fireSelectionChanged, getData, handleHelpRequest, removeHelpListener, removeSelectionChangedListener, scrollDown, scrollUp, setData, setSelection
-
-
-
-
Constructor Detail
-
TextMergeViewer
public TextMergeViewer(Composite parent, CompareConfiguration configuration)
Creates a text merge viewer under the given parent control.- Parameters:
parent- the parent controlconfiguration- the configuration object
-
TextMergeViewer
public TextMergeViewer(Composite parent, int style, CompareConfiguration configuration)
Creates a text merge viewer under the given parent control.- Parameters:
parent- the parent controlstyle- SWT style bits for top level composite of this viewerconfiguration- the configuration object
-
-
Method Detail
-
setBackgroundColor
public void setBackgroundColor(RGB background)
Sets the viewer's background color to the given RGB value. If the value isnullthe system's default background color is used.- Parameters:
background- the background color ornullto use the system's default background color- Since:
- 2.0
-
setForegroundColor
public void setForegroundColor(RGB foreground)
Sets the viewer's foreground color to the given RGB value. If the value isnullthe system's default foreground color is used.- Parameters:
foreground- the foreground color ornullto use the system's default foreground color- Since:
- 2.0
-
invalidateTextPresentation
public void invalidateTextPresentation()
Invalidates the current presentation by invalidating the three text viewers.- Since:
- 2.0
-
configureTextViewer
protected void configureTextViewer(TextViewer textViewer)
Configures the passed text viewer. This method is called after the three text viewers have been created for the content areas. TheTextMergeViewerimplementation of this method will configure the viewer with aSourceViewerConfiguration. Subclasses may reimplement to provide a specific configuration for the text viewer.- Parameters:
textViewer- the text viewer to configure
-
createTokenComparator
protected ITokenComparator createTokenComparator(String line)
Creates anITokenComparatorwhich is used to show the intra line differences. TheTextMergeViewerimplementation of this method returns a tokenizer that breaks a line into words separated by whitespace. Subclasses may reimplement to provide a specific tokenizer.- Parameters:
line- the line for which to create theITokenComparator- Returns:
- a ITokenComparator which is used for a second level token compare.
-
setupDocument
protected void setupDocument(IDocument document)
Setup the given document for use with this viewer. By default, the partitioner returned fromgetDocumentPartitioner()is registered as the default partitioner for the document. Subclasses that return a partitioner must also overridegetDocumentPartitioning()if they wish to be able to use shared documents (i.e. file buffers).- Parameters:
document- the document to be set up- Since:
- 3.3
-
getDocumentPartitioner
protected IDocumentPartitioner getDocumentPartitioner()
Returns a document partitioner which is suitable for the underlying content type. This method is only called if the input provided by the content provider is aIStreamContentAccessorand an internal document must be obtained. This document is initialized with the partitioner returned from this method.The
TextMergeViewerimplementation of this method returnsnull. Subclasses may reimplement to create a partitioner for a specific content type. Subclasses that do return a partitioner should also return a partitioning fromgetDocumentPartitioning()in order to make use of shared documents (e.g. file buffers).- Returns:
- a document partitioner, or
null
-
getDocumentPartitioning
protected String getDocumentPartitioning()
Return the partitioning to which the partitioner returned fromgetDocumentPartitioner()is to be associated. Returnnullonly if partitioning is not needed or if the subclass overrodesetupDocument(IDocument)directly. By default,nullis returned which means that shared documents that return a partitioner fromgetDocumentPartitioner()will not be able to use shared documents.- Returns:
- a partitioning
- Since:
- 3.3
- See Also:
IDocumentExtension3
-
handleDispose
protected void handleDispose(DisposeEvent event)
Called on the viewer disposal. Unregisters from the compare configuration. Clients may extend if they have to do additional cleanup.- Overrides:
handleDisposein classContentMergeViewer- Parameters:
event- a dispose event- See Also:
ContentViewer.handleDispose(org.eclipse.swt.events.DisposeEvent)
-
createControls
protected void createControls(Composite composite)
Description copied from class:ContentMergeViewerCreates the SWT controls for the ancestor, left, and right content areas of this compare viewer. Implementations typically hold onto the controls so that they can be initialized with the input objects in methodupdateContent.- Specified by:
createControlsin classContentMergeViewer- Parameters:
composite- the container for the three areas
-
handleSetFocus
protected boolean handleSetFocus()
Override to give focus to the pane that previously had focus or to a suitable default pane.- Overrides:
handleSetFocusin classContentMergeViewer- Returns:
- whether particular widget was given focus
- Since:
- 3.3
- See Also:
ContentMergeViewer.handleSetFocus()
-
createCenterControl
protected final Control createCenterControl(Composite parent)
Description copied from class:ContentMergeViewerCreate the control that divides the left and right sides of the merge viewer.- Overrides:
createCenterControlin classContentMergeViewer- Parameters:
parent- the parent composite- Returns:
- the center control
-
getCenterWidth
protected final int getCenterWidth()
Description copied from class:ContentMergeViewerReturn the desired width of the center control. This width is used to calculate the values used to layout the ancestor, left and right sides.- Overrides:
getCenterWidthin classContentMergeViewer- Returns:
- the desired width of the center control
- See Also:
ContentMergeViewer.handleResizeLeftRight(int, int, int, int, int, int),ContentMergeViewer.handleResizeAncestor(int, int, int, int)
-
createSourceViewer
protected SourceViewer createSourceViewer(Composite parent, int textOrientation)
Creates a new source viewer. This method is called when creating and initializing the content areas of the merge viewer (seecreateControls(Composite)). It is called three times for each text part of the comparison: ancestor, left, right. Clients may implement to provide their own type of source viewers. The viewer is not expected to be configured with a source viewer configuration.- Parameters:
parent- the parent of the viewer's controltextOrientation- style constant bit for text orientation- Returns:
- Default implementation returns an instance of
SourceViewer. - Since:
- 3.5
-
isEditorBacked
protected boolean isEditorBacked(ITextViewer textViewer)
Tells whether the given text viewer is backed by an editor.- Parameters:
textViewer- the text viewer to check- Returns:
trueif the viewer is backed by an editor- Since:
- 3.5
-
getEditorInput
protected IEditorInput getEditorInput(ISourceViewer sourceViewer)
Returns an editor input for the given source viewer. The method returnsnullwhen no input is available, for example when the input for the merge viewer has not been set yet.- Parameters:
sourceViewer- the source viewer to get input for- Returns:
- input for the given viewer or
nullwhen no input is available - Since:
- 3.5
-
setActionsActivated
protected void setActionsActivated(SourceViewer sourceViewer, boolean state)
Activates or deactivates actions of the given source viewer.The default implementation does nothing, but clients should override to properly react to viewers switching.
- Parameters:
sourceViewer- the source viewerstate-trueif activated- Since:
- 3.5
-
doSave
protected boolean doSave(Object newInput, Object oldInput)
Overridden to prevent save confirmation if new input is sub document of current input.- Overrides:
doSavein classContentMergeViewer- Parameters:
newInput- the new input of this viewer, ornullif there is no new inputoldInput- the old input element, ornullif there was previously no input- Returns:
trueif saving was successful, or if the user didn't want to save (by pressing 'NO' in the confirmation dialog).- Since:
- 2.0
-
updateContent
protected void updateContent(Object ancestor, Object left, Object right)
Description copied from class:ContentMergeViewerInitializes the controls of the three content areas with the given input objects.- Specified by:
updateContentin classContentMergeViewer- Parameters:
ancestor- the input for the ancestor arealeft- the input for the left arearight- the input for the right area
-
setEditable
protected void setEditable(ISourceViewer sourceViewer, boolean state)
Sets the editable state of the given source viewer.- Parameters:
sourceViewer- the source viewerstate- the state- Since:
- 3.5
-
findInsertionPosition
protected int findInsertionPosition(char type, ICompareInput input)
-
getContents
protected byte[] getContents(boolean left)
Returns the contents of the underlying document as an array of bytes using the current workbench encoding.- Specified by:
getContentsin classContentMergeViewer- Parameters:
left- iftruethe contents of the left side is returned; otherwise the right side- Returns:
- the contents of the left or right document or null
-
handleResizeAncestor
protected final void handleResizeAncestor(int x, int y, int width, int height)Description copied from class:ContentMergeViewerLays out the ancestor area of the compare viewer. It is called whenever the viewer is resized or when the sashes between the areas are moved to adjust the size of the areas.- Specified by:
handleResizeAncestorin classContentMergeViewer- Parameters:
x- the horizontal position of the ancestor area within its containery- the vertical position of the ancestor area within its containerwidth- the width of the ancestor areaheight- the height of the ancestor area
-
handleResizeLeftRight
protected final void handleResizeLeftRight(int x, int y, int width1, int centerWidth, int width2, int height)Description copied from class:ContentMergeViewerLays out the left and right areas of the compare viewer. It is called whenever the viewer is resized or when the sashes between the areas are moved to adjust the size of the areas.- Specified by:
handleResizeLeftRightin classContentMergeViewer- Parameters:
x- the horizontal position of the left area within its containery- the vertical position of the left and right area within its containerwidth1- the width of the left areacenterWidth- the width of the gap between the left and right areaswidth2- the width of the right areaheight- the height of the left and right areas
-
updateHeader
protected void updateHeader()
Description copied from class:ContentMergeViewerUpdates the headers of the three areas by querying the content provider for a name and image for the three sides of the input object.This method is called whenever the header must be updated.
Subclasses may extend this method, although this is generally not required.
- Overrides:
updateHeaderin classContentMergeViewer
-
createToolItems
protected void createToolItems(ToolBarManager tbm)
Description copied from class:ContentMergeViewerContributes items to the givenToolBarManager. It is called when this viewer is installed in its container and if the container has aToolBarManager. TheContentMergeViewerimplementation of this method does nothing. Subclasses may reimplement.- Overrides:
createToolItemsin classContentMergeViewer- Parameters:
tbm- the toolbar manager to contribute to
-
handlePropertyChangeEvent
protected void handlePropertyChangeEvent(PropertyChangeEvent event)
Description copied from class:ContentMergeViewerCallback that is invoked when a property in the compare configuration (ContentMergeViewer.getCompareConfiguration()changes.- Overrides:
handlePropertyChangeEventin classContentMergeViewer- Parameters:
event- the property change event
-
updateToolItems
protected void updateToolItems()
Description copied from class:ContentMergeViewerUpdates the enabled state of the toolbar items.This method is called whenever the state of the items needs updating.
Subclasses may extend this method, although this is generally not required.
- Overrides:
updateToolItemsin classContentMergeViewer
-
copy
protected void copy(boolean leftToRight)
Description copied from class:ContentMergeViewerCopies the content of one side to the other side. Called from the (internal) actions for copying the sides of the viewer's input object.- Specified by:
copyin classContentMergeViewer- Parameters:
leftToRight- iftrue, the left side is copied to the right side; iffalse, the right side is copied to the left side
-
flushContent
protected void flushContent(Object oldInput, IProgressMonitor monitor)
Description copied from class:ContentMergeViewerFlushes the modified content back to input elements via the content provider. The provided input may be the current input of the viewer or it may be the previous input (i.e. this method may be called to flush modified content during an input change).- Overrides:
flushContentin classContentMergeViewer- Parameters:
oldInput- the compare inputmonitor- a progress monitor ornullif the method was call from a place where a progress monitor was not available.
-
getAdapter
public <T> T getAdapter(Class<T> adapter)
Description copied from interface:IAdaptableReturns an object which is an instance of the given class associated with this object. Returnsnullif no such object can be found.Clients may implement this method but should generally call
Adapters.adapt(Object, Class, boolean)rather than invoking it directly.- Specified by:
getAdapterin interfaceIAdaptable- Type Parameters:
T- the class type- Parameters:
adapter- the adapter class to look up- Returns:
- a object of the given class,
or
nullif this object does not have an adapter for the given class
-
handleCompareInputChange
protected void handleCompareInputChange()
Description copied from class:ContentMergeViewerHandle a change to the given input reported from anICompareInputChangeListener. This class registers a listener with its input and reports any change events through this method. By default, this method prompts for any unsaved changes and then refreshes the viewer. Subclasses may override.- Overrides:
handleCompareInputChangein classContentMergeViewer
-
-