org.eclipse.ui.IPartService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.ui.workbench Show documentation
This is org.eclipse.ui.workbench jar used by Scout SDK
There is a newer version: 3.108.0.v20160602-1232
Show newest version
/*******************************************************************************
 * Copyright (c) 2000, 2011 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;

/**
 * A part service tracks the creation and activation of parts within a
 * workbench page.
 * 
 * This service can be acquired from your service locator:
 * 
 * 	IPartService service = (IPartService) getSite().getService(IPartService.class);
 * 
 * 
 * This service is not available globally, only from the workbench window level down.
 * 
 * 
 *
 * @see IWorkbenchPage
 * @see org.eclipse.ui.services.IServiceLocator#getService(Class)
 * @noimplement This interface is not intended to be implemented by clients.
 */
public interface IPartService {

    /**
     * Adds the given listener for part lifecycle events.
     * Has no effect if an identical listener is already registered.
	 * 
	 * Note: listeners should be removed when no longer necessary. If
	 * not, they will be removed when the IServiceLocator used to acquire this
	 * service is disposed.
	 * 
     *
     * @param listener a part listener
     * @see #removePartListener(IPartListener)
     */
    public void addPartListener(IPartListener listener);

    /**
     * Adds the given listener for part lifecycle events.
     * Has no effect if an identical listener is already registered.
     * 
     * As of 3.5, the IPartListener2 can also implement IPageChangedListener
     * to be notified about any parts that implement IPageChangeProvider and
     * post PageChangedEvents.
     * 
	 * 
	 * Note: listeners should be removed when no longer necessary. If
	 * not, they will be removed when the IServiceLocator used to acquire this
	 * service is disposed.
	 * 
     *
     * @param listener a part listener
     * @see #removePartListener(IPartListener2)
     * @see org.eclipse.jface.dialogs.IPageChangeProvider
     * @see org.eclipse.jface.dialogs.IPageChangedListener
     */
    public void addPartListener(IPartListener2 listener);

    /**
     * Returns the active part.
     *
     * @return the active part, or null if no part is currently active
     */
    public IWorkbenchPart getActivePart();

    /**
     * Returns the active part reference.
     *
     * @return the active part reference, or null if no part
     * is currently active
     */
    public IWorkbenchPartReference getActivePartReference();

    /**
	 * Removes the given part listener. Has no effect if an identical listener
	 * is not registered.
	 *
	 * @param listener
	 *            a part listener
	 */
    public void removePartListener(IPartListener listener);

    /**
	 * Removes the given part listener. Has no effect if an identical listener
	 * is not registered.
	 *
	 * @param listener
	 *            a part listener
	 */
    public void removePartListener(IPartListener2 listener);
}