Back to index

plone3  3.1.7
Public Member Functions
CMFPlone.browser.interfaces.IPlone Class Reference
Inheritance diagram for CMFPlone.browser.interfaces.IPlone:
Inheritance graph
[legend]
Collaboration diagram for CMFPlone.browser.interfaces.IPlone:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def globalize
def getCurrentUrl
def keyFilteredActions
def visibleIdsEnabled
def isRightToLeft
def toLocalizedTime
def isDefaultPageInFolder
def isStructuralFolder
def hide_columns
def navigationRootPath
def navigationRootUrl
def getParentObject
def getCurrentFolder
def getCurrentFolderUrl
def getCurrentObjectUrl
def isFolderOrFolderDefaultPage
def isPortalOrPortalDefaultPage
def getViewTemplateId
def showEditableBorder
def displayContentsTab
def getIcon
def cropText
def have_portlets

Detailed Description

Definition at line 196 of file interfaces.py.


Member Function Documentation

def CMFPlone.browser.interfaces.IPlone.cropText (   text,
  length,
  ellipsis 
)
Crop text on a word boundary 

Definition at line 411 of file interfaces.py.

00411 
00412     def cropText(text, length, ellipsis):
00413         """ Crop text on a word boundary """

Returns true if the contents tab should be displayed in the current
   context.  Evaluates whether the object is a folder or the default
   page of a folder, and checks if the user has relevant permissions.

Definition at line 398 of file interfaces.py.

00398 
00399     def displayContentsTab():
00400         """Returns true if the contents tab should be displayed in the current
00401            context.  Evaluates whether the object is a folder or the default
00402            page of a folder, and checks if the user has relevant permissions.
00403         """

If the context is the default page of a folder or is not itself a
   folder, the parent is returned, otherwise the object itself is
   returned.  This is useful for providing a context for methods
   which wish to act on what is considered the current folder in the
   ui.

Definition at line 361 of file interfaces.py.

00361 
00362     def getCurrentFolder():
00363         """If the context is the default page of a folder or is not itself a
00364            folder, the parent is returned, otherwise the object itself is
00365            returned.  This is useful for providing a context for methods
00366            which wish to act on what is considered the current folder in the
00367            ui.
00368         """

Here is the caller graph for this function:

Returns the URL of the current folder as determined by
   self.getCurrentFolder(), used heavily in actions.

Definition at line 369 of file interfaces.py.

00369 
00370     def getCurrentFolderUrl():
00371         """Returns the URL of the current folder as determined by
00372            self.getCurrentFolder(), used heavily in actions.
00373         """

Returns the URL of the current object unless that object is a
   folder default page, in which case it returns the parent.

Definition at line 374 of file interfaces.py.

00374 
00375     def getCurrentObjectUrl():
00376         """Returns the URL of the current object unless that object is a
00377            folder default page, in which case it returns the parent.
00378         """

Returns the actual url plus the query string. 

Definition at line 306 of file interfaces.py.

00306 
00307     def getCurrentUrl():
00308         """ Returns the actual url plus the query string. """

Returns an object which implements the IContentIcon interface and
   provides the informations necessary to render an icon.
   The item parameter needs to be adaptable to IContentIcon.
   Icons can be disabled globally or just for anonymous users with
   the icon_visibility property in site_properties.

Definition at line 404 of file interfaces.py.

00404 
00405     def getIcon(item):
00406         """Returns an object which implements the IContentIcon interface and
00407            provides the informations necessary to render an icon.
00408            The item parameter needs to be adaptable to IContentIcon.
00409            Icons can be disabled globally or just for anonymous users with
00410            the icon_visibility property in site_properties."""

Here is the caller graph for this function:

Returns the parent of the current object, equivalent to
   aq_inner(aq_parent(context)), or context.aq_inner.getParentNode()

Definition at line 356 of file interfaces.py.

00356 
00357     def getParentObject():
00358         """Returns the parent of the current object, equivalent to
00359            aq_inner(aq_parent(context)), or context.aq_inner.getParentNode()
00360         """

Returns the template Id corresponding to the default view method of
   the context object.

Definition at line 389 of file interfaces.py.

00389 
00390     def getViewTemplateId():
00391         """Returns the template Id corresponding to the default view method of
00392            the context object.
00393         """
        
