|
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.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
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, marginHeight, marginWidth |
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 | |
void |
addDoubleClickListener(IDoubleClickListener l)
|
void |
addOpenListener(IOpenListener l)
|
void |
addSelectionChangedListener(ISelectionChangedListener l)
Adds a listener for selection changes in this selection provider. |
void |
doubleClick(DoubleClickEvent event)
Notifies of a double click. |
Object |
getInput()
Returns the current input of this pane or null if the pane has no input. |
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. |
boolean |
isEmpty()
Returns true if no viewer is installed or if the current viewer
is a NullViewer . |
void |
removeDoubleClickListener(IDoubleClickListener l)
|
void |
removeOpenListener(IOpenListener l)
|
void |
removeSelectionChangedListener(ISelectionChangedListener l)
Removes the given selection change listener from this selection provider. |
void |
selectionChanged(SelectionChangedEvent ev)
Notifies that the selection has changed. |
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 |
clearToolBar, getToolBarManager, setImage, setText |
Methods inherited from class org.eclipse.swt.custom.ViewForm |
computeSize, computeTrim, getClientArea, getContent, getTopCenter, getTopLeft, getTopRight, layout, setBorderVisible, setContent, setFont, setLayout, setTopCenter, setTopCenterSeparate, setTopLeft, setTopRight |
Methods inherited from class org.eclipse.swt.widgets.Composite |
checkSubclass, getChildren, getLayout, getTabList, layout, setFocus, 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, getStyle, 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 |
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.
Note: this method is for internal use only. Clients should not call this method.
null
public 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 NullViewer
public void addSelectionChangedListener(ISelectionChangedListener l)
ISelectionProvider
addSelectionChangedListener
in interface ISelectionProvider
l
- a selection changed listenerpublic void removeSelectionChangedListener(ISelectionChangedListener l)
ISelectionProvider
removeSelectionChangedListener
in interface ISelectionProvider
l
- a selection changed listenerpublic void addDoubleClickListener(IDoubleClickListener l)
public void removeDoubleClickListener(IDoubleClickListener l)
public void addOpenListener(IOpenListener l)
public void removeOpenListener(IOpenListener l)
public void doubleClick(DoubleClickEvent event)
IDoubleClickListener
doubleClick
in interface IDoubleClickListener
event
- event object describing the double-clickpublic ISelection getSelection()
ISelectionProvider
getSelection
in interface ISelectionProvider
public void setSelection(ISelection s)
ISelectionProvider
setSelection
in interface ISelectionProvider
s
- the new selectionpublic void selectionChanged(SelectionChangedEvent ev)
ISelectionChangedListener
selectionChanged
in interface ISelectionChangedListener
ev
- event object describing the changepublic 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.
input
- the new input object or null
public void setTitleArgument(String argument)
argument
- an optional argument for the pane's titlepublic Object getInput()
Object
that is the input to this pane or null if the pane has no input.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 null
input
- the input object for which a viewer must be determined or null
null
if no viewer can be determined
|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |