pyams_content.component.association
package ⊞¶
Subpackages¶
pyams_content.component.association.container
¶
pyams_content.component.association.interfaces
¶
-
interface
pyams_content.component.association.interfaces.
IAssociationContainer
[source]¶ Extends:
zope.container.interfaces.IOrderedContainer
Associations container interface
-
__setitem__
(key, value)¶ Add the given object to the container under the given name.
Raises a
TypeError
if the key is not a unicode or ascii string.Raises a
ValueError
if the key is empty, or if the key contains a character which is not allowed in an object name.Raises a
KeyError
if the key violates a uniqueness constraint.The container might choose to add a different object than the one passed to this method.
If the object doesn’t implement IContained, then one of two things must be done:
- If the object implements ILocation, then the IContained interface must be declared for the object.
- Otherwise, a ContainedProxy is created for the object and stored.
The object’s __parent__ and __name__ attributes are set to the container and the given name.
If the old parent was
None
, then an IObjectAddedEvent is generated, otherwise, an IObjectMovedEvent is generated. An IContainerModifiedEvent is generated for the container.If the object replaces another object, then the old object is deleted before the new object is added, unless the container vetos the replacement by raising an exception.
If the object’s __parent__ and __name__ were already set to the container and the name, then no events are generated and no hooks. This allows advanced clients to take over event generation.
-
append
(self, value, notify=True)¶ Append given value to container
-
get_visible_items
(self, request=None)¶ Get list of visible items
-
-
interface
pyams_content.component.association.interfaces.
IAssociationContainerTarget
[source]¶ Extends:
zope.annotation.interfaces.IAttributeAnnotatable
Associations container target interface
-
interface
pyams_content.component.association.interfaces.
IAssociationInfo
[source]¶ Association information interface
-
pictogram
¶ Association pictogram
-
user_title
¶ Association title proposed on public site
-
user_icon
¶ Icon associated with user title
-
inner_title
¶ Inner content, if available
-
human_size
¶ Content size, if available
-
-
interface
pyams_content.component.association.interfaces.
IAssociationItem
[source]¶ Extends:
zope.annotation.interfaces.IAttributeAnnotatable
Base association item interface
-
__parent__
¶ Implementation: zope.schema.Field
Read Only: False Required: True Default Value: None
-
icon_class
¶ Icon class in associations list
-
icon_hint
¶ Icon hint in associations list
-
visible
¶ Visible?
Is this item visible in front-office?
Implementation: zope.schema.Bool
Read Only: False Required: True Default Value: True Allowed Type: bool
-
is_visible
(self, request=None)¶ Is association item published?
-
get_url
(self, request=None, view_name=None)¶ Get link URL
-
-
interface
pyams_content.component.association.interfaces.
IAssociationParagraph
[source]¶ Extends:
pyams_content.component.paragraph.interfaces.IBaseParagraph
Associations paragraph interface
-
renderer
¶ Associations template
Presentation template used for associations
Implementation: zope.schema.Choice
Read Only: False Required: True Default Value: ‘default’
-