/*******************************************************************************
* 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.jface.action.IMenuManager;
import org.eclipse.jface.action.IStatusLineManager;
import org.eclipse.jface.action.IToolBarManager;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.ui.IActionBars;
/**
* Abstract base superclass for pages in a pagebook view.
* <p>
* This class should be subclassed by clients wishing to define new types
* of pages for multi-page views.
* </p>
* <p>
* Subclasses must implement the following methods:
* <ul>
* <li><code>createControl</code> - to create the page's control</li>
* <li><code>getControl</code> - to retrieve the page's control</li>
* </ul>
* </p>
* <p>
* Subclasses may extend or reimplement the following methods as required:
* <ul>
* <li><code>dispose</code> - extend to provide additional cleanup</li>
* <li><code>setFocus</code> - reimplement to accept focus</li>
* <li><code>setActionBars</code> - reimplement to make contributions</li>
* <li><code>makeContributions</code> - this method exists to support previous versions</li>
* <li><code>setActionBars</code> - this method exists to support previous versions</li>
* <li><code>init</code> - extend to provide additional setup</li>
* </ul>
* </p>
*
* @see PageBookView
*/
public abstract class Page implements IPageBookViewPage {
/**
* The site which contains this page
*/
private IPageSite site;
/*
* Creates a new page for a pagebook view.
*/
protected Page() {
}
/* (non-Javadoc)
* Method declared on IPage.
*/
public abstract void createControl(Composite parent);
/**
* The <code>Page</code> implementation of this <code>IPage</code> method
* disposes of this page's control (if it has one and it has not already
* been disposed). Subclasses may extend.
*/
public void dispose() {
Control ctrl = getControl();
if (ctrl != null && !ctrl.isDisposed()) {
ctrl.dispose();
}
}
/**
* The <code>Page</code> implementation of this <code>IPage</code> method returns
* <code>null</code>. Subclasses must reimplement.
*/
public abstract Control getControl();
/* (non-Javadoc)
* This method exists for backward compatibility.
* Subclasses should reimplement <code>init</code>.
*/
public void makeContributions(IMenuManager menuManager,
IToolBarManager toolBarManager, IStatusLineManager statusLineManager) {
}
/* (non-Javadoc)
* This method exists for backward compatibility.
* Subclasses should reimplement <code>init</code>.
*/
public void setActionBars(IActionBars actionBars) {
makeContributions(actionBars.getMenuManager(), actionBars
.getToolBarManager(), actionBars.getStatusLineManager());
}
/**
* The <code>Page</code> implementation of this <code>IPageBookViewPage</code> method
* stores a reference to the supplied site (the site which contains this
* page).
* <p>
* Subclasses may extend.
* </p>
*
* @since 2.0
*/
public void init(IPageSite pageSite) {
site = pageSite;
}
/**
* Returns the site which contains this page.
*
* @return the site which contains this page
*/
public IPageSite getSite() {
return site;
}
/**
* The <code>Page</code> implementation of this <code>IPage</code> method
* does nothing. Subclasses must implement.
*/
public abstract void setFocus();
}