public class CommonViewer extends TreeViewer
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.
StructuredViewer.ColorAndFontCollector, StructuredViewer.ColorAndFontCollectorWithProvidersALL_LEVELSWIDGET_DATA_KEY| Constructor and Description |
|---|
CommonViewer(String aViewerId,
Composite aParent,
int aStyle)
Constructs the Tree Viewer for the Common Navigator and the corresponding
NavigatorContentService.
|
| Modifier and Type | Method and Description |
|---|---|
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
INavigatorContentServiceprovides 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.
|
addTreeListener, assertContentProviderType, buildLabel, cancelEditing, createChildren, doUpdateItem, editElement, getCellEditors, getCellModifier, getChild, getChildren, getColumnProperties, getControl, getExpanded, getItem, getItemCount, getItemCount, getItems, getLabelProvider, getParentElement, getParentItem, getRawChildren, getSelection, getTree, hookControl, internalAdd, internalRefreshStruct, isCellEditorActive, isExpandable, isSameSelection, mapElement, newItem, removeAll, replace, setCellEditors, setCellModifier, setChildCount, setColumnProperties, setExpanded, setLabelProvider, setSelection, showItemadd, addSelectionListener, addTreeListener, associate, collapseAll, collapseToLevel, disassociate, doFindInputItem, doFindItem, doUpdateItem, expandAll, expandToLevel, expandToLevel, fireTreeCollapsed, fireTreeExpanded, getAutoExpandLevel, getExpandedElements, getExpandedState, getExpandedTreePaths, getFilteredChildren, getNextItem, getPreviousItem, getSelectionFromWidget, getSortedChildren, getTreePathFromItem, getVisibleExpandedElements, handleTreeCollapse, handleTreeExpand, indexForElement, inputChanged, insert, internalCollapseToLevel, internalExpand, internalExpandToLevel, internalGetWidgetToSelect, internalRefresh, internalRefresh, internalRemove, internalRemove, labelProviderChanged, remove, remove, removeTreeListener, reveal, scrollDown, scrollUp, setAutoExpandLevel, setContentProvider, setExpandedElements, setExpandedState, setExpandedTreePaths, setSelectionToWidget, updateChildren, updatePlusaddDoubleClickListener, addDragSupport, addDropSupport, addFilter, addOpenListener, addPostSelectionChangedListener, assertElementsNotNull, equals, filter, findItem, findItems, fireDoubleClick, fireOpen, firePostSelectionChanged, getColorAndFontCollector, getComparator, getComparer, getFilters, getRoot, getSorter, handleInvalidSelection, hasFilters, internalUpdate, needsRefilter, preservingSelection, refresh, refresh, refreshItem, removeDoubleClickListener, removeFilter, removeOpenListener, removePostSelectionChangedListener, resetFilters, setComparator, setComparer, setInput, setUseHashlookup, testFindItem, testFindItems, unmapAllElements, unmapElement, unmapElement, update, updateItem, updateSelection, usingElementMapgetContentProvider, getInputaddHelpListener, addSelectionChangedListener, fireHelpRequested, fireSelectionChanged, getData, handleHelpRequest, removeHelpListener, removeSelectionChangedListener, setData, setSelectionclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitaddSelectionChangedListener, removeSelectionChangedListener, setSelectionpublic 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.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,
CommonDropAdapterprotected void createTreeItem(Widget parent, Object element, int index)
AbstractTreeViewercreateTreeItem in class AbstractTreeViewerparent - the parent widgetelement - the elementindex - if non-negative, indicates the position to insert the item
into its parentprotected void handleLabelProviderChanged(LabelProviderChangedEvent event)
StructuredViewerStructuredViewer 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 StructuredViewerevent - 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 ContentViewerevent - a dispose eventpublic 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 StructuredViewersorter - a viewer sorter, or null if nonepublic INavigatorContentService getNavigatorContentService()
The INavigatorContentServiceprovides the hook into the framework
to provide content from the various extensions.
INavigatorContentServicethat was created when the
viewer was created.public void add(Object parentElement, Object[] childElements)
AbstractTreeViewerThis 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 AbstractTreeViewerparentElement - 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 AbstractTreeViewerelements - the elements to removeAbstractTreeViewer.remove(java.lang.Object[])public void refresh(Object element, boolean updateLabels)
StructuredViewerrefresh(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 StructuredViewerelement - the elementupdateLabels - true to update labels for existing elements,
false to only update labels as needed, assuming
that labels for existing elements are unchanged.public void setSelection(ISelection selection, boolean reveal)
ViewerSubclasses must implement this method.
setSelection in class StructuredViewerselection - the new selectionreveal - true if the selection is to be made
visible, and false otherwiseprotected void setSelectionToWidget(List v, boolean reveal)
AbstractTreeViewersetSelectionToWidget in class AbstractTreeViewerv - list of selected elements (element type: Object)
or null if the selection is to be clearedreveal - true if the selection is to be made visible,
and false otherwiseprotected void handleDoubleSelect(SelectionEvent event)
StructuredViewerThis method is internal to the framework; subclassers should not call this method.
handleDoubleSelect in class AbstractTreeViewerevent - the SWT selection eventprotected void handleOpen(SelectionEvent event)
StructuredViewerThis method is internal to the framework; subclassers should not call this method.
handleOpen in class StructuredViewerevent - the SWT selection eventprotected void handlePostSelect(SelectionEvent e)
StructuredViewerThis method is internal to the framework; subclassers should not call this method.
handlePostSelect in class StructuredViewere - the SWT selection eventprotected void handleSelect(SelectionEvent event)
StructuredViewerThis method is internal to the framework; subclassers should not call this method.
handleSelect in class StructuredViewerevent - 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 ISelectionProvidergetSelection in class AbstractTreeViewerAbstractTreeViewer.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 StructuredViewerelement - the elementpublic 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.
Specifing 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.
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 StructuredViewerelement - the elementproperties - the properties that have changed, or null to
indicate unknownprotected void internalRefresh(Object element, boolean updateLabels)
StructuredViewerrefresh(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 AbstractTreeViewerelement - the elementupdateLabels - true to update labels for existing elements,
false to only update labels as needed, assuming
that labels for existing elements are unchanged.Guidelines for using Eclipse APIs. Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.