Class Index | File Index

Classes


Built-In Namespace _global_

Field Summary
Field Attributes Field Name and Description
 
Keeps a record of the 'invocation' object for a renderred command.
 
This is an override of the normal addEventListener to allow it to keep listeners synch'd with the current binding overrides whether or not they get added before or after the actual binding overrides have been retrieved from the preference store.
 
Creates a new content assist manager for the given text view
 
Creates an override for the binding of a particular Command or Text Action.
 
Object that is responsible for verifying JavaScript text
 
Quietly expect a comma when in tolerant mode, otherwise delegates to expect(value)
 
Formats the origin into a readable string that can fit in content assist.
 
Return an {Object} containing all active environments in the given ast based on eslint env and global settings
 
returns the binding that the given id should be overridden with (or null if no override exists).
 
Returns the rule object for ESLint
 
Return the best contentType match to the given filename or null if no match.
 
Returns a completion proposal for the given type object or null if no proposal should be added
 
The raw rule object
 
 
Creates a new TernServer
 
 
Matches a comment delimiter (*) as the start of the line, and traverses up the lines to confirm if it is a multi-line comment by matching the start of a block comment.
 
orion.shell.CompletionStatus.PARTIAL the current text matches a subset of the initial characters of a valid argument value (ie.- a value in the midst of being typed) the current text matches a subset of the initial characters of a valid argument value (ie.- a value in the midst of being typed)
 
p
 
Returns the pixel value of the given CSS attribute
 
Add the error if not already reported.
 
Generates an explorer showing the sites on each site service.
 
 
 
Creates a new TernServer
 
