blob: c1a4b7aaf4d1f26572e27798a05604f73d2623ba (
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
|
/*******************************************************************************
* Copyright (c) 2009, 2019 SWTBot Committers 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:
* Ralf Ebert www.ralfebert.de - (bug 271630) SWTBot Improved RCP / Workbench support
*******************************************************************************/
package org.eclipse.swtbot.eclipse.finder.widgets;
import org.eclipse.core.runtime.Assert;
import org.eclipse.swtbot.eclipse.finder.SWTWorkbenchBot;
import org.eclipse.swtbot.swt.finder.exceptions.WidgetNotFoundException;
import org.eclipse.swtbot.swt.finder.finders.UIThreadRunnable;
import org.eclipse.swtbot.swt.finder.results.VoidResult;
import org.eclipse.ui.IPerspectiveDescriptor;
import org.eclipse.ui.IWorkbench;
import org.eclipse.ui.PlatformUI;
/**
* This represents an eclipse workbench perspective.
*
* @author Ralf Ebert www.ralfebert.de (bug 271630)
*/
public class SWTBotPerspective {
private final SWTWorkbenchBot bot;
private final IPerspectiveDescriptor perspectiveDescriptor;
/**
* Constructs an instance of the given object.
*
* @param perspectiveDescriptor the perspective descriptor.
* @param bot the instance of {@link SWTWorkbenchBot} which will be used to drive operations on behalf of this
* object.
* @throws WidgetNotFoundException if the widget is <code>null</code> or widget has been disposed.
* @since 2.0
*/
public SWTBotPerspective(IPerspectiveDescriptor perspectiveDescriptor, SWTWorkbenchBot bot) throws WidgetNotFoundException {
this.bot = bot;
Assert.isNotNull(perspectiveDescriptor, "The perspective descriptor cannot be null"); //$NON-NLS-1$
this.perspectiveDescriptor = perspectiveDescriptor;
}
/**
* Switches the active workbench page to this perspective.
*/
public void activate() {
UIThreadRunnable.syncExec(new VoidResult() {
@Override
public void run() {
try {
IWorkbench workbench = PlatformUI.getWorkbench();
workbench.showPerspective(perspectiveDescriptor.getId(), workbench.getActiveWorkbenchWindow());
} catch (Exception e) {
// TODO: what's the correct exception for such an error? Own exception class?
throw new WidgetNotFoundException(e.getMessage(), e);
}
}
});
}
/**
* Closes the perspective.
*
* @since 2.9
*/
public void close() {
UIThreadRunnable.syncExec(new VoidResult() {
@Override
public void run() {
try {
IWorkbench workbench = PlatformUI.getWorkbench();
workbench.getActiveWorkbenchWindow().getActivePage().closePerspective(perspectiveDescriptor, false, false);
} catch (Exception e) {
throw new WidgetNotFoundException(e.getMessage(), e);
}
}
});
}
/**
* @return true if this perspective is active in the active workbench page
*/
public boolean isActive() {
return bot.activePerspective().perspectiveDescriptor.getId().equals(this.perspectiveDescriptor.getId());
}
/**
* @return the perspective label
*/
public String getLabel() {
return this.perspectiveDescriptor.getLabel();
}
@Override
public String toString() {
return "SWTBotEclipsePerspective[id=\"" + perspectiveDescriptor.getLabel() + "\", label=\"" + perspectiveDescriptor.getLabel()
+ "\"]";
}
}
|