Class: HtmlTable.Select

Додає можливість видіряти рядки в таблиці.

Рефактори

• HtmlTable

HtmlTable Метод: construct

Синтаксис

new HtmlTable([table, options]);

Аргументи

1. table - (mixed; опціонально) - елемент DOM таблиці або його id; якщо ви не вкажете його, він буде створений.
2. options - (object; опціонально) набір ключ/значення опцій.

Опції

• всі опції, визначені HtmlTable, плюс:
• classZebra - (string) клас, що додається до непарних рядків; за замовчуванням 'table-tr-odd'
• useKeyboard - (boolean) якщо true (за замовчуванням) дозволяє використання стрілок для навігації по рядках та enter для їх виділення.
• classRowSelected - (string) клас, що додається до tr, який виділений; за замовчуванням 'table-tr-selected'
• classRowHovered - (string) клас, що додається до tr, на якому наведено мишу або який має фокус клавіатури; за замовчуванням 'table-tr-hovered'
• classSelectable - (string) клас, що додається до таблиці, коли виділення увімкнено; за замовчуванням 'table-selectable'
• selectable - (boolean) якщо true рядки будуть виділятись. За замовчуванням false.
• allowMultiSelect - (boolean) якщо true (за замовчуванням) користувач може виділити більше одного рядка за раз.
• shiftForMultiSelect - (boolean) увімкнює підтримку утримання shift для багатовибірки файлів (за замовчуванням false). Якщо false (і allowMultiSelect є true), клік по будь-якому рядку виділяє його.
• selectHiddenRows - (boolean) якщо false (за замовчуванням), логіка виділення ігнорує приховані рядки, ніби їх немає в DOM.

Події

• rowFocus - callback, що виконується при виділенні рядка; передається tr виділеного рядка, та колекція виділених рядків
• rowUnfocus - callback, що виконується при знятті виділення з рядка; передається tr невиділеного рядка, та колекція виділених рядків

Приклад

var myTable = new HtmlTable({
    properties: {
        border: 1,
        cellspacing: 3
    },
    rows: [
        ['apple', 'red'],
        ['lemon', 'yellow']
    ],
    selectable: true
});
myTable.inject($('someContainer'));

HtmlTable метод: enableSelect

Увімкнює виділення рядків.

Синтаксис

myTable.enableSelect();

Повертає

• (object) Цей екземпляр HtmlTable.

HtmlTable метод: disableSelect

Вимкнює виділення рядків.

Синтаксис

myTable.disableSelect();

Повертає

• (object) Цей екземпляр HtmlTable.

HtmlTable метод: toggleRow

Перемикає стан виділення рядка.

Синтаксис

myTable.toggleRow(trElement);

Повертає

• (object) Цей екземпляр HtmlTable.

HtmlTable метод: selectRow

Виділяє рядок.

Синтаксис

myTable.selectRow(trElement);

Повертає

• (object) Цей екземпляр HtmlTable.

HtmlTable метод: deselectRow

Виділяє рядок.

Синтаксис

myTable.deselectRow(trElement);

Повертає

• (object) Цей екземпляр HtmlTable.

HtmlTable метод: isSelected

Повертає стан виділення елемента рядка.

Синтаксис

myTable.isSelected(trElement);

Повертає

• (boolean) true, якщо рядок виділений.

HtmlTable метод: getSelected

Повертає масив рядків, які виділені.

Синтаксис

myTable.getSelected();

Повертає

• (array) масив елементів TR, які виділені.

HtmlTable метод: selectRange

Виділяє групу рядків.

Синтаксис

myTable.selectRange(startRow, endRow);

Аргументи

• startRow - (mixed) елемент TR, що починає виділення, або ціле число його індексу в рядках тіла таблиці.
• endRow - (mixed) елемент TR, що закінчує виділення, або ціле число його індексу в рядках тіла таблиці.

Примітка

Фактичний порядок початкового і кінцевого рядків не має значення. Діапазон виділяється навіть якщо кінцевий рядок перед початковим.

Повертає

• (object) Цей екземпляр HtmlTable.

HtmlTable метод: deselectRange

Знімає виділення з групи рядків.

Синтаксис

myTable.deselectRange(startRow, endRow);

Аргументи

• startRow - (element) елемент TR, що починає зняття виділення.
• endRow - (element) елемент TR, що закінчує зняття виділення.

Примітка

Фактичний порядок початкового і кінцевого рядків не має значення. Діапазон знімається з виділення навіть якщо кінцевий рядок перед початковим.

Повертає

• (object) Цей екземпляр HtmlTable.

HtmlTable Метод: selectAll

Виділяє всі рядки

Синтаксис

myHtmlTable.selectAll();

Повертає

• (object) Цей екземпляр HtmlTable.

HtmlTable Метод: selectNone

Знімає виділення зі всіх рядків

Синтаксис

myHtmlTable.selectNone();

Повертає

• (object) Цей екземпляр HtmlTable.

HtmlTable Метод: serialize

Повертає об'єкт, що зберігає стан виділення таблиці.

Синтаксис

      myTable.serialize();

Повертає

• (object) Object що містить стан виділення таблиці.

HtmlTable Метод: restore

Відновлює стан виділення таблиці з переданого об'єкта.

Синтаксис

      myTable.restore(tableState);

Аргументи

1. tableState - Object створений HtmlTable.serialize(), який містить стан виділення таблиці.