Source Code Cross Referenced for IWorkbenchPreferencePage.java in  » IDE-Eclipse » ui-workbench » org » eclipse » ui » Java Source Code / Java DocumentationJava Source Code and Java Documentation

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;
11:
12:        import org.eclipse.jface.preference.IPreferencePage;
13:
14:        /**
15:         * Interface for workbench preference pages.
16:         * <p>
17:         * Clients should implement this interface and include the name of their class
18:         * in an extension contributed to the workbench's preference extension point 
19:         * (named <code>"org.eclipse.ui.preferencePages"</code>).
20:         * For example, the plug-in's XML markup might contain:
21:         * <pre>
22:         * &LT;extension point="org.eclipse.ui.preferencePages"&GT;
23:         *      &LT;page id="com.example.myplugin.prefs"
24:         *         name="Knobs"
25:         *         class="com.example.myplugin.MyPreferencePage" /&GT;
26:         * &LT;/extension&GT;
27:         * </pre>
28:         * </p>
29:         */
30:        public interface IWorkbenchPreferencePage extends IPreferencePage {
31:            /**
32:             * Initializes this preference page for the given workbench.
33:             * <p>
34:             * This method is called automatically as the preference page is being created
35:             * and initialized. Clients must not call this method.
36:             * </p>
37:             *
38:             * @param workbench the workbench
39:             */
40:            void init(IWorkbench workbench);
41:        }