Class Index | File Index

Classes


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/I201210191304/plugins/org.eclipse.orion.client.core/web/orion/widgets/Shell.js>.

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
 
output(content)
Renders HTML content in the Shell's output area.
 
registerCommand(command)
Registers a new command in the Shell.
 
Registers a custom parameter type in the Shell.
 
Sets focus to the Shell's input area.
<inner>  
Shell(options)
Creates a new Shell.
Class Detail
orion.shell.Shell()
Method Detail
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

setFocus()
Sets focus to the Shell's input area.

<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

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Oct 19 2012 13:08:15 GMT-0400 (EDT)