Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.ui.commands
Interface ICommandManager


Deprecated. Please use the "org.eclipse.core.commands" plug-in instead.

public interface ICommandManager

An instance of ICommandManager can be used to obtain instances of ICommand, as well as manage whether or not those instances are active or inactive, enabled or disabled.

This interface is not intended to be extended or implemented by clients.

Since:
3.0
See Also:
ICommand, ICommandManagerListener, CommandManager
Restriction:
This interface is not intended to be implemented by clients.

Method Summary
 void addCommandManagerListener ( ICommandManagerListener commandManagerListener)
          Deprecated. Registers an instance of ICommandManagerListener to listen for changes to attributes of this instance.
  Set getActiveContextIds ()
          Deprecated. Returns the set of identifiers to active contexts.
  String getActiveKeyConfigurationId ()
          Deprecated. Returns the active key configuration.
  String getActiveLocale ()
          Deprecated. Returns the active locale.
  String getActivePlatform ()
          Deprecated. Returns the active platform.
  ICategory getCategory ( String categoryId)
          Deprecated. Returns a handle to a category given an identifier.
  ICommand getCommand ( String commandId)
          Deprecated. Returns a handle to a command given an identifier.
  Set getDefinedCategoryIds ()
          Deprecated.  Returns the set of identifiers to defined categories.
  Set getDefinedCommandIds ()
          Deprecated.  Returns the set of identifiers to defined commands.
  Set getDefinedKeyConfigurationIds ()
          Deprecated.  Returns the set of identifiers to defined key configurations.
  IKeyConfiguration getKeyConfiguration ( String keyConfigurationId)
          Deprecated. Returns a handle to a key configuration given an identifier.
  Map getPartialMatches ( KeySequence keySequence)
          Deprecated. Finds all of the commands which have key bindings that start with the given key sequence.
  String getPerfectMatch ( KeySequence keySequence)
          Deprecated. Finds the command which has the given key sequence as one of its key bindings.
 boolean isPartialMatch ( KeySequence keySequence)
          Deprecated. Checks to see whether there are any commands which have key bindings that start with the given key sequence.
 boolean isPerfectMatch ( KeySequence keySequence)
          Deprecated. Checks to see if there is a command with the given key sequence as one of its key bindings.
 void removeCommandManagerListener ( ICommandManagerListener commandManagerListener)
          Deprecated. Unregisters an instance of ICommandManagerListener listening for changes to attributes of this instance.
 

Method Detail

addCommandManagerListener

void addCommandManagerListener(
ICommandManagerListener commandManagerListener)
Deprecated. 
Registers an instance of ICommandManagerListener to listen for changes to attributes of this instance.

Parameters:
commandManagerListener - the instance of ICommandManagerListener to register. Must not be null. If an attempt is made to register an instance of ICommandManagerListener which is already registered with this instance, no operation is performed.

getActiveContextIds

Set getActiveContextIds()
Deprecated. 
Returns the set of identifiers to active contexts.

Notification is sent to all registered listeners if this property changes.

Returns:
the set of identifiers to active contexts. This set may be empty, but is guaranteed not to be null. If this set is not empty, it is guaranteed to only contain instances of String.

getActiveKeyConfigurationId

String getActiveKeyConfigurationId()
Deprecated. 
Returns the active key configuration.

Notification is sent to all registered listeners if this property changes.

Returns:
the active key configuration identifier. This set may be empty, but it is guaranteed to not be null. If this set is not empty, it is guaranteed to only contains instances of String.

getActiveLocale

String getActiveLocale()
Deprecated. 
Returns the active locale. While this property tends to be simply the result of Locale.getDefault() , it may also be changed at runtime by different implementations of command manager.

Notification is sent to all registered listeners if this property changes.

Returns:
the active locale. May be null.

getActivePlatform

String getActivePlatform()
Deprecated. 
Returns the active platform. While this property tends to be simply the result of SWT.getPlatform(), it may also be changed at runtime by different implementations of command manager.

Notification is sent to all registered listeners if this property changes.

Returns:
the active platform. May be null.

getCategory

ICategory getCategory(
String categoryId)
Deprecated. 
Returns a handle to a category given an identifier.

Parameters:
categoryId - an identifier. Must not be null
Returns:
a handle to a category.

getCommand

ICommand getCommand(
String commandId)
Deprecated. 
Returns a handle to a command given an identifier.

Parameters:
commandId - an identifier. Must not be null
Returns:
a handle to a command; never null.

getDefinedCategoryIds

Set getDefinedCategoryIds()
Deprecated. 

Returns the set of identifiers to defined categories.

Notification is sent to all registered listeners if this attribute changes.

Returns:
the set of identifiers to defined categories. This set may be empty, but is guaranteed not to be null. If this set is not empty, it is guaranteed to only contain instances of String.

getDefinedCommandIds

Set getDefinedCommandIds()
Deprecated. 

Returns the set of identifiers to defined commands.

Notification is sent to all registered listeners if this attribute changes.

Returns:
the set of identifiers to defined commands. This set may be empty, but is guaranteed not to be null. If this set is not empty, it is guaranteed to only contain instances of String.

getDefinedKeyConfigurationIds

Set getDefinedKeyConfigurationIds()
Deprecated. 

Returns the set of identifiers to defined key configurations.

Notification is sent to all registered listeners if this attribute changes.

Returns:
the set of identifiers to defined key configurations. This set may be empty, but is guaranteed not to be null. If this set is not empty, it is guaranteed to only contain instances of String.

getKeyConfiguration

IKeyConfiguration getKeyConfiguration(
String keyConfigurationId)
Deprecated. 
Returns a handle to a key configuration given an identifier.

Parameters:
keyConfigurationId - an identifier. Must not be null
Returns:
a handle to a key configuration.

getPartialMatches

Map getPartialMatches(
KeySequence keySequence)
Deprecated. 
Finds all of the commands which have key bindings that start with the given key sequence.

Parameters:
keySequence - The prefix to look for; must not be null.
Returns:
A map of all of the matching key sequences ( KeySequence) to command identifiers ( String). This map may be empty, but it is never null.

getPerfectMatch

String getPerfectMatch(
KeySequence keySequence)
Deprecated. 
Finds the command which has the given key sequence as one of its key bindings.

Parameters:
keySequence - The key binding to look for; must not be null.
Returns:
The command id for the matching command, if any; null if none.

isPartialMatch

boolean isPartialMatch(
KeySequence keySequence)
Deprecated. 
Checks to see whether there are any commands which have key bindings that start with the given key sequence.

Parameters:
keySequence - The prefix to look for; must not be null.
Returns:
true if at least one command has a key binding that starts with keySequence;false otherwise.

isPerfectMatch

boolean isPerfectMatch(
KeySequence keySequence)
Deprecated. 
Checks to see if there is a command with the given key sequence as one of its key bindings.

Parameters:
keySequence - The key binding to look for; must not be null.
Returns:
true if a command has a matching key binding; false otherwise.

removeCommandManagerListener

void removeCommandManagerListener(
ICommandManagerListener commandManagerListener)
Deprecated. 
Unregisters an instance of ICommandManagerListener listening for changes to attributes of this instance.

Parameters:
commandManagerListener - the instance of ICommandManagerListener to unregister. Must not be null. If an attempt is made to unregister an instance of ICommandManagerListener which is not already registered with this instance, no operation is performed.

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire