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.compare
Class CompareViewerSwitchingPane

java.lang.Object
  extended by 

org.eclipse.swt.widgets.Widget
      extended by 

org.eclipse.swt.widgets.Control
          extended by 

org.eclipse.swt.widgets.Scrollable
              extended by 

org.eclipse.swt.widgets.Composite
                  extended by 

org.eclipse.swt.custom.ViewForm
                      extended by 

org.eclipse.compare.CompareViewerPane
                          extended by 
org.eclipse.compare.CompareViewerSwitchingPane
All Implemented Interfaces:
IAdaptable, IDoubleClickListener, IOpenListener, ISelectionChangedListener, ISelectionProvider, Drawable

public abstract class CompareViewerSwitchingPane
extends CompareViewerPane

A custom CompareViewerPane that supports dynamic viewer switching.

Clients must implement the viewer switching strategy by implementing the getViewer(Viewer, Object) method.

If a property with the name CompareUI.COMPARE_VIEWER_TITLE is set on the top level SWT control of a viewer, it is used as a title in the CompareViewerPane's title bar.

Since:
2.0

Field Summary
 
Fields inherited from class org.eclipse.swt.custom. ViewForm
borderInsideRGB, borderMiddleRGB, borderOutsideRGB, horizontalSpacing, marginHeight, marginWidth, verticalSpacing
 
Fields inherited from class org.eclipse.swt.widgets. Control
handle
 
Constructor Summary
CompareViewerSwitchingPane ( Composite parent, int style)
          Creates a CompareViewerSwitchingPane as a child of the given parent and with the specified SWT style bits.
CompareViewerSwitchingPane ( Composite parent, int style, boolean visibility)
          Creates a CompareViewerSwitchingPane as a child of the given parent and with the specified SWT style bits.
 
Method Summary
  Object getAdapter ( Class adapter)
          Returns an object which is an instance of the given class associated with this object.
  ISelection getSelection ()
          Returns the current selection for this provider.
  String getTitleArgument ()
          Returns the optional title argument that has been set with setTitelArgument or null if no optional title argument has been set.
  Viewer getViewer ()
          Returns the current viewer.
protected abstract   Viewer getViewer ( Viewer oldViewer, Object input)
          Returns a viewer which is able to display the given input.
protected  boolean inputChanged ( Object input)
           
 boolean isEmpty ()
          Returns true if no viewer is installed or if the current viewer is a NullViewer.
 boolean setFocus ()
          Causes the receiver to have the keyboard focus, such that all keyboard events will be delivered to it.
 void setInput ( Object input)
          Sets the input object of this pane.
 void setSelection ( ISelection s)
          Sets the current selection for this selection provider.
 void setTitleArgument ( String argument)
          Sets an additional and optional argument for the pane's title.
 
Methods inherited from class org.eclipse.compare. CompareViewerPane
addDoubleClickListener, addOpenListener, addSelectionChangedListener, clearToolBar, createTopLeft, doubleClick, getInput, getToolBarManager, open, removeDoubleClickListener, removeOpenListener, removeSelectionChangedListener, selectionChanged, setImage, setText
 
Methods inherited from class org.eclipse.swt.custom. ViewForm
computeTrim, getClientArea, getContent, getTopCenter, getTopLeft, getTopRight, setBorderVisible, setContent, setLayout, setTopCenter, setTopCenterSeparate, setTopLeft, setTopRight
 
Methods inherited from class org.eclipse.swt.widgets. Composite
changed, checkSubclass, computeSize, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, layout, layout, layout, setBackgroundMode, setLayoutDeferred, setTabList
 
Methods inherited from class org.eclipse.swt.widgets. Scrollable
getHorizontalBar, getVerticalBar
 
Methods inherited from class org.eclipse.swt.widgets. Control
addControlListener, addDragDetectListener, addFocusListener, addHelpListener, addKeyListener, addMenuDetectListener, addMouseListener, addMouseMoveListener, addMouseTrackListener, addMouseWheelListener, addPaintListener, addTraverseListener, computeSize, dragDetect, dragDetect, forceFocus, getAccessible, getBackground, getBackgroundImage, getBorderWidth, getBounds, getCursor, getDragDetect, getEnabled, getFont, getForeground, getLayoutData, getLocation, getMenu, getMonitor, getParent, getRegion, getShell, getSize, getToolTipText, getVisible, internal_dispose_GC, internal_new_GC, isEnabled, isFocusControl, isReparentable, isVisible, moveAbove, moveBelow, pack, pack, print, redraw, redraw, removeControlListener, removeDragDetectListener, removeFocusListener, removeHelpListener, removeKeyListener, removeMenuDetectListener, removeMouseListener, removeMouseMoveListener, removeMouseTrackListener, removeMouseWheelListener, removePaintListener, removeTraverseListener, setBackground, setBackgroundImage, setBounds, setBounds, setCapture, setCursor, setDragDetect, setEnabled, setFont, setForeground, setLayoutData, setLocation, setLocation, setMenu, setParent, setRedraw, setRegion, setSize, setSize, setToolTipText, setVisible, toControl, toControl, toDisplay, toDisplay, traverse, update
 