A method which puts all of the following view attributes into the
    globals of the current tal expression context (plus the
    toLocalizedTime method):

    atool = Attribute("The portal_actions tool")

    utool = Attribute("The portal_url tool")

    portal = Attribute("The portal object itself")

    portal_url = Attribute("The portal url")

    mtool = Attribute("The portal_membership tool")

    putils = Attribute("The plone_utils tool (PloneTool)")

    wtool = Attribute("The portal_workflow tool")

    ifacetool = Attribute("The portal_interface tool")

    syntool = Attribute("The portal_syndication tool")

    portal_title = Attribute("The title of the portal")

    object_title = Attribute("The title of the current object (context)")

    member = Attribute("The member object for the authenticated user in "
       "context")

    checkPermission = Attribute("The checkPermission method of the membership"
                " tool")

    membersfolder = Attribute("The portal's Members folder")

    isAnon = Attribute("Boolean indicating whether the current user is "
       "anonymous")

    actions = Attribute("The result of listFilteredActionsFor(context) in the "
        "portal_actions tool")

    keyed_actions = Attribute("A mapping of action categories to action ids "
              "to action information: "
              "mapping[cat][id] == actioninfo")

    user_actions = Attribute("Actions in the user category")

    workflow_actions = Attribute("Actions in the workflow category")

    folder_actions = Attribute("Actions in the folder category")

    global_actions = Attribute("Actions in the global category")

    portal_tabs = Attribute("The actions for the portal tabs")

    wf_state = Attribute("The review_state of the current object")

    portal_properties = Attribute("The portal_properties tool")

    site_properties = Attribute("The site_properties tool")

    ztu = Attribute("The ZTUtils module")

    isFolderish = Attribute("A boolean indicating whether the object is "
            "folderish")

    here_url = Attribute("The url of the current object")

    sl = Attribute("True if the left slot should be shown")

    sr = Attribute("True if the right slot should be shown")

    hidecolumns = Attribute("The css class to use for the column container"
            "which determines which columns to show")

    default_language = Attribute("The default language of the portal")

    language = Attribute("The language of the current request or context.")

    is_editable = Attribute("A boolean indicating if the current user has "
            " edit permissions in this context")

    isLocked = Attribute("A boolean indicating that the object is webdav "
         "locked")

    isRTL = Attribute("A boolean indicating that the current language is a "
      "right-to-left language.")

    visible_ids = Attribute("A boolean indicating whether to show object ids "
            "to the current user")

    current_page_url = Attribute("The full url with query string")

    isContextDefaultPage = Attribute("Boolean indicating that the context is "
                     "the default page of its parent folder.")

    isStructuralFolder = Attribute("Boolean indicating that the context is a "
                   "'Structural Folder'.")

    Iterator = Attribute("A factory for generating sinple integer Iterators.")

    tabindex = Attribute("An iterator for use in creating tabindexes.")

    uniqueItemIndex = Attribute("An iterator for help inc reading unique "
                "html ids.")

Definition at line 199 of file interfaces.py.

00199 
00200     def globalize():
00201         """ A method which puts all of the following view attributes into the
00202             globals of the current tal expression context (plus the
00203             toLocalizedTime method):
00204 
00205     atool = Attribute("The portal_actions tool")
00206 
00207     utool = Attribute("The portal_url tool")
00208 
00209     portal = Attribute("The portal object itself")
00210 
00211     portal_url = Attribute("The portal url")
00212 
00213     mtool = Attribute("The portal_membership tool")
00214 
00215     putils = Attribute("The plone_utils tool (PloneTool)")
00216 
00217     wtool = Attribute("The portal_workflow tool")
00218 
00219     ifacetool = Attribute("The portal_interface tool")
00220 
00221     syntool = Attribute("The portal_syndication tool")
00222 
00223     portal_title = Attribute("The title of the portal")
00224 
00225     object_title = Attribute("The title of the current object (context)")
00226 
00227     member = Attribute("The member object for the authenticated user in "
00228                        "context")
00229 
00230     checkPermission = Attribute("The checkPermission method of the membership"
00231                                 " tool")
00232 
00233     membersfolder = Attribute("The portal's Members folder")
00234 
00235     isAnon = Attribute("Boolean indicating whether the current user is "
00236                        "anonymous")
00237 
00238     actions = Attribute("The result of listFilteredActionsFor(context) in the "
00239                         "portal_actions tool")
00240 
00241     keyed_actions = Attribute("A mapping of action categories to action ids "
00242                               "to action information: "
00243                               "mapping[cat][id] == actioninfo")
00244 
00245     user_actions = Attribute("Actions in the user category")
00246 
00247     workflow_actions = Attribute("Actions in the workflow category")
00248 
00249     folder_actions = Attribute("Actions in the folder category")
00250 
00251     global_actions = Attribute("Actions in the global category")
00252 
00253     portal_tabs = Attribute("The actions for the portal tabs")
00254 
00255     wf_state = Attribute("The review_state of the current object")
00256 
00257     portal_properties = Attribute("The portal_properties tool")
00258 
00259     site_properties = Attribute("The site_properties tool")
00260 
00261     ztu = Attribute("The ZTUtils module")
00262 
00263     isFolderish = Attribute("A boolean indicating whether the object is "
00264                             "folderish")
00265 
00266     here_url = Attribute("The url of the current object")
00267 
00268     sl = Attribute("True if the left slot should be shown")
00269 
00270     sr = Attribute("True if the right slot should be shown")
00271 
00272     hidecolumns = Attribute("The css class to use for the column container"
00273                             "which determines which columns to show")
00274 
00275     default_language = Attribute("The default language of the portal")
00276 
00277     language = Attribute("The language of the current request or context.")
00278 
00279     is_editable = Attribute("A boolean indicating if the current user has "
00280                             " edit permissions in this context")
00281 
00282     isLocked = Attribute("A boolean indicating that the object is webdav "
00283                          "locked")
00284 
00285     isRTL = Attribute("A boolean indicating that the current language is a "
00286                       "right-to-left language.")
00287 
00288     visible_ids = Attribute("A boolean indicating whether to show object ids "
00289                             "to the current user")
00290 
00291     current_page_url = Attribute("The full url with query string")
00292 
00293     isContextDefaultPage = Attribute("Boolean indicating that the context is "
00294                                      "the default page of its parent folder.")
00295 
00296     isStructuralFolder = Attribute("Boolean indicating that the context is a "
00297                                    "'Structural Folder'.")
00298 
00299     Iterator = Attribute("A factory for generating sinple integer Iterators.")
00300 
00301     tabindex = Attribute("An iterator for use in creating tabindexes.")
00302 
00303     uniqueItemIndex = Attribute("An iterator for help inc reading unique "
00304                                 "html ids.")
00305     """

