|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Provides services related to the command architecture within the workbench. This service can be used to access the set of commands and command categories.
This interface should not be implemented or extended by clients.
Method Summary | |
---|---|
void |
addExecutionListener(IExecutionListener listener)
Adds an execution listener to the command service. |
Category |
getCategory(String categoryId)
Retrieves the category with the given identifier. |
Command |
getCommand(String commandId)
Retrieves the command with the given identifier. |
Collection |
getDefinedCategoryIds()
Returns the collection of the identifiers for all of the defined categories in the workbench. |
Collection |
getDefinedCommandIds()
Returns the collection of the identifiers for all of the defined commands in the workbench. |
void |
readRegistry()
Reads the command information from the registry and the preferences. |
void |
removeExecutionListener(IExecutionListener listener)
Removes an execution listener from the command service. |
Method Detail |
public void addExecutionListener(IExecutionListener listener)
listener
- The listener to add; must not be null
.public Category getCategory(String categoryId)
categoryId
- The identifier to find; must not be null
.
public Command getCommand(String commandId)
commandId
- The identifier to find; must not be null
.
public Collection getDefinedCategoryIds()
String
)
that are defined; never null
, but may be empty.public Collection getDefinedCommandIds()
String
)
that are defined; never null
, but may be empty.public void readRegistry()
Reads the command information from the registry and the preferences. This will overwrite any of the existing information in the command service. This method is intended to be called during start-up. When this method completes, this command service will reflect the current state of the registry and preference store.
public void removeExecutionListener(IExecutionListener listener)
listener
- The listener to remove; must not be null
.
|
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.