blob: 320de08b00a1557ed0d0c0620ea8854f918a5fb4 (
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
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
|
/*******************************************************************************
* Copyright (c) 2000, 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;
/**
* <p>
* An instance of <code>IKeyConfiguration</code> is a handle representing a key
* configuration as defined by the extension point
* <code>org.eclipse.ui.commands</code>. The identifier of the handle is
* identifier of the key configuration being represented.
* </p>
* <p>
* An instance of <code>IKeyConfiguration</code> can be obtained from an
* instance of <code>ICommandManager</code> for any identifier, whether or not a
* key configuration with that identifier defined in the plugin registry.
* </p>
* <p>
* The handle-based nature of this API allows it to work well with runtime
* plugin activation and deactivation. If a key configuration is defined, that
* means that its corresponding plug-in is active. If the plug-in is then
* deactivated, the configuration will still exist but it will be undefined. An
* attempt to use an undefined key configuration will result in a
* <code>NotDefinedException</code> being thrown.
* </p>
* <p>
* This interface is not intended to be extended or implemented by clients.
* </p>
*
* @since 3.0
* @see IKeyConfigurationListener
* @see ICommandManager
* @see org.eclipse.jface.bindings.Scheme
* @deprecated Please use the bindings support in the "org.eclipse.jface"
* plug-in instead.
* @noimplement This interface is not intended to be implemented by clients.
*/
@Deprecated
@SuppressWarnings("all")
public interface IKeyConfiguration extends Comparable {
/**
* Registers an instance of <code>IKeyConfigurationListener</code> to listen for
* changes to attributes of this instance.
*
* @param keyConfigurationListener the instance of
* <code>IKeyConfigurationListener</code> to
* register. Must not be <code>null</code>. If
* an attempt is made to register an instance of
* <code>IKeyConfigurationListener</code> which
* is already registered with this instance, no
* operation is performed.
*/
@Deprecated
void addKeyConfigurationListener(IKeyConfigurationListener keyConfigurationListener);
/**
* <p>
* Returns the description of the key configuration represented by this handle,
* suitable for display to the user.
* </p>
* <p>
* Notification is sent to all registered listeners if this attribute changes.
* </p>
*
* @return the description of the key configuration represented by this handle.
* Guaranteed not to be <code>null</code>.
* @throws NotDefinedException if the key configuration represented by this
* handle is not defined.
*/
@Deprecated
String getDescription() throws NotDefinedException;
/**
* Returns the identifier of this handle.
*
* @return the identifier of this handle. Guaranteed not to be
* <code>null</code>.
*/
@Deprecated
String getId();
/**
* <p>
* Returns the name of the key configuration represented by this handle,
* suitable for display to the user.
* </p>
* <p>
* Notification is sent to all registered listeners if this attribute changes.
* </p>
*
* @return the name of the key configuration represented by this handle.
* Guaranteed not to be <code>null</code>.
* @throws NotDefinedException if the key configuration represented by this
* handle is not defined.
*/
@Deprecated
String getName() throws NotDefinedException;
/**
* <p>
* Returns the identifier of the parent of the key configuration represented by
* this handle.
* </p>
* <p>
* Notification is sent to all registered listeners if this attribute changes.
* </p>
*
* @return the identifier of the parent of the key configuration represented by
* this handle. May be <code>null</code>.
* @throws NotDefinedException if the key configuration represented by this
* handle is not defined.
*/
@Deprecated
String getParentId() throws NotDefinedException;
/**
* <p>
* Returns whether or not this command is active. Instances of
* <code>ICommand</code> are activated and deactivated by the instance of
* <code>ICommandManager</code> from whence they were brokered.
* </p>
* <p>
* Notification is sent to all registered listeners if this attribute changes.
* </p>
*
* @return <code>true</code>, iff this command is active.
*/
@Deprecated
boolean isActive();
/**
* <p>
* Returns whether or not the key configuration represented by this handle is
* defined.
* </p>
* <p>
* Notification is sent to all registered listeners if this attribute changes.
* </p>
*
* @return <code>true</code>, iff the key configuration represented by this
* handle is defined.
*/
@Deprecated
boolean isDefined();
/**
* Unregisters an instance of <code>IKeyConfigurationListener</code> listening
* for changes to attributes of this instance.
*
* @param keyConfigurationListener the instance of
* <code>IKeyConfigurationListener</code> to
* unregister. Must not be <code>null</code>. If
* an attempt is made to unregister an instance
* of <code>IKeyConfigurationListener</code>
* which is not already registered with this
* instance, no operation is performed.
*/
@Deprecated
void removeKeyConfigurationListener(IKeyConfigurationListener keyConfigurationListener);
}
|
