|
Eclipse Platform Release 3.7 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.swt.widgets.Widget
org.eclipse.swt.widgets.Control
org.eclipse.swt.widgets.Scrollable
org.eclipse.swt.widgets.Composite
org.eclipse.swt.custom.ViewForm
org.eclipse.compare.CompareViewerPane
org.eclipse.compare.CompareViewerSwitchingPane
public abstract class CompareViewerSwitchingPane
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.
| 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, drawBackground, getBackgroundMode, getChildren, getLayout, getLayoutDeferred, getTabList, isLayoutDeferred, layout, 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.Widget |
|---|
addDisposeListener, addListener, checkWidget, dispose, getData, getData, getDisplay, getListeners, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, reskin, setData, setData, toString |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public CompareViewerSwitchingPane(Composite parent,
int style)
CompareViewerSwitchingPane as a child of the given parent and with the
specified SWT style bits.
parent - a widget which will be the parent of the new instance (cannot be null)style - the style of widget to construct
IllegalArgumentException - SWTException -
public CompareViewerSwitchingPane(Composite parent,
int style,
boolean visibility)
CompareViewerSwitchingPane as a child of the given parent and with the
specified SWT style bits.
parent - a widget which will be the parent of the new instance (cannot be null)style - the style of widget to constructvisibility - the initial visibility of the CompareViewerSwitchingPane
IllegalArgumentException - SWTException - | Method Detail |
|---|
public Viewer getViewer()
public String getTitleArgument()
setTitelArgument or null if no optional title
argument has been set.
nullpublic boolean isEmpty()
true if no viewer is installed or if the current viewer
is a NullViewer.
true if no viewer is installed or if the current viewer is a NullViewerpublic ISelection getSelection()
ISelectionProvider
getSelection in interface ISelectionProvidergetSelection in class CompareViewerPanepublic void setSelection(ISelection s)
ISelectionProvider
setSelection in interface ISelectionProvidersetSelection in class CompareViewerPanes - the new selectionprotected boolean inputChanged(Object input)
input - the input
public void setInput(Object input)
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.
setInput in class CompareViewerPaneinput - the new input object or nullpublic void setTitleArgument(String argument)
argument - an optional argument for the pane's titlepublic Object getAdapter(Class adapter)
null if
no such object can be found.
getAdapter in interface IAdaptablegetAdapter in class CompareViewerPaneadapter - the adapter class to look up
null if this object does not
have an adapter for the given classIAdaptable.getAdapter(java.lang.Class)public boolean setFocus()
Control
setFocus in class Compositetrue if the control got focus, and false if it was unable to.Control.forceFocus()
protected abstract Viewer getViewer(Viewer oldViewer,
Object input)
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).
oldViewer - the currently installed viewer or nullinput - the input object for which a viewer must be determined or null
null if no viewer can be determined
|
Eclipse Platform Release 3.7 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2011. All rights reserved.