Back to index

plone3  3.1.7
Public Member Functions
plone.portlets.interfaces.ILocalPortletAssignmentManager Class Reference
Inheritance diagram for plone.portlets.interfaces.ILocalPortletAssignmentManager:
Inheritance graph
[legend]
Collaboration diagram for plone.portlets.interfaces.ILocalPortletAssignmentManager:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def setBlacklistStatus
def getBlacklistStatus

Detailed Description

A component that can manage the display of locally assigned portlets.

An ILocalPortletAssignable may be multi-adapted along with
an IPortletManager to this interface, to manage how portlets will be
displayed relative to this context.

Definition at line 216 of file interfaces.py.


Member Function Documentation

Get the blacklisting status of the given category.

Note that this only applies to the current context - the status is
not inherited, and will default to None if not set.

Definition at line 239 of file interfaces.py.

00239 
00240     def getBlacklistStatus(category):
00241         """Get the blacklisting status of the given category.
00242         
00243         Note that this only applies to the current context - the status is
00244         not inherited, and will default to None if not set.
00245         """

A component that can manage the display of locally assigned portlets.

An ILocalPortletAssignable may be multi-adapted along with
an IPortletManager to this interface, to manage how portlets will be
displayed relative to this context.
Manage the blacklisting status of the given category.

If status is None, the blacklist status will be obtained from a parent,
defaulting to False. If status is False, the given portlet category 
will always be eligible for display. If status is True, the given
portlet category will always be blocked.

Thus, call setBlacklistStatus('user', True) to always black out 'user'
portlets in this context, or setBlacklistStatus('user', False) to 
override any blacklisting done by a parent object. Calling
setBlacklistStatus('user', None) will cause the status to be acquired
from the parent instead (defaulting to no blacklisting).

Definition at line 224 of file interfaces.py.

00224 
00225     def setBlacklistStatus(category, status):
00226         """Manage the blacklisting status of the given category.
00227         
00228         If status is None, the blacklist status will be obtained from a parent,
00229         defaulting to False. If status is False, the given portlet category 
00230         will always be eligible for display. If status is True, the given
00231         portlet category will always be blocked.
00232         
00233         Thus, call setBlacklistStatus('user', True) to always black out 'user'
00234         portlets in this context, or setBlacklistStatus('user', False) to 
00235         override any blacklisting done by a parent object. Calling
00236         setBlacklistStatus('user', None) will cause the status to be acquired
00237         from the parent instead (defaulting to no blacklisting).
00238         """
    

The documentation for this class was generated from the following file: