Class orion.editor.BaseEditor

This is the base interface for text and visual editors based on a text buffer.
Defined in: </shared/eclipse/e4/orion/I201404012230/bundles/org.eclipse.orion.client.editor/web/orion/editor/editor.js>.

Class Summary
Constructor Attributes	Constructor Name and Description
	orion.editor.BaseEditor(options) Creates a new Base Editor with the given options.

Method Summary
Method Attributes	Method Name and Description
	addEventListener(type, listener, useCapture) Adds an event listener to this event target.
	destroy() Destroys the editor.
	dispatchEvent(evt) Dispatches the given event to the listeners added to this event target.
	focus() Focus the the editor view.
	getModel() Returns the text model of the editor.
	getText(start, end) Returns the text for the given range.
	getTitle() Returns the editor title.
	getUndoStack() Returns the editor undo stack.
	install() Creates the DOM hierarchy of the editor and add it to the document.
	isDirty() Returns `true` if the editor is dirty; `false` otherwise.
	markClean() Marks the current state of the editor as clean.
	onChanged(inputChangedEvent) Called when the editor's text model has been changed.
	onDirtyChanged(dirtyChangedEvent) Called when the dirty state of the editor changes.
	onInputChanged(inputChangedEvent) Called when the editor's contents have been changed or saved.
	removeEventListener(type, listener, useCapture) Removes an event listener from the event target.
	reportStatus(message, type, isAccessible) Report the message to the user.
	resize() Resizes the editor view.
	setDirty(dirty) Sets whether the editor is dirty.
	setInput(title, message, contents, contentsSaved) Sets the editor's contents.
	setText(text, start, end) Replaces the text in the given range with the given text.
	uninstall() Removes the DOM hierarchy of the editor from the document.

Class Detail

orion.editor.BaseEditor(options)

Creates a new Base Editor with the given options.

Parameters:
{Object} options: Creation options for this editor.
{Object} options.domNode
{Object} options.statusReporter

Method Detail

addEventListener(type, listener, useCapture)

Adds an event listener to this event target.
Defined in: </shared/eclipse/e4/orion/I201404012230/bundles/org.eclipse.orion.client.editor/web/orion/editor/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:: orion.editor.EventTarget#removeEventListener

destroy()

Destroys the editor. Uninstall the editor view.

dispatchEvent(evt)

Dispatches the given event to the listeners added to this event target.
Defined in: </shared/eclipse/e4/orion/I201404012230/bundles/org.eclipse.orion.client.editor/web/orion/editor/eventTarget.js>.

Parameters:
{Event} evt: The event to dispatch.

focus()

Focus the the editor view. The default implementation does nothing.

{orion.editor.TextModel} getModel()

Returns the text model of the editor.

Returns:: {orion.editor.TextModel} the text model of the view.

getText(start, end)

Returns the text for the given range.

The text does not include the character at the end offset.

Parameters:
{Number} start Optional, Default: 0: the start offset of text range.
{Number} end Optional, Default: char count: the end offset of text range.

See:: orion.editor.TextView#setText

{String} getTitle()

Returns the editor title.

Returns:: {String} the editor title.

{orion.editor.UndoStack} getUndoStack()

Returns the editor undo stack.

Returns:: {orion.editor.UndoStack} the editor undo stack.

install()

Creates the DOM hierarchy of the editor and add it to the document.

{Boolean} isDirty()

Returns true if the editor is dirty; false otherwise.

Returns:: {Boolean} whether the editor is dirty

markClean()

Marks the current state of the editor as clean. Meaning there are no unsaved modifications.

onChanged(inputChangedEvent)

Called when the editor's text model has been changed.

Parameters:
{Event} inputChangedEvent

onDirtyChanged(dirtyChangedEvent)

Called when the dirty state of the editor changes.

Parameters:
{Event} dirtyChangedEvent

onInputChanged(inputChangedEvent)

Called when the editor's contents have been changed or saved.

Parameters:
{Event} inputChangedEvent

removeEventListener(type, listener, useCapture)

Removes an event listener from the event target.

All the parameters must be the same ones used to add the listener.

Defined in: </shared/eclipse/e4/orion/I201404012230/bundles/org.eclipse.orion.client.editor/web/orion/editor/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:: orion.editor.EventTarget#addEventListener

reportStatus(message, type, isAccessible)

Report the message to the user.

Parameters:
{String} message: the message to show
{String} type Optional: the message type. Either normal or "progress" or "error";
{Boolean} isAccessible Optional: If true, a screen reader will read this message. Otherwise defaults to the domNode default.

resize()

Resizes the editor view. The default implementation does nothing.

setDirty(dirty)

Sets whether the editor is dirty.

Parameters:
{Boolean} dirty

setInput(title, message, contents, contentsSaved)

Sets the editor's contents.

Parameters:
{String} title: the editor title
{String} message: an error message
{String} contents: the editor contents
{Boolean} contentsSaved: whether the editor contents was saved.

setText(text, start, end)

Replaces the text in the given range with the given text.

The character at the end offset is not replaced.

Parameters:
{String} text: the new text.
{Number} start Optional, Default: 0: the start offset of text range.
{Number} end Optional, Default: char count: the end offset of text range.

uninstall()

Removes the DOM hierarchy of the editor from the document.

Classes

Class orion.editor.BaseEditor