01: /*******************************************************************************
02: * Copyright (c) 2000, 2006 IBM Corporation and others.
03: * All rights reserved. This program and the accompanying materials
04: * are made available under the terms of the Eclipse Public License v1.0
05: * which accompanies this distribution, and is available at
06: * http://www.eclipse.org/legal/epl-v10.html
07: *
08: * Contributors:
09: * IBM Corporation - initial API and implementation
10: *******************************************************************************/package org.eclipse.ui.part;
11:
12: import org.eclipse.ui.PartInitException;
13:
14: /**
15: * Interface for a page in a pagebook view.
16: * <p>
17: * Pages should implement this interface.
18: * </p>
19: * @see PageBookView
20: * @see Page
21: */
22: public interface IPageBookViewPage extends IPage {
23: /**
24: * Returns the site for this page. May be <code>null</code>
25: * if no site has been set.
26: *
27: * @return the page site or <code>null</code>
28: */
29: public IPageSite getSite();
30:
31: /**
32: * Initializes this page with the given page site.
33: * <p>
34: * This method is automatically called by the workbench shortly after page
35: * construction. It marks the start of the pages's lifecycle. Clients must
36: * not call this method.
37: * </p>
38: *
39: * @param site the page site
40: * @exception PartInitException if this page was not initialized successfully
41: */
42: public void init(IPageSite site) throws PartInitException;
43: }
|