Java Doc for ICommandManager.java in » IDE-Eclipse » ui-workbench » org » eclipse » ui » commands » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » IDE Eclipse » ui workbench » org.eclipse.ui.commands

Source Cross Reference Class Diagram Java Document (Java Doc)

org.eclipse.ui.commands .ICommandManager

All known Subclasses:   org.eclipse.ui.internal.commands .CommandManagerLegacyWrapper,
ICommandManager
public interface ICommandManager (Code)

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:   org.eclipse.ui.commands.ICommand
See Also:   org.eclipse.ui.commands.ICommandManagerListener
See Also:   org.eclipse.core.commands.CommandManager

Method Summary
void addCommandManagerListener(ICommandManagerListener commandManagerListener)
     Registers an instance of ICommandManagerListener to listen for changes to attributes of this instance.
Parameters:
  commandManagerListener - the instance of ICommandManagerListener toregister.
Set getActiveContextIds()
     Returns the set of identifiers to active contexts.
Notification is sent to all registered listeners if this property changes.
the set of identifiers to active contexts.
String getActiveKeyConfigurationId()
     Returns the active key configuration.
Notification is sent to all registered listeners if this property changes.
the active key configuration identifier.
String getActiveLocale()
     Returns the active locale.
String getActivePlatform()
     Returns the active platform.
ICategory getCategory(String categoryId)
     Returns a handle to a category given an identifier.
Parameters:
  categoryId - an identifier.
ICommand getCommand(String commandId)
     Returns a handle to a command given an identifier.
Parameters:
  commandId - an identifier.
Set getDefinedCategoryIds()

Returns the set of identifiers to defined categories.

Notification is sent to all registered listeners if this attribute changes.
the set of identifiers to defined categories.
Set getDefinedCommandIds()

Returns the set of identifiers to defined commands.

Notification is sent to all registered listeners if this attribute changes.
the set of identifiers to defined commands.
Set getDefinedKeyConfigurationIds()

Returns the set of identifiers to defined key configurations.

Notification is sent to all registered listeners if this attribute changes.
the set of identifiers to defined key configurations.
IKeyConfiguration getKeyConfiguration(String keyConfigurationId)
     Returns a handle to a key configuration given an identifier.
Parameters:
  keyConfigurationId - an identifier.
Map getPartialMatches(KeySequence keySequence)
     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.
String getPerfectMatch(KeySequence keySequence)
     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.
boolean isPartialMatch(KeySequence keySequence)
     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.
boolean isPerfectMatch(KeySequence keySequence)
     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.
void removeCommandManagerListener(ICommandManagerListener commandManagerListener)
     Unregisters an instance of ICommandManagerListener listening for changes to attributes of this instance.
Parameters:
  commandManagerListener - the instance of ICommandManagerListener tounregister.

Method Detail
addCommandManagerListener
void addCommandManagerListener(ICommandManagerListener commandManagerListener)(Code)
Registers an instance of ICommandManagerListener to listen for changes to attributes of this instance.
Parameters:
  commandManagerListener - the instance of ICommandManagerListener toregister. Must not be null. If an attempt ismade to register an instance ofICommandManagerListener which is alreadyregistered with this instance, no operation is performed.

getActiveContextIds
Set getActiveContextIds()(Code)
Returns the set of identifiers to active contexts.
Notification is sent to all registered listeners if this property changes.
the set of identifiers to active contexts. This set may beempty, but is guaranteed not to be null. If thisset is not empty, it is guaranteed to only contain instances ofString.

getActiveKeyConfigurationId
String getActiveKeyConfigurationId()(Code)
Returns the active key configuration.
Notification is sent to all registered listeners if this property changes.
the active key configuration identifier. This set may be empty,but it is guaranteed to not be null. If this setis not empty, it is guaranteed to only contains instances ofString.

getActiveLocale
String getActiveLocale()(Code)
Returns the active locale. While this property tends to be simply the result of java.util.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.
the active locale. May be null.

getActivePlatform
String getActivePlatform()(Code)
Returns the active platform. While this property tends to be simply the result of org.eclipse.swt.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.
the active platform. May be null.

getCategory
ICategory getCategory(String categoryId)(Code)
Returns a handle to a category given an identifier.
Parameters:
  categoryId - an identifier. Must not be null a handle to a category.

getCommand
ICommand getCommand(String commandId)(Code)
Returns a handle to a command given an identifier.
Parameters:
  commandId - an identifier. Must not be null a handle to a command; never null.

getDefinedCategoryIds
Set getDefinedCategoryIds()(Code)

Returns the set of identifiers to defined categories.

Notification is sent to all registered listeners if this attribute changes.
the set of identifiers to defined categories. This set may beempty, but is guaranteed not to be null. If thisset is not empty, it is guaranteed to only contain instances ofString.

getDefinedCommandIds
Set getDefinedCommandIds()(Code)

Returns the set of identifiers to defined commands.

Notification is sent to all registered listeners if this attribute changes.
the set of identifiers to defined commands. This set may beempty, but is guaranteed not to be null. If thisset is not empty, it is guaranteed to only contain instances ofString.

getDefinedKeyConfigurationIds
Set getDefinedKeyConfigurationIds()(Code)

Returns the set of identifiers to defined key configurations.

Notification is sent to all registered listeners if this attribute changes.
the set of identifiers to defined key configurations. This setmay be empty, but is guaranteed not to be null.If this set is not empty, it is guaranteed to only containinstances of String.

getKeyConfiguration
IKeyConfiguration getKeyConfiguration(String keyConfigurationId)(Code)
Returns a handle to a key configuration given an identifier.
Parameters:
  keyConfigurationId - an identifier. Must not be null a handle to a key configuration.

getPartialMatches
Map getPartialMatches(KeySequence keySequence)(Code)
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. A map of all of the matching key sequences (KeySequence) to command identifiers (String). This map may be empty, but it is nevernull.

getPerfectMatch
String getPerfectMatch(KeySequence keySequence)(Code)
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. The command id for the matching command, if any;null if none.

isPartialMatch
boolean isPartialMatch(KeySequence keySequence)(Code)
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. true if at least one command has a key bindingthat starts with keySequence;falseotherwise.

isPerfectMatch
boolean isPerfectMatch(KeySequence keySequence)(Code)
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. true if a command has a matching key binding;false otherwise.

removeCommandManagerListener
void removeCommandManagerListener(ICommandManagerListener commandManagerListener)(Code)
Unregisters an instance of ICommandManagerListener listening for changes to attributes of this instance.
Parameters:
  commandManagerListener - the instance of ICommandManagerListener tounregister. Must not be null. If an attempt ismade to unregister an instance ofICommandManagerListener which is not alreadyregistered with this instance, no operation is performed.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.