KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ui > part > IPageBookViewPage


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.part;
12
13 import org.eclipse.ui.PartInitException;
14
15 /**
16  * Interface for a page in a pagebook view.
17  * <p>
18  * Pages should implement this interface.
19  * </p>
20  * @see PageBookView
21  * @see Page
22  */
23 public interface IPageBookViewPage extends IPage {
24     /**
25      * Returns the site for this page. May be <code>null</code>
26      * if no site has been set.
27      *
28      * @return the page site or <code>null</code>
29      */
30     public IPageSite getSite();
31
32     /**
33      * Initializes this page with the given page site.
34      * <p>
35      * This method is automatically called by the workbench shortly after page
36      * construction. It marks the start of the pages's lifecycle. Clients must
37      * not call this method.
38      * </p>
39      *
40      * @param site the page site
41      * @exception PartInitException if this page was not initialized successfully
42      */
43     public void init(IPageSite site) throws PartInitException;
44 }
45
Popular Tags