org.eclipse.remote.internal.ui

Class RemoteTreeContentManager

java.lang.Object

org.eclipse.remote.internal.ui.RemoteTreeContentManager

public class RemoteTreeContentManager
extends java.lang.Object

A remote content manager that merges content into a tree rather then replacing its children with a "pending" node, and then the real children when they are available. This avoids collapsing the viewer when a refresh is performed. This implementation is currently tied to the RemoteTreeViewer.

Since:

3.1

Constructor Summary

Constructors

Constructor and Description
RemoteTreeContentManager(org.eclipse.jface.viewers.ITreeContentProvider provider, RemoteTreeViewer viewer, org.eclipse.ui.IWorkbenchPartSite site) Contructs a new content manager.

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() Cancels any content this provider is currently fetching.
protected org.eclipse.ui.progress.IElementCollector	createElementCollector(java.lang.Object parent, PendingUpdateAdapter placeholder) Create the element collector for the receiver.
protected org.eclipse.ui.progress.IDeferredWorkbenchAdapter	getAdapter(java.lang.Object element) Return the IDeferredWorkbenchAdapter for element or the element if it is an instance of IDeferredWorkbenchAdapter.
java.lang.Object[]	getChildren(java.lang.Object parent) Returns the child elements of the given element, or in the case of a deferred element, returns a placeholder.
protected java.lang.String	getFetchJobName(java.lang.Object parent, org.eclipse.ui.progress.IDeferredWorkbenchAdapter adapter)
boolean	mayHaveChildren(java.lang.Object element) Provides an optimized lookup for determining if an element has children.
protected void	prune(java.lang.Object parent, int offset) Create a UIJob to prune the children of the parent in the tree viewer, starting at the given offset.
protected void	replaceChildren(java.lang.Object parent, java.lang.Object[] children, int offset, org.eclipse.core.runtime.IProgressMonitor monitor) Create a UIJob to replace the children of the parent in the tree viewer.
protected void	runClearPlaceholderJob(PendingUpdateAdapter placeholder) Run a job to clear the placeholder.
protected void	startFetchingDeferredChildren(java.lang.Object parent, org.eclipse.ui.progress.IDeferredWorkbenchAdapter adapter, PendingUpdateAdapter placeholder)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RemoteTreeContentManager

public RemoteTreeContentManager(org.eclipse.jface.viewers.ITreeContentProvider provider,
                        RemoteTreeViewer viewer,
                        org.eclipse.ui.IWorkbenchPartSite site)

Contructs a new content manager.

Parameters:

provider - content provider

viewer - viewer

site - part site

Method Detail

createElementCollector

protected org.eclipse.ui.progress.IElementCollector createElementCollector(java.lang.Object parent,
                                                               PendingUpdateAdapter placeholder)

Create the element collector for the receiver.

Parameters:

parent - The parent object being filled in,

placeholder - The adapter that will be used to indicate that results are pending, possibly null

Returns:

IElementCollector

getChildren

public java.lang.Object[] getChildren(java.lang.Object parent)

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.

Returns:

Object[] or null if parent is not an instance of IDeferredWorkbenchAdapter.

replaceChildren

protected void replaceChildren(java.lang.Object parent,
                   java.lang.Object[] children,
                   int offset,
                   org.eclipse.core.runtime.IProgressMonitor monitor)

Create a UIJob to replace the children of the parent in the tree viewer.

Parameters:

parent - the parent for which children are to be replaced

children - the replacement children

offset - the offset at which to start replacing children

monitor - progress monitor

prune

protected void prune(java.lang.Object parent,
         int offset)

Create a UIJob to prune the children of the parent in the tree viewer, starting at the given offset.

Parameters:

parent - the parent for which children should be pruned

offset - the offset at which children should be pruned. All children at and after this index will be removed from the tree.

runClearPlaceholderJob

protected void runClearPlaceholderJob(PendingUpdateAdapter placeholder)

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 -

getFetchJobName

protected java.lang.String getFetchJobName(java.lang.Object parent,
                               org.eclipse.ui.progress.IDeferredWorkbenchAdapter adapter)

getAdapter

protected org.eclipse.ui.progress.IDeferredWorkbenchAdapter getAdapter(java.lang.Object element)

Return the IDeferredWorkbenchAdapter for element or the element if it is an instance of IDeferredWorkbenchAdapter. If it does not exist return null.

Parameters:

element -

Returns:

IDeferredWorkbenchAdapter or null

startFetchingDeferredChildren

protected void startFetchingDeferredChildren(java.lang.Object parent,
                                 org.eclipse.ui.progress.IDeferredWorkbenchAdapter adapter,
                                 PendingUpdateAdapter placeholder)

mayHaveChildren

public boolean mayHaveChildren(java.lang.Object element)

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 be null.

Returns:

boolean true if there are potentially children.

Throws:

java.lang.RuntimeException - if the element is null.

cancel

public void cancel()

Cancels any content this provider is currently fetching.