blob: 2bbd3bc83c2e09090460c76888e1fefa29718dbc [file] [log] [blame]
/*******************************************************************************
* Copyright (c) 2000, 2015 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* 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
*/
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>
*/
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
*/
void init(IPageSite site) throws PartInitException;
}