KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > internal > registry > IViewRegistry


1 /*******************************************************************************
2  * Copyright (c) 2000, 2004 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Common Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/cpl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/

11 package org.eclipse.ui.internal.registry;
12
13
14 /**
15  * The view registry maintains a list of views explicitly registered
16  * against the view extension point..
17  * <p>
18  * [Issue: This interface is not exposed in API, but time may
19  * demonstrate that it should be. For the short term leave it be.
20  * In the long term its use should be re-evaluated. ]
21  * </p>
22  * <p>
23  * The description of a given view is kept in a IViewDescriptor
24  * </p>
25  */

26 public interface IViewRegistry {
27 /**
28  * Return a view descriptor with the given extension ID. If no view exists
29  * with the ID return null.
30  */

31 public IViewDescriptor find(String JavaDoc id);
32 /**
33  * Returns an enumeration of view categories, if defined.
34  */

35 public Category [] getCategories();
36 /**
37  * Return the view category count.
38  */

39 public int getCategoryCount();
40 /**
41  * Return the view count.
42  */

43 public int getViewCount();
44 /**
45  * Return a list of views defined in the registry.
46  */

47 public IViewDescriptor [] getViews();
48 /**
49  * Return a list of sticky views defined in the registry.
50  */

51 public IStickyViewDescriptor [] getStickyViews();
52 }
53
Popular Tags