Class Index | File Index

Classes


Class orion.commands.ParametersDescription


Defined in: </jobs/genie.orion/orion-client-stable/workspace/bundles/org.eclipse.orion.client.ui/web/orion/commandRegistry.js>.

Class Summary
Constructor Attributes Constructor Name and Description
 
orion.commands.ParametersDescription(parameters, options, getParameters)
A ParametersDescription defines the parameters required by a command, and whether there are additional optional parameters that can be specified.
Method Summary
Method Attributes Method Name and Description
 
forEach(func)
Evaluate the specified function for each parameter.
 
Return a boolean indicating whether additional optional parameters are available.
 
Returns a boolean indicating whether any parameters have been specified.
 
Make a copy of this description.
 
Returns the CommandParameter with the given name, or null if there is no parameter by that name.
 
setValue(name, value)
Sets the value of the parameter with the given name.
 
Returns a boolean indicating whether a collector should try to collect parameters.
 
updateParameters(commandInvocation)
Update the stored parameters by running the stored function if one has been supplied.
 
validate(name, value)
 
valueFor(name)
Returns the value of the parameter with the given name, or null if there is no parameter by that name, or no value for that parameter.
Class Detail
orion.commands.ParametersDescription(parameters, options, getParameters)
A ParametersDescription defines the parameters required by a command, and whether there are additional optional parameters that can be specified. The command registry will attempt to collect required parameters before calling a command callback. The command is expected to provide UI for optional parameter, when the user has signaled a desire to provide optional information.
Parameters:
{orion.commands.CommandParameter[]} parameters
an array of CommandParameters that are required
{Object} options
The parameters description options object.
{Boolean} options.hasOptionalParameters
specifies whether there are additional optional parameters that could be collected. If true, then the collector will show an affordance for invoking an additional options collector and the client can use the optionsRequested flag to determine whether additional parameters should be shown. Default is false.
{Boolean} options.clientCollect
specifies whether the client will collect the parameters in its callback. Default is false, which means the callback will not be called until an attempt has been made to collect parameters.
{Function} options.getParameterElement
a function used to look up the DOM element for a given parameter.
{Function} options.getSubmitName
a function used to return a name to use for the Submit button.
{Function} getParameters Optional
a function used to define the parameters just before the command is invoked. This is used when a particular invocation of the command will change the parameters. The function will be passed the CommandInvocation as a parameter. Any stored parameters will be ignored, and replaced with those returned by this function. If no parameters (empty array or null) are returned, then it is assumed that the command should not try to obtain parameters before invoking the command's callback (similar to options.clientCollect === true).
Method Detail
forEach(func)
Evaluate the specified function for each parameter.
Parameters:
{Function} func
a function which operates on a provided command parameter

hasOptionalParameters()
Return a boolean indicating whether additional optional parameters are available.

{Boolean} hasParameters()
Returns a boolean indicating whether any parameters have been specified.
Returns:
{Boolean} whether there are parameters to collect.

makeCopy()
Make a copy of this description. Used for collecting values when a client doesn't want the values to be persisted across different objects.

{orion.commands.CommandParameter} parameterNamed(name)
Returns the CommandParameter with the given name, or null if there is no parameter by that name.
Parameters:
{String} name
the name of the parameter
Returns:
{orion.commands.CommandParameter} the parameter with the given name

setValue(name, value)
Sets the value of the parameter with the given name.
Parameters:
{String} name
the name of the parameter
{String} value
the value of the parameter with the given name

{Boolean} shouldCollectParameters()
Returns a boolean indicating whether a collector should try to collect parameters. If there are no parameters specified, or the client is expecting to collect them, this will return false.
Returns:
{Boolean} indicating whether the caller should attempt to collect the parameters.

updateParameters(commandInvocation)
Update the stored parameters by running the stored function if one has been supplied.
Parameters:
commandInvocation

validate(name, value)
Parameters:
name
value

{String} valueFor(name)
Returns the value of the parameter with the given name, or null if there is no parameter by that name, or no value for that parameter.
Parameters:
{String} name
the name of the parameter
Returns:
{String} the value of the parameter with the given name

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Mar 17 2017 08:51:34 GMT-0400 (EDT)