| java.lang.Object
 org.eclipse.ui.progress.DeferredTreeContentManager
| DeferredTreeContentManager | | public class DeferredTreeContentManager (Code) | | The DeferredContentManager is a class that helps an ITreeContentProvider get
its deferred input.
NOTE AbstractTreeViewer#isExpandable may need to
be implemented in AbstractTreeViewer subclasses with
deferred content that use filtering as a call to
#getChildren may be required to determine the correct
state of the expanding control.
AbstractTreeViewers which use this class may wish to
sacrifice accuracy of the expandable state indicator for the
performance benefits of deferring content.
See Also: IDeferredWorkbenchAdapter
since:
3.0 |
| Inner Class :class DeferredContentFamily | |
| Constructor Summary | |
| public | DeferredTreeContentManager(ITreeContentProvider provider, AbstractTreeViewer viewer, IWorkbenchPartSite site)
Create a new instance of the receiver using the supplied content
provider and viewer. | | public | DeferredTreeContentManager(ITreeContentProvider provider, AbstractTreeViewer viewer)
Create a new instance of the receiver using the supplied content
provider and viewer. |
| contentProvider | | ITreeContentProvider contentProvider(Code) | | |
| treeViewer | | AbstractTreeViewer treeViewer(Code) | | |
| DeferredTreeContentManager | | public DeferredTreeContentManager(ITreeContentProvider provider, AbstractTreeViewer viewer, IWorkbenchPartSite site)(Code) | | Create a new instance of the receiver using the supplied content
provider and viewer. Run any jobs using the site.
Parameters:
provider -
Parameters:
viewer -
Parameters:
site - |
| DeferredTreeContentManager | | public DeferredTreeContentManager(ITreeContentProvider provider, AbstractTreeViewer viewer)(Code) | | Create a new instance of the receiver using the supplied content
provider and viewer.
Parameters:
provider - The content provider that will be updated
Parameters:
viewer - The tree viewer that the results are added to |
| addChildren | | protected void addChildren(Object parent, Object[] children, IProgressMonitor monitor)(Code) | | Create a UIJob to add the children to the parent in the tree viewer.
Parameters:
parent -
Parameters:
children -
Parameters:
monitor - |
| cancel | | public void cancel(Object parent)(Code) | | Cancel all jobs that are fetching content for the given parent or any of
its children.
Parameters:
parent - |
| createElementCollector | | protected IElementCollector createElementCollector(Object parent, PendingUpdateAdapter placeholder)(Code) | | Create the element collector for the receiver.
Parameters:
parent - The parent object being filled in,
Parameters:
placeholder - The adapter that will be used to indicate that results arepending. IElementCollector |
| createPendingUpdateAdapter | | protected PendingUpdateAdapter createPendingUpdateAdapter()(Code) | | Factory method for creating the pending update adapter representing the
placeholder node. Subclasses may override.
a pending update adapter
since:
3.2 |
| getAdapter | | protected IDeferredWorkbenchAdapter getAdapter(Object element)(Code) | | Return the IDeferredWorkbenchAdapter for element or the element if it is
an instance of IDeferredWorkbenchAdapter. If it does not exist return
null.
Parameters:
element - IDeferredWorkbenchAdapter or null |
| getChildren | | public Object[] getChildren(Object parent)(Code) | | Returns the child elements of the given element, or in the case of a
deferred element, returns a placeholder. If a deferred element is used, a
job is created to fetch the children in the background.
Parameters:
parent - The parent object. Object[] or null if parent is not an instance ofIDeferredWorkbenchAdapter. |
| getFetchJobName | | protected String getFetchJobName(Object parent, IDeferredWorkbenchAdapter adapter)(Code) | | Returns a name to use for the job that fetches children of the given parent.
Subclasses may override. Default job name is parent's label.
Parameters:
parent - parent that children are to be fetched for
Parameters:
adapter - parent's deferred adapter job name |
| isDeferredAdapter | | public boolean isDeferredAdapter(Object element)(Code) | | Return whether or not the element is or adapts to an
IDeferredWorkbenchAdapter.
Parameters:
element - boolean true if the element is anIDeferredWorkbenchAdapter |
| mayHaveChildren | | public boolean mayHaveChildren(Object element)(Code) | | Provides an optimized lookup for determining if an element has children.
This is required because elements that are populated lazilly can't
answer getChildren just to determine the potential for
children. Throw an AssertionFailedException if element is null.
Parameters:
element - The Object being tested. This should not benull. boolean true if there are potentially children.
throws:
RuntimeException - if the element is null. |
| runClearPlaceholderJob | | protected void runClearPlaceholderJob(PendingUpdateAdapter placeholder)(Code) | | Run a job to clear the placeholder. This is used when the update
for the tree is complete so that the user is aware that no more
updates are pending.
Parameters:
placeholder - |
| startFetchingDeferredChildren | | protected void startFetchingDeferredChildren(Object parent, IDeferredWorkbenchAdapter adapter, PendingUpdateAdapter placeholder)(Code) | | Starts a job and creates a collector for fetching the children of this
deferred adapter. If children are waiting to be retrieved for this parent
already, that job is cancelled and another is started.
Parameters:
parent - The parent object being filled in,
Parameters:
adapter - The adapter being used to fetch the children.
Parameters:
placeholder - The adapter that will be used to indicate that results arepending. |
|
|