Package org.eclipse.ui.internal

Class PerspectiveTracker

java.lang.Object

org.eclipse.ui.PerspectiveAdapter

org.eclipse.ui.internal.PerspectiveTracker

All Implemented Interfaces:

IPageListener, IPerspectiveListener, IPerspectiveListener2, IPerspectiveListener3, IPerspectiveListener4

public class PerspectiveTracker
extends PerspectiveAdapter
implements IPageListener

Utility class for tracking the active perspective in a window.

Since:

3.1

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PerspectiveTracker(IWorkbenchWindow window)	Creates a perspective tracker for the given window.
	PerspectiveTracker(IWorkbenchWindow window, IAction action)	Creates a perspective tracker for the given window which will enable the given action only when there is an active perspective.

Method Summary

Modifier and Type	Method	Description
void	dispose()	Disposes the tracker.
void	pageActivated(IWorkbenchPage page)	Notifies this listener that the given page has been activated.
void	pageClosed(IWorkbenchPage page)	Notifies this listener that the given page has been closed.
void	pageOpened(IWorkbenchPage page)	Notifies this listener that the given page has been opened.
void	perspectiveActivated(IWorkbenchPage page, IPerspectiveDescriptor perspective)	Notifies this listener that a perspective in the given page has been activated.
protected void	update(IPerspectiveDescriptor persp)	Performs some function based on the active perspective in the window.

Methods inherited from class org.eclipse.ui.PerspectiveAdapter

perspectiveChanged, perspectiveChanged, perspectiveClosed, perspectiveDeactivated, perspectiveOpened, perspectivePreDeactivate, perspectiveSavedAs

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PerspectiveTracker

protected PerspectiveTracker(IWorkbenchWindow window)

Creates a perspective tracker for the given window. Subclasses should override update(IPerspectiveDescriptor) to get notified of perspective changes.

Parameters:

window - the window to track

PerspectiveTracker

public PerspectiveTracker(IWorkbenchWindow window,
 IAction action)

Creates a perspective tracker for the given window which will enable the given action only when there is an active perspective.

Parameters:

window - the window to track

action - the action to enable or disable

Method Details

dispose

public void dispose()

Disposes the tracker.

pageActivated

public void pageActivated(IWorkbenchPage page)

Description copied from interface: IPageListener

Notifies this listener that the given page has been activated.

Specified by:

pageActivated in interface IPageListener

Parameters:

page - the page that was activated

See Also:

• IWorkbenchWindow.setActivePage(org.eclipse.ui.IWorkbenchPage)

pageClosed

public void pageClosed(IWorkbenchPage page)

Description copied from interface: IPageListener

Notifies this listener that the given page has been closed.

Specified by:

pageClosed in interface IPageListener

Parameters:

page - the page that was closed

See Also:

• IWorkbenchPage.close()

pageOpened

public void pageOpened(IWorkbenchPage page)

Description copied from interface: IPageListener

Notifies this listener that the given page has been opened.

Specified by:

pageOpened in interface IPageListener

Parameters:

page - the page that was opened

See Also:

• IWorkbenchWindow.openPage(java.lang.String, org.eclipse.core.runtime.IAdaptable)

perspectiveActivated

public void perspectiveActivated(IWorkbenchPage page,
 IPerspectiveDescriptor perspective)

Description copied from interface: IPerspectiveListener

Notifies this listener that a perspective in the given page has been activated.

Specified by:

perspectiveActivated in interface IPerspectiveListener

Overrides:

perspectiveActivated in class PerspectiveAdapter

Parameters:

page - the page containing the activated perspective

perspective - the perspective descriptor that was activated

See Also:

• IWorkbenchPage.setPerspective(org.eclipse.ui.IPerspectiveDescriptor)

update

protected void update(IPerspectiveDescriptor persp)

Performs some function based on the active perspective in the window.

The default implementation enables the action (if given) if there is an active perspective, otherwise it disables it.

Subclasses may override or extend.

Parameters:

persp - the active perspective in the window, or null if none