public abstract class ContentMergeViewer extends ContentViewer implements IPropertyChangeNotifier, org.eclipse.compare.internal.ISavable
ContentMergeViewer
ContentMergeViewer accesses its
model by means of a content provider which must implement the
IMergeViewerContentProvider interface.
Clients may wish to use the standard concrete subclass TextMergeViewer,
or define their own subclass.
IMergeViewerContentProvider,
TextMergeViewerWIDGET_DATA_KEY| Modifier | Constructor and Description |
|---|---|
protected |
ContentMergeViewer(int style,
ResourceBundle bundle,
CompareConfiguration cc)
Creates a new content merge viewer and initializes with a resource bundle and a
configuration.
|
| Modifier and Type | Method and Description |
|---|---|
void |
addPropertyChangeListener(IPropertyChangeListener listener)
Adds a listener for property changes to this notifier.
|
protected Control |
buildControl(Composite parent)
Builds the SWT controls for the three areas of a compare/merge viewer.
|
protected abstract void |
copy(boolean leftToRight)
Copies the content of one side to the other side.
|
protected abstract void |
createControls(Composite composite)
Creates the SWT controls for the ancestor, left, and right
content areas of this compare viewer.
|
protected void |
createToolItems(ToolBarManager toolBarManager)
Contributes items to the given
ToolBarManager. |
protected boolean |
doSave(Object newInput,
Object oldInput)
This method is called from the
Viewer method inputChanged
to save any unsaved changes of the old input. |
protected CompareConfiguration |
getCompareConfiguration()
Returns the compare configuration of this viewer,
or
null if this viewer does not yet have a configuration. |
protected abstract byte[] |
getContents(boolean left)
Returns the byte contents of the left or right side.
|
Control |
getControl()
Returns the primary control associated with this viewer.
|
protected ResourceBundle |
getResourceBundle()
Returns the resource bundle of this viewer.
|
ISelection |
getSelection()
The
ContentMergeViewer implementation of this
Viewer method returns the empty selection. |
String |
getTitle()
Returns the viewer's name.
|
protected void |
handleDispose(DisposeEvent event)
Handles a dispose event on this viewer's control.
|
protected abstract void |
handleResizeAncestor(int x,
int y,
int width,
int height)
Lays out the ancestor area of the compare viewer.
|
protected abstract void |
handleResizeLeftRight(int x,
int y,
int leftWidth,
int centerWidth,
int rightWidth,
int height)
Lays out the left and right areas of the compare viewer.
|
protected void |
inputChanged(Object input,
Object oldInput)
Internal hook method called when the input to this viewer is
initially set or subsequently changed.
|
void |
refresh()
Refreshes this viewer completely with information freshly obtained from this
viewer's model.
|
void |
removePropertyChangeListener(IPropertyChangeListener listener)
Removes the given content change listener from this notifier.
|
void |
save(IProgressMonitor pm) |
void |
setConfirmSave(boolean enable)
Controls whether
doSave(Object, Object) asks for confirmation before saving
the old input with saveContent(Object). |
void |
setContentProvider(IContentProvider contentProvider)
The
ContentMergeViewer implementation of this
ContentViewer method
checks to ensure that the content provider is an IMergeViewerContentProvider. |
protected void |
setLeftDirty(boolean dirty)
Sets the dirty state of the left side of this viewer.
|
protected void |
setRightDirty(boolean dirty)
Sets the dirty state of the right side of this viewer.
|
void |
setSelection(ISelection selection,
boolean reveal)
Sets a new selection for this viewer and optionally makes it visible.
|
protected abstract 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.
|
getContentProvider, getInput, getLabelProvider, handleLabelProviderChanged, hookControl, labelProviderChanged, setInput, setLabelProvideraddHelpListener, addSelectionChangedListener, fireHelpRequested, fireSelectionChanged, getData, handleHelpRequest, removeHelpListener, removeSelectionChangedListener, scrollDown, scrollUp, setData, setSelectionprotected ContentMergeViewer(int style,
ResourceBundle bundle,
CompareConfiguration cc)
style - SWT style bitsbundle - the resource bundlecc - the configuration objectpublic String getTitle()
protected abstract void createControls(Composite composite)
updateContent.composite - the container for the three areasprotected abstract void handleResizeAncestor(int x,
int y,
int width,
int height)
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 areaprotected abstract void handleResizeLeftRight(int x,
int y,
int leftWidth,
int centerWidth,
int rightWidth,
int height)
x - the horizontal position of the left area within its containery - the vertical position of the left and right area within its containerleftWidth - the width of the left areacenterWidth - the width of the gap between the left and right areasrightWidth - the width of the right areaheight - the height of the left and right areasprotected void createToolItems(ToolBarManager toolBarManager)
ToolBarManager.
It is called when this viewer is installed in its container and if the container
has a ToolBarManager.
The ContentMergeViewer implementation of this method does nothing.
Subclasses may reimplement.toolBarManager - the toolbar manager to contribute toprotected abstract void updateContent(Object ancestor, Object left, Object right)
ancestor - the input for the ancestor arealeft - the input for the left arearight - the input for the right areaprotected abstract void copy(boolean leftToRight)
leftToRight - if true, the left side is copied to the right side;
if false, the right side is copied to the left sideprotected abstract byte[] getContents(boolean left)
null can be returned.left - if true, the byte contents of the left area is returned;
if false, the byte contents of the right areanullprotected ResourceBundle getResourceBundle()
protected CompareConfiguration getCompareConfiguration()
null if this viewer does not yet have a configuration.null if nonepublic void setContentProvider(IContentProvider contentProvider)
ContentMergeViewer implementation of this
ContentViewer method
checks to ensure that the content provider is an IMergeViewerContentProvider.setContentProvider in class ContentViewercontentProvider - the content provider to set. Must implement IMergeViewerContentProvider.ContentViewer.getContentProvider()public ISelection getSelection()
ContentMergeViewer implementation of this
Viewer method returns the empty selection. Subclasses may override.getSelection in interface ISelectionProvidergetSelection in class Viewerpublic void setSelection(ISelection selection, boolean reveal)
ViewerSubclasses must implement this method.
setSelection in class Viewerselection - the new selectionreveal - true if the selection is to be made
visible, and false otherwiseprotected final void inputChanged(Object input, Object oldInput)
The ContentMergeViewer implementation of this Viewer
method tries to save the old input by calling doSave(...) and
then calls internalRefresh(...).
inputChanged in class Viewerinput - the new input of this viewer, or null if there is no new inputoldInput - the old input element, or null if there was previously no inputprotected boolean doSave(Object newInput, Object oldInput)
Viewer method inputChanged
to save any unsaved changes of the old input.
The ContentMergeViewer implementation of this
method calls saveContent(...). If confirmation has been turned on
with setConfirmSave(true), a confirmation alert is posted before saving.
newInput - the new input of this viewer, or null if there is no new inputoldInput - the old input element, or null if there was previously no inputtrue if saving was successful, or if the user didn't want to save (by pressing 'NO' in the confirmation dialog).public void setConfirmSave(boolean enable)
doSave(Object, Object) asks for confirmation before saving
the old input with saveContent(Object).enable - a value of true enables confirmationpublic void refresh()
Viewerprotected final Control buildControl(Composite parent)
Calls the hooks createControls and createToolItems
to let subclasses build the specific content areas and to add items to
an enclosing toolbar.
This method must only be called in the constructor of subclasses.
parent - the parent controlpublic Control getControl()
ViewergetControl in class Viewerprotected void handleDispose(DisposeEvent event)
ContentViewer
The ContentViewer implementation of this method disposes of this
viewer's label provider and content provider (if it has one).
Subclasses should override this method to perform any additional
cleanup of resources; however, overriding methods must invoke
super.handleDispose.
handleDispose in class ContentViewerevent - a dispose eventprotected void updateToolItems()
This method is called whenever the state of the items needs updating.
Subclasses may extend this method, although this is generally not required.
protected void updateHeader()
This method is called whenever the header must be updated.
Subclasses may extend this method, although this is generally not required.
public void addPropertyChangeListener(IPropertyChangeListener listener)
IPropertyChangeNotifieraddPropertyChangeListener in interface IPropertyChangeNotifierlistener - a property change listenerpublic void removePropertyChangeListener(IPropertyChangeListener listener)
IPropertyChangeNotifierremovePropertyChangeListener in interface IPropertyChangeNotifierlistener - a property change listenerprotected void setLeftDirty(boolean dirty)
PropertyChangeEvent with the
property name CompareEditorInput.DIRTY_STATE.dirty - the state of the left side dirty flagprotected void setRightDirty(boolean dirty)
PropertyChangeEvent with the
property name CompareEditorInput.DIRTY_STATE.dirty - the state of the right side dirty flagpublic void save(IProgressMonitor pm) throws CoreException
save in interface org.eclipse.compare.internal.ISavableCoreExceptionGuidelines for using Eclipse APIs. Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.