PyAMS viewlets¶
- -Subpackages¶
- -Submodules¶
-pyams_viewlet.manager module¶
--
-
-
-class
pyams_viewlet.manager.
ConditionalViewletManager
(context, request, view)¶
- Bases:
-pyams_viewlet.manager.WeightOrderedViewletManager
Conditional weight ordered viewlet managers.
--
-
-
-
filter
(viewlets)¶
- Sort out all viewlets which are explicit not available
-
-viewlets
is a list of tuples of the form (name, viewlet).
-
-
-
-
-
-class
pyams_viewlet.manager.
TemplateBasedViewletManager
¶
- Bases:
-object
Template based viewlet manager mixin class
--
-
-
-
template
= <BoundViewTemplate of None>¶
-
-
-
-
-
-
-class
pyams_viewlet.manager.
ViewletManager
(context, request, view)¶
- Bases:
-object
The Viewlet Manager base
-A generic manager class which can be instantiated
--
-
-
-
filter
(viewlets)¶
- Sort out all content providers
-
-viewlets
is a list of tuples of the form (name, viewlet).
-
-
-
-
get
(name, default=None)¶
- See zope.interface.common.mapping.IReadMapping
-
-
-
-
-
permission
= None¶
-
-
-
-
-
render
()¶
- See zope.contentprovider.interfaces.IContentProvider
-
-
-
-
-
sort
(viewlets)¶
- Sort the viewlets.
-
-viewlets
is a list of tuples of the form (name, viewlet).
-
-
-
-
template
= None¶
-
-
-
-
-
update
()¶
- See zope.contentprovider.interfaces.IContentProvider
-
-
-
-
-
-
-
pyams_viewlet.manager.
ViewletManagerFactory
(name, interface, bases=(), cdict=None)¶
- Viewlet manager factory
-
-
-
-
-class
pyams_viewlet.manager.
WeightOrderedViewletManager
(context, request, view)¶
- Bases:
-pyams_viewlet.manager.ViewletManager
Weight ordered viewlet managers.
--
-
-
-
sort
(viewlets)¶
-
-
-
-
-
-
-
pyams_viewlet.manager.
get_weight
(item)¶
-
-
-
-
-
pyams_viewlet.manager.
is_available
(viewlet)¶
-
-
-
-
-class
pyams_viewlet.manager.
viewletmanager_config
(**settings)¶
- Bases:
-object
Class or interface decorator used to declare a viewlet manager
-You can provide same arguments as in ‘viewletManager’ ZCML directive: -@name = name of the viewlet; may be unique for a given viewlet manager -@view = the view class or interface for which viewlet is displayed -@for_ = the context class or interface for which viewlet is displayed -@permission = name of a permission required to display the viewlet -@layer = request interface required to display the viewlet -@class_ = the class handling the viewlet manager; if the decorator is applied
--
-on an interface and if this argument is not provided, the viewlet manager -will be handled by a default ViewletManager class-
-
- @provides = an interface the viewlet manager provides; if the decorator is -
- applied on an Interface, this will be the decorated interface; if the -decorated is applied on a class and if this argument is not specified, -the manager will provide IViewletManager interface. -
-
-
-
-
venusian
= <module 'venusian' from '/var/local/env/pycharm/lib/python3.5/site-packages/venusian/__init__.py'>¶
-
pyams_viewlet.metaconfigure module¶
--
-
-
-
pyams_viewlet.metaconfigure.
ViewletDirective
(_context, name, class_, context=<InterfaceClass zope.interface.Interface>, layer=<InterfaceClass pyramid.interfaces.IRequest>, view=<InterfaceClass pyramid.interfaces.IView>, manager=<InterfaceClass pyams_viewlet.interfaces.IViewletManager>, attribute='render', permission=None, **kwargs)¶
-
-
-
-
-
pyams_viewlet.metaconfigure.
ViewletManagerDirective
(_context, name, context=<InterfaceClass zope.interface.Interface>, layer=<InterfaceClass pyramid.interfaces.IRequest>, view=<InterfaceClass pyramid.interfaces.IView>, provides=<InterfaceClass pyams_viewlet.interfaces.IViewletManager>, class_=None, permission=None)¶
-
pyams_viewlet.metadirectives module¶
-pyams_viewlet.provider module¶
--
-
-
-class
pyams_viewlet.provider.
ProviderExpr
(expression, braces_required=False)¶
- Bases:
-pyams_utils.tales.ContextExprMixin
,chameleon.tales.StringExpr
provider: TALES expression
--
-
-
-
transform
= <Symbol value=<function render_content_provider> at 7fe785bf55c0>¶
-
-
-
-
-
-
-
pyams_viewlet.provider.
render_content_provider
(econtext, name)¶
-
pyams_viewlet.viewlet module¶
--
-
-
-class
pyams_viewlet.viewlet.
BaseContentProvider
(context, request)¶
- Bases:
-object
Base template based content provider
--
-
-
-
permission
= None¶
-
-
-
-
-
render
= <BoundViewTemplate of None>¶
-
-
-
-
-
update
()¶
-
-
-
-
-
-
-class
pyams_viewlet.viewlet.
ViewContentProvider
(context, request, view)¶
- Bases:
-pyams_viewlet.viewlet.BaseContentProvider
Template based content provider
-
-
-
-
-class
pyams_viewlet.viewlet.
Viewlet
(context, request, view, manager)¶
- Bases:
-object
Viewlet adapter class used in meta directive as a mixin class.
--
-
-
-
permission
= None¶
-
-
-
-
-
render
= <BoundViewTemplate of None>¶
-
-
-
-
-
update
()¶
-
-
-
-
-
-
-class
pyams_viewlet.viewlet.
contentprovider_config
(**settings)¶
- Bases:
-object
Class decorator used to declare a content provider
-You can provide same arguments as in ‘viewlet’ ZCML directive: -@name = name of the viewlet; may be unique for a given viewlet manager -@view = the view class or interface for which viewlet is displayed -@for = the context class or interface for which viewlet is displayed -@permission = name of a permission required to display the viewlet -@layer = request interface required to display the viewlet
--
-
-
-
venusian
= <module 'venusian' from '/var/local/env/pycharm/lib/python3.5/site-packages/venusian/__init__.py'>¶
-
-
-
-
-
-
-class
pyams_viewlet.viewlet.
viewlet_config
(**settings)¶
- Bases:
-object
Class decorator used to declare a viewlet
-You can provide same arguments as in ‘viewlet’ ZCML directive: -@name = name of the viewlet; may be unique for a given viewlet manager -@manager = manager class or interface holding the viewlet -@view = the view class or interface for which viewlet is displayed -@for = the context class or interface for which viewlet is displayed -@permission = name of a permission required to display the viewlet -@layer = request interface required to display the viewlet -@weight = weight of the viewlet when using a weight ordered viewlet manager
--
-
-
-
venusian
= <module 'venusian' from '/var/local/env/pycharm/lib/python3.5/site-packages/venusian/__init__.py'>¶
-
-
-