def CMFPlone.browser.interfaces.IPlone.have_portlets (   manager_name,
  view = None 
)
Determine whether a column should be shown.

Definition at line 414 of file interfaces.py.

00414 
00415     def have_portlets(manager_name, view=None):
00416         """Determine whether a column should be shown."""

Here is the caller graph for this function:

def CMFPlone.browser.interfaces.IPlone.hide_columns (   self,
  column_left,
  column_right 
)
Returns the CSS class used by the page layout hide empty
    portlet columns.

Definition at line 343 of file interfaces.py.

00343 
00344     def hide_columns(self, column_left, column_right):
00345         """ Returns the CSS class used by the page layout hide empty
00346             portlet columns.
00347         """

Here is the caller graph for this function:

Returns a boolean indicating whether the current context is the
    default page of its parent folder.

Definition at line 330 of file interfaces.py.

00330 
00331     def isDefaultPageInFolder():
00332         """ Returns a boolean indicating whether the current context is the
00333             default page of its parent folder.
00334         """

Here is the caller graph for this function:

Returns true only if the current object is either a folder (as
   determined by isStructuralFolder) or the default page in context.

Definition at line 379 of file interfaces.py.

00379 
00380     def isFolderOrFolderDefaultPage():
00381         """Returns true only if the current object is either a folder (as
00382            determined by isStructuralFolder) or the default page in context.
00383         """

Returns true only if the current object is either the portal object
   or the default page of the portal.

Definition at line 384 of file interfaces.py.

00384 
00385     def isPortalOrPortalDefaultPage():
00386         """Returns true only if the current object is either the portal object
00387            or the default page of the portal.
00388         """

Is the currently selected language a right to left language

Definition at line 321 of file interfaces.py.

00321 
00322     def isRightToLeft(domain='plone'):
00323         """Is the currently selected language a right to left language"""

Checks if a given object is a "structural folder".

That is, a folderish item which does not explicitly implement
INonStructuralFolder to declare that it doesn't wish to be treated
as a folder by the navtree, the tab generation etc.

Definition at line 335 of file interfaces.py.

00335 
00336     def isStructuralFolder():
00337         """Checks if a given object is a "structural folder".
00338 
00339         That is, a folderish item which does not explicitly implement
00340         INonStructuralFolder to declare that it doesn't wish to be treated
00341         as a folder by the navtree, the tab generation etc.
00342         """

Here is the caller graph for this function:

Returns a mapping of action categories to action ids to action
    information: mapping[cat][id] == actioninfo

    Optionally takes an action list, if ommitted it will be calculated

Definition at line 309 of file interfaces.py.

00309 
00310     def keyFilteredActions(actions=None):
00311         """ Returns a mapping of action categories to action ids to action
00312             information: mapping[cat][id] == actioninfo
00313 
00314             Optionally takes an action list, if ommitted it will be calculated
00315         """

Get the current navigation root path

Definition at line 348 of file interfaces.py.

00348 
00349     def navigationRootPath():
00350         """Get the current navigation root path
00351         """

Get the url to the current navigation root

Definition at line 352 of file interfaces.py.

00352 
00353     def navigationRootUrl():
00354         """Get the url to the current navigation root
00355         """

Returns true if the editable border should be shown

Definition at line 394 of file interfaces.py.

00394 
00395     def showEditableBorder():
00396         """Returns true if the editable border should be shown
00397         """

def CMFPlone.browser.interfaces.IPlone.toLocalizedTime (   time,
  long_format = None 
)
The time parameter must be either a string that is suitable for
    initializing a DateTime or a DateTime object. Returns a localized
    string.

Definition at line 324 of file interfaces.py.

00324 
00325     def toLocalizedTime(time, long_format=None):
00326         """ The time parameter must be either a string that is suitable for
00327             initializing a DateTime or a DateTime object. Returns a localized
00328             string.
00329         """

Here is the caller graph for this function:

Determines whether to show object ids based on portal and user
   settings.

Definition at line 316 of file interfaces.py.

00316 
00317     def visibleIdsEnabled():
00318         """Determines whether to show object ids based on portal and user
00319            settings.
00320         """

Here is the caller graph for this function:


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