KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > views > IViewRegistry


1 /*******************************************************************************
2  * Copyright (c) 2000, 2005 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 package org.eclipse.ui.views;
12
13
14 /**
15  * The view registry maintains a list of views explicitly registered
16  * against the view extension point..
17  * <p>
18  * The description of a given view is kept in a <code>IViewDescriptor</code>.
19  * </p>
20  * <p>
21  * This interface is not intended to be implemented by clients.
22  * </p>
23  *
24  * @see org.eclipse.ui.views.IViewDescriptor
25  * @see org.eclipse.ui.views.IStickyViewDescriptor
26  * @since 3.1
27  */
28 public interface IViewRegistry {
29     /**
30      * Return a view descriptor with the given extension id. If no view exists
31      * with the id return <code>null</code>.
32      *
33      * @param id the id to search for
34      * @return the descriptor or <code>null</code>
35      */
36     public IViewDescriptor find(String JavaDoc id);
37
38     /**
39      * Returns an array of view categories.
40      *
41      * @return the categories. Never <code>null</code>.
42      */
43     public IViewCategory[] getCategories();
44
45     /**
46      * Return a list of views defined in the registry.
47      *
48      * @return the views. Never <code>null</code>.
49      */
50     public IViewDescriptor[] getViews();
51
52     /**
53      * Return a list of sticky views defined in the registry.
54      *
55      * @return the sticky views. Never <code>null</code>.
56      */
57     public IStickyViewDescriptor[] getStickyViews();
58 }
59
Popular Tags