01: /*******************************************************************************
02: * Copyright (c) 2000, 2006 IBM Corporation and others.
03: * All rights reserved. This program and the accompanying materials
04: * are made available under the terms of the Eclipse Public License v1.0
05: * which accompanies this distribution, and is available at
06: * http://www.eclipse.org/legal/epl-v10.html
07: *
08: * Contributors:
09: * IBM Corporation - initial API and implementation
10: *******************************************************************************/package org.eclipse.ui.progress;
11:
12: import org.eclipse.core.runtime.IProgressMonitor;
13: import org.eclipse.core.runtime.jobs.ISchedulingRule;
14: import org.eclipse.ui.model.IWorkbenchAdapter;
15:
16: /**
17: * This adapter interface provides support for lazy initialization of UI workbench elements
18: * that are displayed visually. This adapter is used with an associated deferred content provider.
19: *
20: * @see DeferredTreeContentManager
21: * @since 3.0
22: */
23: public interface IDeferredWorkbenchAdapter extends IWorkbenchAdapter {
24:
25: /**
26: * Called by a job run in a separate thread to fetch the children of this adapter.
27: * The adapter should in return notify of new children via the collector.
28: * This is generally used when a content provider is getting elements.
29: * <p>
30: * It is good practice to check the passed in monitor for cancellation. This will
31: * provide good responsiveness for cancellation requests made by the user.
32: * </p>
33: *
34: * @param object the object to fetch the children for
35: * @param collector the collector to notify about new children. Should not
36: * be <code>null</code>.
37: * @param monitor a progress monitor that will never be <code>null<code> to
38: * support reporting and cancellation.
39: */
40: public void fetchDeferredChildren(Object object,
41: IElementCollector collector, IProgressMonitor monitor);
42:
43: /**
44: * Returns whether this adapter may have children. This is an optimized method
45: * used by content providers to allow showing the [+] expand icon without having
46: * yet fetched the children for the element.
47: * <p>
48: * If <code>false</code> is returned, then the content provider may assume
49: * that this adapter has no children. If <code>true</code> is returned,
50: * then the job manager may assume that this adapter may have children.
51: * <p>
52: *
53: * @return <code>true</code>if the adapter may have childen, and <code>false</code>
54: * otherwise.
55: */
56: public boolean isContainer();
57:
58: /**
59: * Returns the rule used to schedule the deferred fetching of children for this adapter.
60: *
61: * @param object the object whose children are being fetched
62: * @return the scheduling rule. May be <code>null</code>.
63: * @see org.eclipse.core.runtime.jobs.Job#setRule(ISchedulingRule)
64: */
65: public ISchedulingRule getRule(Object object);
66: }
|