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