Z3C Таблица

Цель, которую преследует пакет z3c.table - предложить модульную библиотеку для отрисовки таблиц. Мы используем шаблон "контент провайдер" с колонками, реализованными как адаптеры. Такой подход - мощная базовая концепция.

Важные требования

разделение реализации в обновлении частей отрисовки. Такой подход позволяет манипулировать данными после обновления, и перед отрисовкой.
мы можем использовать шаблоны страниц, если потребуется, но, по умолчанию, все делается в Python.
мы может отрисовывать порционную навигацию отдельно от самой таблицы.

Никаких скинов

Этот пакет не предоставляет никаких шаблонов и скинов. В любом случае, когда вам нужно отрисовать красивую таблицу, вам придется писать свой собственный скин или шаблон. Отсутствие шаблонов и скинов позволяет удостоверится, что z3c.table имеет очень мало зависимостей, а поэтому легко поддается повторному использованию.

Заметка

Как вы, вероятно, уже знаете, перед тем, как выполняется сортировка по столбцам при порционном отображении данных таблицы, должна быть выполнена сортировка полного набора данных. При большом наборе данных это ведет к проблемам с быстродействием. При работе с большими объемами данных мы рекомендуем не совмещать порционное отображение с сортировкой по столбцам, либо, если нужно, предоставлять "умный" механизм кеширования данных для хранения отсортированных последовательностей.

Пример установки данных

Таблицы часто используются для отображения нормализованных порций данных. Например, нам необходимо отобразить информацию о файлах в папке. Каждый файл имеет заголовок, размер и тип. Наша таблица должна иметь строку для каждого файла и столбец для этих трех полей данных (заголовка, размера, и типа). Контекстом таблицы всегда является структура данных, по которой можно выполнить итерацию, при этом каждый элемент последовательности соответствует строке таблицы. Давайте создадим папку, которую мы сможем использовать как контекст:

-  ⇤ ← Версия 21 от 2010-07-13 13:47:58 → 
  Размер: 63141
  Редактор: RostislavDzinko
  Комментарий:
+   ← Версия 31 от 2010-07-14 12:27:34 → ⇥
  Размер: 83511
  Редактор: RostislavDzinko
  Комментарий:
-Удаления помечены так.
+Добавления помечены так.
 Строка 5:
-= Z3C Table =
+= Z3C Таблица =
 Строка 9:
-= Важные требования =
+== Важные требования ==
 Строка 15:
-= Никаких скинов =
+== Никаких скинов ==
 Строка 19:
-= Заметка =
+== Заметка ==
 Строка 23:
-= Пример установки данных =
+== Пример установки данных ==
 Строка 60:
-= Создание таблиц =
+== Создание таблиц ==
 Строка 88:
-= Создание столбцов =
+== Создание столбцов ==
 Строка 105:
-= Добавление колонки в таблицу с использованием адаптеров =
+== Добавление колонки в таблицу с использованием адаптеров ==
 Строка 182:
-= Объединение ячеек =
+== Объединение ячеек ==
 Строка 268:
-= Установка колонок =
+== Установка колонок ==
 Строка 331:
-= Каскадные таблицы стилей =
+== Каскадные таблицы стилей ==
 Строка 391:
-= Перемежающиеся таблицы =
+== Перемежающиеся таблицы ==
 Строка 454:
-= Сортировка таблицы =
+== Сортировка таблицы ==
 Строка 673:
-= Настройка таблицы на базе класса =
+== Настройка таблицы на базе класса ==
 Строка 786:
-= Порционное отображение данных =
+== Порционное отображение данных ==
 Строка 1233:
-= BatchProvider =
+== BatchProvider ==
 Строка 1423:
-= SequenceTable =
+== SequenceTable ==
 Строка 1677:
-= Заголовки =
+== Заголовки ==
 Строка 1734:
-= Другое =
+== Другое ==
 Строка 1811:
+= Column (Столбец) =

