Class Index | File Index

Classes


Class orion.editor.ContentAssist

A key mode for orion.editor.Editor that displays content assist suggestions.
Defined in: </shared/eclipse/e4/orion/I201110211442/plugins/org.eclipse.orion.client.editor/web/orion/editor/contentAssist.js>.

Class Summary
Constructor Attributes Constructor Name and Description
 
orion.editor.ContentAssist(editor, contentAssistId)
Creates a ContentAssist.
Method Summary
Method Attributes Method Name and Description
 
Accepts the currently selected proposal, if any.
 
addEventListener(type, listener)
Registers a listener with this ContentAssist.
 
addProvider(provider, name, pattern)
Adds a content assist provider.
 
getKeywords(prefix, buffer, selection)
 
 
 
removeEventListener(type, listener)
Removes a registered event listener.
 
showContentAssist(enable, event)
Class Detail
orion.editor.ContentAssist(editor, contentAssistId)
Creates a ContentAssist. A ContentAssist displays suggestions from registered content assist providers to the user. Content assist providers are registered by calling #addProvider.

A ContentAssist emits events, for which listeners may be registered using #addEventListener. Supported event types are:

show
Dispatched when this ContentAssist is activated.
hide
Dispatched when this ContentAssist is dismissed.
accept
Dispatched when a proposal has been accepted by the user. The event's data field contains information about the accepted proposal.
Parameters:
{orion.editor.Editor} editor
The Editor to provide content assist for.
{String|DomNode} contentAssistId
The ID or DOMNode to use as the parent for content assist.
Method Detail
{Boolean} accept()
Accepts the currently selected proposal, if any.
Returns:
{Boolean} true if a proposal could be accepted; false if none was selected or available.

addEventListener(type, listener)
Registers a listener with this ContentAssist.
Parameters:
{String} type
{Function} listener

addProvider(provider, name, pattern)
Adds a content assist provider.
Parameters:
{Object} provider
The provider object. See orion.contentAssist.CssContentAssistProvider for an example.
{String} name
Name for this provider.
{String} pattern
A regex pattern matching filenames that provider can offer content assist for.

{Object} getKeywords(prefix, buffer, selection)
Parameters:
{String} prefix
A prefix against which content assist proposals should be evaluated.
{String} buffer
The entire buffer being edited.
{orion.textview.Selection} selection
The current selection from the Editor.
Returns:
{Object} A promise that will provide the keywords.

{DOMNode} getSelectedNode()
Returns:
{DOMNode} The DOM node of the currently selected proposal.

{Object} getSelectedProposal()
Returns:
{Object} The currently selected proposal.

removeEventListener(type, listener)
Removes a registered event listener.
Parameters:
{String} type
{Function} listener

showContentAssist(enable, event)
Parameters:
{Boolean} enable
{orion.textview.ModelChangedEvent} event Optional

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Oct 21 2011 14:44:12 GMT-0400 (EDT)