l.a.b.l.Hierarchy(LaunchpadView) : class documentation

Part of lp.app.browser.launchpad View In Hierarchy

Known subclasses: lp.app.browser.launchpad.ExceptionHierarchy

The heading, title, facet links and breadcrumbs parts of each page.
Method objects The objects for which we want breadcrumbs.
Method items Return a list of IBreadcrumb objects visible in the hierarchy.
Method items_for_body Return breadcrumbs to display in the page body's hierarchy section.
Method makeBreadcrumbsForRequestedPage Return a sequence of `IBreadcrumb`s for the requested page.
Method display_breadcrumbs Return whether the breadcrumbs should be displayed.
Method heading_breadcrumbs Undocumented
Method heading Return the heading markup for the page.
Method logo Return the logo image for the top header breadcrumb's context.
Method _naked_context_view Return the unproxied view for the context of the hierarchy.
@property
def objects(self):
overridden in lp.app.browser.launchpad.ExceptionHierarchy
The objects for which we want breadcrumbs.
@cachedproperty
def items(self):
Return a list of IBreadcrumb objects visible in the hierarchy.

The list starts with the breadcrumb closest to the hierarchy root.

@property
def items_for_body(self):
Return breadcrumbs to display in the page body's hierarchy section.

While the entire sequence of breadcrumbs must be included in the document title, the first 0-3 are represented specially in the header (headings and facet links), so we don't want to duplicate them in the main content.

@property
def _naked_context_view(self):
Return the unproxied view for the context of the hierarchy.
def makeBreadcrumbsForRequestedPage(self): 
Return a sequence of `IBreadcrumb`s for the requested page.

The `IBreadcrumb` for the requested page is created using the current
URL and the page's name (i.e. the last path segment of the URL).

If the view is the default one for the object or the current
facet, no breadcrumbs are returned -- we'll have injected a
facet Breadcrumb earlier in the hierarchy which links here.
@property
def display_breadcrumbs(self):
Return whether the breadcrumbs should be displayed.
@property
def heading_breadcrumbs(self):
Undocumented
def heading(self):
Return the heading markup for the page.

If the context provides IMajorHeadingView then we return an H1, else an H2.

def logo(self):
Return the logo image for the top header breadcrumb's context.
API Documentation for Launchpad, generated by pydoctor at 2022-06-16 00:00:12.