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
256
257
|
/*******************************************************************************
* 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
*******************************************************************************/
package org.eclipse.ui.commands;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.ui.IWorkbenchPartSite;
import org.eclipse.ui.internal.util.Util;
/**
* <p>
* An instance of this class represents a request to handle a command. A handler
* submission specifies a list of conditions under which it would be appropriate
* for a particular command to have a particular handler. These conditions
* include things like the active part or the active shell. So, it is possible
* to say things like: "when my part is active, please consider calling these
* classes when you want to perform a cut, copy or paste".
* </p>
* <p>
* The workbench considers all of the submissions it has received and choses the
* ones it views as the best possible match.
* </p>
* <p>
* This class is not intended to be extended by clients.
* </p>
* <p>
* Note: this class has a natural ordering that is inconsistent with equals.
* </p>
*
* @since 3.0
* @see org.eclipse.ui.commands.IWorkbenchCommandSupport
* @deprecated Please use <code>IHandlerService.activateHandler</code> instead.
* @see org.eclipse.ui.handlers.IHandlerService
*/
@Deprecated
@SuppressWarnings("all")
public final class HandlerSubmission implements Comparable {
/**
* The part identifier for the part that should be active before this
* submission can be considered. This value can be <code>null</code>, which
* indicates that it should match any part.
*/
private final String activePartId;
/**
* The shell that must be active before this submission can be considered.
* This value can be <code>null</code>, which indicates that it should match
* any shell.
*/
private final Shell activeShell;
/**
* The workbench site that must be active before this submission can be
* considered. This value can be <code>null</code>, which indicates that it
* should match an workbench part site.
*/
private final IWorkbenchPartSite activeWorkbenchPartSite;
/**
* The identifier for the command which the submitted handler handles. This
* value cannot be <code>null</code>.
*/
private final String commandId;
/**
* The handler being submitted. This value cannot be <code>null</code>.
*/
private final IHandler handler;
/**
* The priority for this submission. In the event of all other factors
* being equal, the priority will be considered in an attempt to resolve
* conflicts. This value cannot be <code>null</code>.
*/
private final Priority priority;
/**
* A lazily computed cache of the string representation of this submission.
* This value is computed once; before it is computed, it is
* <code>null</code>.
*/
private transient String string;
/**
* Creates a new instance of this class.
*
* @param activePartId
* the identifier of the part that must be active for this
* request to be considered. May be <code>null</code>.
* @param activeShell
* the shell that must be active for this request to be
* considered. May be <code>null</code>.
* @param activeWorkbenchPartSite
* the workbench part site of the part that must be active for
* this request to be considered. May be <code>null</code>.
* @param commandId
* the identifier of the command to be handled. Must not be
* <code>null</code>.
* @param handler
* the handler. Must not be <code>null</code>.
* @param priority
* the priority. Must not be <code>null</code>.
*/
@Deprecated
public HandlerSubmission(String activePartId, Shell activeShell,
IWorkbenchPartSite activeWorkbenchPartSite, String commandId,
IHandler handler, Priority priority) {
if (commandId == null || handler == null || priority == null) {
throw new NullPointerException();
}
this.activePartId = activePartId;
this.activeShell = activeShell;
this.activeWorkbenchPartSite = activeWorkbenchPartSite;
this.commandId = commandId;
this.handler = handler;
this.priority = priority;
}
/**
* @see Comparable#compareTo(java.lang.Object)
*/
@Override
@Deprecated
public int compareTo(Object object) {
HandlerSubmission castedObject = (HandlerSubmission) object;
int compareTo = Util.compare(activeWorkbenchPartSite,
castedObject.activeWorkbenchPartSite);
if (compareTo == 0) {
compareTo = Util.compare(activePartId, castedObject.activePartId);
if (compareTo == 0) {
compareTo = Util.compare(activeShell, castedObject.activeShell);
if (compareTo == 0) {
compareTo = Util.compare(priority, castedObject.priority);
if (compareTo == 0) {
compareTo = Util.compare(commandId,
castedObject.commandId);
if (compareTo == 0) {
compareTo = Util.compare(handler,
castedObject.handler);
}
}
}
}
}
return compareTo;
}
/**
* Returns the identifier of the part that must be active for this request
* to be considered.
*
* @return the identifier of the part that must be active for this request
* to be considered. May be <code>null</code>.
*/
@Deprecated
public String getActivePartId() {
return activePartId;
}
/**
* Returns the shell that must be active for this request to be considered.
*
* @return the shell that must be active for this request to be considered.
* May be <code>null</code>.
*/
@Deprecated
public Shell getActiveShell() {
return activeShell;
}
/**
* Returns the workbench part site of the part that must be active for this
* request to be considered.
*
* @return the workbench part site of the part that must be active for this
* request to be considered. May be <code>null</code>.
*/
@Deprecated
public IWorkbenchPartSite getActiveWorkbenchPartSite() {
return activeWorkbenchPartSite;
}
/**
* Returns the identifier of the command to be handled.
*
* @return the identifier of the command to be handled. Guaranteed not to be
* <code>null</code>.
*/
@Deprecated
public String getCommandId() {
return commandId;
}
/**
* Returns the handler.
*
* @return the handler. Guaranteed not to be <code>null</code>.
*/
@Deprecated
public IHandler getHandler() {
return handler;
}
/**
* Returns the priority.
*
* @return the priority. Guaranteed not to be <code>null</code>.
*/
@Deprecated
public Priority getPriority() {
return priority;
}
/**
* @see Object#toString()
*/
@Override
public String toString() {
if (string == null) {
final StringBuilder stringBuffer = new StringBuilder();
stringBuffer.append("[activePartId="); //$NON-NLS-1$
stringBuffer.append(activePartId);
stringBuffer.append(",activeShell="); //$NON-NLS-1$
stringBuffer.append(activeShell);
stringBuffer.append(",activeWorkbenchSite="); //$NON-NLS-1$
stringBuffer.append(activeWorkbenchPartSite);
stringBuffer.append(",commandId="); //$NON-NLS-1$
stringBuffer.append(commandId);
stringBuffer.append(",handler="); //$NON-NLS-1$
stringBuffer.append(handler);
stringBuffer.append(",priority="); //$NON-NLS-1$
stringBuffer.append(priority);
stringBuffer.append(']');
string = stringBuffer.toString();
}
return string;
}
}
|
