Class orion.outliner.Outliner
An Outliner is a visual component that renders an itemized overview of a resource and acts as
a selection provider on that resource. The itemized overview is obtained from the orion.outliner.OutlineService.
Defined in: </shared/eclipse/e4/orion/I201404012230/bundles/org.eclipse.orion.client.ui/web/orion/outliner.js>.
Constructor Attributes | Constructor Name and Description |
---|---|
orion.outliner.Outliner(options, Parent)
Constructs a new Outliner with the given options.
|
Method Attributes | Method Name and Description |
---|---|
createViewMode(provider)
|
|
destroyViewMode(provider)
|
|
Invokes the outline service to produce an outline
|
|
setContentType(fileContentType, title)
Called when the inputManager's contentType has changed, so we need to look up the capable outline providers.
|
|
setOutlineProviders(providers)
|
|
setSelectedProvider(provider)
|
Class Detail
orion.outliner.Outliner(options, Parent)
Constructs a new Outliner with the given options.
- Parameters:
- {Object} options
- The options object
- {Element} options.parent
- The parent DOM element to put this outliner inside.
- {Element} options.toolbar
- The DOM element to render toolbar commands in.
- {orion.serviceRegistry.ServiceRegistry} options.serviceRegistry
- The service registry.
- {orion.commands.CommandService} options.commandService
- {Service of type orion.outliner.OutlineService} options.outlineService
- The outline service to use.
- {orion.selection.Selection} options.selectionService Optional
- If provided, the selection service will be notified on outline selection rather than using anchor tag hrefs.
- {orion.sidebar.Sidebar} Parent
- sidebar
Method Detail
createViewMode(provider)
- Parameters:
- provider
destroyViewMode(provider)
- Parameters:
- provider
generateOutline()
Invokes the outline service to produce an outline
setContentType(fileContentType, title)
Called when the inputManager's contentType has changed, so we need to look up the capable outline providers.
- Parameters:
- {String} fileContentType
- {String} title
- TODO this is deprecated, should be removed along with "pattern" property of outliners.
setOutlineProviders(providers)
- Parameters:
- providers
setSelectedProvider(provider)
- Parameters:
- {orion.serviceregistry.ServiceReference} provider