|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.eclipse.jface.viewers.Viewer | +--org.eclipse.jface.viewers.ContentViewer | +--org.eclipse.compare.contentmergeviewer.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
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
,
TextMergeViewer
Field Summary |
Fields inherited from class org.eclipse.jface.viewers.Viewer |
WIDGET_DATA_KEY |
Constructor Summary | |
protected |
ContentMergeViewer(int style,
ResourceBundle bundle,
CompareConfiguration cc)
Creates a new content merge viewer and initializes with a resource bundle and a configuration. |
Method Summary | |
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)
Called on the viewer disposal. |
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)
Save the viewers's content. |
void |
setConfirmSave(boolean enable)
Controls whether doSave(...) asks for confirmation before saving
the old input with saveContent(...) . |
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 s,
boolean reveal)
The ContentMergeViewer implementation of this
Viewer method does nothing. |
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. |
Methods inherited from class org.eclipse.jface.viewers.ContentViewer |
getContentProvider, getInput, getLabelProvider, handleLabelProviderChanged, hookControl, labelProviderChanged, setInput, setLabelProvider |
Methods inherited from class org.eclipse.jface.viewers.Viewer |
addHelpListener, addSelectionChangedListener, fireHelpRequested, fireSelectionChanged, getData, handleHelpRequest, removeHelpListener, removeSelectionChangedListener, scrollDown, scrollUp, setData, setSelection |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
protected ContentMergeViewer(int style, ResourceBundle bundle, CompareConfiguration cc)
bundle
- the resource bundlecc
- the configuration objectMethod Detail |
public 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 area
null
protected 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 ContentViewer
contentProvider
- the content providerContentViewer.getContentProvider()
public ISelection getSelection()
ContentMergeViewer
implementation of this
Viewer
method returns the empty selection. Subclasses may override.
getSelection
in interface ISelectionProvider
getSelection
in class Viewer
public void setSelection(ISelection s, boolean reveal)
ContentMergeViewer
implementation of this
Viewer
method does nothing. Subclasses may reimplement.
setSelection
in class Viewer
s
- 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 Viewer
input
- 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 input
true
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(...)
asks for confirmation before saving
the old input with saveContent(...)
.
enable
- a value of true
enables confirmationpublic void refresh()
Viewer
refresh
in class Viewer
protected 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 control
public Control getControl()
Viewer
getControl
in class Viewer
protected void handleDispose(DisposeEvent event)
handleDispose
in class ContentViewer
event
- 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)
IPropertyChangeNotifier
addPropertyChangeListener
in interface IPropertyChangeNotifier
listener
- a property change listenerpublic void removePropertyChangeListener(IPropertyChangeListener listener)
IPropertyChangeNotifier
removePropertyChangeListener
in interface IPropertyChangeNotifier
listener
- 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.ISavable
CoreException
|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |