Home Reference Source Repository
public class | source

AdapterSortableTable

Extends:

Feature → AdapterSortableTable

SortableTable Adapter module

Constructor Summary

Public Constructor
public

Creates an instance of AdapterSortableTable

Member Summary

Public Members
public

Enable asynchronous sort, if triggers are external

public

Cell attribute key storing custom value used for sorting

public

Module description

public

Css class for ascending sort indicator image

public

Blank image file name

public

Css class for sort indicator image

public

Css class for descending sort indicator image

public

Path to images

public
public

Module name

public

Callback fired after a table column is sorted

public

Callback fired before a table column is sorted

public

Callback fired when sort extension is instanciated

public

Column to be sorted at initialization, ie: sort_col_at_start: [1, true]

public

List of sort type per column basis

public

List of element IDs triggering sort on a per column basis

Method Summary

Public Methods
public

addSortType(args: ...*)

Adds a sort type

public

Remove extension

public

init()

Initializes AdapterSortableTable instance

public

Set SortableTable overrides for TableFilter integration

public

sortByColumnIndex(colIdx: Number, desc: Boolean)

Sort specified column

Inherited Summary

From class Feature
public

TableFilter configuration

public

TableFilter emitter instance

public

TableFilter feature setting

public

Feature name

public

Field indicating whether Feature is initialized

public

TableFilter instance

public

Destroy the feature

public

Disable the feature

public

enable()

Enable the feature

public

init()

Initialize the feature

public

Indicate whether the feature is enabled or not

public

reset()

Reset the feature after being disabled

Public Constructors

public constructor(tf: TableFilter, opts: Object) source

Creates an instance of AdapterSortableTable

Override:

Feature#constructor

Params:

NameTypeAttributeDescription
tf TableFilter

TableFilter instance

opts Object

Configuration object

Public Members

public asyncSort: Boolean source

Enable asynchronous sort, if triggers are external

public customKey: String source

Cell attribute key storing custom value used for sorting

public desc: String source

Module description

public imgAscClassName: String source

Css class for ascending sort indicator image

public imgBlank: String source

Blank image file name

public imgClassName: String source

Css class for sort indicator image

public imgDescClassName: String source

Css class for descending sort indicator image

public imgPath: String source

Path to images

public initialized: boolean source

Override:

Feature#initialized

public name: String source

Module name

public onAfterSort: Function source

Callback fired after a table column is sorted

public onBeforeSort: Function source

Callback fired before a table column is sorted

public onSortLoaded: Function source

Callback fired when sort extension is instanciated

public sortColAtStart: Array source

Column to be sorted at initialization, ie: sort_col_at_start: [1, true]

public sortTypes: Array source

List of sort type per column basis

public triggerIds: Array source

List of element IDs triggering sort on a per column basis

Public Methods

public addSortType(args: ...*) source

Adds a sort type

Params:

NameTypeAttributeDescription
args ...*

public destroy() source

Remove extension

Override:

Feature#destroy

public init() source

Initializes AdapterSortableTable instance

Override:

Feature#init

public overrideSortableTable() source

Set SortableTable overrides for TableFilter integration

public sortByColumnIndex(colIdx: Number, desc: Boolean) source

Sort specified column

Params:

NameTypeAttributeDescription
colIdx Number

Column index

desc Boolean

Optional: descending manner