Class orion.editor.ContentAssist
A key mode for orion.editor.Editor that displays content assist suggestions.
Defined in: </shared/eclipse/e4/orion/I201202282230/plugins/org.eclipse.orion.client.editor/web/orion/editor/contentAssist.js>.
Constructor Attributes | Constructor Name and Description |
---|---|
orion.editor.ContentAssist(editor, contentAssistId)
Creates a
ContentAssist . |
Method Attributes | Method Name and Description |
---|---|
accept()
Accepts the currently selected proposal, if any.
|
|
addEventListener(type, listener, useCapture)
Adds an event listener to this event target.
|
|
dispatchEvent(evt)
Dispatches the given event to the listeners added to this event target.
|
|
getKeywords(prefix, buffer, selection)
|
|
removeEventListener(type, listener, useCapture)
Removes an event listener from the event target.
|
|
setProviders(providers)
Sets the content assist providers that we will consult to obtain proposals.
|
|
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 #setProviders.
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, useCapture)
Adds an event listener to this event target.
Defined in: </shared/eclipse/e4/orion/I201202282230/plugins/org.eclipse.orion.client.editor/web/orion/textview/eventTarget.js>.
Defined in: </shared/eclipse/e4/orion/I201202282230/plugins/org.eclipse.orion.client.editor/web/orion/textview/eventTarget.js>.
- Parameters:
- {String} type
- The event type.
- {Function|EventListener} listener
- The function or the EventListener that will be executed when the event happens.
- {Boolean} useCapture Optional, Default: false
true
if the listener should be trigged in the capture phase.
- See:
- #removeEventListener
dispatchEvent(evt)
Dispatches the given event to the listeners added to this event target.
Defined in: </shared/eclipse/e4/orion/I201202282230/plugins/org.eclipse.orion.client.editor/web/orion/textview/eventTarget.js>.
Defined in: </shared/eclipse/e4/orion/I201202282230/plugins/org.eclipse.orion.client.editor/web/orion/textview/eventTarget.js>.
- Parameters:
- {Event} evt
- The event to dispatch.
{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, useCapture)
Removes an event listener from the event target.
Defined in: </shared/eclipse/e4/orion/I201202282230/plugins/org.eclipse.orion.client.editor/web/orion/textview/eventTarget.js>.
All the parameters must be the same ones used to add the listener.
Defined in: </shared/eclipse/e4/orion/I201202282230/plugins/org.eclipse.orion.client.editor/web/orion/textview/eventTarget.js>.
- Parameters:
- {String} type
- The event type
- {Function|EventListener} listener
- The function or the EventListener that will be executed when the event happens.
- {Boolean} useCapture Optional, Default: false
true
if the listener should be trigged in the capture phase.
- See:
- #addEventListener
setProviders(providers)
Sets the content assist providers that we will consult to obtain proposals.
- Parameters:
- {Object[]} providers
- The providers. See orion.contentAssist.CssContentAssistProvider for an example.
showContentAssist(enable, event)
- Parameters:
- {Boolean} enable
- {orion.textview.ModelChangedEvent} event Optional