org.eclipse.jface.viewers
Interface ITreePathContentProvider
-
All Superinterfaces:
-
IContentProvider,
IStructuredContentProvider
-
public interface ITreePathContentProvider
- extends
IStructuredContentProvider
An interface to content providers for tree-structure-oriented viewers that
provides content based on the path of elements in the tree viewer..
-
Since:
- 3.2
-
See Also:
-
AbstractTreeViewer
getChildren
Object[] getChildren(
TreePath parentPath)
- Returns the child elements of the last element in the given path.
Implementors may want to use the additional context of the complete path
of a parent element in order to decide which children to return.
The provided path is relative to the input. The root elements must
be obtained by calling
IStructuredContentProvider.getElements(Object).
The result is not modified by the viewer.
-
-
-
Parameters:
-
parentPath - the path of the parent element
-
Returns:
- an array of child elements
hasChildren
boolean hasChildren(
TreePath path)
- Returns whether the last element of the given path 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
getChildren.
-
-
-
Parameters:
-
path - the path
-
Returns:
-
true if the lat element of the path has children,
and false if it has no children
getParents
TreePath[] getParents(
Object element)
- Return the possible parent paths for the given element. An empty array
can be returned if the paths cannot be computed. If the element is
a potential child of the input of the viewer, an empty tree path
should be an entry in the returned array.
-
-
-
Parameters:
-
element - the element
-
Returns:
- the possible parent paths for the given element
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.
