public class ParticipantPageCompareEditorInput extends PageCompareEditorInput
ModelSynchronizeParticipant.DIRTY_STATE, PROP_SELECTED_EDITION, PROP_TITLE, PROP_TITLE_IMAGE| Constructor and Description |
|---|
ParticipantPageCompareEditorInput(CompareConfiguration configuration,
ISynchronizePageConfiguration pageConfiguration,
ISynchronizeParticipant participant)
Creates a part for the provided participant.
|
| Modifier and Type | Method and Description |
|---|---|
protected ICompareInput |
asCompareInput(ISelection selection)
Return a compare input that represents the selection.
|
void |
cancelPressed()
The
CANCEL button was pressed in a dialog. |
void |
contentChanged(IContentChangeNotifier source)
Called whenever the content of the given source has changed.
|
Control |
createContents(Composite parent)
Create the SWT controls that are used to display the result of the compare operation.
|
protected IPage |
createPage(CompareViewerPane parent,
IToolBarManager toolBarManager)
Create the page for this part and return the top level control
for the page.
|
String |
getCancelButtonLabel()
Return the label used for the
CANCEL
button when this input is shown in a compare dialog
using CompareUI.openCompareDialog(CompareEditorInput). |
String |
getOKButtonLabel()
Return the label to be used for the
OK
button when this input is displayed in a dialog. |
ISynchronizePageConfiguration |
getPageConfiguration()
Return the synchronize page configuration for this part
|
ISynchronizeParticipant |
getParticipant()
Return the Synchronize participant for this part
|
protected ISelectionProvider |
getSelectionProvider()
Return the selection provider for the page.
|
Image |
getTitleImage()
Returns the title image which will be used in the compare editor's title bar.
|
protected void |
handleDispose()
Callback that occurs when the UI associated with this compare editor
input is disposed.
|
protected boolean |
isOfferToRememberParticipant()
Return whether the ability to remember the participant in the synchronize
view should be presented to the user.
|
boolean |
isSaveNeeded()
Returns
true if there are unsaved changes in either left or
right side. |
boolean |
okPressed()
The
OK button was pressed in a dialog. |
protected void |
prepareInput(ICompareInput input,
CompareConfiguration configuration,
IProgressMonitor monitor)
Prepare the compare input for display in a content viewer.
|
protected Object |
prepareInput(IProgressMonitor monitor)
Runs the compare operation and returns the compare result.
|
void |
saveChanges(IProgressMonitor monitor)
Save any unsaved changes.
|
canRunAsJob, createStructureInputPane, prepareCompareInput, setPageDescriptionaddCompareInputChangeListener, addPropertyChangeListener, belongsTo, contentsCreated, contributeToToolBar, createContentViewerSwitchingPane, createDiffViewer, createOutlineContents, exists, findContentViewer, findStructureViewer, firePropertyChange, flushLeftViewers, flushRightViewers, flushViewers, getActionBars, getAdapter, getCompareConfiguration, getCompareResult, getContainer, getContentViewerDescriptor, getImageDescriptor, getMessage, getName, getNavigator, getPersistable, getSelectedEdition, getServiceLocator, getStructureViewerDescriptor, getTitle, getToolTipText, getWorkbenchPart, isDirty, isEditionSelectionDialog, isLeftSaveNeeded, isRightSaveNeeded, registerContextMenu, removeCompareInputChangeListener, removePropertyChangeListener, run, run, runAsynchronously, save, setContainer, setContentViewerDescriptor, setDirty, setFocus, setFocus2, setHelpContextId, setLeftDirty, setMessage, setRightDirty, setStatusMessage, setStructureViewerDescriptor, setTitlepublic ParticipantPageCompareEditorInput(CompareConfiguration configuration, ISynchronizePageConfiguration pageConfiguration, ISynchronizeParticipant participant)
For example, clients can decide if the user can edit the compare panes by calling CompareConfiguration.setLeftEditable(boolean)
or CompareConfiguration.setRightEditable(boolean).
configuration - the compare configuration that will be used to create the compare panespageConfiguration - the configuration that will be provided to the participant prior to creating the pageparticipant - the participant whose page will be displayed in this partprotected Object prepareInput(IProgressMonitor monitor) throws InvocationTargetException, InterruptedException
CompareEditorInputnull is returned no differences were found and no compare editor needs to be opened.
Progress should be reported to the given progress monitor.
A request to cancel the operation should be honored and acknowledged
by throwing InterruptedException.
Note: this method is typically called in a modal context thread which doesn't have a Display assigned. Implementors of this method shouldn't therefore allocated any SWT resources in this method.
prepareInput in class CompareEditorInputmonitor - the progress monitor to use to display progress and receive
requests for cancelationnull if there are no differencesInvocationTargetException - if the prepareInput method must propagate a checked exception,
it should wrap it inside an InvocationTargetException; runtime exceptions are automatically
wrapped in an InvocationTargetException by the calling contextInterruptedException - if the operation detects a request to cancel,
using IProgressMonitor.isCanceled(), it should exit by throwing
InterruptedExceptionpublic Image getTitleImage()
CompareEditorInputgetTitleImage in class CompareEditorInputnull if noneprotected void handleDispose()
CompareEditorInputCompareEditorInput.createContents(Composite).
Subclasses can extend this method but ensure that the overridden method
is invoked.handleDispose in class PageCompareEditorInputprotected IPage createPage(CompareViewerPane parent, IToolBarManager toolBarManager)
PageCompareEditorInputcreatePage in class PageCompareEditorInputparent - the parent compositetoolBarManager - the toolbar manager for the pageprotected ISelectionProvider getSelectionProvider()
PageCompareEditorInputgetSelectionProvider in class PageCompareEditorInputprotected ICompareInput asCompareInput(ISelection selection)
PageCompareEditorInputICompareInput.
Subclasses may override.asCompareInput in class PageCompareEditorInputselection - the selectionprotected void prepareInput(ICompareInput input, CompareConfiguration configuration, IProgressMonitor monitor) throws InvocationTargetException
PageCompareEditorInputPageCompareEditorInput.prepareCompareInput(ICompareInput) and may be called
from a non-UI thread. This method should not be called by others.prepareInput in class PageCompareEditorInputinput - the inputconfiguration - the compare configurationmonitor - a progress monitorInvocationTargetExceptionpublic boolean isSaveNeeded()
CompareEditorInputtrue if there are unsaved changes in either left or
right side. The value returned is the value of the
DIRTY_STATE property of this input object.
Returns true if left or right side has unsaved changes
Subclasses don't have to override if the functionality provided by
setDirty is sufficient.isSaveNeeded in class CompareEditorInputtrue if there are changes that need to be savedpublic void saveChanges(IProgressMonitor monitor) throws CoreException
CompareEditorInputISavable.save on them.saveChanges in class CompareEditorInputmonitor - an IProgressMonitor that the implementation of save may use to show progressCoreExceptionpublic void contentChanged(IContentChangeNotifier source)
IContentChangeListenercontentChanged in interface IContentChangeListenercontentChanged in class PageCompareEditorInputsource - the source whose contents has changedpublic ISynchronizePageConfiguration getPageConfiguration()
public ISynchronizeParticipant getParticipant()
public Control createContents(Composite parent)
CompareEditorInputSubclasses may override if they need to change the layout or wiring between panes.
createContents in class CompareEditorInputparent - the parent control under which the control must be createdprotected boolean isOfferToRememberParticipant()
true is
returned. Subclasses may override.public boolean okPressed()
CompareEditorInputOK button was pressed in a dialog. If one or both of
the sides of the input is editable then any changes will be saved. If the
input is for edition selection (see CompareEditorInput.isEditionSelectionDialog()),
it is up to subclasses to override this method in order to perform the
appropriate operation on the selected edition.okPressed in class CompareEditorInputpublic void cancelPressed()
CompareEditorInputCANCEL button was pressed in a dialog.
By default, nothing is done. Subclasses may override.cancelPressed in class CompareEditorInputpublic String getOKButtonLabel()
CompareEditorInputOK
button when this input is displayed in a dialog.
By default, different labels are used depending on
whether the input is editable or is for edition selection
(see CompareEditorInput.isEditionSelectionDialog().getOKButtonLabel in class CompareEditorInputOK
button when this input is displayed in a dialogpublic String getCancelButtonLabel()
CompareEditorInputCANCEL
button when this input is shown in a compare dialog
using CompareUI.openCompareDialog(CompareEditorInput).getCancelButtonLabel in class CompareEditorInputCANCEL button
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.