001: /*******************************************************************************
002: * Copyright (c) 2000, 2006 IBM Corporation and others.
003: * All rights reserved. This program and the accompanying materials
004: * are made available under the terms of the Eclipse Public License v1.0
005: * which accompanies this distribution, and is available at
006: * http://www.eclipse.org/legal/epl-v10.html
007: *
008: * Contributors:
009: * IBM Corporation - initial API and implementation
010: *******************************************************************************/package org.eclipse.ui.part;
011:
012: import org.eclipse.jface.action.IMenuManager;
013: import org.eclipse.jface.action.IStatusLineManager;
014: import org.eclipse.jface.action.IToolBarManager;
015: import org.eclipse.swt.widgets.Composite;
016: import org.eclipse.swt.widgets.Control;
017: import org.eclipse.ui.IActionBars;
018:
019: /**
020: * Abstract base superclass for pages in a pagebook view.
021: * <p>
022: * This class should be subclassed by clients wishing to define new types
023: * of pages for multi-page views.
024: * </p>
025: * <p>
026: * Subclasses must implement the following methods:
027: * <ul>
028: * <li><code>createControl</code> - to create the page's control</li>
029: * <li><code>getControl</code> - to retrieve the page's control</li>
030: * </ul>
031: * </p>
032: * <p>
033: * Subclasses may extend or reimplement the following methods as required:
034: * <ul>
035: * <li><code>dispose</code> - extend to provide additional cleanup</li>
036: * <li><code>setFocus</code> - reimplement to accept focus</li>
037: * <li><code>setActionBars</code> - reimplement to make contributions</li>
038: * <li><code>makeContributions</code> - this method exists to support previous versions</li>
039: * <li><code>setActionBars</code> - this method exists to support previous versions</li>
040: * <li><code>init</code> - extend to provide additional setup</li>
041: * </ul>
042: * </p>
043: *
044: * @see PageBookView
045: */
046: public abstract class Page implements IPageBookViewPage {
047: /**
048: * The site which contains this page
049: */
050: private IPageSite site;
051:
052: /*
053: * Creates a new page for a pagebook view.
054: */
055: protected Page() {
056: }
057:
058: /* (non-Javadoc)
059: * Method declared on IPage.
060: */
061: public abstract void createControl(Composite parent);
062:
063: /**
064: * The <code>Page</code> implementation of this <code>IPage</code> method
065: * disposes of this page's control (if it has one and it has not already
066: * been disposed). Subclasses may extend.
067: */
068: public void dispose() {
069: Control ctrl = getControl();
070: if (ctrl != null && !ctrl.isDisposed()) {
071: ctrl.dispose();
072: }
073: }
074:
075: /**
076: * The <code>Page</code> implementation of this <code>IPage</code> method returns
077: * <code>null</code>. Subclasses must reimplement.
078: */
079: public abstract Control getControl();
080:
081: /* (non-Javadoc)
082: * This method exists for backward compatibility.
083: * Subclasses should reimplement <code>init</code>.
084: */
085: public void makeContributions(IMenuManager menuManager,
086: IToolBarManager toolBarManager,
087: IStatusLineManager statusLineManager) {
088: }
089:
090: /* (non-Javadoc)
091: * This method exists for backward compatibility.
092: * Subclasses should reimplement <code>init</code>.
093: */
094: public void setActionBars(IActionBars actionBars) {
095: makeContributions(actionBars.getMenuManager(), actionBars
096: .getToolBarManager(), actionBars.getStatusLineManager());
097: }
098:
099: /**
100: * The <code>Page</code> implementation of this <code>IPageBookViewPage</code> method
101: * stores a reference to the supplied site (the site which contains this
102: * page).
103: * <p>
104: * Subclasses may extend.
105: * </p>
106: *
107: * @since 2.0
108: */
109: public void init(IPageSite pageSite) {
110: site = pageSite;
111: }
112:
113: /**
114: * Returns the site which contains this page.
115: *
116: * @return the site which contains this page
117: */
118: public IPageSite getSite() {
119: return site;
120: }
121:
122: /**
123: * The <code>Page</code> implementation of this <code>IPage</code> method
124: * does nothing. Subclasses must implement.
125: */
126: public abstract void setFocus();
127: }
|