- Type Parameters:
E- type of the values that are provided by this object
ITreeContentProviderfor use with an
AbstractTreeViewer, which uses the provided
set factoryto obtain the elements of a tree. Objects of this class listen for changes to each
IObservableSetcreated by the factory, and will insert and remove viewer elements to reflect the observed changes.
- This class is not intended to be subclassed by clients.
Method SummaryModifier and TypeMethodDescription
dispose()Disposes of this content provider.
ObjectReturns the child elements of the given parent element.
ObjectReturns the elements to display in the viewer when its input is set to the given element.Returns the set of elements known to this content provider.Returns the parent for the given element, or
nullindicating that the parent can't be computed.Returns the set of known elements which have been realized in the viewer.
booleanReturns whether the given element has children.
voidNotifies this content provider that the given viewer's input has been switched to a different element.
(IObservableFactory<? super E, ? extends IObservableSet<E>> setFactory, TreeStructureAdvisor<E> structureAdvisor)Constructs an ObservableListTreeContentProvider using the given list factory. Must be called from the display thread.
setFactory- observable factory that produces an IObservableSet of children for a given parent element. Observable sets created by this factory must be on the realm of the current display.
structureAdvisor- an advisor that will be consulted from the implementations of the
nullif no advisor is available. It is recommended that clients pass a non-null advisor if they can provide additional structural information about the tree.
inputChangedDescription copied from interface:
IContentProviderNotifies this content provider that the given viewer's input has been switched to a different element.
A typical use for this method is registering the content provider as a listener to changes on the new input (using model-specific means), and deregistering the viewer from the old input. In response to these change notifications, the content provider should update the viewer (see the add, remove, update and refresh methods on the viewers).
The viewer should not be updated during this call, as it might be in the process of being disposed.
The default implementation does nothing.
getElementsReturns the elements to display in the viewer when its input is set to the given element. These elements can be presented as rows in a table, items in a list, etc. The result is not modified by the viewer.
hasChildrenpublic boolean hasChildren
(Object element)Returns whether the given element has children.
Intended as an optimization for when the viewer does not need the actual children. Clients may be able to implement this more efficiently than
getChildrenReturns the child elements of the given parent element.
The difference between this method andThe result is not modified by the viewer.
getElementsis called to obtain the tree viewer's root elements, whereas
getChildrenis used to obtain the children of a given parent element in the tree (including a root).
getParentReturns the parent for the given element, or
nullindicating that the parent can't be computed. In this case the tree-structured viewer can't expand a given node correctly if requested.
disposepublic void dispose()Disposes of this content provider. This is called by the viewer when a content provider is replaced, or when the viewer itself is disposed.
The viewer should not be updated during this call, as it is in the process of being disposed.
Note: Data binding content providers become unusable on disposal.
getKnownElementsReturns the set of elements known to this content provider. Label providers may track this set if they need to be notified about additions before the viewer sees the added element, and notified about removals after the element was removed from the viewer. This is intended for use by label providers, as it will always return the items that need labels.
- readableSet of items that will need labels
getRealizedElementsReturns the set of known elements which have been realized in the viewer. Clients may track this set in order to perform custom actions on elements while they are known to be present in the viewer.
- the set of known elements which have been realized in the viewer.