Class RowSelect

Row selection model

Hierarchy

Observable
- RowSelect

Index

Constructors

Properties

_selected fireSelectionChange hasKeyUpListener lastIndex list multiSelect shiftStartIndex?

Accessors

Methods

add clear fire on onFirstListenerAdded onKeyDown onRowMouseDown relayEvent remove selectAll setSelected un

Constructors

constructor

new RowSelect(list): RowSelect
Parameters
- list: List<Store<StoreRecord>>
Returns RowSelect
Inherited from Observable.constructor
- Defined in component/table/RowSelect.ts:79

Properties

`Private` _selected

_selected: number[] = []

`Private` fireSelectionChange

fireSelectionChange: (() => void)

Type declaration

- (): void
- Returns void

`Private` hasKeyUpListener

hasKeyUpListener: Boolean = false

`Private` lastIndex

lastIndex: number = -1

Last selected index used for multi selection with shift

`Readonly` list

list: List<Store<StoreRecord>>

multiSelect

multiSelect: boolean = true

`Private` `Optional` shiftStartIndex

shiftStartIndex?: number

Accessors

selected

get selected(): number[]
Get selected indexes

Note that this is a copy and can't be edited directly. You have to set the selected property with a changed array.

Returns number[]
- Defined in component/table/RowSelect.ts:127
set selected(newSelection): void
Parameters
- newSelection: number[]
Returns void
- Defined in component/table/RowSelect.ts:131

Methods

add

add(index): void
Parameters
- index: number
Returns void
- Defined in component/table/RowSelect.ts:163

clear

clear(): void
Returns void
- Defined in component/table/RowSelect.ts:110

fire

fire<K>(eventName, ...args): boolean
Fire an event

When a listener returns false this function will return false too.
Type Parameters
- K extends keyof RowSelectEventMap<this>
Parameters
- eventName: K
- Rest ...args: Parameters<RowSelectEventMap<any>[K]>
Returns boolean
Inherited from Observable.fire
- Defined in component/table/RowSelect.ts:56

on

on<K, L>(eventName, listener, options?): L
Add a listener
Type Parameters
- K extends keyof RowSelectEventMap<this>
- L extends Listener
Parameters
- eventName: K
- listener: Partial<RowSelectEventMap<RowSelect>>[K]
- Optional options: ObservableListenerOpts
Returns L
Inherited from Observable.on
- Defined in component/table/RowSelect.ts:54

`Protected` onFirstListenerAdded

onFirstListenerAdded(eventName): void
Protected
Override this function to lazily initialize events
Parameters
- eventName: string
Returns void
Inherited from Observable.onFirstListenerAdded
- Defined in component/Observable.ts:133

`Private` onKeyDown

onKeyDown(e): void
Parameters
- e: KeyboardEvent
Returns void
- Defined in component/table/RowSelect.ts:231

`Private` onRowMouseDown

onRowMouseDown(_list, index, e): void
Parameters
- _list: List<Store<StoreRecord>>
- index: number
- e: MouseEvent
Returns void
- Defined in component/table/RowSelect.ts:136

`Protected` relayEvent

relayEvent(comp, type): void
Parameters
- comp: Observable
- type: any
Returns void
Inherited from Observable.relayEvent
- Defined in component/Observable.ts:199

remove

remove(index, silent?): void
Remove an index from the selection
Parameters
- index: number
- silent: boolean = false
  
  Don't fire events
Returns void
- Defined in component/table/RowSelect.ts:181

selectAll

selectAll(): void
Returns void
- Defined in component/table/RowSelect.ts:114

`Private` setSelected

setSelected(newSelection, silent?): boolean
Set selected indexes
Parameters
- newSelection: number[]
- silent: boolean = false
  
  Suspends 'selectionchange' event
Returns boolean
- Defined in component/table/RowSelect.ts:202

un

un(eventName, listener): boolean
Remove listener
Parameters
- eventName: never
- listener: Function
Returns boolean
Inherited from Observable.un
- Defined in component/Observable.ts:155

Generated using TypeDoc