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/I201202282230/plugins/org.eclipse.orion.client.core/web/orion/outliner.js>.
Constructor Attributes | Constructor Name and Description |
---|---|
orion.outliner.Outliner(options)
Constructs a new Outliner with the given options.
|
Method Attributes | Method Name and Description |
---|---|
outlineChanged(outlinerService, title, contents)
|
|
setOutlineProviders(providers)
|
|
setSelectedProvider(provider)
Clients can connect to this function to be notified of user choice of outline provider.
|
Class Detail
orion.outliner.Outliner(options)
Constructs a new Outliner with the given options.
- Parameters:
- {Object} options
- The options object
- {Object} options.parent
- The parent DOM element to put this outliner inside
- {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.
Method Detail
outlineChanged(outlinerService, title, contents)
- Parameters:
- outlinerService
- title
- contents
setOutlineProviders(providers)
- Parameters:
- providers
setSelectedProvider(provider)
Clients can connect to this function to be notified of user choice of outline provider.
- Parameters:
- {ServiceReference} provider