Eclipse Platform
Release 3.4

org.eclipse.ui
Interface IPageService

All Known Subinterfaces:
IWorkbenchWindow

public interface IPageService

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);
 

See Also:
IWorkbenchWindow, IPageListener, IPerspectiveListener, IServiceLocator.getService(Class)
Restriction
This interface is not intended to be implemented by clients.

Method Summary
 void addPageListener(IPageListener listener)
          Adds the given listener for page lifecycle events.
 void addPerspectiveListener(IPerspectiveListener listener)
          Adds the given listener for a page's perspective lifecycle events.
 IWorkbenchPage getActivePage()
          Returns the active page.
 void removePageListener(IPageListener listener)
          Removes the given page listener.
 void removePerspectiveListener(IPerspectiveListener listener)
          Removes the given page's perspective listener.
 

Method Detail

addPageListener

public void addPageListener(IPageListener listener)
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.

Parameters:
listener - a page listener
See Also:
removePageListener(IPageListener)

addPerspectiveListener

public void addPerspectiveListener(IPerspectiveListener 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.

Parameters:
listener - a perspective listener
See Also:
removePerspectiveListener(IPerspectiveListener)

getActivePage

public IWorkbenchPage getActivePage()
Returns the active page.

Returns:
the active page, or null if no page is currently active

removePageListener

public void removePageListener(IPageListener listener)
Removes the given page listener. Has no affect if an identical listener is not registered.

Parameters:
listener - a page listener

removePerspectiveListener

public void removePerspectiveListener(IPerspectiveListener listener)
Removes the given page's perspective listener. Has no affect if an identical listener is not registered.

Parameters:
listener - a perspective listener

Eclipse Platform
Release 3.4

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.