Tooltip support for text views show() - Opens the tooltip update() - Updates the content of the open tooltip onHover() - Checks if the x,y coordinates are outside the current tooltip area and updates the tooltip if necessary hide() - Closes the tooltip isVisible() - Returns whether the tooltip is currently showing The methods above ask for a tooltipInfo object, which must contain a callback function getTooltipInfo() This function must return an info object with the following contents: Info { Contents {string, html element, annotation array, etc.
 
Method Summary
Method Attributes Method Name and Description
 
_update(input)
 
assert(cond, text)
 
b(a)
 
c(a, b, d)
 
 
constructor(start, end, title)
 
e(a, b)
 
wraps logging in case we have the worker support turned on
 
f(b)
 
g()
 
get(namespace, key, options)
Gets one or more preferences from the node specified by namespace.
 
Get the file client;
 
Returns an editable ruleset to pass into verify() based on values set in the config settings
 
handleClosingBracket(closingChar)
When the user types a closing bracket we should skip auto-paired brackets and reduce indenting if we are on a new line.
 
handler(event)
 
handleResult(result)
 
 
hide()
Hides the current tooltip (if it's showing)
 
 
isArray(array)
 
Return whether the given x/y pixel position, relative to the document, is inside of document text.
 
Returns a boolean indicating whether the tooltip is currently visible
 
 
log()
wraps logging in case we have the worker support turned on
 
nud()
 
 
 
onconnect(evnt)
Worker callback when a shared worker starts up
 
onerror(evnt)
Worker callback when an error occurs
 
onHover(tooltipInfo, x, y)
Checks the x,y location and updates the tooltip contents or hides the tooltip as appropriate
 
 
onmessage(evnt)
Worker callback when a message is sent to the worker
 
put(namespace, data, options)
Sets multiple preferences in the node specified by namespace.
 
r(a, b, d)
 
remove(namespace, key, options)
Removes one or more preferences in the node specified by namespace.
 
resolveModule(server, name, parent)
 
show(tooltipInfo, target, locked, giveFocus)
Show the tooltip using the given target information
 
skip()
 
sliceSource(source, index, last)
 
statusReporter(message, isError)
 
u(a)
 
update(tooltipInfo, noContent)
Updates the information in an already visible tooltip
 
z(a)
Field Detail
_registerRenderedCommand
Keeps a record of the 'invocation' object for a renderred command. The invocation contains a lot of information about the rendered item (including the DOM element created to show it). This is currently used to update the menu item's key binding info if its binding changes.
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.ui/web/orion/commandRegistry.js>.

addEventListener
This is an override of the normal addEventListener to allow it to keep listeners synch'd with the current binding overrides whether or not they get added before or after the actual binding overrides have been retrieved from the preference store. Once the overrides preference is loaded any currently registered listeners are informed of the current binding overrides. Subsequent listeners are also imformed when they get added.
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.ui/web/orion/commandRegistry.js>.

ContentAssist
Creates a new content assist manager for the given text view
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.editor/web/orion/editor/contentAssist.js>.

createBindingOverride
Creates an override for the binding of a particular Command or Text Action.
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.ui/web/orion/commandRegistry.js>.

eslint
Object that is responsible for verifying JavaScript text
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.javascript/web/javascript/plugins/javascriptPlugin.js.src.js>.

expectCommaSeparator
Quietly expect a comma when in tolerant mode, otherwise delegates to expect(value)
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.javascript/web/javascript/plugins/javascriptPlugin.js.src.js>.
Since:
2.0

formatOrigin
Formats the origin into a readable string that can fit in content assist.
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.javascript/web/javascript/contentAssist/ternAssist.js>.

getActiveEnvironments
Return an {Object} containing all active environments in the given ast based on eslint env and global settings
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.javascript/web/javascript/ternPlugins/jsdoc.js>.

getBindingOverride
returns the binding that the given id should be overridden with (or null if no override exists). Note that this method is only valid for Commands, not Text Actions,
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.ui/web/orion/commandRegistry.js>.

{Object} getESLintRules
Returns the rule object for ESLint
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.javascript/web/javascript/plugins/javascriptPlugin.js.src.js>.
Since:
7.0

getFilenameContentType
Return the best contentType match to the given filename or null if no match. Filename pattern checked first, then extension
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.core/web/orion/contentTypes.js>.

getProposalForType
Returns a completion proposal for the given type object or null if no proposal should be added
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.javascript/web/javascript/ternPlugins/jsdoc.js>.

{Object} getRules
The raw rule object
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.javascript/web/javascript/plugins/javascriptPlugin.js.src.js>.

hasOwnProperty

Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.javascript/web/javascript/plugins/javascriptPlugin.js.src.js>.

{TernServer} JavaScript
Creates a new TernServer
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.javascript/web/javascript/api/javaScript.js>.
Since:
11.0

JSLINT

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

match
Matches a comment delimiter (*) as the start of the line, and traverses up the lines to confirm if it is a multi-line comment by matching the start of a block comment. If so, continue the multi-line comment in the next line. Any text that follows after the caret is moved to the newly added comment delimiter.
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.editor/web/orion/editor/actions.js>.

orion.shell.CompletionStatus.PARTIAL the current text matches a subset of the initial characters of a valid argument value (ie.- a value in the midst of being typed)

Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.ui/web/orion/shell/Shell.js>.

p

Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.javascript/web/javascript/plugins/built-javascriptPlugin.js>.

pixelValueOf
Returns the pixel value of the given CSS attribute
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.ui/web/orion/webui/littlelib.js>.

recordError
Add the error if not already reported.
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.javascript/web/javascript/plugins/javascriptPlugin.js.src.js>.
Since:
5.0

SiteServicesExplorer
Generates an explorer showing the sites on each site service.
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.ui/web/orion/sites/sitesExplorer.js>.

SitesRenderer

Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.ui/web/orion/sites/sitesExplorer.js>.

SiteTreeModel

Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.ui/web/orion/sites/sitesExplorer.js>.

{TernServer} TernServer
Creates a new TernServer
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.javascript/web/javascript/api/ternServer.js>.

Tooltip
Tooltip support for text views show() - Opens the tooltip update() - Updates the content of the open tooltip onHover() - Checks if the x,y coordinates are outside the current tooltip area and updates the tooltip if necessary hide() - Closes the tooltip isVisible() - Returns whether the tooltip is currently showing The methods above ask for a tooltipInfo object, which must contain a callback function getTooltipInfo() This function must return an info object with the following contents: Info { Contents {string, html element, annotation array, etc.} Contents to display, if undefined, the hover service will be asked for content Context {source, offset, offsetStart, offsetEnd}} Information used to modify the tooltip position or contents Position {String} One of left, right, top, bottom used to position the tooltip relative to the anchor area AnchorArea {top, left, width, height} rectangle defining the source of the tooltip and where to position relative to TooltipArea {top, left, width, height} rectangle to define the tooltip's exact placement rather than a relative position to the anchor TooltipOffsetX {Number} Hint to move the tooltip position horizontally TooltipOffsetY {Number} Hint to move the tooltip position vertically
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.editor/web/orion/editor/tooltip.js>.

workerReady

Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.javascript/web/javascript/plugins/javascriptPlugin.js>.
Method Detail
_update(input)

Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.webtools/web/webtools/plugins/webToolsPlugin.js.src.js>.
Parameters:
input

assert(cond, text)

Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.javascript/web/javascript/plugins/javascriptPlugin.js.src.js>.
Parameters:
cond
text

b(a)

Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.javascript/web/javascript/plugins/built-javascriptPlugin.js>.
Parameters:
a

c(a, b, d)

Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.javascript/web/javascript/plugins/built-javascriptPlugin.js>.
Parameters:
a
b
d

closeFunction()

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

constructor(start, end, title)

Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.editor/web/orion/editor/annotations.js>.
Parameters:
start
end
title

e(a, b)

Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.javascript/web/javascript/plugins/built-javascriptPlugin.js>.
Parameters:
a
b

error()
wraps logging in case we have the worker support turned on
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.javascript/web/javascript/plugins/javascriptPlugin.js.src.js>.
Since:
7.0

f(b)

Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.javascript/web/javascript/plugins/built-javascriptPlugin.js>.
Parameters:
b

g()

Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.javascript/web/javascript/plugins/built-javascriptPlugin.js>.

get(namespace, key, options)
Gets one or more preferences from the node specified by namespace.
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.core/web/orion/preferences.js>.
Parameters:
{String} namespace
A slash-delimited path to the preference node to get
{String|Array|Object} key Optional, Default: undefined
the key, or array of keys, or an object specifying the default values of the keys to get. An empty array or object will return an empty object. Pass in null or undefined
options
the options object
Returns:
A promise that will resolve when the preferences has been retrivied. The promise result is an object with key-value mappings.

{orion.FileClient} getFileClient()
Get the file client;
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.ui/web/orion/searchClient.js>.
Returns:
{orion.FileClient} returns a file client

{Object} getRuleSet()
Returns an editable ruleset to pass into verify() based on values set in the config settings
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.webtools/web/webtools/plugins/webToolsPlugin.js.src.js>.
Returns:
{Object} A ruleset based on the config settings

handleClosingBracket(closingChar)
When the user types a closing bracket we should skip auto-paired brackets and reduce indenting if we are on a new line.
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.editor/web/orion/editor/actions.js>.
Parameters:
closingChar
{String} the closing bracket character
Returns:
returns true to skip printing the closing bracket, false to print it

handler(event)

Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.ui/web/orion/sites/siteMappingsTable.js>.
Parameters:
event

handleResult(result)

Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.ui/web/orion/editorCommands.js>.
Parameters:
result

hasNext()

Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.webtools/web/webtools/plugins/webToolsPlugin.js.src.js>.

hide()
Hides the current tooltip (if it's showing)
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.editor/web/orion/editor/tooltip.js>.

insensitive(str)

Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.ui/web/orion/keyAssist.js>.
Parameters:
str

isArray(array)

Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.javascript/web/javascript/plugins/javascriptPlugin.js.src.js>.
Parameters:
array

isValidTextPosition(x, y)
Return whether the given x/y pixel position, relative to the document, is inside of document text. This tests both whether the y position is below the text lines of the document as we as whether the x position is within the text of the line.
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.editor/web/orion/editor/textView.js>.
Parameters:
x
{Number} [x] the x pixel position
y
{Number} [y] the line pixel position
Returns:
returns {Boolean} true if the pixel position is over text content

{boolean} isVisible()
Returns a boolean indicating whether the tooltip is currently visible
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.editor/web/orion/editor/tooltip.js>.
Returns:
{boolean} 'true' iff the tooltip is currently visible

listener()

Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.git/web/orion/git/widgets/gitCommitList.js>.

log()
wraps logging in case we have the worker support turned on
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.javascript/web/javascript/plugins/javascriptPlugin.js.src.js>.
Since:
7.0

nud()

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

onchange(e)

Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.ui/web/orion/widgets/themes/ThemeBuilder.js>.
Parameters:
e

onClickThen(doIt)

Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.ui/web/orion/commands.js>.
Parameters:
doIt

onconnect(evnt)
Worker callback when a shared worker starts up
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.javascript/web/javascript/plugins/ternWorkerCore.js>.
Parameters:
evnt

onerror(evnt)
Worker callback when an error occurs
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.javascript/web/javascript/plugins/ternWorkerCore.js>.
Parameters:
evnt

onHover(tooltipInfo, x, y)
Checks the x,y location and updates the tooltip contents or hides the tooltip as appropriate
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.editor/web/orion/editor/tooltip.js>.
Parameters:
tooltipInfo
a function that will return the parameters need to update the information (see _processInfo())
x
coordinates of the mouse event
y
coordinates of the mouse event

onload()

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

onmessage(evnt)
Worker callback when a message is sent to the worker
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.javascript/web/javascript/plugins/ternWorkerCore.js>.
Parameters:
evnt

put(namespace, data, options)
Sets multiple preferences in the node specified by namespace.
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.core/web/orion/preferences.js>.
Parameters:
{String} namespace
A slash-delimited path to the preference node to update
data
An object with key-value pairs to update. Any other key/value pairs in the node will not be affected unless the options clear is set.
options
the options object
Returns:
A promise that will resolve when the preferences has been updated.

r(a, b, d)

Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.javascript/web/javascript/plugins/built-javascriptPlugin.js>.
Parameters:
a
b
d

remove(namespace, key, options)
Removes one or more preferences in the node specified by namespace.
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.core/web/orion/preferences.js>.
Parameters:
{String} namespace
A slash-delimited path to the preference node to update
{String|Array|Object} key Optional, Default: undefined
the key, or array of keys, or an object specifying the the keys to remove. An empty array or object will remove nothing. Pass in null or undefined to remove all the preferences of the specified node.
options
the options object
Returns:
A promise that will resolve when the preferences has been updated.

resolveModule(server, name, parent)

Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.javascript/web/javascript/plugins/ternWorker.js.src.js>.
Parameters:
server
name
parent

show(tooltipInfo, target, locked, giveFocus)
Show the tooltip using the given target information
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.editor/web/orion/editor/tooltip.js>.
Parameters:
tooltipInfo
a function that will return the tooltip contents (see _processInfo())
target
The target through which the info is obtained
locked
If true locks the tooltip (never hides unless 'hide' is called)
giveFocus
If true forces the focus onto the tooltip (used for F2 processing)

skip()

Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.javascript/web/javascript/plugins/javascriptPlugin.js.src.js>.

sliceSource(source, index, last)

Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.javascript/web/javascript/plugins/javascriptPlugin.js.src.js>.
Parameters:
source
index
last

statusReporter(message, isError)

Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.ui/web/orion/compare/compareView.js>.
Parameters:
message
isError

u(a)

Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.javascript/web/javascript/plugins/built-javascriptPlugin.js>.
Parameters:
a

update(tooltipInfo, noContent)
Updates the information in an already visible tooltip
Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.editor/web/orion/editor/tooltip.js>.
Parameters:
tooltipInfo
a function that will return the parameters need to update the information (see _processInfo())
noContent
If true makes no attempt to gather new info and just updates the tooltip's position

z(a)

Defined in: </jobs/genie.orion/orion-client-dev/workspace/bundles/org.eclipse.orion.client.javascript/web/javascript/plugins/built-javascriptPlugin.js>.
Parameters:
a

Documentation generated by JsDoc Toolkit 2.4.0 on Tue Feb 23 2016 22:02:57 GMT-0500 (EST)