Class orion.shell.Shell
A Shell is a visual widget that provides a command line interface.
Commands can be registered in the Shell, and as a user types commands in its input
field the Shell provides visual hints about the expected arguments.
Defined in: </shared/eclipse/e4/orion/I201404012230/bundles/org.eclipse.orion.client.ui/web/orion/shell/Shell.js>.
Constructor Attributes | Constructor Name and Description |
---|---|
Method Attributes | Method Name and Description |
---|---|
clear()
Clears the Shell's output area.
|
|
output(content)
Renders HTML content in the Shell's output area.
|
|
registerCommand(command)
Registers a new command in the Shell.
|
|
registerType(type)
Registers a custom parameter type in the Shell.
|
|
Sets focus to the Shell's input area.
|
|
setInputText(value)
Populates the Shell's input area with a string value.
|
|
<inner> |
Shell(options)
Creates a new Shell.
|
Method Detail
clear()
Clears the Shell's output area.
output(content)
Renders HTML content in the Shell's output area.
- Parameters:
- {String} content
- the HTML content to output
registerCommand(command)
Registers a new command in the Shell.
- Parameters:
- {orion.shell.Command} command
- the command to register in the Shell
registerType(type)
Registers a custom parameter type in the Shell.
- Parameters:
- {orion.shell.ParameterType} type
- the parameter type to register in the Shell
setFocusToInput()
Sets focus to the Shell's input area.
setInputText(value)
Populates the Shell's input area with a string value.
- Parameters:
- value
<inner>
Shell(options)
Creates a new Shell.
- Parameters:
- {Object} options
- the options controlling the features of this Shell
- {Object} options.input
- the HTML element to parent the Shell's created input text on
- {Object} options.output
- the HTML element to parent the Shell's created output text on