Package org.eclipse.ease.ui.tools
Class AbstractVirtualTreeProvider
java.lang.Object
org.eclipse.ease.ui.tools.AbstractVirtualTreeProvider
- All Implemented Interfaces:
org.eclipse.jface.viewers.IContentProvider
,org.eclipse.jface.viewers.IStructuredContentProvider
,org.eclipse.jface.viewers.ITreeContentProvider
- Direct Known Subclasses:
ModulesContentProvider
,ModulesContentProvider
,ScriptContentProvider
public abstract class AbstractVirtualTreeProvider
extends Object
implements org.eclipse.jface.viewers.ITreeContentProvider
A virtual tree content provider. Allows to build a tree structure by registering tree elements using
IPath
s. When the input changes
populateElements(Object)
is called on the derived class to create the tree structure.-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final org.eclipse.core.runtime.IPath
Static root node. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
dispose()
Object[]
getChildren
(Object parentElement) Object[]
getElements
(Object inputElement) boolean
hasChildren
(Object element) void
inputChanged
(org.eclipse.jface.viewers.Viewer viewer, Object oldInput, Object newInput) void
registerElement
(org.eclipse.core.runtime.IPath path, Object element) Register an element contained within the tree.void
registerNodeReplacement
(org.eclipse.core.runtime.IPath path, Object element) Register an element that should be used instead of a dedicated path node.void
registerPath
(org.eclipse.core.runtime.IPath path) Register an element path to be visible on the tree.void
setShowRoot
(boolean showRoot) Set to show the single root node.
-
Field Details
-
ROOT
public static final org.eclipse.core.runtime.IPath ROOTStatic root node.
-
-
Constructor Details
-
AbstractVirtualTreeProvider
public AbstractVirtualTreeProvider()
-
-
Method Details
-
dispose
public void dispose()- Specified by:
dispose
in interfaceorg.eclipse.jface.viewers.IContentProvider
-
inputChanged
- Specified by:
inputChanged
in interfaceorg.eclipse.jface.viewers.IContentProvider
-
getElements
- Specified by:
getElements
in interfaceorg.eclipse.jface.viewers.IStructuredContentProvider
- Specified by:
getElements
in interfaceorg.eclipse.jface.viewers.ITreeContentProvider
-
getChildren
- Specified by:
getChildren
in interfaceorg.eclipse.jface.viewers.ITreeContentProvider
-
getParent
- Specified by:
getParent
in interfaceorg.eclipse.jface.viewers.ITreeContentProvider
-
hasChildren
- Specified by:
hasChildren
in interfaceorg.eclipse.jface.viewers.ITreeContentProvider
-
registerElement
Register an element contained within the tree. To register an element 'myFoo' under the entry '/my/element/is/myFoo' use '/my/element/is' as path. The LabelProvider needs to take care of the rendering of the element itself.- Parameters:
path
- full path to be used to display this element (excluding element entry)element
- element to be stored within path
-
registerPath
public void registerPath(org.eclipse.core.runtime.IPath path) Register an element path to be visible on the tree.- Parameters:
path
- path to be visible
-
registerNodeReplacement
Register an element that should be used instead of a dedicated path node. Allows to display a dedicated object instead of a path. To replace the root element useROOT
as path. Do not replace multiple nodes with the same object (regarding its equals() method) as the tree cannot handle such structures.- Parameters:
path
- path to be replacedelement
- replacement
-
setShowRoot
public void setShowRoot(boolean showRoot) Set to show the single root node. The root node is hidden by default.- Parameters:
showRoot
-true
to display the root node
-