KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > core > internal > databinding > observable > tree > IOrderedTreeProvider


1 /*******************************************************************************
2  * Copyright (c) 2006, 2007 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11
12 package org.eclipse.core.internal.databinding.observable.tree;
13
14 import org.eclipse.core.databinding.observable.Realm;
15 import org.eclipse.core.databinding.observable.list.IObservableList;
16
17 /**
18  * Objects that implement this interface are capable of describing a tree by
19  * returning the list of children of any given element in the tree.
20  *
21  * @since 3.3
22  */
23 public interface IOrderedTreeProvider {
24     /**
25      * Returns the children of the given element, or null if the element is a
26      * leaf node. The caller of this method is expected to dispose the result
27      * list when it is no longer needed.
28      *
29      * @param element
30      * the tree path of the element to query
31      * @return the children of the given element, or null if the element is a
32      * leaf node
33      */
34     IObservableList createChildList(TreePath element);
35
36     /**
37      * @return the realm shared by all child lists
38      */
39     Realm getRealm();
40 }
41
Popular Tags