Давайте покажем разницу между столбцами, которые мы предлагаем по умолчанию. Но сначала взгляните на '''README.txt''', который объясняет концепции '''Table''' (таблицы) и '''Column''' (колонки).

== Настройка тестовых данных ==

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

{{{#!highlight python
>>> from zope.app.container import btree
>>> class Container(btree.BTreeContainer):
...     """Sample container."""
>>> container = Container()
>>> root['container'] = container
}}}

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

{{{#!highlight python
>>> class Content(object):
...     """Sample content."""
...     def __init__(self, title, number):
...         self.title = title
...         self.number = number
}}}

Теперь добавим несколько объектов в контейнер:

{{{#!highlight python
>>> container[u'zero'] = Content('Zero', 0)
>>> container[u'first'] = Content('First', 1)
>>> container[u'second'] = Content('Second', 2)
>>> container[u'third'] = Content('Third', 3)
>>> container[u'fourth'] = Content('Fourth', 4)
}}}

Давайте также создадим простую сортируемую колонку:

{{{#!highlight python
>>> from z3c.table import column
>>> class NumberColumn(column.Column):
...
...     header = u'Number'
...     weight = 20
...
...     def getSortKey(self, item):
...         return item.number
...
...     def renderCell(self, item):
...         return 'number: %s' % item.number
}}}

== NameColumn ==

Давайте определим таблицу с использованием '''!NameColumn''':

{{{#!highlight python:
>>> from z3c.table import table
>>> class NameTable(table.Table):
...
...     def setUpColumns(self):
...         return [
...             column.addColumn(self, column.NameColumn, u'name',
...                              weight=1),
...             column.addColumn(self, NumberColumn, name=u'number',
...                              weight=2, header=u'Number')
...             ]
}}}

Теперь создадим, обновим и отобразим таблицу и вы увидите, что '''!NameColumn''' отображает имя объекта, используя метод '''zope.traversing.api.getName()''':

{{{#!highlight python
>>> from zope.publisher.browser import TestRequest
>>> request = TestRequest()
>>> nameTable = NameTable(container, request)
>>> nameTable.update()
>>> print nameTable.render()
}}}
{{{#!highlight html
<table>
  <thead>
    <tr>
      <th>Name</th>
      <th>Number</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>first</td>
      <td>number: 1</td>
    </tr>
    <tr>
      <td>fourth</td>
      <td>number: 4</td>
    </tr>
    <tr>
      <td>second</td>
      <td>number: 2</td>
    </tr>
    <tr>
      <td>third</td>
      <td>number: 3</td>
    </tr>
    <tr>
      <td>zero</td>
      <td>number: 0</td>
    </tr>
  </tbody>
</table>
}}}

== RadioColumn ==

Давайте определим таблицу используя '''!RadioColumn''':

{{{#!highlight python
>>> class RadioTable(table.Table):
...
...     def setUpColumns(self):
...         return [
...             column.addColumn(self, column.RadioColumn, u'radioColumn',
...                              weight=1),
...             column.addColumn(self, NumberColumn, name=u'number',
...                              weight=2, header=u'Number')
...             ]
}}}

Теперь создадим, обновим и отобразим таблицу:

{{{#!highlight python
>>> request = TestRequest()
>>> radioTable = RadioTable(container, request)
>>> radioTable.update()
>>> print radioTable.render()
}}}
{{{#!highlight html
<table>
  <thead>
    <tr>
      <th>X</th>
      <th>Number</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><input type="radio" class="radio-widget" name="table-radioColumn-0-selectedItem" value="first"  /></td>
      <td>number: 1</td>
    </tr>
    <tr>
      <td><input type="radio" class="radio-widget" name="table-radioColumn-0-selectedItem" value="fourth"  /></td>
      <td>number: 4</td>
    </tr>
    <tr>
      <td><input type="radio" class="radio-widget" name="table-radioColumn-0-selectedItem" value="second"  /></td>
      <td>number: 2</td>
    </tr>
    <tr>
      <td><input type="radio" class="radio-widget" name="table-radioColumn-0-selectedItem" value="third"  /></td>
      <td>number: 3</td>
    </tr>
    <tr>
      <td><input type="radio" class="radio-widget" name="table-radioColumn-0-selectedItem" value="zero"  /></td>
      <td>number: 0</td>
    </tr>
  </tbody>
</table>
}}}

