Back to index

plone3  3.1.7
Public Member Functions
CMFDynamicViewFTI.interface._base.ISelectableBrowserDefault Class Reference
Inheritance diagram for CMFDynamicViewFTI.interface._base.ISelectableBrowserDefault:
Inheritance graph
[legend]
Collaboration diagram for CMFDynamicViewFTI.interface._base.ISelectableBrowserDefault:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def canSetDefaultPage
def setDefaultPage
def canSetLayout
def setLayout
def getAvailableLayouts
def defaultView
def __call__
def getDefaultPage
def getLayout
def getDefaultLayout

Detailed Description

Content supporting operations to explicitly set the default layout 
template or default page object.

Definition at line 84 of file _base.py.


Member Function Documentation

Resolve and return the selected view template applied to the object.

This should not consider any default page set.

Definition at line 61 of file _base.py.

00061 
00062     def __call__():
00063         """Resolve and return the selected view template applied to the object.
00064         
00065         This should not consider any default page set.
00066         """

Here is the caller graph for this function:

Content supporting operations to explicitly set the default layout 
template or default page object.
Can a default page be set?

Return True if the user has permission to select a default page on this
(folderish) item, and the item is folderish.

Definition at line 89 of file _base.py.

00089 
00090     def canSetDefaultPage():
00091         """Can a default page be set?
00092         
00093         Return True if the user has permission to select a default page on this
00094         (folderish) item, and the item is folderish.
00095         """

Return True if the current authenticated user is permitted to select
a layout.

Definition at line 106 of file _base.py.

00106 
00107     def canSetLayout():
00108         """Return True if the current authenticated user is permitted to select
00109         a layout.
00110         """

Content supporting different views on a per-instance basis.

This can be either as a page template (a layout), or as the id of a 
contained object (aka a default page, set inside a folderish item only).
Get the actual view to use. 

If a default page is set, its id will
be returned. Else, the current layout's page template id is returned.

Definition at line 54 of file _base.py.

00054 
00055     def defaultView(request=None):
00056         """Get the actual view to use. 
00057         
00058         If a default page is set, its id will
00059         be returned. Else, the current layout's page template id is returned.
00060         """

Get the layouts registered for this object.

This should return a list of tuples: (id, title), where id is the id
of the page template providing the layout and title is the title of
that page template as it will be displayed to the user.

Definition at line 119 of file _base.py.

00119 
00120     def getAvailableLayouts():
00121         """Get the layouts registered for this object.
00122 
00123         This should return a list of tuples: (id, title), where id is the id
00124         of the page template providing the layout and title is the title of
00125         that page template as it will be displayed to the user.
00126         """

Here is the caller graph for this function:

Get the default layout template.

Definition at line 79 of file _base.py.

00079 
00080     def getDefaultLayout():
00081         """Get the default layout template.
00082         """
00083 

Return the id of the default page, or None if none is set. 

The default page must be contained within this (folderish) item.

Definition at line 67 of file _base.py.

00067 
00068     def getDefaultPage():
00069         """Return the id of the default page, or None if none is set. 
00070         
00071         The default page must be contained within this (folderish) item.
00072         """

Here is the caller graph for this function:

Get the selected layout template. 

Note that a selected default page will override the layout template.

Definition at line 73 of file _base.py.

00073 
00074     def getLayout(**kw):
00075         """Get the selected layout template. 
00076         
00077         Note that a selected default page will override the layout template.
00078         """

Here is the caller graph for this function:

Set the default page to display in this (folderish) object. 

The objectId must be a value found in self.objectIds() (i.e. a contained 
object). This object will be displayed as the default_page/index_html 
object of this (folderish) object. This will override the current layout
template returned by getLayout(). Pass None for objectId to turn off
the default page and return to using the selected layout template.

Definition at line 96 of file _base.py.

00096 
00097     def setDefaultPage(objectId):
00098         """Set the default page to display in this (folderish) object. 
00099         
00100         The objectId must be a value found in self.objectIds() (i.e. a contained 
00101         object). This object will be displayed as the default_page/index_html 
00102         object of this (folderish) object. This will override the current layout
00103         template returned by getLayout(). Pass None for objectId to turn off
00104         the default page and return to using the selected layout template.
00105         """

Set the layout as the current view. 

'layout' should be one of the list returned by getAvailableLayouts(). 
If a default page has been set with setDefaultPage(), it is turned off 
by calling setDefaultPage(None).

Definition at line 111 of file _base.py.

00111 
00112     def setLayout(layout):
00113         """Set the layout as the current view. 
00114         
00115         'layout' should be one of the list returned by getAvailableLayouts(). 
00116         If a default page has been set with setDefaultPage(), it is turned off 
00117         by calling setDefaultPage(None).
00118         """

Here is the caller graph for this function:


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