Class DefaultSelectionService

Default implementation of SelectionService.

Hierarchy

DefaultSelectionService

Implements

SelectionService

Index

Constructors

constructor

new DefaultSelectionService(): DefaultSelectionService

- Defined in default-selection-service.ts:36
Returns DefaultSelectionService

Properties

items

items: any[]

Collection of elements for selection.

lastProcessedIndex

lastProcessedIndex: number

Index of last selected/deselected element in items collection.

Protected selectionsList

selectionsList: SelectionTuple[] = new Array<SelectionTuple>()

Collection of SelectionTuple elements which represents currently selected items in items collection.

trackByFn

trackByFn: function

inheritdoc

Type declaration

- (index: number, item: any): any
- Parameters
  - index: number
  - item: any
  Returns any

Methods

checkSelection

checkSelection(): void

Implementation of SelectionService.checkSelection
- Defined in default-selection-service.ts:52
Performs check that every selected element is actually selected.

Returns void

deselectAll

deselectAll(): void

Implementation of SelectionService.deselectAll
- Defined in default-selection-service.ts:82
Deselects all elements in items collection.

Returns void

deselectIndex

deselectIndex(index: number): void

Implementation of SelectionService.deselectIndex
- Defined in default-selection-service.ts:204
Deselects element at specified index in items collection.

Parameters
- index: number
Returns void

Protected deselectItem

deselectItem(selectionTuple: SelectionTuple): void

- Defined in default-selection-service.ts:257
Internal method that used to perform item selection.

Parameters
- selectionTuple: SelectionTuple
Returns void

destroy

destroy(): void

Implementation of SelectionService.destroy
- Defined in default-selection-service.ts:44
Performs application-defined logic for service destroy.

Returns void

getItemIndex

getItemIndex(item: any): number

Implementation of SelectionService.getItemIndex
- Defined in default-selection-service.ts:154
Returns index of specified element in items collection.

see

trackByFn

Parameters
- item: any
Returns number

index of specified element in items collection. -1 if element not found.

getMaxSelectedIndex

getMaxSelectedIndex(): number

Implementation of SelectionService.getMaxSelectedIndex
- Defined in default-selection-service.ts:170
Returns index of last selected element from items collection.

Returns number

index of last selected element. -1 if nothing is selected.

getMinSelectedIndex

getMinSelectedIndex(): number

Implementation of SelectionService.getMinSelectedIndex
- Defined in default-selection-service.ts:160
Returns index of first selected element from items collection.

Returns number

index of first selected element. -1 if nothing is selected.

getSelectedElements

getSelectedElements(): any[]

Implementation of SelectionService.getSelectedElements
- Defined in default-selection-service.ts:229
Returns all elements from items collection which are marked as selected.

Returns any[]

collection of selected elements.

getSelectedIndexes

getSelectedIndexes(): number[]

Implementation of SelectionService.getSelectedIndexes
- Defined in default-selection-service.ts:235
Returns indexes of all elements from items collection which are marked as selected.

Returns number[]

collection of selected elements indexes in items collection.

Protected getSelectionTuple

getSelectionTuple(index: number): SelectionTuple

- Defined in default-selection-service.ts:293
Internal method that used to represent selection item as SelectionTuple.

Parameters
- index: number
Returns SelectionTuple

hasSelections

hasSelections(): boolean

Implementation of SelectionService.hasSelections
- Defined in default-selection-service.ts:120
Checks that at least one element selected in items collection.

Returns boolean

true if anything is selected.

isIndexAcceptable

isIndexAcceptable(index: number): boolean

- Defined in default-selection-service.ts:76
Checks that applied index is valid number and it's value is inside items boundaries.

Parameters
- index: number
  
  index to check.
Returns boolean

true if index is valid.

isIndexSelected

isIndexSelected(index: number): boolean

Implementation of SelectionService.isIndexSelected
- Defined in default-selection-service.ts:145
Checks that element at specified index is selected.

Parameters
- index: number
Returns boolean

true if element is selected.

isRangeSelected

isRangeSelected(from: number, to: number): boolean

Implementation of SelectionService.isRangeSelected
- Defined in default-selection-service.ts:126
Checks that all elements inside specified range are selected in items collection.

Parameters
- from: number
- to: number
Returns boolean

true if all elements inside specified range are selected.

Protected processSelection

processSelection(tuple: SelectionTuple, selected: boolean): void

- Defined in default-selection-service.ts:249
Performs final processing of selection/deselection of element.

Current implementation sets {@link selected} propery of element (if it's defined).

Parameters
- tuple: SelectionTuple
- selected: boolean
Returns void

selectAll

selectAll(): void

Implementation of SelectionService.selectAll
- Defined in default-selection-service.ts:92
Selects all elements in items collection.

Returns void

selectFirst

selectFirst(): void

Implementation of SelectionService.selectFirst
- Defined in default-selection-service.ts:180
Selects first element in items collection.

Returns void

selectIndex

selectIndex(index: number, savePrevious?: boolean): void

Implementation of SelectionService.selectIndex
- Defined in default-selection-service.ts:196
Selects element at specified index in items collection.

Parameters
- index: number
- Default value savePrevious: boolean = false
Returns void

Protected selectItem

selectItem(selectionTuple: SelectionTuple, savePrevious?: boolean): void

- Defined in default-selection-service.ts:270
Internal method that used to execute item deselection.

Parameters
- selectionTuple: SelectionTuple
- Default value savePrevious: boolean = false
Returns void

selectLast

selectLast(): void

Implementation of SelectionService.selectLast
- Defined in default-selection-service.ts:188
Selects last element in items collection.

Returns void

selectRange

selectRange(fromIndex: number, toIndex: number): void

Implementation of SelectionService.selectRange
- Defined in default-selection-service.ts:98
Selects range of elements in items collection.

Parameters
- fromIndex: number
- toIndex: number
Returns void

toggleSelection

toggleSelection(index: number, savePrevious?: boolean): void

Implementation of SelectionService.toggleSelection
- Defined in default-selection-service.ts:212
Toggles selection of element at the specified index.

Parameters
- index: number
- Default value savePrevious: boolean = false
Returns void

Protected trackByIdentity

trackByIdentity(index: number, item: any): any

- Defined in default-selection-service.ts:242
Default tracking function that will be used if nothing was specified for trackByFn. Implements comparison by reference equality of objects.

Parameters
- index: number
- item: any
Returns any

Generated using TypeDoc