public interface MCommand extends MApplicationElement, MLocalizable
A Command represents a logical operation within the applicaiton. The implementation is provided by an MHandler chosen by examining all the candidate's enablement.
The following features are supported:
Modifier and Type | Method and Description |
---|---|
MCategory |
getCategory()
Returns the value of the 'Category' reference
|
String |
getCommandName()
Returns the value of the 'Command Name' attribute
|
String |
getDescription()
Returns the value of the 'Description' attribute
|
String |
getLocalizedCommandName()
Returns the value of the 'Localized Command Name' attribute
|
String |
getLocalizedDescription()
Returns the value of the 'Localized Description' attribute
|
List<MCommandParameter> |
getParameters()
Returns the value of the 'Parameters' containment reference list.
|
void |
setCategory(MCategory value)
Sets the value of the '
Category ' reference |
void |
setCommandName(String value)
Sets the value of the '
Command Name ' attribute |
void |
setDescription(String value)
Sets the value of the '
Description ' attribute |
getContributorURI, getElementId, getPersistedState, getTags, getTransientData, setContributorURI, setElementId
updateLocalization
String getCommandName()
This field holds the command's name, used in the UI by default when there are menu or toolbar items representing this command.
setCommandName(String)
void setCommandName(String value)
Command Name
' attribute.
value
- the new value of the 'Command Name' attribute.getCommandName()
String getDescription()
This field holds the command's description, used in the UI when the commands being shown in dialogs....
setDescription(String)
void setDescription(String value)
Description
' attribute.
value
- the new value of the 'Description' attribute.getDescription()
List<MCommandParameter> getParameters()
MCommandParameter
.
This list defines the ste of parameters that this command expects to have defined during execution.
MCategory getCategory()
Developers: Add more detailed documentation by editing this comment in org.eclipse.ui.model.workbench/model/UIElements.ecore. There is a GenModel/documentation node under each type and attribute.
setCategory(MCategory)
void setCategory(MCategory value)
Category
' reference.
value
- the new value of the 'Category' reference.getCategory()
String getLocalizedCommandName()
String getLocalizedDescription()
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.