Package org.eclipse.handly.ui.viewer
Class DeferredTreeContentProvider
- java.lang.Object
-
- org.eclipse.handly.ui.viewer.DeferredTreeContentProvider
-
- All Implemented Interfaces:
org.eclipse.jface.viewers.IContentProvider,org.eclipse.jface.viewers.IStructuredContentProvider,org.eclipse.jface.viewers.ITreeContentProvider
- Direct Known Subclasses:
CallHierarchyContentProvider
public abstract class DeferredTreeContentProvider extends java.lang.Object implements org.eclipse.jface.viewers.ITreeContentProviderAn abstract base class for a tree content provider that supports asynchronous fetching of children.- See Also:
DeferredTreeContentManager
-
-
Constructor Summary
Constructors Constructor Description DeferredTreeContentProvider(org.eclipse.jface.viewers.AbstractTreeViewer viewer, org.eclipse.ui.IWorkbenchPartSite site)Creates a new instance of the content provider.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract voidfetchDeferredChildren(java.lang.Object parentElement, org.eclipse.ui.progress.IElementCollector collector, org.eclipse.core.runtime.IProgressMonitor monitor)Called by a job to fetch the child elements of the given parent element.protected org.eclipse.ui.progress.DeferredTreeContentManagergetDeferredTreeContentManager()Returns theDeferredTreeContentManagerused by this content provider.protected java.lang.StringgetLabel(java.lang.Object element)Returns the label text for the given element.protected org.eclipse.core.runtime.jobs.ISchedulingRulegetRule(java.lang.Object parentElement)Returns the rule used to schedule the deferred fetching of children for the given parent element.voidinputChanged(org.eclipse.jface.viewers.Viewer viewer, java.lang.Object oldInput, java.lang.Object newInput)
-
-
-
Constructor Detail
-
DeferredTreeContentProvider
public DeferredTreeContentProvider(org.eclipse.jface.viewers.AbstractTreeViewer viewer, org.eclipse.ui.IWorkbenchPartSite site)Creates a new instance of the content provider.- Parameters:
viewer- the tree viewer that will use this content provider (notnull)site- the site of the containing workbench part (may benull)
-
-
Method Detail
-
inputChanged
public void inputChanged(org.eclipse.jface.viewers.Viewer viewer, java.lang.Object oldInput, java.lang.Object newInput)The
DeferredTreeContentProviderimplementation of this method cancels all jobs that are fetching content for the given old input.- Specified by:
inputChangedin interfaceorg.eclipse.jface.viewers.IContentProvider
-
getDeferredTreeContentManager
protected final org.eclipse.ui.progress.DeferredTreeContentManager getDeferredTreeContentManager()
Returns theDeferredTreeContentManagerused by this content provider.- Returns:
- a
DeferredTreeContentManager(nevernull)
-
fetchDeferredChildren
protected abstract void fetchDeferredChildren(java.lang.Object parentElement, org.eclipse.ui.progress.IElementCollector collector, org.eclipse.core.runtime.IProgressMonitor monitor)Called by a job to fetch the child elements of the given parent element. This method should report the fetched elements via the given collector.- Parameters:
parentElement- the parent elementcollector- the element collector (nevernull)monitor- a progress monitor to support reporting and cancellation (nevernull)
-
getRule
protected org.eclipse.core.runtime.jobs.ISchedulingRule getRule(java.lang.Object parentElement)
Returns the rule used to schedule the deferred fetching of children for the given parent element.Default implementation returns
new SerialPerObjectRule(this).- Parameters:
parentElement- the parent element- Returns:
- the scheduling rule. May be
null - See Also:
Job.setRule(ISchedulingRule)
-
getLabel
protected java.lang.String getLabel(java.lang.Object element)
Returns the label text for the given element. Returns an empty string if there is no appropriate label text for the element.Default implementation uses the tree viewer's label provider to obtain the element's label.
- Parameters:
element- the element to obtain a label for- Returns:
- the element's label (never
null)
-
-