lp.app.browser.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	Traverse the specified path, processing any optional parameters.
Method	link	Return an HTML link to the object's page.
Method	global_css	Undocumented
Method	pagetitle	The page title to be used.
Method	_getSaneBreadcrumbDetail	Undocumented

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 lp.app.browser.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):

Traverse the specified path, processing any optional parameters.

Up to 2 parameters are currently supported, and the path name will be
of the form:
    name:param1:param2
where
    param1 = rootsite (only used for link and url paths).
    param2 = default (used when self.context is None). The context
             is not None here so this parameter is ignored.

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 global_css(self):

Undocumented

def _getSaneBreadcrumbDetail(self, breadcrumb):

Undocumented

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 is used.

l.a.b.t.ObjectFormatterAPI : class documentation