blob: ba91efb138c51cbee4c0874087726079f2c7eba9 [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2000, 2006 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.ui.part;
import org.eclipse.ui.PartInitException;
/**
* Interface for a page in a pagebook view.
* <p>
* Pages should implement this interface.
* </p>
* @see PageBookView
* @see Page
* @since 1.0
*/
public interface IPageBookViewPage extends IPage {
/**
* Returns the site for this page. May be <code>null</code>
* if no site has been set.
*
* @return the page site or <code>null</code>
*/
public IPageSite getSite();
/**
* Initializes this page with the given page site.
* <p>
* This method is automatically called by the workbench shortly after page
* construction. It marks the start of the pages's lifecycle. Clients must
* not call this method.
* </p>
*
* @param site the page site
* @exception PartInitException if this page was not initialized successfully
*/
public void init(IPageSite site) throws PartInitException;
}