Как видите, мы можем насильно отобразить поле опционного ввода, как выбрано в значении, что передается через переменную запроса:

{{{#!highlight python
>>> radioRequest = TestRequest(form={'table-radioColumn-0-selectedItem': 'third'})
>>> radioTable = RadioTable(container, radioRequest)
>>> radioTable.update()
>>> print radioTable.render()
}}}
{{{#!highlight html
<table>
  <thead>
    <tr>
      <th>X</th>
      <th>Number</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><input type="radio" class="radio-widget" name="table-radioColumn-0-selectedItem" value="first"  /></td>
      <td>number: 1</td>
    </tr>
    <tr>
      <td><input type="radio" class="radio-widget" name="table-radioColumn-0-selectedItem" value="fourth"  /></td>
      <td>number: 4</td>
    </tr>
    <tr>
      <td><input type="radio" class="radio-widget" name="table-radioColumn-0-selectedItem" value="second"  /></td>
      <td>number: 2</td>
    </tr>
    <tr>
      <td><input type="radio" class="radio-widget" name="table-radioColumn-0-selectedItem" value="third" checked="checked" /></td>
      <td>number: 3</td>
    </tr>
    <tr>
      <td><input type="radio" class="radio-widget" name="table-radioColumn-0-selectedItem" value="zero"  /></td>
      <td>number: 0</td>
    </tr>
  </tbody>
</table>
}}}

== CheckBoxColumn ==

Давайте определим таблицу с использованием '''!CheckBoxColumn''':

{{{#!highlight python
>>> class CheckBoxTable(table.Table):
...
...     def setUpColumns(self):
...         return [
...             column.addColumn(self, column.CheckBoxColumn, u'checkBoxColumn',
...                              weight=1),
...             column.addColumn(self, NumberColumn, name=u'number',
...                              weight=2, header=u'Number')
...             ]
}}}

Теперь создадим, обновим и отобразим таблицу:

{{{#!highlight python
>>> request = TestRequest()
>>> checkBoxTable = CheckBoxTable(container, request)
>>> checkBoxTable.update()
>>> print checkBoxTable.render()
}}}
{{{#!highlight html
<table>
  <thead>
    <tr>
      <th>X</th>
      <th>Number</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><input type="checkbox" class="checkbox-widget" name="table-checkBoxColumn-0-selectedItems" value="first"  /></td>
      <td>number: 1</td>
    </tr>
    <tr>
      <td><input type="checkbox" class="checkbox-widget" name="table-checkBoxColumn-0-selectedItems" value="fourth"  /></td>
      <td>number: 4</td>
    </tr>
    <tr>
      <td><input type="checkbox" class="checkbox-widget" name="table-checkBoxColumn-0-selectedItems" value="second"  /></td>
      <td>number: 2</td>
    </tr>
    <tr>
      <td><input type="checkbox" class="checkbox-widget" name="table-checkBoxColumn-0-selectedItems" value="third"  /></td>
      <td>number: 3</td>
    </tr>
    <tr>
      <td><input type="checkbox" class="checkbox-widget" name="table-checkBoxColumn-0-selectedItems" value="zero"  /></td>
      <td>number: 0</td>
    </tr>
  </tbody>
</table>
}}}

И снова вы можете насильно отобразить поле ввода с галочкой, как указано в переменной запроса:

{{{#!highlight python
>>> checkBoxRequest = TestRequest(form={'table-checkBoxColumn-0-selectedItems':
...                                     ['first', 'third']})
>>> checkBoxTable = CheckBoxTable(container, checkBoxRequest)
>>> checkBoxTable.update()
>>> print checkBoxTable.render()
}}}
{{{#!highlight html
<table>
  <thead>
    <tr>
      <th>X</th>
      <th>Number</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><input type="checkbox" class="checkbox-widget" name="table-checkBoxColumn-0-selectedItems" value="first" checked="checked" /></td>
      <td>number: 1</td>
    </tr>
    <tr>
      <td><input type="checkbox" class="checkbox-widget" name="table-checkBoxColumn-0-selectedItems" value="fourth"  /></td>
      <td>number: 4</td>
    </tr>
    <tr>
      <td><input type="checkbox" class="checkbox-widget" name="table-checkBoxColumn-0-selectedItems" value="second"  /></td>
      <td>number: 2</td>
    </tr>
    <tr>
      <td><input type="checkbox" class="checkbox-widget" name="table-checkBoxColumn-0-selectedItems" value="third" checked="checked" /></td>
      <td>number: 3</td>
    </tr>
    <tr>
      <td><input type="checkbox" class="checkbox-widget" name="table-checkBoxColumn-0-selectedItems" value="zero"  /></td>
      <td>number: 0</td>
    </tr>
  </tbody>
</table>
}}}

Если вы выбираете строку, вы также можете предоставить дополнительный CSS стиль. Это может быть использовано при создании перемежающихся строк:

{{{#!highlight python
>>> checkBoxRequest = TestRequest(form={'table-checkBoxColumn-0-selectedItems':
...                                     ['first', 'third']})
>>> checkBoxTable = CheckBoxTable(container, checkBoxRequest)
>>> checkBoxTable.cssClasses = {'tr': 'tr'}
>>> checkBoxTable.cssClassSelected = u'selected'
>>> checkBoxTable.cssClassEven = u'even'
>>> checkBoxTable.cssClassOdd = u'odd'
>>> checkBoxTable.update()
>>> print checkBoxTable.render()
}}}
{{{#!highlight html
<table>
  <thead>
    <tr class="tr">
      <th>X</th>
      <th>Number</th>
    </tr>
  </thead>
  <tbody>
    <tr class="selected even tr">
      <td><input type="checkbox" class="checkbox-widget" name="table-checkBoxColumn-0-selectedItems" value="first" checked="checked" /></td>
      <td>number: 1</td>
    </tr>
    <tr class="odd tr">
      <td><input type="checkbox" class="checkbox-widget" name="table-checkBoxColumn-0-selectedItems" value="fourth"  /></td>
      <td>number: 4</td>
    </tr>
    <tr class="even tr">
      <td><input type="checkbox" class="checkbox-widget" name="table-checkBoxColumn-0-selectedItems" value="second"  /></td>
      <td>number: 2</td>
    </tr>
    <tr class="selected odd tr">
      <td><input type="checkbox" class="checkbox-widget" name="table-checkBoxColumn-0-selectedItems" value="third" checked="checked" /></td>
      <td>number: 3</td>
    </tr>
    <tr class="even tr">
      <td><input type="checkbox" class="checkbox-widget" name="table-checkBoxColumn-0-selectedItems" value="zero"  /></td>
      <td>number: 0</td>
    </tr>
  </tbody>
</table>
}}}

Давайте протестируем '''cssClassSelected''' без других css классов

{{{#!highlight python
>>> checkBoxRequest = TestRequest(form={'table-checkBoxColumn-0-selectedItems':
...                                     ['first', 'third']})
>>> checkBoxTable = CheckBoxTable(container, checkBoxRequest)
>>> checkBoxTable.cssClassSelected = u'selected'
>>> checkBoxTable.update()
>>> print checkBoxTable.render()
}}}
{{{#!highlight html
<table>
  <thead>
    <tr>
      <th>X</th>
      <th>Number</th>
    </tr>
  </thead>
  <tbody>
    <tr class="selected">
      <td><input type="checkbox" class="checkbox-widget" name="table-checkBoxColumn-0-selectedItems" value="first" checked="checked" /></td>
      <td>number: 1</td>
    </tr>
    <tr>
      <td><input type="checkbox" class="checkbox-widget" name="table-checkBoxColumn-0-selectedItems" value="fourth"  /></td>
      <td>number: 4</td>
    </tr>
    <tr>
      <td><input type="checkbox" class="checkbox-widget" name="table-checkBoxColumn-0-selectedItems" value="second"  /></td>
      <td>number: 2</td>
    </tr>
    <tr class="selected">
      <td><input type="checkbox" class="checkbox-widget" name="table-checkBoxColumn-0-selectedItems" value="third" checked="checked" /></td>
      <td>number: 3</td>
    </tr>
    <tr>
      <td><input type="checkbox" class="checkbox-widget" name="table-checkBoxColumn-0-selectedItems" value="zero"  /></td>
      <td>number: 0</td>
    </tr>
  </tbody>
</table>
}}}

== CreatedColumn ==

Давайте определим таблицу с использованием '''!CreatedColumn''':

{{{#!highlight python
>>> class CreatedColumnTable(table.Table):
...
...     def setUpColumns(self):
...         return [
...             column.addColumn(self, column.CreatedColumn, u'createdColumn',
...                              weight=1),
...             ]
}}}

Теперь создадим, обновим и отобразим таблицу. Заметьте, что мы используем тестовый адаптер к dublin core, который возвращает 01/01/01 01:01 в качестве даты создания:

{{{#!highlight python
>>> request = TestRequest()
>>> createdColumnTable = CreatedColumnTable(container, request)
>>> createdColumnTable.update()
>>> print createdColumnTable.render()
}}}
{{{#!highlight html
<table>
  <thead>
    <tr>
      <th>Created</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>01/01/01 01:01</td>
    </tr>
    <tr>
      <td>01/01/01 01:01</td>
    </tr>
    <tr>
      <td>01/01/01 01:01</td>
    </tr>
    <tr>
      <td>01/01/01 01:01</td>
    </tr>
    <tr>
      <td>01/01/01 01:01</td>
    </tr>
  </tbody>
</table>
}}}

== ModifiedColumn ==

Давайте определим таблицу используя '''!ModifiedColumn''':

{{{#!highlight python
>>> class ModifiedColumnTable(table.Table):
...
...     def setUpColumns(self):
...         return [
...             column.addColumn(self, column.ModifiedColumn,
...                              u'modifiedColumn', weight=1),
...             ]
}}}

Теперь создадим, обновим и отобразим таблицу. Заметьте, мы использовали тестовый адаптер dublin core, который возвращает 02/02/02 02:02 в качестве даты модификации:

{{{#!highlight python
>>> request = TestRequest()
>>> modifiedColumnTable = ModifiedColumnTable(container, request)
>>> modifiedColumnTable.update()
>>> print modifiedColumnTable.render()
}}}
{{{#!highlight html
<table>
  <thead>
    <tr>
      <th>Modified</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>02/02/02 02:02</td>
    </tr>
    <tr>
      <td>02/02/02 02:02</td>
    </tr>
    <tr>
      <td>02/02/02 02:02</td>
    </tr>
    <tr>
      <td>02/02/02 02:02</td>
    </tr>
    <tr>
      <td>02/02/02 02:02</td>
    </tr>
  </tbody>
</table>
}}}

== GetAttrColumn ==

Столбец '''!GetAttrColumn''' - это помесь (mixin), которая используется в '''!CreatedColumn''' и в '''!ModifiedColumn'''. Если все хорошо, то используется не весь код. Давайте протестируем эту колонку саму по себе:

{{{#!highlight python
>>> class GetTitleColumn(column.GetAttrColumn):
...
...     attrName = 'title'
...     defaultValue = u'missing'
>>> class GetAttrColumnTable(table.Table):
...
...     attrName = 'title'
...     defaultValue = u'missing'
...
...     def setUpColumns(self):
...         return [
...             column.addColumn(self, GetTitleColumn, u'title'),
...             ]
}}}

Обновите и отобразите таблицу:

{{{#!highlight python
>>> request = TestRequest()
>>> getAttrColumnTable = GetAttrColumnTable(container, request)
>>> getAttrColumnTable.update()
>>> print getAttrColumnTable.render()
}}}
{{{#!highlight html
<table>
  <thead>
    <tr>
      <th></th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>First</td>
    </tr>
    <tr>
      <td>Fourth</td>
    </tr>
    <tr>
      <td>Second</td>
    </tr>
    <tr>
      <td>Third</td>
    </tr>
    <tr>
      <td>Zero</td>
    </tr>
  </tbody>
</table>
}}}

Если мы используем не существующий атрибут, то не получаете '''!AttributeError''', а значение по умолчанию, которое определено в '''!GetAttrColumnTable'''.

{{{#!highlight python
>>> class UndefinedAttributeColumn(column.GetAttrColumn):
...
...     attrName = 'undefined'
...     defaultValue = u'missing'
>>> class GetAttrColumnTable(table.Table):
...
...     attrName = 'title'
...     defaultValue = u'missing'
...
...     def setUpColumns(self):
...         return [
...             column.addColumn(self, UndefinedAttributeColumn, u'missing'),
...             ]
}}}

Обновите и отобразите таблицу:

{{{#!highlight python
>>> request = TestRequest()
>>> getAttrColumnTable = GetAttrColumnTable(container, request)
>>> getAttrColumnTable.update()
>>> print getAttrColumnTable.render()
}}}
{{{#!hihghlight html
<table>
  <thead>
    <tr>
      <th></th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>missing</td>
    </tr>
    <tr>
      <td>missing</td>
    </tr>
    <tr>
      <td>missing</td>
    </tr>
    <tr>
      <td>missing</td>
    </tr>
    <tr>
      <td>missing</td>
    </tr>
  </tbody>
</table>
}}}

Несуществующий '''attrName''' в '''GetAttrColumn''' также вернет '''defaultValue''':

{{{#!highlight python
>>> class BadAttributeColumn(column.GetAttrColumn):
...
...     defaultValue = u'missing'
>>> firstItem = container[u'first']
>>> simpleTable = table.Table(container, request)
>>> badColumn = column.addColumn(simpleTable, BadAttributeColumn, u'bad')
>>> badColumn.renderCell(firstItem)
u'missing'
}}}

Если мы попытаемся получить доступ к защищенному атрибуту, объект вызовет исключение '''Unauthorized'''. В этом случае вы также получите '''defaultValue'''. Давайте установим объект, который вызывает такую ошибку при попытке доступа к атрибуту '''title''':

{{{#!highlight python
>>> from zope.security.interfaces import Unauthorized
>>> class ProtectedItem(object):
...
...     @property
...     def forbidden(self):
...         raise Unauthorized, 'forbidden'
}}}

Установите и протестируйте объект:

{{{#!highlight python
>>> protectedItem = ProtectedItem()
>>> protectedItem.forbidden
...
Unauthorized: forbidden
}}}

Теперь определим столбец:

{{{#!highlight python
>>> class ForbiddenAttributeColumn(column.GetAttrColumn):
...
...     attrName = 'forbidden'
...     defaultValue = u'missing'
And test the attribute access:

>>> simpleTable = table.Table(container, request)
>>> badColumn = column.addColumn(simpleTable, ForbiddenAttributeColumn, u'x')
>>> badColumn.renderCell(protectedItem)
u'missing'
}}}

Страница

Пользователь

Z3C Таблица

Важные требования

Никаких скинов

Заметка

Пример установки данных

Создание таблиц

Создание столбцов

Добавление колонки в таблицу с использованием адаптеров

Объединение ячеек

Установка колонок

Каскадные таблицы стилей

Перемежающиеся таблицы

Сортировка таблицы

Настройка таблицы на базе класса

Порционное отображение данных

BatchProvider

SequenceTable

Заголовки

Другое

Column (Столбец)

Настройка тестовых данных

NameColumn

RadioColumn

CheckBoxColumn

CreatedColumn

ModifiedColumn

GetAttrColumn