agency.layout

Classes

PageLayout

The default layout meant for the public facing parts of the site.

PersonLayout

The default layout meant for the public facing parts of the site.

MoveAgencyMixin

NavTreeMixin

AgencyCollectionLayout

The default layout meant for the public facing parts of the site.

AgencyLayout

The default layout meant for the public facing parts of the site.

AgencyPathMixin

MembershipLayout

The default layout meant for the public facing parts of the site.

ExtendedPersonCollectionLayout

The default layout meant for the public facing parts of the site.

ExtendedPersonLayout

The default layout meant for the public facing parts of the site.

AgencySearchLayout

The default layout meant for the public facing parts of the site.

Module Contents

class agency.layout.PageLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)[source]

Bases: onegov.org.layout.PageLayout

The default layout meant for the public facing parts of the site.

A list of links shown in the sidebar, used for navigation.

class agency.layout.PersonLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)[source]

Bases: onegov.org.layout.PersonLayout

The default layout meant for the public facing parts of the site.

A of onegov.org.elements.LinkGroup classes. Each of them will be shown in the top editbar, with the group title being the dropdown title.

class agency.layout.MoveAgencyMixin[source]
move_agency_url_template() str[source]
class agency.layout.NavTreeMixin[source]
nav_item_url(agency: onegov.agency.models.ExtendedAgency) str[source]
browsed_agency() ExtendedAgency | None[source]
browsed_agency_parents() list[int][source]
prerender_content(agency_id: int | str) bool[source]
class agency.layout.AgencyCollectionLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)[source]

Bases: onegov.org.layout.DefaultLayout, MoveAgencyMixin, NavTreeMixin

The default layout meant for the public facing parts of the site.

request: onegov.agency.request.AgencyRequest[source]
breadcrumbs() list[onegov.core.elements.Link][source]

Returns the breadcrumbs for the current page.

A of onegov.org.elements.LinkGroup classes. Each of them will be shown in the top editbar, with the group title being the dropdown title.

class agency.layout.AgencyLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)[source]

Bases: onegov.org.layout.AdjacencyListLayout, MoveAgencyMixin

The default layout meant for the public facing parts of the site.

request: onegov.agency.request.AgencyRequest[source]
include_editor() None[source]
collection() onegov.agency.collections.ExtendedAgencyCollection[source]
breadcrumbs() list[onegov.core.elements.Link][source]

Returns the breadcrumbs for the current page.

A of onegov.org.elements.LinkGroup classes. Each of them will be shown in the top editbar, with the group title being the dropdown title.

move_membership_within_agency_url_template() str[source]
class agency.layout.AgencyPathMixin[source]
get_ancestors(item: onegov.agency.models.ExtendedAgency, with_item: bool = True, levels: Collection[int] | None = None) Iterator[Link][source]
parent_path(agency: onegov.agency.models.ExtendedAgency) str[source]
agency_path(agency: onegov.agency.models.ExtendedAgency) str[source]
class agency.layout.MembershipLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)[source]

Bases: onegov.org.layout.DefaultLayout

The default layout meant for the public facing parts of the site.

breadcrumbs() list[onegov.core.elements.Link][source]

Returns the breadcrumbs for the current page.

A of onegov.org.elements.LinkGroup classes. Each of them will be shown in the top editbar, with the group title being the dropdown title.

class agency.layout.ExtendedPersonCollectionLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)[source]

Bases: onegov.org.layout.PersonCollectionLayout, AgencyPathMixin

The default layout meant for the public facing parts of the site.

request: onegov.agency.request.AgencyRequest[source]

A of onegov.org.elements.LinkGroup classes. Each of them will be shown in the top editbar, with the group title being the dropdown title.

class agency.layout.ExtendedPersonLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)[source]

Bases: PersonLayout, AgencyPathMixin

The default layout meant for the public facing parts of the site.

request: onegov.agency.request.AgencyRequest[source]
collection() onegov.agency.collections.ExtendedPersonCollection[source]
move_membership_within_person_url_template() str[source]
property default_membership_title: str[source]
class agency.layout.AgencySearchLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)[source]

Bases: onegov.org.layout.DefaultLayout, AgencyPathMixin

The default layout meant for the public facing parts of the site.

request: onegov.agency.request.AgencyRequest[source]