Back to index

plone3  3.1.7
Static Public Attributes
plone.app.portlets.portlets.navigation.INavigationPortlet Class Reference
Inheritance diagram for plone.app.portlets.portlets.navigation.INavigationPortlet:
Inheritance graph
[legend]
Collaboration diagram for plone.app.portlets.portlets.navigation.INavigationPortlet:
Collaboration graph
[legend]

List of all members.

Static Public Attributes

tuple name
tuple root
tuple includeTop
tuple currentFolderOnly
tuple topLevel
tuple bottomLevel

Detailed Description

A portlet which can render the navigation tree

Definition at line 32 of file navigation.py.


Member Data Documentation

Initial value:
schema.Int(
            title=_(u"label_navigation_tree_depth",
                    default=u"Navigation tree depth"),
            description=_(u"help_navigation_tree_depth",
                          default=u"How many folders should be included "
                                   "before the navigation tree stops. 0 "
                                   "means no limit. 1 only includes the "
                                   "root folder."),
            default=0,
            required=False)

Definition at line 87 of file navigation.py.

Initial value:
schema.Bool(
            title=_(u"label_current_folder_only",
                    default=u"Only show the contents of the current folder."),
            description=_(u"help_current_folder_only",
                          default=u"If selected, the navigation tree will "
                                   "only show the current folder and its "
                                   "children at all times."),
            default=False,
            required=False)

Definition at line 63 of file navigation.py.

Initial value:
schema.Bool(
            title=_(u"label_include_top_node", default=u"Include top node"),
            description=_(u"help_include_top_node",
                          default=u"Whether or not to show the top, or 'root', "
                                   "node in the navigation tree. This is affected " 
                                   "by the 'Start level' setting."),
            default=False,
            required=False)

Definition at line 54 of file navigation.py.

Initial value:
schema.TextLine(
            title=_(u"label_navigation_title", default=u"Title"),
            description=_(u"help_navigation_title",
                          default=u"The title of the navigation tree. Leave "
                                   "blank for the default, translated title."),
            default=u"",
            required=False)

Definition at line 36 of file navigation.py.

Initial value:
schema.Choice(
            title=_(u"label_navigation_root_path", default=u"Root node"),
            description=_(u'help_navigation_root',
                          default=u"You may search for and choose a folder "
                                    "to act as the root of the navigation tree. "
                                    "Leave blank to use the Plone site root."),
            required=False,
            source=SearchableTextSourceBinder({'is_folderish' : True},
                                              default_query='path:'))

Definition at line 44 of file navigation.py.

Initial value:
schema.Int(
            title=_(u"label_navigation_startlevel", default=u"Start level"),
            description=_(u"help_navigation_start_level",
                default=u"An integer value that specifies the number of folder "
                         "levels below the site root that must be exceeded "
                         "before the navigation tree will display. 0 means "
                         "that the navigation tree should be displayed "
                         "everywhere including pages in the root of the site. "
                         "1 means the tree only shows up inside folders "
                         "located in the root and downwards, never showing "
                         "at the top level."),
            default=1,
            required=False)

Definition at line 73 of file navigation.py.


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