- -
-

PyAMS skin utilities

-
-

Module contents

-
-
-pyams_skin.includeme(config)
-

Pyramid include

-
- -
- -
-

Submodules

-
-

pyams_skin.configuration module

-
-
-class pyams_skin.configuration.BackOfficeConfiguration
-

Bases: persistent.Persistent, zope.container.contained.Contained

-

Back-office manageable configuration

-
-
-display_content_icon
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-display_shared_tool_title
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-static get_title_prefix(request)
-
- -
-
-icon
-

Property class used to handle files

-
- -
- -

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-login_header
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
- -

Property class used to handle files

-
- -
-
-short_title
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-title
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
- -
-
-pyams_skin.configuration.BackOfficeConfigurationFactory(context)
-

Back-office configuration factory

-
- -
-
-class pyams_skin.configuration.BackOfficeConfigurationTalesExtension(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

extension:back_configuration TALES expression

-
-
-render(context=None)
-
- -
- -
-
-class pyams_skin.configuration.BackOfficeConfigurationTraverser(context)
-

Bases: pyams_utils.adapter.ContextAdapter

-

++back-configuration++ namespace traverser

-
-
-traverse(name, furtherpath=None)
-
- -
- -
-
-class pyams_skin.configuration.Configuration
-

Bases: persistent.Persistent, zope.container.contained.Contained

-

Manageable configuration

-
-
-author
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-description
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-static get_title_prefix(request)
-
- -
-
-icon
-

Property class used to handle files

-
- -
- -

Property class used to handle files

-
- -
-
-short_title
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-title
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
- -
-
-pyams_skin.configuration.ConfigurationFactory(context)
-

Configuration factory

-
- -
-
-class pyams_skin.configuration.ConfigurationTalesExtension(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

extension:configuration TALES expression

-
-
-render(context=None)
-
- -
- -
-
-class pyams_skin.configuration.ConfigurationTraverser(context)
-

Bases: pyams_utils.adapter.ContextAdapter

-

++configuration++ namespace traverser

-
-
-traverse(name, furtherpath=None)
-
- -
- -
-
-class pyams_skin.configuration.StaticConfiguration(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Default static configuration

-
-
-accordion_menus = True
-
- -
-
-application_name = 'PyAMS'
-
- -
-
-application_package = 'pyams_skin'
-
- -
-
-body_css_class = 'fixed-header fixed-ribbon fixed-navigation'
-
- -
-
-include_flags = False
-
- -
-
-include_header = True
-
- -
-
-include_logout_button = True
-
- -
-
-include_menus = True
-
- -
-
-include_minify_button = True
-
- -
- -
- -
-
-include_reload_button = True
-
- -
-
-include_ribbon = True
-
- -
- -
- -
- -
- -
-
-include_user_activity = True
-
- -
-
-include_user_shortcuts = True
-
- -
-
-inner_package = None
-
- -
-
-inner_package_name = None
-
- -
-
-mobile_search_handler = '#search.html'
-
- -
-
-mobile_search_placeholder = 'Search...'
-
- -
-
-site_search_handler = '#search.html'
-
- -
-
-site_search_placeholder = 'Search...'
-
- -
-
-version
-
- -
-
-version_location = 'menus'
-
- -
- -
-
-class pyams_skin.configuration.StaticConfigurationTalesExtension(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

extension:static_configuration TALES expression

-
-
-render(context=None)
-
- -
- -
-
-pyams_skin.configuration.back_office_site_icon(request)
-
- -
-
-pyams_skin.configuration.site_icon(request)
-
- -
-
-

pyams_skin.container module

-
-
-class pyams_skin.container.ContainerView(context, request)
-

Bases: object

-

Base container view

-
-
-table_class
-

alias of BaseTable

-
- -
-
-update()
-
- -
- -
-
-pyams_skin.container.delete_container_element(request)
-

Delete container element

-
- -
-
-

pyams_skin.extension module

-
-
-class pyams_skin.extension.GoogleAnalyticsInfo
-

Bases: persistent.Persistent

-

Google Analytics settings class

-
-
-activation_mode
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-enabled
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-verification_code
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-website_id
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
- -
-
-pyams_skin.extension.GoogleAnalyticsInfoFactory(context)
-

Google Analytics settings factory

-
- -
-
-class pyams_skin.extension.GoogleTagManagerInfo
-

Bases: persistent.Persistent

-

Google tag manager settings class

-
-
-activation_mode
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-container_id
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-enabled
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
- -
-
-pyams_skin.extension.GoogleTagManagerInfoFactory(context)
-

Google Tag Manager settings factory

-
- -
-
-class pyams_skin.extension.UserReportInfo
-

Bases: persistent.Persistent

-

User report settings class

-
-
-account_id
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-activation_mode
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-enabled
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
- -
-
-pyams_skin.extension.UserReportInfoFactory(context)
-

User report settings factory

-
- -
-
-

pyams_skin.help module

-
-
-class pyams_skin.help.ContentHelp(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Content help

-
-
-header
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-message
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-message_format
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-outer_margin
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
-
-status
-

Computed attributes based on schema fields

-

Field properties provide default values, data validation and error messages -based on data found in field meta-data.

-

Note that FieldProperties cannot be used with slots. They can only -be used for attributes stored in instance dictionaries.

-
- -
- -
-
-class pyams_skin.help.HelpContentProvider
-

Bases: object

-

Help content provider

-
-
-help = None
-
- -
-
-update()
-
- -
- -
-
-class pyams_skin.help.HelpRenderer(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Help renderer

-
-
-render(**kwargs)
-
- -
- -
-
-

pyams_skin.layer module

-
-
-

pyams_skin.metas module

-
-
-class pyams_skin.metas.ContentMeta(name, value)
-

Bases: object

-

Content meta header

-
-
-render()
-
- -
- -
-
-class pyams_skin.metas.ContentTypeMetasAdapter(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Content-type metas adapter

-
-
-static get_metas()
-
- -
-
-order = 10
-
- -
- -
-
-class pyams_skin.metas.HTTPEquivMeta(http_equiv, value)
-

Bases: object

-

HTTP-Equiv meta header

-
-
-render()
-
- -
- -
-
-class pyams_skin.metas.LayoutMetasAdapter(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Basic layout metas adapter

-
-
-static get_metas()
-
- -
-
-order = -1
-
- -
- -
-
-class pyams_skin.metas.LinkMeta(rel, type, href)
-

Bases: object

-

Link meta header

-
-
-render()
-
- -
- -
-
-class pyams_skin.metas.MetasTalesExtension(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

extension:metas TALES extension

-
-
-render(context=None)
-
- -
- -
-
-class pyams_skin.metas.PropertyMeta(property, value)
-

Bases: object

-

Property meta header

-
-
-render()
-
- -
- -
-
-class pyams_skin.metas.ValueMeta(name, value)
-

Bases: object

-

Basic value meta header

-
-
-render()
-
- -
- -
-
-class pyams_skin.metas.VerificationCodeMetasAdapter(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Google verification code metas adapter

-
-
-get_metas()
-
- -
-
-order = 20
-
- -
- -
-
-

pyams_skin.page module

-
-
-class pyams_skin.page.DefaultPageHeaderAdapter(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Default page header adapter

-
-
-back_target = None
-
- -
-
-back_url = None
-
- -
-
-icon_class = 'fa fa-fw'
-
- -
-
-subtitle = None
-
- -
-
-subtitle_badge = None
-
- -
-
-subtitle_badge_class = 'badge inbox-badge bg-color-red'
-
- -
-
-title
-
- -
-
-title_badge = None
-
- -
-
-title_badge_class = 'badge inbox-badge bg-color-red'
-
- -
- -
-
-class pyams_skin.page.HeaderContentProvider
-

Bases: object

-

Header content provider

-
-
-header = None
-
- -
-
-update()
-
- -
- -
-
-class pyams_skin.page.InnerPage
-

Bases: object

-

Inner page

-
- -
-
-class pyams_skin.page.ModalPage
-

Bases: object

-

Modal page

-
- -
-
-

pyams_skin.resources module

-
-
-class pyams_skin.resources.ResourcesAdapter(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Get context resources

-
-
-get_resources()
-
- -
- -
-
-class pyams_skin.resources.ResourcesTalesExtension(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

extension:resources TALES extension

-
-
-render(context=None)
-
- -
- -
-
-

pyams_skin.site module

-
-
-class pyams_skin.site.ContextTitlePrefixAdapter(context, request)
-

Bases: pyams_utils.adapter.ContextRequestAdapter

-

Context title prefix adapter

-
-
-prefix
-
- -
- -
-
-

pyams_skin.skin module

-
-
-class pyams_skin.skin.PyAMSSkin
-

Bases: object

-

PyAMS base skin

-
-
-label = 'PyAMS base skin'
-
- -
-
-layer = <InterfaceClass pyams_skin.layer.IPyAMSLayer>
-
- -
- -
-
-class pyams_skin.skin.SkinnableContent
-

Bases: object

-

Skinnable content base class

-
-
-can_inherit_skin
-
- -
-
-get_skin(request=None)
-
- -
-
-inherit_skin
-
- -
-
-skin
-
- -
-
-skin_parent
-
- -
- -
-
-class pyams_skin.skin.UserSkinnableContent
-

Bases: pyams_skin.skin.SkinnableContent

-

User skinnable content base class

-
- -
-
-pyams_skin.skin.apply_skin(request, skin)
-

Apply given skin to request

-
- -
-
-pyams_skin.skin.handle_content_skin(event)
-

Apply skin when traversing skinnable object

-
- -
-
-pyams_skin.skin.handle_root_skin(event)
-

Apply skin when traversing site root

-
- -
-
-

pyams_skin.table module

-
-
-class pyams_skin.table.ActionColumn(context, request, table)
-

Bases: z3c.table.column.Column

-

Base action icon column

-
-
-checker = None
-
- -
-
-cssClasses = {'th': 'action', 'td': 'action'}
-
- -
-
-get_icon(item)
-
- -
-
-get_icon_class(item)
-
- -
-
-get_icon_hint(item)
-
- -
-
-get_url(item)
-
- -
-
-has_permission(item)
-
- -
-
-header = ''
-
- -
-
-icon_class = 'fa fa-fw fa-edit'
-
- -
-
-icon_hint = 'Properties'
-
- -
-
-modal_target = False
-
- -
-
-permission = None
-
- -
-
-renderCell(item)
-
- -
-
-target = '#content'
-
- -
-
-url = '#'
-
- -
- -
-
-class pyams_skin.table.BaseTable(context, request)
-

Bases: z3c.table.table.Table

-

Custom table

-
-
-batchSize = 10000
-
- -
-
-static check_data_attribute(attribute, source, column=None)
-
- -
-
-cssClasses = {'table': 'table table-bordered table-striped table-hover table-tight datatable'}
-
- -
-
-data_attributes
-
- -
-
-getBatchSize()
-
- -
-
-getBatchStart()
-
- -
-
-getSortOn()
-
- -
-
-getSortOrder()
-
- -
-
-static get_column_type(column, _=None)
-
- -
-
-get_data_attributes(element, source, column=None)
-
- -
-
-id = 'TableID'
-
- -
-
-render = <BoundViewTemplate of None>
-
- -
-
-renderCell(item, column, colspan=0)
-
- -
-
-renderHeadCell(column)
-
- -
-
-renderRow(row, cssClass=None)
-
- -
-
-renderTable()
-
- -
-
-startBatchingAt = 10000
-
- -
-
-title = 'Container elements'
-
- -
- -
-
-class pyams_skin.table.ContainerValuesAdapter(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Default container values adapter

-
-
-values
-
- -
- -
-
-class pyams_skin.table.DefaultElementEditorAdapter(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Default contained element editor

-
-
-modal_target = True
-
- -
-
-url
-
- -
-
-view_name = 'properties.html'
-
- -
- -
-
-class pyams_skin.table.I18nColumn
-

Bases: object

-

Column with I18n header

-
-
-header
-
- -
-
-request = None
-
- -
- -
-
-class pyams_skin.table.I18nValueColumn(context, request, table)
-

Bases: z3c.table.column.GetAttrColumn

-

Column with I18n value

-
-
-getValue(obj)
-
- -
- -
-
-class pyams_skin.table.ImageColumn(context, request, table)
-

Bases: pyams_skin.table.ActionColumn

-

Simple image column

-
-
-renderCell(item)
-
- -
- -
-
-class pyams_skin.table.JsActionColumn(context, request, table)
-

Bases: pyams_skin.table.ActionColumn

-

Javascript function caller action column

-
-
-get_url(item)
-
- -
- -
-
-class pyams_skin.table.MenuActionsColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.Column

-

Menu actions column

-
-
-cssClasses = {'th': 'actions-menu', 'td': 'nowrap'}
-
- -
-
-renderCell(item)
-
- -
-
-weight = 9000
-
- -
- -
-
-class pyams_skin.table.NameColumn(context, request, table)
-

Bases: pyams_skin.table.I18nColumn, z3c.table.column.GetAttrColumn

-

Container name column

-
-
-attrName = '__name__'
-
- -
-
-dt_sort_type = 'string'
-
- -
-
-getValue(obj)
-
- -
-
-weight = 10
-
- -
- -
-
-class pyams_skin.table.SorterColumn(context, request, table)
-

Bases: pyams_skin.table.ActionColumn

-

Rows sorter column

-
-
-cssClasses = {'th': 'action', 'td': 'action sorter'}
-
- -
-
-get_url(item)
-
- -
-
-icon_class = 'fa fa-fw fa-sort'
-
- -
-
-icon_hint = 'Click and drag to sort rows'
-
- -
-
-url = '#'
-
- -
-
-weight = 1
-
- -
- -
-
-class pyams_skin.table.TrashColumn(context, request, table)
-

Bases: pyams_skin.table.JsActionColumn

-

Trash action icon column

-
-
-icon_class = 'fa fa-fw fa-trash'
-
- -
-
-icon_hint = 'Delete object'
-
- -
-
-permission = 'manage'
-
- -
-
-url = 'MyAMS.container.deleteElement'
-
- -
-
-weight = 9999
-
- -
- -
-
-pyams_skin.table.get_element_editor(table, element)
-

Get editor for selected element

-
- -
-
-pyams_skin.table.get_object_name(context, request, view=None)
-

Get required object name

-
- -
-
-

pyams_skin.vocabulary module

-
-
-class pyams_skin.vocabulary.SkinsVocabulary(context, **kw)
-

Bases: zope.componentvocabulary.vocabulary.UtilityVocabulary

-

PyAMS skins vocabulary

-
-
-interface = <InterfaceClass pyams_skin.interfaces.ISkin>
-
- -
-
-nameOnly = True
-
- -
- -
-
-class pyams_skin.vocabulary.UserSkinsVocabulary(context, **kw)
-

Bases: zope.componentvocabulary.vocabulary.UtilityVocabulary

-

PyAMS custom users skins vocabulary

-
-
-interface = <InterfaceClass pyams_skin.interfaces.ISkin>
-
- -
-
-nameOnly = True
-
- -
- -
-
-
- - -