Class orion.commandregistry.ParameterCollector
Defined in: </shared/eclipse/e4/orion/I201404012230/bundles/org.eclipse.orion.client.ui/web/orion/commandRegistry.js>.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Interface for a parameter collector.
|
| Method Attributes | Method Name and Description |
|---|---|
|
close()
Closes any active parameter collectors.
|
|
|
collectParameters(commandInvocation)
Collect parameters for the given command.
|
|
|
getFillFunction(the, closeFunction)
Returns a function that can be used to fill a specified parent node with parameter information.
|
|
|
open(commandNode, fillFunction, onClose)
Open a parameter collector and return the dom node where parameter information should be inserted.
|
Method Detail
close()
Closes any active parameter collectors.
{Boolean}
collectParameters(commandInvocation)
Collect parameters for the given command.
- Parameters:
- {orion.commands.CommandInvocation} commandInvocation
- The command invocation
- Returns:
- {Boolean} Whether or not required parameters were collected.
{Function}
getFillFunction(the, closeFunction)
Returns a function that can be used to fill a specified parent node with parameter information.
- Parameters:
- {orion.commands.CommandInvocation} the
- command invocation used when gathering parameters
- {Function} closeFunction
- an optional function called when the area must be closed.
- Returns:
- {Function} a function that can fill the specified dom node with parameter collection behavior
{Boolean}
open(commandNode, fillFunction, onClose)
Open a parameter collector and return the dom node where parameter information should be inserted.
- Parameters:
- {String|DOMElement} commandNode
- the node containing the triggering command
- {Function} fillFunction
- a function that will fill the parameter area
- {Function} onClose
- a function that will be called when the parameter area is closed
- Returns:
- {Boolean} Whether the node is open.