Class Index | File Index

Classes


Class orion.commands.CommandInvocation

Carries information about a command invocation.
Defined in: </jobs/genie.orion/orion-client-stable/workspace/bundles/org.eclipse.orion.client.ui/web/orion/commands.js>.

Class Summary
Constructor Attributes Constructor Name and Description
 
orion.commands.CommandInvocation(handler, items, userData, command, commandRegistry)
CommandInvocation is a data structure that carries all relevant information about a command invocation.
Field Summary
Field Attributes Field Name and Description
 
 
 
 
 
 
Method Summary
Method Attributes Method Name and Description
 
Returns whether this command invocation can collect parameters.
 
makeCopy(parameters)
Makes and returns a (shallow) copy of this command invocation.
Class Detail
orion.commands.CommandInvocation(handler, items, userData, command, commandRegistry)
CommandInvocation is a data structure that carries all relevant information about a command invocation. It represents a unique invocation of a command by the user. Each time a user invokes a command (by click, keystroke, URL), a new invocation is passed to the client.

Note: When retrieving parameters from a command invocation, clients should always use #parameters rather than obtaining the parameter object originally specified for the command (using #command.parameters). This ensures that the parameter values for a unique invocation are used vs. any default parameters that may have been specified originally. Similarly, if a client wishes to store data that will preserved across multiple invocations of a command, that data can be stored in the original parameters description and a reference maintained by the client.

Parameters:
{Object} handler
{Array} items
{Object} userData Optional
{orion.commands.Command} command
{orion.commandregistry.CommandRegistry} commandRegistry Optional
Field Detail
{orion.commands.Command} command

{orion.commandregistry.CommandRegistry} commandRegistry

{Object} handler

{Array} items

{orion.commands.ParametersDescription} parameters

{Object} userData
Method Detail
{Boolean} collectsParameters()
Returns whether this command invocation can collect parameters.
Returns:
{Boolean} whether parameters can be collected

makeCopy(parameters)
Makes and returns a (shallow) copy of this command invocation.
Parameters:
{orion.commands.ParametersDescription} parameters
A description of parameters to be used in the copy. Optional. If not specified, then the existing parameters should be copied.

Documentation generated by JsDoc Toolkit 2.4.0 on Wed Jan 18 2017 12:15:08 GMT-0500 (EST)