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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
|
/*******************************************************************************
* Copyright (c) 2003, 2015 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
* Lars Vogel <Lars.Vogel@gmail.com> - Bug 440810
* Andrey Loskutov <loskutov@gmx.de> - Bug 445538
*******************************************************************************/
package org.eclipse.ui.actions;
import org.eclipse.jface.action.IContributionItem;
import org.eclipse.ui.IWorkbenchCommandConstants;
import org.eclipse.ui.IWorkbenchWindow;
import org.eclipse.ui.internal.ChangeToPerspectiveMenu;
import org.eclipse.ui.internal.IPreferenceConstants;
import org.eclipse.ui.internal.IWorkbenchGraphicConstants;
import org.eclipse.ui.internal.ReopenEditorMenu;
import org.eclipse.ui.internal.ShowInMenu;
import org.eclipse.ui.internal.ShowViewMenu;
import org.eclipse.ui.internal.SwitchToWindowMenu;
import org.eclipse.ui.internal.WorkbenchImages;
import org.eclipse.ui.internal.WorkbenchMessages;
import org.eclipse.ui.internal.WorkbenchPlugin;
import org.eclipse.ui.internal.actions.HelpSearchContributionItem;
import org.eclipse.ui.menus.CommandContributionItem;
import org.eclipse.ui.menus.CommandContributionItemParameter;
/**
* Access to standard contribution items provided by the workbench.
* <p>
* Most of the functionality of this class is provided by static methods and
* fields. Example usage:
* </p>
*
* <pre>
* MenuManager menu = ...;
* IContributionItem reEdit = ContributionItemFactory.REOPEN_EDITORS.create(window);
* menu.add(reEdit);
* </pre>
* <p>
* Clients may declare subclasses that provide additional application-specific
* contribution item factories.
* </p>
*
* @since 3.0
*/
public abstract class ContributionItemFactory {
/**
* Id of contribution items created by this factory.
*/
private final String contributionItemId;
/**
* Creates a new workbench contribution item factory with the given id.
*
* @param contributionItemId the id of contribution items created by this
* factory
*/
protected ContributionItemFactory(String contributionItemId) {
this.contributionItemId = contributionItemId;
}
/**
* Creates a new standard contribution item for the given workbench window.
* <p>
* A typical contribution item automatically registers listeners against the
* workbench window so that it can keep its enablement state up to date.
* Ordinarily, the window's references to these listeners will be dropped
* automatically when the window closes. However, if the client needs to get rid
* of a contribution item while the window is still open, the client must call
* IContributionItem#dispose to give the item an opportunity to deregister its
* listeners and to perform any other cleanup.
* </p>
*
* @param window the workbench window
* @return the workbench contribution item
*/
public abstract IContributionItem create(IWorkbenchWindow window);
/**
* Returns the id of this contribution item factory.
*
* @return the id of contribution items created by this factory
*/
public String getId() {
return contributionItemId;
}
/**
* Workbench action (id "pinEditor"): Toggle whether the editor is pinned. This
* action maintains its enablement state.
*/
public static final ContributionItemFactory PIN_EDITOR = new ContributionItemFactory("pinEditor") { //$NON-NLS-1$
private static final String COMMAND_ID = IWorkbenchCommandConstants.WINDOW_PIN_EDITOR;
@Override
public IContributionItem create(final IWorkbenchWindow window) {
if (window == null) {
throw new IllegalArgumentException();
}
CommandContributionItemParameter parameter = new CommandContributionItemParameter(window, COMMAND_ID,
COMMAND_ID, null,
WorkbenchImages.getImageDescriptor(IWorkbenchGraphicConstants.IMG_ETOOL_PIN_EDITOR),
WorkbenchImages.getImageDescriptor(IWorkbenchGraphicConstants.IMG_ETOOL_PIN_EDITOR_DISABLED), null,
null, null, WorkbenchMessages.PinEditorAction_toolTip, // Local workaround for
// http://bugs.eclipse.org/387583
CommandContributionItem.STYLE_CHECK, null, false);
final CommandContributionItem action = new CommandContributionItem(parameter);
action.setVisible(WorkbenchPlugin.getDefault().getPreferenceStore()
.getBoolean(IPreferenceConstants.REUSE_EDITORS_BOOLEAN));
return action;
}
};
/**
* Workbench contribution item (id "openWindows"): A list of windows currently
* open in the workbench. Selecting one of the items makes the corresponding
* window the active window. This action dynamically maintains the list of
* windows.
*/
public static final ContributionItemFactory OPEN_WINDOWS = new ContributionItemFactory("openWindows") { //$NON-NLS-1$
@Override
public IContributionItem create(IWorkbenchWindow window) {
if (window == null) {
throw new IllegalArgumentException();
}
return new SwitchToWindowMenu(window, getId(), true);
}
};
/**
* Workbench contribution item (id "viewsShortlist"): A list of views available
* to be opened in the window, arranged as a shortlist of promising views and an
* "Other" subitem. Selecting one of the items opens the corresponding view in
* the active window. This action dynamically maintains the view shortlist.
*/
public static final ContributionItemFactory VIEWS_SHORTLIST = new ContributionItemFactory("viewsShortlist") { //$NON-NLS-1$
@Override
public IContributionItem create(IWorkbenchWindow window) {
if (window == null) {
throw new IllegalArgumentException();
}
return new ShowViewMenu(window, getId());
}
};
/**
* Workbench contribution item (id "viewsShowIn"): A list of views available to
* be opened in the window, arranged as a list of alternate views to show the
* same item currently selected. Selecting one of the items opens the
* corresponding view in the active window. This action dynamically maintains
* the view list.
*/
public static final ContributionItemFactory VIEWS_SHOW_IN = new ContributionItemFactory("viewsShowIn") { //$NON-NLS-1$
@Override
public IContributionItem create(IWorkbenchWindow window) {
if (window == null) {
throw new IllegalArgumentException();
}
ShowInMenu showInMenu = new ShowInMenu();
showInMenu.setId(getId());
showInMenu.initialize(window);
return showInMenu;
}
};
/**
* Workbench contribution item (id "reopenEditors"): A list of recent editors
* (with inputs) available to be reopened in the window. Selecting one of the
* items reopens the corresponding editor on its input in the active window.
* This action dynamically maintains the list of editors.
*/
public static final ContributionItemFactory REOPEN_EDITORS = new ContributionItemFactory("reopenEditors") { //$NON-NLS-1$
@Override
public IContributionItem create(IWorkbenchWindow window) {
if (window == null) {
throw new IllegalArgumentException();
}
return new ReopenEditorMenu(window, getId(), true);
}
};
/**
* Workbench contribution item (id "perspectivesShortlist"): A list of
* perspectives available to be opened, arranged as a shortlist of promising
* perspectives and an "Other" subitem. Selecting one of the items makes the
* corresponding perspective active. Should a new perspective need to be opened,
* a workbench user preference controls whether the perspective is opened in the
* active window or a new window. This action dynamically maintains the
* perspectives shortlist.
*/
public static final ContributionItemFactory PERSPECTIVES_SHORTLIST = new ContributionItemFactory(
"perspectivesShortlist") { //$NON-NLS-1$
@Override
public IContributionItem create(IWorkbenchWindow window) {
if (window == null) {
throw new IllegalArgumentException();
}
return new ChangeToPerspectiveMenu(window, getId());
}
};
/**
* Workbench contribution item (id "newWizardShortlist"): A list of new item
* wizards available to be opened, arranged as a shortlist of promising new item
* wizards and an "Other" subitem. Selecting one of the items invokes the
* corresponding new item wizard. This action dynamically maintains the new item
* wizard shortlist.
*
* @since 3.1
*/
public static final ContributionItemFactory NEW_WIZARD_SHORTLIST = new ContributionItemFactory(
"newWizardShortlist") { //$NON-NLS-1$
@Override
public IContributionItem create(IWorkbenchWindow window) {
if (window == null) {
throw new IllegalArgumentException();
}
return new BaseNewWizardMenu(window, getId());
}
};
/**
* Workbench contribution item (id "helpSearch"): An editable field for entering
* help search queries.
*
* @since 3.1
*/
public static final ContributionItemFactory HELP_SEARCH = new ContributionItemFactory("helpSearch") {//$NON-NLS-1$
@Override
public IContributionItem create(IWorkbenchWindow window) {
if (window == null) {
throw new IllegalArgumentException();
}
return new HelpSearchContributionItem(window, getId());
}
};
}
|
