org.eclipse.ui.IPageService 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 page service tracks the page and perspective lifecycle events
 * within a workbench window.
 * 
 * This service can be acquired from your service locator:
 * 
 * 	IPageService service = (IPageService) getSite().getService(IPageService.class);
 * 
 * 
 * This service is not available globally, only from the workbench window level down.
 * 
 * 
 *
 * @see IWorkbenchWindow
 * @see IPageListener
 * @see IPerspectiveListener
 * @see org.eclipse.ui.services.IServiceLocator#getService(Class)
 * @noimplement This interface is not intended to be implemented by clients.
 */
public interface IPageService {
    /**
     * Adds the given listener for page 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 page listener
     * @see #removePageListener(IPageListener)
     */
    public void addPageListener(IPageListener listener);

    /**
     * Adds the given listener for a page's perspective 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 perspective listener
     * @see #removePerspectiveListener(IPerspectiveListener)
     */
    public void addPerspectiveListener(IPerspectiveListener listener);

    /**
     * Returns the active page.
     *
     * @return the active page, or null if no page is currently active
     */
    public IWorkbenchPage getActivePage();

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

    /**
	 * Removes the given page's perspective listener. Has no effect if an
	 * identical listener is not registered.
	 *
	 * @param listener
	 *            a perspective listener
	 */
    public void removePerspectiveListener(IPerspectiveListener listener);
}