canonical.launchpad.webapp.tales.ObjectFormatterAPI : API documentation

Method	__init__	Undocumented
Method	url	Return the object's canonical URL.
Method	api_url	Return the object's (partial) canonical web service URL.
Method	traverse	Undocumented
Method	link	Return an HTML link to the object's page.
Method	public_private_css	Return the CSS class that represents the object's privacy.
Method	pagetitle	The page title to be used.

def __init__(self, context):

Undocumented

def url(self, view_name=None, rootsite=None):

Return the object's canonical URL.

Parameters	view_name	If not None, return the URL to the page with that name on this object.
	rootsite	If not None, return the URL to the page on the specified rootsite. Note this is available only for subclasses that allow specifying the rootsite.

def api_url(self, context):

overridden in canonical.launchpad.webapp.tales.TeamFormatterAPI

Return the object's (partial) canonical web service URL.

This method returns everything that goes after the web service version number. Effectively the canonical URL but only the relative part with no site.

def traverse(self, name, furtherPath):

Undocumented

def link(self, view_name, rootsite=None):

Return an HTML link to the object's page.

The link consists of an icon followed by the object's name.

Parameters	view_name	If not None, the link will point to the page with that name on this object.
	rootsite	If not None, return the URL to the page on the specified rootsite. Note this is available only for subclasses that allow specifying the rootsite.

def public_private_css(self):

Return the CSS class that represents the object's privacy.

def pagetitle(self):

The page title to be used.

By default, reverse breadcrumbs are always used if they are available. If not available, then the view's .page_title attribute or entry in pagetitles.py (deprecated) is used. If breadcrumbs are available, then a view can still choose to override them by setting the attribute .override_title_breadcrumbs to True.

c.l.w.t.ObjectFormatterAPI : class documentation