|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
IBindingService
and
IContextService
instead.
An instance of this interface provides support for managing contexts at the
IWorkbench
level. This provides the functionality necessary to
enabled contexts, disable or enabled the key binding service, as well as
register shells as particular types of windows.
This interface is not intended to be extended or implemented by clients.
IContextService
,
IBindingService
Field Summary | |
---|---|
static String |
CONTEXT_ID_DIALOG
Deprecated. The identifier for the context that is active when a shell registered as a dialog. |
static String |
CONTEXT_ID_DIALOG_AND_WINDOW
Deprecated. The identifier for the context that is active when a shell is registered as either a window or a dialog. |
static String |
CONTEXT_ID_WINDOW
Deprecated. The identifier for the context that is active when a shell is registered as a window. |
static int |
TYPE_DIALOG
Deprecated. The type used for registration indicating that the shell should be treated as a dialog. |
static int |
TYPE_NONE
Deprecated. The type used for registration indicating that the shell should not receive any key bindings be default. |
static int |
TYPE_WINDOW
Deprecated. The type used for registration indicating that the shell should be treated as a window. |
Method Summary | |
---|---|
void |
addEnabledSubmission(EnabledSubmission enabledSubmission)
Deprecated. Add a single enabled submission for consideration. |
void |
addEnabledSubmissions(Collection enabledSubmissions)
Deprecated. Adds zero or more enabled submissions for consideration. |
IContextManager |
getContextManager()
Deprecated. Returns the context manager for the workbench. |
int |
getShellType(Shell shell)
Deprecated. Returns the shell type for the given shell. |
boolean |
isKeyFilterEnabled()
Deprecated. Tests whether the global key binding architecture is currently active. |
void |
openKeyAssistDialog()
Deprecated. Opens the key assistant dialog positioned near the key binding entry in the status bar. |
boolean |
registerShell(Shell shell,
int type)
Deprecated. Registers a shell to automatically promote or demote some basic types of contexts. |
void |
removeEnabledSubmission(EnabledSubmission enabledSubmission)
Deprecated. Removes a single enabled submission from consideration. |
void |
removeEnabledSubmissions(Collection enabledSubmissions)
Deprecated. Removes a collection of enabled submissions from consideration. |
void |
setKeyFilterEnabled(boolean enabled)
Deprecated. Enables or disables the global key binding architecture. |
boolean |
unregisterShell(Shell shell)
Deprecated. Unregisters a shell that was previously registered. |
Field Detail |
public static final String CONTEXT_ID_DIALOG
public static final String CONTEXT_ID_DIALOG_AND_WINDOW
public static final String CONTEXT_ID_WINDOW
public static final int TYPE_DIALOG
public static final int TYPE_NONE
EnabledSubmission
instances for the
"In Dialogs" or "In Windows" contexts.
public static final int TYPE_WINDOW
Method Detail |
public void addEnabledSubmission(EnabledSubmission enabledSubmission)
Add a single enabled submission for consideration. An enabled submission is a description of certain criteria under which a particular context should become active. All added submissions will be check when the conditions in the workbench change, and zero or more contexts will be selected as active.
Just because an enabled submission is added, it does not mean that the corresponding context will become active. The workbench will consider the request, but other factors (such as conflicts) may prevent the context from becoming active.
enabledSubmission
- The enabled submission to be considered; must not be
null
.public void addEnabledSubmissions(Collection enabledSubmissions)
Adds zero or more enabled submissions for consideration. An enabled submission is a description of certain criteria under which a particular context should become active. All added submissions will be check when the conditions in the workbench change, and zero or more contexts will be selected as active.
Just because an enabled submission is added, it does not mean that the corresponding context will become active. The workbench will consider the request, but other factors (such as conflicts) may prevent the context from becoming active.
enabledSubmissions
- The enabled submissions to be considered; must not be
null
, but may be empty. Every element in the
collection must be an instance of
EnabledSubmission
.public IContextManager getContextManager()
null
.public int getShellType(Shell shell)
shell
- The shell for which the type should be determined. If this
value is null
, then
IWorkbenchContextSupport.TYPE_NONE
is returned.
IWorkbenchContextSupport.TYPE_WINDOW
,
IWorkbenchContextSupport.TYPE_DIALOG
, or
IWorkbenchContextSupport.TYPE_NONE
.public boolean isKeyFilterEnabled()
true
if the key bindings are active;
false
otherwise.public void openKeyAssistDialog()
public boolean registerShell(Shell shell, int type)
Registers a shell to automatically promote or demote some basic types of contexts. The "In Dialogs" and "In Windows" contexts are provided by the system. This a convenience method to ensure that these contexts are promoted when the given is shell is active.
If a shell is registered as a window, then the "In Windows" context is enabled when that shell is active. If a shell is registered as a dialog -- or is not registered, but has a parent shell -- then the "In Dialogs" context is enabled when that shell is active. If the shell is registered as none -- or is not registered, but has no parent shell -- then the neither of the contexts will be enabled (by us -- someone else can always enabled them).
If the provided shell has already been registered, then this method will change the registration.
shell
- The shell to register for key bindings; must not be
null
.type
- The type of shell being registered. This value must be one of
the constants given in this interface.
true
if the shell had already been registered
(i.e., the registration has changed); false
otherwise.public void removeEnabledSubmission(EnabledSubmission enabledSubmission)
Removes a single enabled submission from consideration. Only the same enabled submission will be removed; equivalent submissions will not be removed. Removing an enabled submission does not necessarily mean that the corresponding context will become inactive. It is possible that other parts of the application have requested that the context be enabled.
There is no way to disable a context. It is only possible to not enable it.
enabledSubmission
- The enabled submission to be removed; must not be
null
.public void removeEnabledSubmissions(Collection enabledSubmissions)
Removes a collection of enabled submissions from consideration. Only the same enabled submissions will be removed; equivalent submissions will not be removed. Removing an enabled submission does not necessarily mean that the corresponding context will become inactive. It is possible that other parts of the application have requested that the context be enabled.
There is no way to disable a context. It is only possible to not enable it.
enabledSubmissions
- The enabled submissions to be removed; must not be
null
, but may be empty. The collection must
only contain instances of EnabledSubmission
.public void setKeyFilterEnabled(boolean enabled)
enabled
- Whether the key filter should be enabled.public boolean unregisterShell(Shell shell)
Unregisters a shell that was previously registered. After this method completes, the shell will be treated as if it had never been registered at all. If you have registered a shell, you should ensure that this method is called when the shell is disposed. Otherwise, a potential memory leak will exist.
If the shell was never registered, or if the shell is null
,
then this method returns false
and does nothing.
shell
- The shell to be unregistered; does nothing if this value is
null
.
true
if the shell had been registered;
false
otherwise.
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.