Class Index | File Index

Classes


Class orion.editor.ProjectionTextModel

The ProjectionTextModel represents a projection of its base text model. Projection ranges can be added to the projection text model to hide and/or insert ranges to the base text model.

The contents of the projection text model is modified when changes occur in the base model, projection model or by calls to #addProjection and #removeProjection.

See:
orion.editor.TextView
orion.editor.TextModel orion.editor.TextView#setModel


Defined in: </jobs/genie.orion/orion-client-stable/workspace/bundles/org.eclipse.orion.client.editor/web/orion/editor/projectionTextModel.js>.

Class Summary
Constructor Attributes Constructor Name and Description
 
Constructs a new ProjectionTextModel based on the specified TextModel.
Method Summary
Method Attributes Method Name and Description
 
addEventListener(type, listener, useCapture)
Adds an event listener to this event target.
 
addProjection(projection)
Adds a projection range to the model.
 
Destroys this projection text model.
 
Dispatches the given event to the listeners added to this event target.
 
Gets the base text model.
 
 
getLine(lineIndex, includeDelimiter)
 
 
 
 
getLineEnd(lineIndex, includeDelimiter)
 
getLineStart(lineIndex)
 
Returns all projection ranges of this model.
 
getText(start, end)
 
mapOffset(offset, baseOffset)
Maps offsets between the projection model and its base model.
 
onChanged(modelChangedEvent)
 
onChanging(modelChangingEvent)
 
removeEventListener(type, listener, useCapture)
Removes an event listener from the event target.
 
removeProjection(projection)
Removes a projection range from the model.
 
setLineDelimiter(lineDelimiter)
 
setText(text, start, end)
Class Detail
orion.editor.ProjectionTextModel(baseModel)
Constructs a new ProjectionTextModel based on the specified TextModel.
Parameters:
{orion.editor.TextModel} baseModel
The base text model.
Method Detail
addEventListener(type, listener, useCapture)
Adds an event listener to this event target.
Defined in: </jobs/genie.orion/orion-client-stable/workspace/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

addProjection(projection)
Adds a projection range to the model.

The model must notify the listeners before and after the the text is changed by calling #onChanging and #onChanged respectively.

Parameters:
{orion.editor.Projection} projection
The projection range to be added.
See:
orion.editor.ProjectionTextModel#removeProjection

destroy()
Destroys this projection text model.

dispatchEvent(evt)
Dispatches the given event to the listeners added to this event target.
Defined in: </jobs/genie.orion/orion-client-stable/workspace/bundles/org.eclipse.orion.client.editor/web/orion/editor/eventTarget.js>.
Parameters:
{Event} evt
The event to dispatch.

{orion.editor.TextModel} getBaseModel()
Gets the base text model.
Returns:
{orion.editor.TextModel} The base text model.

getCharCount()
See:
orion.editor.TextModel#getCharCount

getLine(lineIndex, includeDelimiter)
Parameters:
lineIndex
includeDelimiter
See:
orion.editor.TextModel#getLine

getLineAtOffset(offset)
Parameters:
offset
See:
orion.editor.TextModel#getLineAtOffset

getLineCount()
See:
orion.editor.TextModel#getLineCount

getLineDelimiter()
See:
orion.editor.TextModel#getLineDelimiter

getLineEnd(lineIndex, includeDelimiter)
Parameters:
lineIndex
includeDelimiter
See:
orion.editor.TextModel#getLineEnd

getLineStart(lineIndex)
Parameters:
lineIndex
See:
orion.editor.TextModel#getLineStart

{orion.editor.Projection[]} getProjections()
Returns all projection ranges of this model.
Returns:
{orion.editor.Projection[]} The projection ranges.
See:
orion.editor.ProjectionTextModel#addProjection

getText(start, end)
Parameters:
start
end
See:
orion.editor.TextModel#getText

{Number} mapOffset(offset, baseOffset)
Maps offsets between the projection model and its base model.
Parameters:
{Number} offset
The offset to be mapped.
{Boolean} baseOffset Optional, Default: false
true if offset is in base model and should be mapped to the projection model.
Returns:
{Number} The mapped offset

onChanged(modelChangedEvent)
Parameters:
modelChangedEvent
See:
orion.editor.TextModel#onChanged

onChanging(modelChangingEvent)
Parameters:
modelChangingEvent
See:
orion.editor.TextModel#onChanging

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: </jobs/genie.orion/orion-client-stable/workspace/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

removeProjection(projection)
Removes a projection range from the model.

The model must notify the listeners before and after the the text is changed by calling #onChanging and #onChanged respectively.

Parameters:
{orion.editor.Projection} projection
The projection range to be removed.
See:
orion.editor.ProjectionTextModel#addProjection

setLineDelimiter(lineDelimiter)
Parameters:
lineDelimiter
See:
orion.editor.TextModel#setLineDelimiter

setText(text, start, end)
Parameters:
text
start
end
See:
orion.editor.TextModel#setText

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Mar 17 2017 08:51:35 GMT-0400 (EDT)