com.ibm.xtools.common.ui.navigator.viewers

Class NavigatorTreeViewer

java.lang.Object

org.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

com.ibm.xtools.common.ui.navigator.viewers.NavigatorTreeViewer

All Implemented Interfaces:

org.eclipse.jface.viewers.IInputProvider, org.eclipse.jface.viewers.IInputSelectionProvider, org.eclipse.jface.viewers.IPostSelectionProvider, org.eclipse.jface.viewers.ISelectionProvider, org.eclipse.ui.navigator.INavigatorContentServiceListener

public class NavigatorTreeViewer
extends org.eclipse.ui.navigator.CommonViewer
implements org.eclipse.ui.navigator.INavigatorContentServiceListener

A tree viewer implementation that uses the INavigatorContentService to provide content and labels.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jface.viewers.StructuredViewer

org.eclipse.jface.viewers.StructuredViewer.ColorAndFontCollector, org.eclipse.jface.viewers.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

Constructors

Constructor and Description
NavigatorTreeViewer(org.eclipse.swt.widgets.Composite aParent, int aStyle) Constructs the Tree Viewer for the Common Navigator and the corresponding NavigatorContentService.

Method Summary

Modifier and Type	Method and Description
boolean	delayedRefresh()
java.lang.Object	getContextObject() Returns the context object
protected void	init() Initializes the content provider, label provider, and drag and drop support.
boolean	isClosedResourceExpandSupported()
void	onLoad(org.eclipse.ui.navigator.INavigatorContentExtension aDescriptorInstance) Sets the context object for IContextProvider when they are activated.
void	setClosedResourceExpandSupported(boolean b) Set the flag Indicating if the expand gesture on closed resources is supported for the specified viewer
void	setContextObject(java.lang.Object object) Caches the content object.
void	setDelayedRefresh(boolean b)

Methods inherited from class org.eclipse.ui.navigator.CommonViewer

add, createDragAdapter, createDropAdapter, createFrameList, dispose, doUpdateItem, getCommonNavigator, getFrameList, getMapper, getNavigatorContentService, getSelection, handleDispose, handleDoubleSelect, handleLabelProviderChanged, handleOpen, handlePostSelect, handleSelect, hookControl, initDragAndDrop, internalRefresh, mapElement, refresh, refresh, remove, removeWithoutRefresh, setMapper, setSelection, setSelectionToWidget, setSorter, toString, unmapAllElements, unmapElement, update

Methods inherited from class org.eclipse.jface.viewers.TreeViewer

addTreeListener, assertContentProviderType, createViewerEditor, disassociate, doGetColumnCount, editElement, getChild, getChildren, getColumnViewerOwner, getControl, getExpanded, getItemAt, getItemCount, getItemCount, getItems, getLabelProvider, getParentElement, getParentItem, getRawChildren, getSelection, getTree, getViewerRowFromItem, handleTreeCollapse, handleTreeExpand, internalAdd, internalInitializeTree, internalRefreshStruct, isExpandable, newItem, remove, removeAll, replace, setChildCount, setContentProvider, setExpanded, setHasChildren, setSelection, showItem, updatePlus

Methods inherited from class org.eclipse.jface.viewers.AbstractTreeViewer

add, addSelectionListener, addTreeListener, associate, buildLabel, collapseAll, collapseToLevel, createChildren, createTreeItem, doFindInputItem, doFindItem, doUpdateItem, doUpdateItem, expandAll, expandToLevel, expandToLevel, fireTreeCollapsed, fireTreeExpanded, getAutoExpandLevel, getChildren, getExpandedElements, getExpandedState, getExpandedTreePaths, getNextItem, getPreviousItem, getSelectionFromWidget, getSortedChildren, getStructuredSelection, getTreePathFromItem, getVisibleExpandedElements, indexForElement, inputChanged, insert, internalCollapseToLevel, internalExpand, internalExpandToLevel, internalFindItems, internalGetWidgetToSelect, internalIsInputOrEmptyPath, internalRefresh, internalRefresh, internalRemove, internalRemove, isSameSelection, labelProviderChanged, remove, remove, removeTreeListener, reveal, scrollDown, scrollUp, setAutoExpandLevel, setExpandedElements, setExpandedState, setExpandedTreePaths, setExpandPreCheckFilters, setSelectionToWidget, updateChildren

Methods inherited from class org.eclipse.jface.viewers.ColumnViewer

applyEditorValue, cancelEditing, checkBusy, getCell, getCellEditors, getCellModifier, getColumnProperties, getColumnViewerEditor, getItem, getLabelProvider, getViewerRow, hookEditingSupport, isBusy, isCellEditorActive, setBusy, setCellEditors, setCellModifier, setColumnProperties, setColumnViewerEditor, setLabelProvider, triggerEditorActivationEvent

Methods inherited from class org.eclipse.jface.viewers.StructuredViewer

addDoubleClickListener, addDragSupport, addDropSupport, addFilter, addOpenListener, addPostSelectionChangedListener, assertElementsNotNull, equals, filter, findItem, findItems, fireDoubleClick, fireOpen, firePostSelectionChanged, getColorAndFontCollector, getComparator, getComparer, getFilteredChildren, getFilters, getRoot, getSorter, handleInvalidSelection, hasFilters, internalUpdate, needsRefilter, preservingSelection, refresh, refresh, refreshItem, removeDoubleClickListener, removeFilter, removeOpenListener, removePostSelectionChangedListener, resetFilters, setComparator, setComparer, setFilters, setInput, setUseHashlookup, testFindItem, testFindItems, unmapElement, update, updateItem, updateSelection, usingElementMap

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

NavigatorTreeViewer

public NavigatorTreeViewer(org.eclipse.swt.widgets.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.

Parameters:

aParent - A Composite parent to contain the actual SWT widget

aStyle - A style mask that will be used to create the TreeViewer Composite.

Method Detail

init

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.

Overrides:

init in class org.eclipse.ui.navigator.CommonViewer

setContextObject

public void setContextObject(java.lang.Object object)

Caches the content object.

Parameters:

object -

getContextObject

public java.lang.Object getContextObject()

Returns the context object

onLoad

public void onLoad(org.eclipse.ui.navigator.INavigatorContentExtension aDescriptorInstance)

Sets the context object for IContextProvider when they are activated.

Specified by:

onLoad in interface org.eclipse.ui.navigator.INavigatorContentServiceListener

isClosedResourceExpandSupported

public boolean isClosedResourceExpandSupported()

Returns:

Indicator if the expand gesture on closed resources is supported for the specified viewer

setClosedResourceExpandSupported

public void setClosedResourceExpandSupported(boolean b)

Set the flag Indicating if the expand gesture on closed resources is supported for the specified viewer

delayedRefresh

public boolean delayedRefresh()

setDelayedRefresh

public void setDelayedRefresh(boolean b)