Back to index

plone3  3.1.7
Public Member Functions
plone.app.layout.globals.interfaces.IContextState Class Reference
Inheritance diagram for plone.app.layout.globals.interfaces.IContextState:
Inheritance graph
[legend]
Collaboration diagram for plone.app.layout.globals.interfaces.IContextState:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def current_page_url
def current_base_url
def canonical_object
def canonical_object_url
def view_url
def view_template_id
def is_view_template
def object_url
def object_title
def workflow_state
def parent
def folder
def is_folderish
def is_structural_folder
def is_default_page
def is_portal_root
def is_editable
def is_locked
def actions
def keyed_actions
def portlet_assignable

Detailed Description

A view that gives access to the state of the current context

Definition at line 107 of file interfaces.py.


Member Function Documentation

The filtered actions in the context

Definition at line 194 of file interfaces.py.

00194 
00195     def actions():
00196         """The filtered actions in the context
00197         """
    

Here is the caller graph for this function:

The current "canonical" object.

That is, the current object unless this object is the default page
in its folder, in which case the folder is returned.

Definition at line 120 of file interfaces.py.

00120 
00121     def canonical_object():
00122         """The current "canonical" object.
00123         
00124         That is, the current object unless this object is the default page
00125         in its folder, in which case the folder is returned.
00126         """
        
The URL to the current "canonical" object.

That is, the current object unless this object is the default page
in its folder, in which case the folder is returned.

Definition at line 127 of file interfaces.py.

00127 
00128     def canonical_object_url():
00129         """The URL to the current "canonical" object.
00130         
00131         That is, the current object unless this object is the default page
00132         in its folder, in which case the folder is returned.
00133         """
        
The current "actual" URL from the request, excluding the query
string.

Definition at line 115 of file interfaces.py.

00115 
00116     def current_base_url():
00117         """The current "actual" URL from the request, excluding the query
00118         string.
00119         """
        
A view that gives access to the state of the current context
The URL to the current page, including template and query string.

Definition at line 111 of file interfaces.py.

00111 
00112     def current_page_url():
00113         """The URL to the current page, including template and query string.
00114         """
        
The current canonical folder

Definition at line 166 of file interfaces.py.

00166 
00167     def folder():
00168         """The current canonical folder
00169         """
                            
True if this is the default page of its folder

Definition at line 178 of file interfaces.py.

00178 
00179     def is_default_page():
00180         """True if this is the default page of its folder
00181         """
        
Whether or not the current object is editable

Definition at line 186 of file interfaces.py.

00186 
00187     def is_editable():
00188         """Whether or not the current object is editable
00189         """
    
True if this is a folderish object, structural or not

Definition at line 170 of file interfaces.py.

00170 
00171     def is_folderish():
00172         """True if this is a folderish object, structural or not
00173         """
    
Whether or not the current object is locked

Definition at line 190 of file interfaces.py.

00190 
00191     def is_locked():
00192         """Whether or not the current object is locked
00193         """
                            
True if this is the portal or the default page in the portal

Definition at line 182 of file interfaces.py.

00182 
00183     def is_portal_root():
00184         """True if this is the portal or the default page in the portal
00185         """
    
True if this is a structural folder

Definition at line 174 of file interfaces.py.

00174 
00175     def is_structural_folder():
00176         """True if this is a structural folder
00177         """
    
Return True if the currentl URL (in the request) refers to the
standard "view" of the context (i.e. the "view" tab).

Definition at line 145 of file interfaces.py.

00145 
00146     def is_view_template():
00147         """Return True if the currentl URL (in the request) refers to the
00148         standard "view" of the context (i.e. the "view" tab).
00149         """
                            
A mapping of action categories to action ids to
action information: mapping[cat][id] == actioninfo

Definition at line 198 of file interfaces.py.

00198 
00199     def keyed_actions():
00200         """A mapping of action categories to action ids to
00201         action information: mapping[cat][id] == actioninfo
00202         """
        
The prettified title of the current object

Definition at line 154 of file interfaces.py.

00154 
00155     def object_title():
00156         """The prettified title of the current object
00157         """
        
The URL of the current object

Definition at line 150 of file interfaces.py.

00150 
00151     def object_url():
00152         """The URL of the current object
00153         """
        
The direct parent of the current object

Definition at line 162 of file interfaces.py.

00162 
00163     def parent():
00164         """The direct parent of the current object
00165         """
        
Whether or not the context is capable of having locally assigned
portlets.

Definition at line 203 of file interfaces.py.

00203 
00204     def portlet_assignable():
00205         """Whether or not the context is capable of having locally assigned
00206         portlets.
00207         """
        
The id of the view template of the context

Definition at line 141 of file interfaces.py.

00141 
00142     def view_template_id():
00143         """The id of the view template of the context
00144         """
        
URL to use for viewing

Files and Images get downloaded when they are directly
called, instead of with /view appended.  We want to avoid that.

Definition at line 134 of file interfaces.py.

00134 
00135     def view_url():
00136         """URL to use for viewing
00137 
00138         Files and Images get downloaded when they are directly
00139         called, instead of with /view appended.  We want to avoid that.
00140         """

The workflow state of the current object

Definition at line 158 of file interfaces.py.

00158 
00159     def workflow_state():
00160         """The workflow state of the current object
00161         """
    

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