- -
-

pyams_portal.zmi package

- -
-

Submodules

-
-
-

pyams_portal.zmi.container module

-
-
-class pyams_portal.zmi.container.PortalTemplateContainerHeaderAdapter(context, request, view)
-

Bases: pyams_skin.page.DefaultPageHeaderAdapter

-

Portal template container header adapter

-
-
-icon_class = 'fa fa-fw fa-columns'
-
- -
- -
-
-class pyams_portal.zmi.container.PortalTemplateContainerMenuItem(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Portal template container menu

-
-
-icon_class = 'fa-columns'
-
- -
-
-label = 'Portal templates'
-
- -
-
-url = '#portal-templates.html'
-
- -
- -
-
-class pyams_portal.zmi.container.PortalTemplateContainerNameColumn(context, request, table)
-

Bases: pyams_skin.table.NameColumn

-

Portal template container name column

-
-
-attrName = 'name'
-
- -
- -
-
-class pyams_portal.zmi.container.PortalTemplateContainerPropertiesAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_portal.zmi.container.PortalTemplateContainerPropertiesEditForm

-

Portal template container properties edit form, JSON renderer

-
- -
-
-class pyams_portal.zmi.container.PortalTemplateContainerPropertiesEditForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

Portal template container properties edit form

-
-
-ajax_handler = 'properties.json'
-
- -
-
-edit_permission = 'pyams_portal.manage_template'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-thumb-tack'
-
- -
-
-input_css_class = 'col-md-8'
-
- -
-
-label_css_class = 'control-label col-md-4'
-
- -
-
-legend = 'Edit selected portlets'
-
- -
-
-title = 'Portal templates container'
-
- -
- -
-
-class pyams_portal.zmi.container.PortalTemplateContainerTable(context, request)
-

Bases: pyams_skin.table.BaseTable

-

Portal template container table

-
-
-data_attributes
-
- -
-
-id = 'portal_templates_table'
-
- -
-
-title = 'Shared portal templates'
-
- -
- -
-
-class pyams_portal.zmi.container.PortalTemplateContainerTableElementEditor(context, request, view)
-

Bases: pyams_skin.table.DefaultElementEditorAdapter

-

Portal template container table element editor

-
-
-modal_target = False
-
- -
-
-url
-
- -
-
-view_name = 'portal-templates.html'
-
- -
- -
-
-class pyams_portal.zmi.container.PortalTemplateContainerTrashColumn(context, request, table)
-

Bases: pyams_skin.table.TrashColumn

-

Portal template container trash column

-
-
-icon_hint = 'Delete template'
-
- -
-
-permission = 'pyams_portal.manage_template'
-
- -
- -
-
-class pyams_portal.zmi.container.PortalTemplateContainerValuesAdapter(context, request, view)
-

Bases: pyams_utils.adapter.ContextRequestViewAdapter

-

Portal template container values adapter

-
-
-values
-
- -
- -
-
-class pyams_portal.zmi.container.PortalTemplateContainerView(context, request)
-

Bases: pyams_zmi.view.AdminView, pyams_skin.container.ContainerView

-

Portal template container view

-
-
-table_class
-

alias of PortalTemplateContainerTable

-
- -
- -
-
-class pyams_portal.zmi.container.PortalTemplateTableElementEditor(context, request, view)
-

Bases: pyams_skin.table.DefaultElementEditorAdapter

-

Portal template table element editor

-
-
-modal_target = False
-
- -
-
-url
-
- -
- -
-
-class pyams_portal.zmi.container.PortalTemplatesContainerPropertiesMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Portal template container configuration menu

-
-
-get_url()
-
- -
-
-icon_class = 'fa-thumb-tack'
-
- -
-
-label = 'Selected portlets...'
-
- -
-
-modal_target = True
-
- -
-
-url = 'properties.html'
-
- -
- -
-
-

pyams_portal.zmi.interfaces module

-
-
-

pyams_portal.zmi.layout module

-
-
-class pyams_portal.zmi.layout.PortalTemplateAddMenuDivider(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarMenuDivider

-

Portal template menu divider

-
- -
-
-class pyams_portal.zmi.layout.PortalTemplateLayoutHeaderAdapter(context, request, view)
-

Bases: pyams_portal.zmi.template.PortalTemplateHeaderAdapter

-

Portal template configuration header adapter

-
-
-back_target = None
-
- -
-
-back_url = '/admin#portal-templates.html'
-
- -
- -
-
-class pyams_portal.zmi.layout.PortalTemplateLayoutView
-

Bases: pyams_zmi.view.AdminView

-

Portal template main layout configuration view

-
-
-can_change
-
- -
-
-get_context()
-
- -
-
-get_portlet(name)
-
- -
-
-get_portlet_label(name)
-
- -
-
-get_portlet_preview(portlet_id)
-
- -
-
-get_template()
-
- -
-
-portlet_configuration
-
- -
-
-selected_portlets
-
- -
-
-template_configuration
-
- -
-
-title
-
- -
- -
-
-class pyams_portal.zmi.layout.PortalTemplateMenuHeader(context, menu)
-

Bases: object

-

Portal template menu header

-
-
-header
-
- -
- -
-
-class pyams_portal.zmi.layout.PortalTemplatePortletAJAXAddForm(context, request)
-

Bases: pyams_form.form.AJAXAddForm, pyams_portal.zmi.layout.PortalTemplatePortletAddForm

-

Portal template portlet add form, AJAX handler

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_portal.zmi.layout.PortalTemplatePortletAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_portal.zmi.layout.PortalTemplatePortletEditForm

-

Portal template portlet edit form, AJAX renderer

-
- -
-
-class pyams_portal.zmi.layout.PortalTemplatePortletAddForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogAddForm

-

Portal template portlet add form

-
-
-ajax_handler = 'add-template-portlet.json'
-
- -
-
-createAndAdd(data)
-
- -
-
-edit_permission = None
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-columns'
-
- -
-
-legend = 'Add portlet'
-
- -
-
-title
-
- -
- -
-
-class pyams_portal.zmi.layout.PortalTemplatePortletAddMenu(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarMenuItem

-

Portal template portlet add menu

-
-
-label = 'Add portlet...'
-
- -
-
-label_css_class = 'fa fa-fw fa-columns'
-
- -
-
-modal_target = True
-
- -
-
-url = 'add-template-portlet.html'
-
- -
- -
-
-class pyams_portal.zmi.layout.PortalTemplatePortletEditForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

Portal template portlet edit form

-
-
-dialog_class = 'modal-large'
-
- -
- -
-
-class pyams_portal.zmi.layout.PortalTemplatePropertiesMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Portal template properties menu

-
-
-icon_class = 'fa-edit'
-
- -
-
-label = 'Properties'
-
- -
-
-url = '#properties.html'
-
- -
- -
-
-class pyams_portal.zmi.layout.PortalTemplateRowAddMenu(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.JsToolbarMenuItem

-

Portal template row add menu

-
-
-label = 'Add row...'
-
- -
-
-label_css_class = 'fa fa-fw fa-indent'
-
- -
-
-url = 'PyAMS_portal.template.addRow'
-
- -
- -
-
-class pyams_portal.zmi.layout.PortalTemplateSlotAJAXAddForm(context, request)
-

Bases: pyams_form.form.AJAXAddForm, pyams_portal.zmi.layout.PortalTemplateSlotAddForm

-

Portal template slot add form, AJAX handler

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_portal.zmi.layout.PortalTemplateSlotAddForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogAddForm

-

Portal template slot add form

-
-
-ajax_handler = 'add-template-slot.json'
-
- -
-
-createAndAdd(data)
-
- -
-
-edit_permission = None
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-columns'
-
- -
-
-legend = 'Add slot'
-
- -
-
-title
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-class pyams_portal.zmi.layout.PortalTemplateSlotAddMenu(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarMenuItem

-

Portal template slot add menu

-
-
-label = 'Add slot...'
-
- -
-
-label_css_class = 'fa fa-fw fa-columns'
-
- -
-
-modal_target = True
-
- -
-
-url = 'add-template-slot.html'
-
- -
- -
-
-class pyams_portal.zmi.layout.PortalTemplateSlotPropertiesAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_portal.zmi.layout.PortalTemplateSlotPropertiesEditForm

-

Slot properties edit form, AJAX renderer

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_portal.zmi.layout.PortalTemplateSlotPropertiesEditForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

Slot properties edit form

-
-
-ajax_handler = 'slot-properties.json'
-
- -
-
-edit_permission = 'pyams_portal.manage_template'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-getContent()
-
- -
-
-input_css_class = 'col-md-7'
-
- -
-
-label_css_class = 'control-label col-md-5'
-
- -
-
-legend = 'Edit slot properties'
-
- -
-
-title
-
- -
-
-updateWidgets(prefix=None)
-
- -
- -
-
-pyams_portal.zmi.layout.add_template_row(request)
-

Add template raw

-
- -
-
-pyams_portal.zmi.layout.delete_template_portlet(request)
-

Delete template portlet

-
- -
-
-pyams_portal.zmi.layout.delete_template_row(request)
-

Delete template row

-
- -
-
-pyams_portal.zmi.layout.delete_template_slot(request)
-

Delete template slot

-
- -
-
-pyams_portal.zmi.layout.drag_template_portlet(request)
-

Drag portlet icon to slot

-
- -
-
-pyams_portal.zmi.layout.get_template_slots_width(request)
-

Get template slots width

-
- -
-
-pyams_portal.zmi.layout.handle_new_slot_data_extraction(event)
-

Handle new slot form data extraction

-
- -
-
-pyams_portal.zmi.layout.set_template_portlet_order(request)
-

Set template portlet order

-
- -
-
-pyams_portal.zmi.layout.set_template_row_order(request)
-

Set template rows order

-
- -
-
-pyams_portal.zmi.layout.set_template_slot_order(request)
-

Set template slots order

-
- -
-
-pyams_portal.zmi.layout.set_template_slot_width(request)
-

Set template slot width

-
- -
-
-

pyams_portal.zmi.page module

-
-
-class pyams_portal.zmi.page.PortalContextPropertiesEditFormHeaderAdapter(context, request, view)
-

Bases: pyams_zmi.site.PropertiesEditFormHeaderAdapter

-

Portal context template properties edit form header adapter

-
-
-icon_class = 'fa fa-fw fa-columns'
-
- -
- -
-
-class pyams_portal.zmi.page.PortalContextPropertiesEditFormHelpAdapter(context, request, view)
-

Bases: pyams_form.help.FormHelp

-

Portal context properties edit form help adapter

-
-
-message = "If you choose a shared template, you can only adjust settings of each portlet individually but can't change portlets list or page configuration.\nIf you use a local template, you can define a whole custom configuration but the template definition can't be reused anywhere..."
-
- -
-
-message_format = 'text'
-
- -
- -
-
-class pyams_portal.zmi.page.PortalContextTemplateConfigMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Portal context template configuration menu

-
-
-get_url()
-
- -
-
-label = 'Template properties'
-
- -
-
-url = '#template-config.html'
-
- -
- -
-
-class pyams_portal.zmi.page.PortalContextTemplateLayoutHeaderAdapter(context, request, view)
-

Bases: pyams_portal.zmi.template.PortalTemplateHeaderAdapter

-

Portal context template configuration header adapter

-
- -
-
-class pyams_portal.zmi.page.PortalContextTemplateLayoutView
-

Bases: pyams_portal.zmi.layout.PortalTemplateLayoutView

-

Portal context template configuration view

-
-
-can_change
-
- -
-
-get_template()
-
- -
- -
-
-class pyams_portal.zmi.page.PortalContextTemplatePortletAJAXEditForm(context, request)
-

Bases: pyams_portal.zmi.layout.PortalTemplatePortletAJAXEditForm

-

Portal context template portlet edit form, JSON renderer

-
- -
-
-class pyams_portal.zmi.page.PortalContextTemplatePortletEditForm(context, request)
-

Bases: pyams_portal.zmi.layout.PortalTemplatePortletEditForm

-

Portal context template portlet edit form

-
- -
-
-class pyams_portal.zmi.page.PortalContextTemplatePropertiesAJAXEditForm(context, request)
-

Bases: pyams_form.form.AJAXEditForm, pyams_portal.zmi.page.PortalContextTemplatePropertiesEditForm

-

Portal context template properties edit form, JSON renderer

-
-
-get_ajax_output(changes)
-
- -
- -
-
-class pyams_portal.zmi.page.PortalContextTemplatePropertiesEditForm(context, request)
-

Bases: pyams_zmi.form.AdminEditForm

-

Portal context template properties edit form

-
-
-ajax_handler = 'template-properties.json'
-
- -
-
-edit_permission = 'pyams_portal.manage_template'
-
- -
-
-fields
-
- -
-
-getContent()
-
- -
-
-legend = 'Edit template configuration'
-
- -
-
-title
-
- -
-
-update()
-
- -
- -
-
-class pyams_portal.zmi.page.PortalContextTemplatePropertiesMenu(context, request, view, manager=None)
-

Bases: pyams_skin.viewlet.menu.MenuItem

-

Portal context template properties menu

-
-
-icon_class = 'fa-columns'
-
- -
-
-label = 'Presentation'
-
- -
-
-url = '#template-properties.html'
-
- -
- -
-
-pyams_portal.zmi.page.get_template_slots_width(request)
-

Get template slots width

-
- -
-
-

pyams_portal.zmi.portlet module

-
-
-class pyams_portal.zmi.portlet.PortletSettingsEditor(context, request)
-

Bases: pyams_zmi.form.AdminDialogEditForm

-

Portlet settings edit form

-
-
-configuration
-
- -
-
-dialog_class = 'modal-large'
-
- -
-
-edit_permission = 'pyams_portal.manage_template'
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-get_ajax_handler()
-
- -
-
-get_form_action()
-
- -
-
-legend = 'Edit portlet settings'
-
- -
-
-override_label
-
- -
-
-portlet
-
- -
-
-settings = None
-
- -
-
-title
-
- -
- -
-
-class pyams_portal.zmi.portlet.PortletSettingsPropertiesEditor(context, request, view=None)
-

Bases: pyams_zmi.form.InnerAdminEditForm

-

Portlet settings properties editor

-
-
-edit_permission = 'pyams_portal.manage_template'
-
- -
-
-fields
-
- -
-
-id = 'properties_form'
-
- -
-
-legend = None
-
- -
-
-tab_label = 'Main properties'
-
- -
-
-weight = 10
-
- -
- -
-
-

pyams_portal.zmi.template module

-
-
-class pyams_portal.zmi.template.PortalTemplateAJAXAddForm(context, request)
-

Bases: pyams_form.form.AJAXAddForm, pyams_portal.zmi.template.PortalTemplateAddForm

-

Portal template add form, AJAX handler

-
- -
-
-class pyams_portal.zmi.template.PortalTemplateAddAction(context, request, view, manager)
-

Bases: pyams_skin.viewlet.toolbar.ToolbarAction

-

Portal template add action

-
-
-label = 'Add template'
-
- -
-
-modal_target = True
-
- -
-
-url = 'add-portal-template.html'
-
- -
- -
-
-class pyams_portal.zmi.template.PortalTemplateAddForm(context, request)
-

Bases: pyams_zmi.form.AdminDialogAddForm

-

Portal template add form

-
-
-add(template)
-
- -
-
-ajax_handler = 'add-portal-template.json'
-
- -
-
-create(data)
-
- -
-
-edit_permission = None
-
- -
-
-fields = <z3c.form.field.Fields object>
-
- -
-
-icon_css_class = 'fa fa-fw fa-columns'
-
- -
-
-legend = 'Add shared template'
-
- -
-
-nextURL()
-
- -
-
-title = 'Portal templates'
-
- -
- -
-
-class pyams_portal.zmi.template.PortalTemplateHeaderAdapter(context, request, view)
-

Bases: pyams_skin.page.DefaultPageHeaderAdapter

-

Portal template header adapter

-
-
-icon_class = 'fa fa-fw fa-columns'
-
- -
-
-title
-
- -
- -
-
-pyams_portal.zmi.template.delete_portal_template(request)
-

Delete template from portal

-
- -
-
-pyams_portal.zmi.template.handle_new_template_data_extraction(event)
-

Handle new template form data extraction

-
- -
-
-

Module contents

-
-
- - -