Class orion.selection.Selection
Can provide one or more selections describing objects of interest. Used to
establish input and output relationships between components. For example, the selection
in one component can serve as the input of another component.
Defined in: </shared/eclipse/e4/orion/I201404012230/bundles/org.eclipse.orion.client.ui/web/orion/selection.js>.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Constructs a new selection service.
|
| Method Attributes | Method Name and Description |
|---|---|
|
getSelection(onDone)
Obtains the current single selection and passes it to the provided function.
|
|
|
getSelections(onDone)
Obtains all current selections and passes them to the provided function.
|
|
|
setSelections(itemOrArray)
Sets the current selection.
|
| Event Attributes | Event Name and Description |
|---|---|
|
selectionChanged(selectionChangedEvent)
Dispatched when the selection has changed.
|
Class Detail
orion.selection.Selection()
Constructs a new selection service. Clients should obtain a selection service
by requesting the service
orion.page.selection from the service registry.
This service constructor is only intended to be used by page service registry
initialization code.
Method Detail
{Object}
getSelection(onDone)
Obtains the current single selection and passes it to the provided function.
- Parameters:
- {Function} onDone
- The function to invoke with the selection. Deprecated: just use the return value instead.
- Returns:
- {Object}
{Array}
getSelections(onDone)
Obtains all current selections and passes them to the provided function.
- Parameters:
- {Function} onDone
- The function to invoke with the selections. Deprecated: just use the return value instead.
- Returns:
- {Array}
setSelections(itemOrArray)
Sets the current selection. Dispatches a
selectionChanged event.
- Parameters:
- {Object|Object[]|null} itemOrArray
- A single selected item, or an array of selected items, or
null(meaning no selection).
Event Detail
selectionChanged(selectionChangedEvent)
Dispatched when the selection has changed.
- Parameters:
- {selectionChangedEvent} selectionChangedEvent
- {Object} selectionChangedEvent.selection
- The selected item. If there is no selection, this field is
null. If multiple items are selected, this field refers to the first item in the list. - {Object[]} selectionChangedEvent.selections
- The selected items. If there is no selection, this field is
null. - {String} selectionChangedEvent.type
- The type event type. Value is always
"selectionChanged".