KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > views > contentoutline > IContentOutlinePage


1 /*******************************************************************************
2  * Copyright (c) 2000, 2006 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.contentoutline;
12
13 import org.eclipse.jface.viewers.ISelectionProvider;
14 import org.eclipse.ui.part.IPage;
15
16 /**
17  * Marker-style interface for a content outline page. This interface defines
18  * the minimum requirement for pages within the content outline view, namely
19  * they must be pages (implement <code>IPage</code>) and provide selections
20  * (implement <code>ISelectionProvider</code>).
21  * <p>
22  * Access to a content outline page begins when an editor is activated. When
23  * activation occurs, the content outline view will ask the editor for its
24  * content outline page. This is done by invoking
25  * <code>getAdapter(IContentOutlinePage.class)</code> on the editor.
26  * If the editor returns a page, the view then creates the controls for that
27  * page (using <code>createControl</code>) and makes the page visible.
28  * </p>
29  * <p>
30  * Clients may implement this interface from scratch, or subclass the
31  * abstract base class <code>ContentOutlinePage</code>.
32  * </p>
33  * <p>
34  * Note that this interface extends <code>ISelectionProvider</code>.
35  * This is no longer required in the case of implementors who also
36  * implement <code>IPageBookViewPage</code> (or extend <code>Page</code>)
37  * as they are now passed an <code>IPageSite</code> during their initialization
38  * and this site can be configured with a selection provider.
39  * However to avoid a breaking change
40  * 1) this interface will continue to extend ISelectionProvider
41  * 2) if an IContentOutlinePage does not set a selection provider for its
42  * site, the ContentOutline will continue to use the page itself for
43  * this purpose.
44  * </p>
45  *
46  * @see ContentOutlinePage
47  */
48 public interface IContentOutlinePage extends IPage, ISelectionProvider {
49 }
50
Popular Tags