org.eclipse.ui.intro.IIntroSite 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) 2004, 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.intro;

import org.eclipse.ui.IActionBars;
import org.eclipse.ui.IKeyBindingService;
import org.eclipse.ui.IWorkbenchSite;

/** 
 * The primary interface between an intro part and the workbench.
 * 
 * The workbench exposes its implemention of intro part sites via this 
 * interface, which is not intended to be implemented or extended by clients.
 * 
 *  
 * @since 3.0
 */
public interface IIntroSite extends IWorkbenchSite {

    /**
     * Returns the part registry extension id for this intro site's part.
     * 
     * The name comes from the id attribute in the configuration
     * element.
     * 
     *
     * @return the registry extension id
     */
    public String getId();

    /**
     * Returns the unique identifier of the plug-in that defines this intro
     * site's part.
     *
     * @return the unique identifier of the declaring plug-in
     * @see org.eclipse.core.runtime.IPluginDescriptor#getUniqueIdentifier()
     */
    public String getPluginId();

    /**
     * Returns the key binding service in use.
     * 
     * The part will access this service to register
     * all of its actions, to set the active scope.
     * 
     * 
     * @return the key binding service in use
     * @deprecated Use IServiceLocator#getService(*) to retrieve
     * IContextService and IHandlerService instead.
     */
    public IKeyBindingService getKeyBindingService();

    /**
     * Returns the action bars for this part site.
     * The intro part has exclusive use of its site's action bars.
     * 
     * @return the action bars
     */
    public IActionBars getActionBars();
}