Back to index

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

List of all members.

Public Member Functions

def getAvailableViewMethods
def getViewMethod
def getDefaultViewMethod
def getDefaultPage
def defaultView

Detailed Description

Interface for FTI with dynamic views

A value of (dynamic view) as alias is replaced by the output of getLayout()

Definition at line 5 of file _base.py.


Member Function Documentation

Get the layout for an object

At first it tries to get the default page from the context. A default page
must be listed on the folder or else it is ignored.

At last it get the view method.

Return -- a string containing the name of the layout

Definition at line 36 of file _base.py.

00036 
00037     def defaultView(context):
00038         """Get the layout for an object
00039 
00040         At first it tries to get the default page from the context. A default page
00041         must be listed on the folder or else it is ignored.
00042 
00043         At last it get the view method.
00044 
00045         Return -- a string containing the name of the layout
00046         """

Get a list of registered view methods

Definition at line 11 of file _base.py.

00011 
00012     def getAvailableViewMethods(context):
00013         """Get a list of registered view methods
00014         """

Get the default page from a folderish object

Non folderish objects don't have a default view.

If check_exists is enabled the method makes sure the object with the default
page id exists.

Return -- None for no default page or a string

Definition at line 25 of file _base.py.

00025 
00026     def getDefaultPage(context, check_exists=False):
00027         """Get the default page from a folderish object
00028 
00029         Non folderish objects don't have a default view.
00030 
00031         If check_exists is enabled the method makes sure the object with the default
00032         page id exists.
00033 
00034         Return -- None for no default page or a string
00035         """

Here is the caller graph for this function:

Get the default view method from the FTI

Definition at line 21 of file _base.py.

00021 
00022     def getDefaultViewMethod(context):
00023         """Get the default view method from the FTI
00024         """

def CMFDynamicViewFTI.interface._base.IDynamicViewTypeInformation.getViewMethod (   context,
  enforce_available = True 
)
Get view method name from context

Return -- view method from context or default view name

Definition at line 15 of file _base.py.

00015 
00016     def getViewMethod(context, enforce_available = True):
00017         """Get view method name from context
00018 
00019         Return -- view method from context or default view name
00020         """


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