Class orion.commands.CommandParameter
Defined in: </shared/eclipse/e4/orion/I201404012230/bundles/org.eclipse.orion.client.ui/web/orion/commandRegistry.js>.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
orion.commands.CommandParameter(name, type, label, value, lines, eventListeners)
A CommandParameter defines a parameter that is required by a command.
|
| Method Attributes | Method Name and Description |
|---|---|
|
Returns whether the user has requested to assign values to optional parameters
|
Class Detail
orion.commands.CommandParameter(name, type, label, value, lines, eventListeners)
A CommandParameter defines a parameter that is required by a command.
- Parameters:
- {String} name
- the name of the parameter
- {String} type
- the type of the parameter, one of the HTML5 input types, or "boolean"
- {String} label Optional
- the (optional) label that should be used when showing the parameter
- {String} value Optional
- the (optional) default value for the parameter
- {Number} lines Optional
- the (optional) number of lines that should be shown when collecting the value. Valid for type "text" only.
- {Object|Array} eventListeners Optional
- the (optional) array or single command event listener
Method Detail
{Boolean}
optionsRequested()
Returns whether the user has requested to assign values to optional parameters
- Returns:
- {Boolean} whether the user has requested optional parameters