org.eclipse.ui.IWorkbenchPreferencePage 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;

import org.eclipse.jface.preference.IPreferencePage;

/**
 * Interface for workbench preference pages.
 * 
 * Clients should implement this interface and include the name of their class
 * in an extension contributed to the workbench's preference extension point 
 * (named "org.eclipse.ui.preferencePages").
 * For example, the plug-in's XML markup might contain:
 * 
 * <extension point="org.eclipse.ui.preferencePages">
 *      <page id="com.example.myplugin.prefs"
 *         name="Knobs"
 *         class="com.example.myplugin.MyPreferencePage" />
 * </extension>
 * 
 * 
 */
public interface IWorkbenchPreferencePage extends IPreferencePage {
    /**
     * Initializes this preference page for the given workbench.
     * 
     * This method is called automatically as the preference page is being created
     * and initialized. Clients must not call this method.
     * 
     *
     * @param workbench the workbench
     */
    void init(IWorkbench workbench);
}