Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.team.ui
Class PageCompareEditorInput

java.lang.Object
  extended by 

org.eclipse.compare.CompareEditorInput
      extended by 
org.eclipse.team.ui.PageCompareEditorInput
All Implemented Interfaces:
ICompareContainer, IContentChangeListener, IPropertyChangeNotifier, IAdaptable, IRunnableContext, IRunnableWithProgress, IEditorInput
Direct Known Subclasses:
HistoryPageCompareEditorInput, ParticipantPageCompareEditorInput

public abstract class PageCompareEditorInput
extends CompareEditorInput
implements IContentChangeListener

Abstract class for hosting a page based structure input view for the purposes of feeding compare viewers.

This class is not intended to be subclassed by clients outside of the Team framework.

Since:
3.3

Field Summary
 
Fields inherited from class org.eclipse.compare. CompareEditorInput
DIRTY_STATE, PROP_SELECTED_EDITION, PROP_TITLE, PROP_TITLE_IMAGE
 
Constructor Summary
protected PageCompareEditorInput ( CompareConfiguration configuration)
          Create a page compare editor input.
 
Method Summary
protected   ICompareInput asCompareInput ( ISelection selection)
          Return a compare input that represents the selection.
 boolean canRunAsJob ()
          Return whether this compare editor input can be run as a job.
 void contentChanged ( IContentChangeNotifier source)
          Called whenever the content of the given source has changed.
protected abstract   IPage createPage ( CompareViewerPane parent, IToolBarManager toolBarManager)
          Create the page for this part and return the top level control for the page.
protected   CompareViewerPane createStructureInputPane ( Composite parent)
          Create the pane that will contain the structure input pane (upper left).
protected abstract   ISelectionProvider getSelectionProvider ()
          Return the selection provider for the page.
protected  void handleDispose ()
          Callback that occurs when the UI associated with this compare editor input is disposed.
protected  void prepareCompareInput ( ICompareInput input)
          Convenience method that calls prepareInput(ICompareInput, CompareConfiguration, IProgressMonitor) with a progress monitor.
protected abstract  void prepareInput ( ICompareInput input, CompareConfiguration configuration, IProgressMonitor monitor)
          Prepare the compare input for display in a content viewer.
protected  void setPageDescription ( String title)
          Set the title of the page's page to the given text.
 
Methods inherited from class org.eclipse.compare. CompareEditorInput
addCompareInputChangeListener, addPropertyChangeListener, belongsTo, cancelPressed, contentsCreated, contributeToToolBar, createContents, createDiffViewer, createOutlineContents, dispose, exists, findContentViewer, findStructureViewer, firePropertyChange, flushViewers, getActionBars, getAdapter, getCancelButtonLabel, getCompareConfiguration, getCompareResult, getContainer, getContentViewerDescriptor, getImageDescriptor, getMessage, getName, getNavigator, getOKButtonLabel, getPersistable, getSelectedEdition, getServiceLocator, getStructureViewerDescriptor, getTitle, getTitleImage, getToolTipText, getWorkbenchPart, isDirty, isEditionSelectionDialog, isSaveNeeded, okPressed, prepareInput, registerContextMenu, removeCompareInputChangeListener, removePropertyChangeListener, run, run, runAsynchronously, save, saveChanges, setContainer, setContentViewerDescriptor, setDirty, setFocus, setFocus2, setHelpContextId, setMessage, setStatusMessage, setStructureViewerDescriptor, setTitle
 
Methods inherited from class java.lang. Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PageCompareEditorInput

protected PageCompareEditorInput(
CompareConfiguration configuration)
Create a page compare editor input.

Parameters:
configuration - the compare configuration
Method Detail

createStructureInputPane

protected 
CompareViewerPane createStructureInputPane(
Composite parent)
Description copied from class: CompareEditorInput
Create the pane that will contain the structure input pane (upper left). By default, a CompareViewerSwitchingPane is returned. Subclasses may override to provide an alternate pane.

Overrides:
createStructureInputPane in class CompareEditorInput
Parameters:
parent - the parent composite
Returns:
the structure input pane

createPage

protected abstract 
IPage createPage(
CompareViewerPane parent,
                                    
IToolBarManager toolBarManager)
Create the page for this part and return the top level control for the page.

Parameters:
parent - the parent composite
toolBarManager - the toolbar manager for the page
Returns:
the top-level control for the page

getSelectionProvider

protected abstract 
ISelectionProvider getSelectionProvider()
Return the selection provider for the page. This method is called after the page is created in order to register a selection listener on the page.

Returns:
the selection provider for the page

setPageDescription

protected void setPageDescription(
String title)
Set the title of the page's page to the given text. The title will appear in the header of the pane containing the page.

Parameters:
title - the page's title

handleDispose

protected void handleDispose()
Description copied from class: CompareEditorInput
Callback that occurs when the UI associated with this compare editor input is disposed. This method will only be invoked if the UI has been created (i.e. after the call to CompareEditorInput.createContents(Composite). Subclasses can extend this method but ensure that the overridden method is invoked.

Overrides:
handleDispose in class CompareEditorInput

asCompareInput

protected 
ICompareInput asCompareInput(
ISelection selection)
Return a compare input that represents the selection. This input is used to feed the structure and content viewers. By default, a compare input is returned if the selection is of size 1 and the selected element implements ICompareInput. Subclasses may override.

Parameters:
selection - the selection
Returns:
a compare input representing the selection

prepareCompareInput

protected final void prepareCompareInput(
ICompareInput input)
Convenience method that calls prepareInput(ICompareInput, CompareConfiguration, IProgressMonitor) with a progress monitor.

Parameters:
input - the compare input to be prepared

contentChanged

public void contentChanged(
IContentChangeNotifier source)
Description copied from interface: IContentChangeListener
Called whenever the content of the given source has changed.

Specified by:
contentChanged in interface IContentChangeListener
Parameters:
source - the source whose contents has changed

canRunAsJob

public boolean canRunAsJob()
Description copied from class: CompareEditorInput
Return whether this compare editor input can be run as a job. By default, false is returned since traditionally inputs were prepared in the foreground (i.e the UI was blocked when the CompareEditorInput.run(IProgressMonitor) method (and indirectly the CompareEditorInput.prepareInput(IProgressMonitor) method) was invoked. Subclasses may override.

Overrides:
canRunAsJob in class CompareEditorInput
Returns:
whether this compare editor input can be run in the background

prepareInput

protected abstract void prepareInput(
ICompareInput input,
                                     
CompareConfiguration configuration,
                                     
IProgressMonitor monitor)
                              throws 
InvocationTargetException
Prepare the compare input for display in a content viewer. This method is called from prepareCompareInput(ICompareInput) and may be called from a non-UI thread. This method should not be called by others.

Parameters:
input - the input
configuration - the compare configuration
monitor - a progress monitor
Throws:
InvocationTargetException

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire