• Документации
• Bluebream
• BluebreamУчебник3

Учебник - часть 3

Введение

Зачастую требуется разрабатывать веб приложения с одинаковыми/похожими требованиями к функциональности, но с разным внешним видом. Варьирование внешнего вида и ощущения приложения может быть как небольшим, так и существенным. Это может быть всего лишь простая замена CSS файла и нескольких изображений. Иногда требуется изменить конфигурацию приложения с целью замещения компонентов пользовательского интерфейса, таких как виджеты, таблицы и т.д.. Также вам потребуется совместно использовать компоненты интерфейса из разных пакетов.

Есть два термина, которые ассоциируются с внешним видом - слой (layer) и скин (skin). Перед тем, как продолжить, следует лучше разобраться в этих понятиях BlueBream.

Слои

Слой определяет ощущение (feel) пользовательского интерфейса приложения. Слой содержит логику отображения приложения. Логика отображения включает в себя вывод страниц и расстановку виджетов. Общими вещами для слоев являются страницы, контент-провайдеры, менеджеры вьюдетов и вьюлеты. Слои разрабатываются BlueBream (Python) разработчиками.

Скины

Скин определяет внешний вид пользовательского интерфейса приложения. Общими понятиями для скинов являются шаблоны (ZPT) и ресурсы (CSS, Javascript, и т.д.). Скин использует слои для получения данных шаблонами. Скины разрабатываются HTML верстальщиками и графическими дизайнерами.

Слои против скинов

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

И слои и скины поддерживают наследование/заимствование. Этот механизм реализуется путем комбинирования наследования интерфейсов и техник просмотра компонентов.

Из коробки в BlueBream доступны несколько скинов. К сожалению, компоненты интерфейса, которые входят в эти скины сложно использовать повторно, поскольку они базируются на не очень гибком механизме макросов. Поэтому, лучше начинать с нуля. Такой подход также исключает лишнюю работу, которая проявляется при использовании слишком обобщенных и универсализированных скинов. В будущем эти скины будут заменены или удалены совсем.

В этом разделе обсуждается создание нового скина для приложения "сборщик заявок".

Новый скин

Все виды (представления) по умолчанию регистрируются на слой, который установлен по умолчанию. Следовательно, вам не нужно явно указывать слой, чтобы зарегистрировать вид на слой по умолчанию. Интерфейс, который определяет слой по умолчанию, находится тут: zope.publisher.interfaces.browser.IDefaultBrowserLayer. Слой по умолчанию содержит множество вещей, которые вам не всегда нужны (настройки безопасности). Поскольку очень много всего в zope.app зарегистрировано на слой по умолчанию, он содержит неконтролируемое количество мусора. Очень трудно подтвердить, что все регистрации соответствуют потребностям безопасности вашего приложения. Другая проблема в том, что эти виды могут быть доступны, даже когда вы этого не хотите. И хотя рекомендуется разрабатывать слои с нуля, некоторые регистрации в слое по умолчанию могут быть очень даже полезными. Примерами являются регистрации видов страниц с ошибками, регистрации траверсинга, и виджеты.

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

Вы можете создать новый пакет с именем skin внутри пространства имен tc. Все вещи, связанные со скином, будут добавляться здесь. Сначала создайте папку skin и файл _ _init_ _.py, чтобы создать пакет Python:

   1 $ mkdir src/tc/skin
   2 $ echo "#Python Package" > src/tc/skin/__init__.py

Определение скина будет находится в src/tc/skin/interfaces.py, а регистрация в src/tc/skin/configure.zcml. Чтобы создать новый слой, вам следует описать интерфейс типа IBrowserSkinType. Создайте ITCLayer, как показано ниже, в src/tc/skin/interfaces.py:

   1 from zope.publisher.interfaces.browser import IBrowserSkinType
   2 
   3 class ITCLayer(IBrowserSkinType):
   4     """Ticket collector application layer"""

   1 from zope.interface.interfaces import IInterface
   2 
   3 class IMyInterfaceType(IInterface):
   4     """My interface type"""

Чтобы использовать этот слой, поменяйте все директивы page, viewletmanager, и viewlet, чтобы они указывали на его использование:

   1 layer="tc.skin.interfaces.ITCLayer"

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

Скины также являются интерфейсами, которые определены в пакете zope.interface. Вы можете создать интерфейс скина, наследуясь от интерфейса слоя. Например, есть ITCSkin, который наследуется от слоя приложения ticket collector (ITCLayer):

   1 class ITCSkin(ITCLayer):
   2     """Skin for ticket collector app."""

Чтобы зарегистрировать его, можно использовать директивы interface и utility из пространства имен zope. Добавьте следующие строки в src/tc/skin/configure.zcml:

   1 <configure
   2    xmlns="http://namespaces.zope.org/zope"
   3    xmlns:browser="http://namespaces.zope.org/browser"
   4    i18n_domain="ticketcollector">
   5 
   6   <interface
   7       interface="tc.skin.interfaces.ITCSkin"
   8       type="zope.publisher.interfaces.browser.IBrowserSkinType"
   9       />
  10 
  11   <utility
  12       component="tc.skin.interfaces.ITCSkin"
  13       provides="zope.publisher.interfaces.browser.IBrowserSkinType"
  14       name="TCSkin"
  15       />
  16 
  17 </configure>

В качестве сокращения вы также можете использовать только директиву interface, передав ей параметр name. Что касается скинов, следующая директива сделает то же самое, что и две предыдущие:

   1 <interface
   2     interface="tc.skin.interfaces.ITCSkin"
   3     type="zope.publisher.interfaces.browser.IBrowserSkinType"
   4     name="TCSkin"
   5     />

На данном этапе определение скина завершено, но он все еще не включен из главного пакета приложения. Чтобы включить этот пакет в главный (tc.main), вам следует изменить src/tc/main/configure.zcml и добавить следующее перед </configure>:

   1 <include package="tc.skin" />

Теперь вы можете регистрировать все шаблоны на этот скин, добавляя атрибут layer:

   1 layer="tc.skin.interfaces.ITCSkin"

Как видите, не нужно создавать дополнительный слой, чтобы создать новый скин. Но настоятельно рекомендуется объявлять виды для скина прямо, а не регистрировать их для слоя.

Обновление видов

Обновите вид add_ticket_collector в src/tc/collector/configure.zcml:

   1 <browser:page
   2    for="zope.site.interfaces.IRootFolder"
   3    name="add_ticket_collector"
   4    permission="zope.Public"
   5    class="tc.collector.views.AddTicketCollector"
   6    layer="tc.skin.interfaces.ITCSkin"
   7    />

Также обновите главную страницу для ICollector, добавив новый слой в src/tc/collector/configure.zcml:

   1 <browser:page
   2    for="tc.collector.interfaces.ICollector"
   3    name="index"
   4    permission="zope.Public"
   5    class="tc.collector.views.TicketCollectorMainView"
   6    layer="tc.skin.interfaces.ITCSkin"
   7    />

То же самое нужно сделать со всеми другими видами:

   1 <browser:page
   2    for="tc.collector.interfaces.ICollector"
   3    name="add_ticket"
   4    permission="zope.Public"
   5    class="tc.collector.views.AddTicket"
   6    layer="tc.skin.interfaces.ITCSkin"
   7    />
   8 
   9 <browser:page
  10    for="tc.collector.interfaces.ITicket"
  11    name="index"
  12    permission="zope.Public"
  13    class="tc.collector.views.TicketMainView"
  14    layer="tc.skin.interfaces.ITCSkin"
  15    />
  16 
  17 <browser:page
  18    for="tc.collector.interfaces.ITicket"
  19    name="add_comment"
  20    permission="zope.Public"
  21    class="tc.collector.views.AddComment"
  22    layer="tc.skin.interfaces.ITCSkin"
  23    />

Использование скина

To access a skin, you need to use ++skin++ in the begining of the path followed by the skin name. For example, if the skin name is TCSkin, the site can be accessed like this: http://localhost:8080/++skin++TCSkin

You can hide the skin traversal step by using Apache’s virtual hosting feature.

To change the default skin to something else use the browser:defaultSkin directive. You can set TCSkin as the default skin like this:

<browser:defaultSkin name="TCSkin" /> You can add this declaration in the etc/overrides.zcml file. So that it will be overridden by the previous declaration, if there is any.

Регистрация полезных видов

There are few basic views which are useful for any application. This section document all the use useful views available in BlueBream. You can use this tird party package: http://pypi.python.org/pypi/z3c.layer.minimal

Использование CSS ресурсов

Выводы

This chapter introduced concepts related to BlueBream skinning. This chapter also explained howto create layers and skins from scratch.