Interface ISelectable

Hierarchy

Index

Properties

Methods

Properties

optional public alias?: Array<string>

[Config Option] (String[])

optional public allowDeselect?: boolean

[Config Option] (Boolean)

optional public alternateClassName?: any

[Config Option] (String/String[])

optional public config?: any

[Config Option] (Object)

optional public deselectOnContainerClick?: boolean

[Config Option] (Boolean)

optional public disableSelection?: boolean

[Config Option] (Boolean)

optional public extend?: string

[Config Option] (String)

optional public inheritableStatics?: any

[Config Option] (Object)

optional public locked?: boolean

[Config Option] (Boolean)

optional public mixins?: any

[Config Option] (Object)

optional public mode?: string

[Config Option] (String)

optional public platformConfig?: any

[Config Option] (Object)

optional public self?: IClass

[Property] (Ext.Class)

optional public singleton?: boolean

[Config Option] (Boolean)

optional public statics?: any

[Config Option] (Object)

optional public uses?: Array<string>

[Config Option] (String[])

Methods

optional public callOverridden(args?: any): any

[Method] Call the original method that was previously overridden with override This method is deprecated as callParent does

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments)

Returns

any

Object Returns the result of calling the overridden method

optional public callParent(args?: any): any

[Method] Call the parent method of the current method

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callParent(arguments)

Returns

any

Object Returns the result of calling the parent method

optional public callSuper(args?: any): any

[Method] This method is used by an override to call the superclass method but bypass any overridden method

Parameters

  • args?: any optional

    Array/Arguments The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments)

Returns

any

Object Returns the result of calling the superclass method

optional public clearSelections()

[Method] Deselects any currently selected records and clears all stored selections

optional public deselect(records?: any, suppressEvent?: boolean)

[Method] Deselects the given record s

Parameters

  • records?: any optional

    Number/Array/Ext.data.Model The record(s) to deselect. Can also be a number to reference by index.

  • suppressEvent?: boolean optional

    Boolean If true the deselect event will not be fired.

optional public deselectAll(supress?: any)

[Method] Deselects all records

Parameters

  • supress?: any optional

    Object

optional public destroy()

[Method]

optional public doDeselect(records?: any, suppressEvent?: boolean)

[Method] Deselects a record instance by record instance or index

Parameters

  • records?: any optional

    Ext.data.Model/Number An array of records or an index.

  • suppressEvent?: boolean optional

    Boolean Set to false to not fire a deselect event.

optional public doSelect(records?: any, keepExisting?: boolean, suppressEvent?: boolean)

[Method] Selects a record instance by record instance or index

Parameters

  • records?: any optional

    Ext.data.Model/Number An array of records or an index.

  • keepExisting?: boolean optional

    Boolean

  • suppressEvent?: boolean optional

    Boolean Set to false to not fire a select event.

optional public getAllowDeselect(): boolean

[Method] Returns the value of allowDeselect

Returns

boolean

Boolean

optional public getCount(): number

[Method] Returns the number of selections

Returns

number

Number

optional public getDeselectOnContainerClick(): boolean

[Method] Returns the value of deselectOnContainerClick

Returns

boolean

Boolean

optional public getDisableSelection(): boolean

[Method] Returns the value of disableSelection

Returns

boolean

Boolean

optional public getInitialConfig(name?: string): any

[Method] Returns the initial configuration passed to constructor

Parameters

  • name?: string optional

    String When supplied, value for particular configuration option is returned, otherwise the full config object is returned.

Returns

any

Object/Mixed

optional public getLastSelected(): Array<any>

[Method] Returns the array of previously selected items

Returns

Array<any>

Array The previous selection.

optional public getMode(): string

[Method] Returns the value of mode

Returns

string

String

optional public getSelection(): Array<any>

[Method] Returns an array of the currently selected records

Returns

Array<any>

Array An array of selected records.

optional public getSelectionCount(): number

[Method] Returns the number of selections

Returns

number

Number

optional public getSelectionMode(): string

[Method] Returns the selection mode currently used by this Selectable

Returns

string

String The current mode.

optional public hasSelection(): boolean

[Method] Returns true if there is a selected record

Returns

boolean

Boolean

optional public initConfig(instanceConfig?: any): any

[Method] Initialize configuration for this class

Parameters

  • instanceConfig?: any optional

    Object

Returns

any

Object mixins The mixin prototypes as key - value pairs

optional public isLocked(): boolean

[Method] Returns true if the Selectable is currently locked

Returns

boolean

Boolean True if currently locked

optional public isSelected(record?: any): boolean

[Method] Returns true if the specified row is selected

Parameters

  • record?: any optional

    Ext.data.Model/Number The record or index of the record to check.

Returns

boolean

Boolean

optional public select(records?: any, keepExisting?: boolean, suppressEvent?: boolean)

[Method] Adds the given records to the currently selected set

Parameters

  • records?: any optional

    Ext.data.Model/Array/Number The records to select.

  • keepExisting?: boolean optional

    Boolean If true, the existing selection will be added to (if not, the old selection is replaced).

  • suppressEvent?: boolean optional

    Boolean If true, the select event will not be fired.

optional public selectAll(silent?: boolean)

[Method] Selects all records

Parameters

  • silent?: boolean optional

    Boolean true to suppress all select events.

optional public selectRange(startRecord?: number, endRecord?: number, keepExisting?: boolean)

[Method] Selects a range of rows if the selection model getDisableSelection is not locked

Parameters

  • startRecord?: number optional

    Number The index of the first row in the range.

  • endRecord?: number optional

    Number The index of the last row in the range.

  • keepExisting?: boolean optional

    Boolean true to retain existing selections.

optional public setAllowDeselect(allowDeselect?: boolean)

[Method] Sets the value of allowDeselect

Parameters

  • allowDeselect?: boolean optional

    Boolean

optional public setDeselectOnContainerClick(deselectOnContainerClick?: boolean)

[Method] Sets the value of deselectOnContainerClick

Parameters

  • deselectOnContainerClick?: boolean optional

    Boolean

optional public setDisableSelection(disableSelection?: boolean)

[Method] Sets the value of disableSelection

Parameters

  • disableSelection?: boolean optional

    Boolean

optional public setLastFocused()

[Method] This was an internal function accidentally exposed in 1 x and now deprecated

optional public setMode(mode?: string)

[Method] Sets the value of mode

Parameters

  • mode?: string optional

    String

optional public updateLastFocused(newRecord?: IRecord, oldRecord?: IRecord)

[Method] Sets a record as the last focused record

Parameters

  • newRecord?: IRecord optional

    Ext.data.Record

  • oldRecord?: IRecord optional

    Ext.data.Record