|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.viewers.Viewer
org.eclipse.jface.viewers.ContentViewer
org.eclipse.jface.viewers.StructuredViewer
org.eclipse.jface.viewers.ColumnViewer
org.eclipse.jface.viewers.AbstractTreeViewer
org.eclipse.jface.viewers.TreeViewer
org.eclipse.ui.navigator.CommonViewer
Provides the Tree Viewer for the Common Navigator. Content and labels are
provided by an instance of INavigatorContentService
which uses
the ID supplied in the constructor
CommonViewer(String, Composite, int)
or through
NavigatorContentServiceFactory.createContentService(String, org.eclipse.jface.viewers.StructuredViewer)
.
Clients may extend this class.
Note that as of 3.2.1 and 3.3, the common viewer caches its selection. Clients must not set the selection of the viewer's tree control directly.
Nested Class Summary |
---|
Nested classes inherited from class org.eclipse.jface.viewers.StructuredViewer |
---|
StructuredViewer.ColorAndFontCollector, StructuredViewer.ColorAndFontCollectorWithProviders |
Field Summary |
---|
Fields inherited from class org.eclipse.jface.viewers.AbstractTreeViewer |
---|
ALL_LEVELS |
Fields inherited from class org.eclipse.jface.viewers.Viewer |
---|
WIDGET_DATA_KEY |
Constructor Summary | |
---|---|
CommonViewer(String aViewerId,
Composite aParent,
int aStyle)
Constructs the Tree Viewer for the Common Navigator and the corresponding NavigatorContentService. |
Method Summary | |
---|---|
void |
add(Object parentElement,
Object[] childElements)
Adds the given child elements to this viewer as children of the given parent element. |
protected void |
createTreeItem(Widget parent,
Object element,
int index)
Creates a single item for the given parent and synchronizes it with the given element. |
void |
dispose()
Disposes of the NavigatorContentService, which will dispose the Content and Label providers. |
INavigatorContentService |
getNavigatorContentService()
The INavigatorContentService provides the hook into the framework
to provide content from the various extensions.
|
ISelection |
getSelection()
Returns the current selection. |
protected void |
handleDispose(DisposeEvent event)
Handles a dispose event on this viewer's control. |
protected void |
handleDoubleSelect(SelectionEvent event)
Handles a double-click select event from the widget. |
protected void |
handleLabelProviderChanged(LabelProviderChangedEvent event)
The StructuredViewer implementation of this
ContentViewer method calls update if the
event specifies that the label of a given element has changed, otherwise
it calls super. |
protected void |
handleOpen(SelectionEvent event)
Handles an open event from the OpenStrategy. |
protected void |
handlePostSelect(SelectionEvent e)
Handles a post select event from the widget. |
protected void |
handleSelect(SelectionEvent event)
Handles a select event from the widget. |
protected void |
init()
Initializes the content provider, label provider, and drag and drop support. |
protected void |
initDragAndDrop()
Adds DND support to the Navigator. |
protected void |
internalRefresh(Object element,
boolean updateLabels)
Refreshes this viewer starting at the given element. |
void |
refresh(Object element)
Refreshes this viewer starting with the given element. |
void |
refresh(Object element,
boolean updateLabels)
Refreshes this viewer starting with the given element. |
void |
remove(Object[] elements)
Removals are handled by refreshing the parents of each of the given elements. |
protected void |
removeWithoutRefresh(Object[] elements)
|
void |
setSelection(ISelection selection,
boolean reveal)
Sets a new selection for this viewer and optionally makes it visible. |
protected void |
setSelectionToWidget(List v,
boolean reveal)
This implementation of setSelectionToWidget accepts a list of elements or a list of tree paths. |
void |
setSorter(ViewerSorter sorter)
Sets this viewer's sorter and triggers refiltering and resorting of this viewer's element. |
String |
toString()
|
void |
update(Object element,
String[] properties)
Updates the given element's presentation when one or more of its properties changes. |
Methods inherited from class org.eclipse.jface.viewers.TreeViewer |
---|
addTreeListener, assertContentProviderType, createChildren, createViewerEditor, disassociate, doGetColumnCount, editElement, getChild, getChildren, getColumnViewerOwner, getControl, getExpanded, getItemAt, getItemCount, getItemCount, getItems, getLabelProvider, getParentElement, getParentItem, getRawChildren, getSelection, getTree, getViewerRowFromItem, handleTreeExpand, hookControl, internalAdd, internalInitializeTree, internalRefreshStruct, isExpandable, mapElement, newItem, remove, removeAll, replace, setChildCount, setContentProvider, setExpanded, setHasChildren, setSelection, showItem, updatePlus |
Methods inherited from class org.eclipse.jface.viewers.ColumnViewer |
---|
applyEditorValue, cancelEditing, getCellEditors, getCellModifier, getColumnProperties, getColumnViewerEditor, getItem, getLabelProvider, getViewerRow, hookEditingSupport, isCellEditorActive, setCellEditors, setCellModifier, setColumnProperties, setColumnViewerEditor, setLabelProvider, triggerEditorActivationEvent |
Methods inherited from class org.eclipse.jface.viewers.ContentViewer |
---|
getContentProvider, getInput |
Methods inherited from class org.eclipse.jface.viewers.Viewer |
---|
addHelpListener, addSelectionChangedListener, fireHelpRequested, fireSelectionChanged, getData, handleHelpRequest, removeHelpListener, removeSelectionChangedListener, setData, setSelection |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.eclipse.jface.viewers.ISelectionProvider |
---|
addSelectionChangedListener, removeSelectionChangedListener, setSelection |
Constructor Detail |
public CommonViewer(String aViewerId, Composite aParent, int aStyle)
Constructs the Tree Viewer for the Common Navigator and the corresponding NavigatorContentService. The NavigatorContentService will provide the Content Provider and Label Provider -- these need not be supplied by clients.
For the valid bits to supply in the style mask (aStyle), see
documentation provided by TreeViewer
.
aViewerId
- An id tied to the extensions that is used to focus specific
content to a particular instance of the Common NavigatoraParent
- A Composite parent to contain the actual SWT widgetaStyle
- A style mask that will be used to create the TreeViewer
Composite.Method Detail |
protected void init()
Initializes the content provider, label provider, and drag and drop support. Should not be called by clients -- this method is invoked when the constructor is invoked.
protected void removeWithoutRefresh(Object[] elements)
protected void initDragAndDrop()
Adds DND support to the Navigator. Uses hooks into the extensible framework for DND.
By default, the following Transfer types are supported:
CommonDragAdapter
,
CommonDropAdapter
protected void createTreeItem(Widget parent, Object element, int index)
AbstractTreeViewer
createTreeItem
in class AbstractTreeViewer
parent
- the parent widgetelement
- the elementindex
- if non-negative, indicates the position to insert the item
into its parentprotected void handleLabelProviderChanged(LabelProviderChangedEvent event)
StructuredViewer
StructuredViewer
implementation of this
ContentViewer
method calls update
if the
event specifies that the label of a given element has changed, otherwise
it calls super. Subclasses may reimplement or extend.
handleLabelProviderChanged
in class StructuredViewer
event
- the event that generated this updateprotected void handleDispose(DisposeEvent event)
ContentViewer
The ContentViewer
implementation of this method disposes of this
viewer's label provider and content provider (if it has one).
Subclasses should override this method to perform any additional
cleanup of resources; however, overriding methods must invoke
super.handleDispose
.
handleDispose
in class StructuredViewer
public void dispose()
Disposes of the NavigatorContentService, which will dispose the Content and Label providers.
public void setSorter(ViewerSorter sorter)
null
turns sorting off.
setSorter
in class StructuredViewer
sorter
- a viewer sorter, or null
if nonepublic INavigatorContentService getNavigatorContentService()
The INavigatorContentService
provides the hook into the framework
to provide content from the various extensions.
INavigatorContentService
that was created when the
viewer was created.public void add(Object parentElement, Object[] childElements)
AbstractTreeViewer
This method should be called (by the content provider) when elements have been added to the model, in order to cause the viewer to accurately reflect the model. This method only affects the viewer, not the model.
add
in class AbstractTreeViewer
parentElement
- the parent elementchildElements
- the child elements to addpublic void remove(Object[] elements)
Removals are handled by refreshing the parents of each of the given elements. The parents are determined via calls ot the contentProvider.
remove
in class AbstractTreeViewer
elements
- the elements to removeAbstractTreeViewer.remove(java.lang.Object[])
public void refresh(Object element, boolean updateLabels)
StructuredViewer
refresh(boolean updateLabels)
.
Unlike the update
methods, this handles structural changes
to the given element (e.g. addition or removal of children). If only the
given element needs updating, it is more efficient to use the
update
methods.
refresh
in class ColumnViewer
public void setSelection(ISelection selection, boolean reveal)
TreeViewer
Currently the reveal
parameter is not honored because
Tree
does not provide an API to only select an item without
scrolling it into view
setSelection
in class TreeViewer
selection
- the new selectionreveal
- true
if the selection is to be made visible,
and false
otherwiseprotected void setSelectionToWidget(List v, boolean reveal)
AbstractTreeViewer
setSelectionToWidget
in class AbstractTreeViewer
protected void handleDoubleSelect(SelectionEvent event)
StructuredViewer
This method is internal to the framework; subclassers should not call this method.
handleDoubleSelect
in class AbstractTreeViewer
protected void handleOpen(SelectionEvent event)
StructuredViewer
This method is internal to the framework; subclassers should not call this method.
handleOpen
in class StructuredViewer
event
- the SWT selection eventprotected void handlePostSelect(SelectionEvent e)
StructuredViewer
This method is internal to the framework; subclassers should not call this method.
handlePostSelect
in class StructuredViewer
e
- the SWT selection eventprotected void handleSelect(SelectionEvent event)
StructuredViewer
This method is internal to the framework; subclassers should not call this method.
handleSelect
in class StructuredViewer
event
- the SWT selection eventpublic ISelection getSelection()
Note that as of 3.2.1 and 3.3, the common viewer caches its selection. Clients must not set the selection of the viewer's tree control directly.
getSelection
in interface ISelectionProvider
getSelection
in class AbstractTreeViewer
AbstractTreeViewer.getSelection()
public void refresh(Object element)
StructuredViewer
Unlike the update
methods, this handles structural changes
to the given element (e.g. addition or removal of children). If only the
given element needs updating, it is more efficient to use the
update
methods.
refresh
in class ColumnViewer
public void update(Object element, String[] properties)
StructuredViewer
This does not handle structural changes (e.g. addition or removal of
elements), and does not update any other related elements (e.g. child
elements). To handle structural changes, use the refresh
methods instead.
This should be called when an element has changed in the model, in order to have the viewer accurately reflect the model. This method only affects the viewer, not the model.
Specifying which properties are affected may allow the viewer to optimize
the update. For example, if the label provider is not affected by changes
to any of these properties, an update may not actually be required.
Specifying properties
as null
forces a full
update of the element.
If the viewer has a sorter which is affected by a change to one of the
properties, the element's position is updated to maintain the sort order.
Note that resorting does not happen if properties
is
null
.
If the viewer has a filter which is affected by a change to one of the properties, the element may appear or disappear if the change affects whether or not the element is filtered out.
update
in class ColumnViewer
public String toString()
protected void internalRefresh(Object element, boolean updateLabels)
StructuredViewer
refresh(boolean updateLabels)
.
The default implementation simply calls
internalRefresh(element)
, ignoring
updateLabels
.
If this method is overridden to do the actual refresh, then
internalRefresh(Object element)
should simply call
internalRefresh(element, true)
.
internalRefresh
in class AbstractTreeViewer
|
Eclipse Platform Release 3.3 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.