Class Index | File Index

## Classes

- _global_
- Boolean
- Date
- eclipse.sites
- eclipse.sites.SiteRenderer
- eclipse.sites.SiteTreeModel
- exports.GitCommitExplorer-GitCommitExplorer
- exports.GitRepositoryExplorer-GitRepositoryExplorer
- Object
- orion.breadcrumbs.BreadCrumbs
- orion.commands.Command
- orion.commands.CommandService
- orion.commonHTMLFragments
- orion.compare.DiffProvider
- orion.compare.rulers.CompareOverviewRuler
- orion.compare.rulers.CompareRuler
- orion.compare.rulers.LineNumberCompareRuler
- orion.compareUtils
- orion.console.Console
- orion.console.ConsoleInput
- orion.contentAssist.CssContentAssistProvider
- orion.contentAssist.HTMLContentAssistProvider
- orion.dialogs.DialogService
- orion.edit.Dispatcher
- orion.editor.ContentAssist
- orion.editor.Editor
- orion.editor.JavaScriptContentAssistProvider
- orion.editor.regex
- orion.editor.StyleReadyEvent
- orion.editor.StyleReadyEvent#LineStyle
- orion.editor.TextMateStyler
- orion.editor.util
- orion.explorer-table.FileExplorer
- orion.explorer.Explorer
- orion.explorer.ExplorerFlatModel
- orion.explorer.ExplorerModel
- orion.explorer.SelectionRenderer
- orion.ExplorerNavHandler.ExplorerNavHandler
- orion.extensionCommands
- orion.favorites.FavoritesService
- orion.file.ContentType
- orion.file.ContentTypeService
- orion.fileClient.FileClient
- orion.fileCommands
- orion.git.GitClonesExplorer
- orion.git.GitClonesModel
- orion.git.GitCommitNavigator
- orion.git.GitService
- orion.git.widgets.OpenCommitDialog
- orion.globalCommands
- orion.highlight.SyntaxHighlighter
- orion.links.TextLinkService
- orion.log.LogService
- orion.mirror.CodeMirrorStyler
- orion.mirror.Mirror
- orion.mirror.MirrorLineStyle
- orion.mirror.ModeApplier
- orion.navoutliner.NavigationOutliner
- orion.outliner.Outliner
- orion.outliner.OutlineService
- orion.parameterCollectors.CommandParameterCollector
- orion.pluginregistry.Plugin
- orion.pluginregistry.PluginRegistry
- orion.preferences.Preferences
- orion.preferences.PreferencesService
- orion.problems.ProblemService
- orion.profile.usersClient.UsersClient
- orion.progress.ProgressService
- orion.searchClient.Searcher
- orion.searchResults.SearchResultsGenerator
- orion.searchUtils
- orion.selection.Selection
- orion.serviceregistry.EventTarget
- orion.serviceregistry.Service
- orion.serviceregistry.ServiceReference
- orion.serviceregistry.ServiceRegistration
- orion.serviceregistry.ServiceRegistry
- orion.siteService.SiteConfiguration
- orion.siteService.SiteService
- orion.status.StatusReportingService
- orion.textview.Annotation
- orion.textview.AnnotationIterator
- orion.textview.AnnotationModel
- orion.textview.AnnotationRuler
- orion.textview.AnnotationStyler
- orion.textview.AnnotationTypeList
- orion.textview.BlurEvent
- orion.textview.ContextMenuEvent
- orion.textview.DestroyEvent
- orion.textview.EventTarget
- orion.textview.FocusEvent
- orion.textview.FoldingAnnotation
- orion.textview.KeyBinding
- orion.textview.LineNumberRuler
- orion.textview.LineStyleEvent
- orion.textview.LoadEvent
- orion.textview.ModelChangedEvent
- orion.textview.ModelChangingEvent
- orion.textview.ModifyEvent
- orion.textview.OverviewRuler
- orion.textview.Projection
- orion.textview.ProjectionTextModel
- orion.textview.Ruler
- orion.textview.ScrollEvent
- orion.textview.Selection
- orion.textview.SelectionEvent
- orion.textview.Style
- orion.textview.StyleRange
- orion.textview.TextModel
- orion.textview.TextView
- orion.textview.TextViewOptions
- orion.textview.UndoStack
- orion.textview.UnloadEvent
- orion.textview.VerifyEvent
- orion.TreeModelIterator.TreeModelIterator
- orion.treetable.TableTree
- orion.util
- orion.widgets.DirectoryTreeModel
- orion.widgets.OpenResourceDialog
- orion.widgets.SiteEditor
- String

# Class orion.textview.AnnotationStyler

This object represents a styler for annotation attached to a text view.
Defined in: </shared/eclipse/e4/orion/I201202282230/plugins/org.eclipse.orion.client.editor/web/orion/textview/annotations.js>.

Class Summary
Constructor Attributes | Constructor Name and Description
--- | ---
| orion.textview.AnnotationStyler(view, view) Constructs a new styler for annotations.

Method Summary
Method Attributes | Method Name and Description
--- | ---
| addAnnotationType(type) Adds an annotation type to the receiver.
| destroy() Destroys the styler.
| getAnnotationsByType(annotationModel, start, end) Returns an array of annotations in the specified annotation model for the given range of text sorted by type.
| getAnnotationTypePriority(type) Gets the annotation type priority.
| isAnnotationTypeVisible(type) Returns whether the receiver shows annotations of the specified type.
| removeAnnotationType(type) Removes an annotation type from the receiver.

Class Detail
orion.textview.AnnotationStyler(view, view)
Constructs a new styler for annotations.

Parameters:
{orion.textview.TextView} view
  The styler view.
{orion.textview.AnnotationModel} view
  The styler annotation model.

Method Detail
addAnnotationType(type)
Adds an annotation type to the receiver.

Only annotations of the specified types will be shown by the receiver.

Parameters:
{Object} type
  the annotation type to be shown

See:
  #removeAnnotationType
  #isAnnotationTypeVisible

destroy()
Destroys the styler.

Removes all listeners added by this styler.

{orion.textview.Annotation[]} getAnnotationsByType(annotationModel, start, end)
Returns an array of annotations in the specified annotation model for the given range of text sorted by type.

Parameters:
{orion.textview.AnnotationModel} annotationModel
  the annotation model.
{Number} start
  the start offset of the range.
{Number} end
  the end offset of the range.

Returns:
  {orion.textview.Annotation[]} an annotation array.

getAnnotationTypePriority(type)
Gets the annotation type priority. The priority is determined by the order the annotation type is added to the receiver. Annotation types added first have higher priority.

Returns `0` if the annotation type is not added.

Parameters:
{Object} type
  the annotation type

See:
  #addAnnotationType
  #removeAnnotationType
  #isAnnotationTypeVisible

{Boolean} isAnnotationTypeVisible(type)
Returns whether the receiver shows annotations of the specified type.

Parameters:
{Object} type
  the annotation type

Returns:
  {Boolean} whether the specified annotation type is shown

See:
  #addAnnotationType
  #removeAnnotationType

removeAnnotationType(type)
Removes an annotation type from the receiver.

Parameters:
{Object} type
  the annotation type to be removed

See:
  #addAnnotationType
  #isAnnotationTypeVisible

Documentation generated by JsDoc Toolkit 2.4.0 on Tue Feb 28 2012 22:34:47 GMT-0500 (EST)