Methods inherited from class org.eclipse.swt.widgets. Widget
addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, setData, setData, toString
 
Methods inherited from class java.lang. Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CompareViewerSwitchingPane

public CompareViewerSwitchingPane(
Composite parent,
                                  int style)
Creates a CompareViewerSwitchingPane as a child of the given parent and with the specified SWT style bits.

Parameters:
parent - a widget which will be the parent of the new instance (cannot be null)
style - the style of widget to construct
Throws:
IllegalArgumentException -
  • ERROR_NULL_ARGUMENT - if the parent is null
SWTException -
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent

CompareViewerSwitchingPane

public CompareViewerSwitchingPane(
Composite parent,
                                  int style,
                                  boolean visibility)
Creates a CompareViewerSwitchingPane as a child of the given parent and with the specified SWT style bits.

Parameters:
parent - a widget which will be the parent of the new instance (cannot be null)
style - the style of widget to construct
visibility - the initial visibility of the CompareViewerSwitchingPane
Throws:
IllegalArgumentException -
  • ERROR_NULL_ARGUMENT - if the parent is null
SWTException -
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
Method Detail

getViewer

public 
Viewer getViewer()
Returns the current viewer.

Returns:
the current viewer

getTitleArgument

public 
String getTitleArgument()
Returns the optional title argument that has been set with setTitelArgument or null if no optional title argument has been set.

Returns:
the optional title argument or null
Restriction:
This method is for internal use only. Clients should not call this method.
Restriction:
This method is not intended to be re-implemented or extended by clients.

isEmpty

public boolean isEmpty()
Returns true if no viewer is installed or if the current viewer is a NullViewer.

Returns:
true if no viewer is installed or if the current viewer is a NullViewer

getSelection

public 
ISelection getSelection()
Description copied from interface: ISelectionProvider
Returns the current selection for this provider.

Specified by:
getSelection in interface ISelectionProvider
Overrides:
getSelection in class CompareViewerPane
Returns:
the current selection

setSelection

public void setSelection(
ISelection s)
Description copied from interface: ISelectionProvider
Sets the current selection for this selection provider.

Specified by:
setSelection in interface ISelectionProvider
Overrides:
setSelection in class CompareViewerPane
Parameters:
s - the new selection

inputChanged

protected boolean inputChanged(
Object input)
Parameters:
input - the input
Returns:
true, if the input is considered as changed
Restriction:
This method is not intended to be referenced by clients.
Restriction:
This method is not intended to be re-implemented or extended by clients.

setInput

public void setInput(
Object input)
Sets the input object of this pane. For this input object a suitable viewer is determined by calling the abstract method getViewer(Viewer, Object). If the returned viewer differs from the current one, the old viewer is disposed and the new one installed. Then the input object is fed into the newly installed viewer by calling its setInput(Object) method. If new and old viewer don't differ no new viewer is installed but just setInput(Object) is called. If the input is null the pane is cleared, that is the current viewer is disposed.

Overrides:
setInput in class CompareViewerPane
Parameters:
input - the new input object or null

setTitleArgument

public void setTitleArgument(
String argument)
Sets an additional and optional argument for the pane's title.

Parameters:
argument - an optional argument for the pane's title
Restriction:
This method is for internal use only. Clients should not call this method.
Restriction:
This method is not intended to be re-implemented or extended by clients.

getAdapter

public 
Object getAdapter(
Class adapter)
Returns an object which is an instance of the given class associated with this object. Returns null if no such object can be found.

Specified by:
getAdapter in interface IAdaptable
Overrides:
getAdapter in class CompareViewerPane
Parameters:
adapter - the adapter class to look up
Returns:
a object castable to the given class, or null if this object does not have an adapter for the given class
Since:
3.3
See Also:
IAdaptable.getAdapter(java.lang.Class)

setFocus

public boolean setFocus()
Description copied from class: Control
Causes the receiver to have the keyboard focus, such that all keyboard events will be delivered to it. Focus reassignment will respect applicable platform constraints.

Overrides:
setFocus in class Composite
Returns:
true if the control got focus, and false if it was unable to.
See Also:
Control.forceFocus()

getViewer

protected abstract 
Viewer getViewer(
Viewer oldViewer,
                                    
Object input)
Returns a viewer which is able to display the given input. If no viewer can be found, null is returned. The additional argument oldViewer represents the viewer currently installed in the pane (or null if no viewer is installed). It can be returned from this method if the current viewer can deal with the input (and no new viewer must be created).

Parameters:
oldViewer - the currently installed viewer or null
input - the input object for which a viewer must be determined or null
Returns:
a viewer for the given input, or null if no viewer can be determined

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