MODx.grid.Grid

MODx.grid.Grid¶

Расширяет: Ext.grid.EditorGridPanel

Основные характеристики: функциональность коннектора; позволяет легко интегрировать элементы панели инструментов и MODx.Window; встроенная функциональность контекстного меню.

При создании этого экземпляра в интерфейсе с вкладками рекомендуется установить в своей конфигурации protectRender: true, чтобы предотвратить проблемы с отображением JS.

Сетки MODExt используются для отображения табличных данных в комплекте с ColumnModel, верхней панелью инструментов (tbar) и нижней панелью инструментов (bbar). Они также имеют встроенную поддержку постраничного разбиения. Сетки заполняются удаленно по запросу в коннектор, возвращающего объект JSON. Отображение контекстного меню правой кнопкой мыши для каждой строки может быть легко достигнуто включением ключа «menu» для каждой строки данных в вашем процессоре:

foreach( $items as $item ) {
    $data[] = array(
        'id'    => $obj->get( 'id' ),
        'name'  => $obj->get( 'name' ),
        'menu'  => array(
            array(
                'text'      => $modx->lexicon( 'my_lexicon' ),
                'handler'   => 'this.myHandler'
            )
        )
    );
}

Приведенный выше код создает контекстное меню для каждого элемента, текст которого является ключом лексикона, соответствующим «my_lexicon», а обработчик - функцией myHandler, зарегистрированной в вашем объекте Grid.

Альтернативно (и предпочтительно) меню могут быть созданы путем расширения вашей сетки JS и добавления метода «getMenu»:

getMenu: function() {
    var m = [];
    m.push({
        text: _('my_lexicon_key')
        ,handler: this.myHandler
    });
    return m;
}

Возвращение массива элементов в методе getMenu автоматически добавит элементы в контекстное меню.

Сетки Revolution 2.0.x не могут просто вернуть массив - им нужно будет вызвать «this.addContextMenuItem(m);» перед концом функции. Возвращающий массив был добавлен в версии 2.1.

Специфичные для MODExt параметры¶

Прежде всего, MODx.grid.Grid извлекает свои данные удаленно через параметр конфигурации "url". Он также загружает baseParams в вызов, который по умолчанию выглядит как:

baseParams: { action: 'getList' }

Вы можете переопределить baseParams в параметре конфигурации.

MODx.grid.Grid добавляет несколько уникальных параметров, которых нет в типичных объектах Ext.grid.Grid:

Полный список всех параметров, не перечисленных здесь, см. в документации ExtJS.

Пользовательские события¶

MODx.grid.Grid добавляет несколько дополнительных событий, не найденных в объектах Ext.grid.Grid:

Другие уникальные функции¶

Сетки MODExt имеют довольно много других функций.

Пользовательские сообщения об исключениях¶

Если возвращаемый JSON не является допустимой коллекцией хранилища данных и содержит параметр «message», для него будет задано значение emptyText для сетки и будет отображаться в качестве первой строки сетки. Обычно используется $modx->error->failure('Сообщение здесь') в ваших процессорах.

loadWindow¶

Автоматически загружает и показывает окно любого данного xtype:

grid.loadWindow({
  xtype: 'my-xtype-for-the-window'
  ,blankValues: true /* очищает значения окна, полезно для новых оконных объектов, установите в false для обновления окон */
});

Если blankValues не установлен в true, этот метод автоматически передаст данные текущей выбранной строки также в окно, установив его значения в форме (при условии, что ваше окно расширяет MODx.Window.)

remove¶

MODx.grid.Grid поставляется с пользовательским методом под названием «remove», который автоматически запускает AJAX-запрос к вашему коннектору, установленному в config.url с действием «remove», и ID (или primaryKey, установленный в конфигурации) выбранной строки. Это полезно для контекстных меню.

Метод принимает один параметр - текст - текст, отображаемый в диалоговом окне подтверждения, которое запрашивает пользователя, хотят ли они удалить строку перед тем, как это сделать. Событие beforeRemoveRow вызывается до загрузки диалогового окна подтверждения.

grid.remove("Вы уверены, что хотите удалить этот объект?");

config¶

Это пользовательский метод, который позволяет открыть диалоговое окно подтверждения перед выполнением действия:

grid.confirm("approve","Вы уверены, что хотите принять эту статью?");

Как и при удалении, метод принимает идентификатор или primaryKey выбранной в данный момент строки и отправит его на процессорное действие, указанное в первом параметре метода подтверждения. Когда выполнится, метод обновит сетку.

refresh¶

Пользовательский метод, который будет обновлять сетку при каждом запуске.

encodeModified¶

Метод вернет объект JSON всех измененных (грязных) строк и полей. Полезно, если для автосохранения установлено значение false.

encode¶

Метод вернет объект JSON для всех строк.

Смотрите также¶

1. Объект MODExt MODx
2. Учебник по MODExt
   1. Ext JS - Окна сообщений
   2. Ext JS - Ajax
   3. Ext JS - Анимация
   4. Ext JS - Управление узлами
   5. Ext JS - Панели
   6. Ext JS - Расширенная сетка
   7. Ext JS - Внутри CMP
3. MODx.combo.ComboBox
4. MODx.Console
5. MODx.FormPanel
6. MODx.grid.Grid
7. MODx.grid.LocalGrid
8. MODx.msg
9. MODx.tree.Tree
10. MODx.Window