blob: 481f7abbb8acab4c7a35b3dc759049c31fae1feb (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
/*******************************************************************************
* Copyright (c) 2005, 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.internal;
import org.eclipse.core.runtime.Assert;
import org.eclipse.jface.action.IAction;
import org.eclipse.ui.IPageListener;
import org.eclipse.ui.IPerspectiveDescriptor;
import org.eclipse.ui.IWorkbenchPage;
import org.eclipse.ui.IWorkbenchWindow;
import org.eclipse.ui.PerspectiveAdapter;
/**
* Utility class for tracking the active perspective in a window.
*
* @since 3.1
*/
public class PerspectiveTracker extends PerspectiveAdapter implements
IPageListener {
private IWorkbenchWindow window;
private IAction action;
/**
* Creates a perspective tracker for the given window.
* Subclasses should override <code>update(IPerspectiveDescriptor)</code>
* to get notified of perspective changes.
*
* @param window the window to track
*/
protected PerspectiveTracker(IWorkbenchWindow window) {
Assert.isNotNull(window);
this.window = window;
window.addPageListener(this);
window.addPerspectiveListener(this);
}
/**
* Creates a perspective tracker for the given window which will
* enable the given action only when there is an active perspective.
*
* @param window the window to track
* @param action the action to enable or disable
*/
public PerspectiveTracker(IWorkbenchWindow window, IAction action) {
this(window);
this.action = action;
update();
}
/**
* Disposes the tracker.
*/
public void dispose() {
if (window != null) {
window.removePageListener(this);
window.removePerspectiveListener(this);
}
}
public void pageActivated(IWorkbenchPage page) {
update();
}
public void pageClosed(IWorkbenchPage page) {
update();
}
public void pageOpened(IWorkbenchPage page) {
// ignore
}
public void perspectiveActivated(IWorkbenchPage page,
IPerspectiveDescriptor perspective) {
update();
}
/**
* Determines the active perspective in the window
* and calls <code>update(IPerspectiveDescriptor)</code>.
*/
private void update() {
if (window != null) {
IPerspectiveDescriptor persp = null;
IWorkbenchPage page = window.getActivePage();
if (page != null) {
persp = page.getPerspective();
}
update(persp);
}
}
/**
* Performs some function based on the active perspective in the window.
* <p>
* The default implementation enables the action (if given) if there
* is an active perspective, otherwise it disables it.
* </p>
* <p>
* Subclasses may override or extend.
* </p>
*
* @param persp the active perspective in the window, or <code>null</code> if none
*/
protected void update(IPerspectiveDescriptor persp) {
if (action != null) {
action.setEnabled(persp != null);
}
}
}
|