Back to index

plone3  3.1.7
Public Member Functions | Static Public Attributes
plone.app.layout.navigation.interfaces.INavtreeStrategy Class Reference
Inheritance diagram for plone.app.layout.navigation.interfaces.INavtreeStrategy:
Inheritance graph
[legend]
Collaboration diagram for plone.app.layout.navigation.interfaces.INavtreeStrategy:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def nodeFilter
def subtreeFilter
def decoratorFactory
def showChildrenOf

Static Public Attributes

tuple rootPath = Attribute("The path to the root of the navtree (None means use portal root)")
tuple showAllParents = Attribute("Whether or not to show all parents of the current context always")

Detailed Description

An object that is used by buildFolderTree() to determine how to 
construct a navigation tree.

Definition at line 31 of file interfaces.py.


Member Function Documentation

Inject any additional keys in the node that are needed and return
the new node.

Definition at line 51 of file interfaces.py.

00051 
00052     def decoratorFactory(node):
00053         """Inject any additional keys in the node that are needed and return
00054         the new node.
00055         """
        
Return True or False to determine whether to include the given node
in the tree. Nodes are dicts with at least one key - 'item', the
catalog brain of the object the node represents.

Definition at line 40 of file interfaces.py.

00040 
00041     def nodeFilter(node):
00042         """Return True or False to determine whether to include the given node
00043         in the tree. Nodes are dicts with at least one key - 'item', the
00044         catalog brain of the object the node represents.
00045         """

Given an object (usually the root of the site), determine whether
children should be shown or not. Even if this returns True, if
showAllParents is True, the path to the current item may be shown.

Definition at line 56 of file interfaces.py.

00056 
00057     def showChildrenOf(object):
00058         """Given an object (usually the root of the site), determine whether
00059         children should be shown or not. Even if this returns True, if
00060         showAllParents is True, the path to the current item may be shown.
        """
Return True or False to determine whether to expand the given
(folderish) node

Definition at line 46 of file interfaces.py.

00046 
00047     def subtreeFilter(node):
00048         """Return True or False to determine whether to expand the given
00049         (folderish) node
00050         """


Member Data Documentation

tuple plone.app.layout.navigation.interfaces.INavtreeStrategy.rootPath = Attribute("The path to the root of the navtree (None means use portal root)") [static]
An object that is used by buildFolderTree() to determine how to 
construct a navigation tree.

Definition at line 36 of file interfaces.py.

tuple plone.app.layout.navigation.interfaces.INavtreeStrategy.showAllParents = Attribute("Whether or not to show all parents of the current context always") [static]

Definition at line 38 of file interfaces.py.


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