org.eclipse.ui.part.IPageBookViewPage Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of workbench Show documentation

This plug-in contains the bulk of the Workbench implementation, and depends on JFace, SWT, and Core Runtime. It cannot be used independently from org.eclipse.ui. Workbench client plug-ins should not depend directly on this plug-in.

The newest version!

/*******************************************************************************
 * 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.
 * 
 * Pages should implement this interface.
 * 	
 * @see PageBookView
 * @see Page
 */
public interface IPageBookViewPage extends IPage {
    /**
     * Returns the site for this page. May be null
     * if no site has been set.
     *
     * @return the page site or null
     */
    public IPageSite getSite();

    /**
     * Initializes this page with the given page site.  
     * 
     * 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.
     * 
     *
     * @param site the page site
     * @exception PartInitException if this page was not initialized successfully
     */
    public void init(IPageSite site) throws PartInitException;
}