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 theRangeDifferencer
to perform a textual, line-by-line comparison of two (or three) input documents. It is based on theContentMergeViewer
and usesTextViewer
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 "differing range" and the underlying document is editable the
TextMergeViewer
enables 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
TextMergeViewer
uses 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 theITokenComparator
interface and overriding theTextMergeViewer.createTokenComparator
factory method).Access to the
TextMergeViewer
's model is by means of anIMergeViewerContentProvider
. ItsgetXContent
methods must return either anIDocument
, anIDocumentRange
, or anIStreamContentAccessor
. In theIDocumentRange
case theTextMergeViewer
works on a subrange of a document. In theIStreamContentAccessor
case a document is created internally and initialized from the stream.A
TextMergeViewer
can be used as is. However clients may subclass to customize the behavior. For example aMergeTextViewer
for Java would override theconfigureTextViewer
method to configure theTextViewer
for Java source code, thecreateTokenComparator
method 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 void
configureTextViewer(TextViewer textViewer)
Configures the passed text viewer.protected void
copy(boolean leftToRight)
Copies the content of one side to the other side.protected Control
createCenterControl(Composite parent)
Create the control that divides the left and right sides of the merge viewer.protected void
createControls(Composite composite)
Creates the SWT controls for the ancestor, left, and right content areas of this compare viewer.protected SourceViewer
createSourceViewer(Composite parent, int textOrientation)
Creates a new source viewer.protected ITokenComparator
createTokenComparator(String line)
Creates anITokenComparator
which is used to show the intra line differences.protected void
createToolItems(ToolBarManager tbm)
Contributes items to the givenToolBarManager
.protected boolean
doSave(Object newInput, Object oldInput)
Overridden to prevent save confirmation if new input is sub document of current input.protected int
findInsertionPosition(char type, ICompareInput input)
protected void
flushContent(Object oldInput, IProgressMonitor monitor)
Flushes the modified content back to input elements via the content provider.<T> T
getAdapter(Class<T> adapter)
Returns an object which is an instance of the given class associated with this object.protected int
getCenterWidth()
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 IDocumentPartitioner
getDocumentPartitioner()
Returns a document partitioner which is suitable for the underlying content type.protected String
getDocumentPartitioning()
Return the partitioning to which the partitioner returned fromgetDocumentPartitioner()
is to be associated.protected IEditorInput
getEditorInput(ISourceViewer sourceViewer)
Returns an editor input for the given source viewer.protected void
handleCompareInputChange()
Handle a change to the given input reported from anICompareInputChangeListener
.protected void
handleDispose(DisposeEvent event)
Called on the viewer disposal.protected void
handlePropertyChangeEvent(PropertyChangeEvent event)
Callback that is invoked when a property in the compare configuration (ContentMergeViewer.getCompareConfiguration()
changes.protected void
handleResizeAncestor(int x, int y, int width, int height)
Lays out the ancestor area of the compare viewer.protected void
handleResizeLeftRight(int x, int y, int width1, int centerWidth, int width2, int height)
Lays out the left and right areas of the compare viewer.protected boolean
handleSetFocus()
Override to give focus to the pane that previously had focus or to a suitable default pane.void
invalidateTextPresentation()
Invalidates the current presentation by invalidating the three text viewers.protected boolean
isEditorBacked(ITextViewer textViewer)
Tells whether the given text viewer is backed by an editor.protected void
setActionsActivated(SourceViewer sourceViewer, boolean state)
Activates or deactivates actions of the given source viewer.void
setBackgroundColor(RGB background)
Sets the viewer's background color to the given RGB value.protected void
setEditable(ISourceViewer sourceViewer, boolean state)
Sets the editable state of the given source viewer.void
setForegroundColor(RGB foreground)
Sets the viewer's foreground color to the given RGB value.protected void
setupDocument(IDocument document)
Setup the given document for use with this viewer.protected void
updateContent(Object ancestor, Object left, Object right)
Initializes the controls of the three content areas with the given input objects.protected void
updateHeader()
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 void
updateToolItems()
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 isnull
the system's default background color is used.- Parameters:
background
- the background color ornull
to 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 isnull
the system's default foreground color is used.- Parameters:
foreground
- the foreground color ornull
to 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. TheTextMergeViewer
implementation 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 anITokenComparator
which is used to show the intra line differences. TheTextMergeViewer
implementation 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 aIStreamContentAccessor
and an internal document must be obtained. This document is initialized with the partitioner returned from this method.The
TextMergeViewer
implementation 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. Returnnull
only if partitioning is not needed or if the subclass overrodesetupDocument(IDocument)
directly. By default,null
is 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:
handleDispose
in 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:ContentMergeViewer
Creates 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:
createControls
in 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:
handleSetFocus
in 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:ContentMergeViewer
Create the control that divides the left and right sides of the merge viewer.- Overrides:
createCenterControl
in classContentMergeViewer
- Parameters:
parent
- the parent composite- Returns:
- the center control
-
getCenterWidth
protected final int getCenterWidth()
Description copied from class:ContentMergeViewer
Return 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:
getCenterWidth
in 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:
true
if 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 returnsnull
when 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
null
when 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
-true
if 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:
doSave
in classContentMergeViewer
- Parameters:
newInput
- the new input of this viewer, ornull
if there is no new inputoldInput
- the old input element, ornull
if there was previously no input- Returns:
true
if 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:ContentMergeViewer
Initializes the controls of the three content areas with the given input objects.- Specified by:
updateContent
in 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:
getContents
in classContentMergeViewer
- Parameters:
left
- iftrue
the 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:ContentMergeViewer
Lays 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:
handleResizeAncestor
in 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:ContentMergeViewer
Lays 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:
handleResizeLeftRight
in 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:ContentMergeViewer
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.This method is called whenever the header must be updated.
Subclasses may extend this method, although this is generally not required.
- Overrides:
updateHeader
in classContentMergeViewer
-
createToolItems
protected void createToolItems(ToolBarManager tbm)
Description copied from class:ContentMergeViewer
Contributes items to the givenToolBarManager
. It is called when this viewer is installed in its container and if the container has aToolBarManager
. TheContentMergeViewer
implementation of this method does nothing. Subclasses may reimplement.- Overrides:
createToolItems
in classContentMergeViewer
- Parameters:
tbm
- the toolbar manager to contribute to
-
handlePropertyChangeEvent
protected void handlePropertyChangeEvent(PropertyChangeEvent event)
Description copied from class:ContentMergeViewer
Callback that is invoked when a property in the compare configuration (ContentMergeViewer.getCompareConfiguration()
changes.- Overrides:
handlePropertyChangeEvent
in classContentMergeViewer
- Parameters:
event
- the property change event
-
updateToolItems
protected void updateToolItems()
Description copied from class:ContentMergeViewer
Updates 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:
updateToolItems
in classContentMergeViewer
-
copy
protected void copy(boolean leftToRight)
Description copied from class:ContentMergeViewer
Copies 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:
copy
in 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:ContentMergeViewer
Flushes 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:
flushContent
in classContentMergeViewer
- Parameters:
oldInput
- the compare inputmonitor
- a progress monitor ornull
if 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:IAdaptable
Returns an object which is an instance of the given class associated with this object. Returnsnull
if 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:
getAdapter
in interfaceIAdaptable
- Type Parameters:
T
- the class type- Parameters:
adapter
- the adapter class to look up- Returns:
- a object of the given class,
or
null
if this object does not have an adapter for the given class
-
handleCompareInputChange
protected void handleCompareInputChange()
Description copied from class:ContentMergeViewer
Handle 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:
handleCompareInputChange
in classContentMergeViewer
-
-