agency.layout
=============

.. py:module:: agency.layout


Classes
-------

.. autoapisummary::

   agency.layout.PageLayout
   agency.layout.PersonLayout
   agency.layout.MoveAgencyMixin
   agency.layout.NavTreeMixin
   agency.layout.AgencyCollectionLayout
   agency.layout.AgencyLayout
   agency.layout.AgencyPathMixin
   agency.layout.MembershipLayout
   agency.layout.ExtendedPersonCollectionLayout
   agency.layout.ExtendedPersonLayout
   agency.layout.AgencySearchLayout


Module Contents
---------------

.. py:class:: PageLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)

   Bases: :py:obj:`onegov.org.layout.PageLayout`


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


   .. py:property:: sidebar_links
      :type: None


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



.. py:class:: PersonLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)

   Bases: :py:obj:`onegov.org.layout.PersonLayout`


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


   .. py:property:: editbar_links
      :type: list[onegov.core.elements.Link | onegov.core.elements.LinkGroup] | None


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



.. py:class:: MoveAgencyMixin

   .. py:attribute:: request
      :type:  onegov.agency.request.AgencyRequest


   .. py:property:: move_agency_url_template
      :type: str



.. py:class:: NavTreeMixin

   .. py:attribute:: model
      :type:  Any


   .. py:method:: nav_item_url(agency: onegov.agency.models.ExtendedAgency) -> str


   .. py:property:: browsed_agency
      :type: onegov.agency.models.ExtendedAgency | None



   .. py:property:: browsed_agency_parents
      :type: list[int]



   .. py:method:: prerender_content(agency_id: int | str) -> bool


.. py:class:: AgencyCollectionLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)

   Bases: :py:obj:`onegov.org.layout.DefaultLayout`, :py:obj:`MoveAgencyMixin`, :py:obj:`NavTreeMixin`


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


   .. py:attribute:: request
      :type:  onegov.agency.request.AgencyRequest


   .. py:property:: breadcrumbs
      :type: list[onegov.core.elements.Link]


      Returns the breadcrumbs for the current page. 



   .. py:property:: editbar_links
      :type: list[onegov.core.elements.Link | onegov.core.elements.LinkGroup] | None


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



.. py:class:: AgencyLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)

   Bases: :py:obj:`onegov.org.layout.AdjacencyListLayout`, :py:obj:`MoveAgencyMixin`


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


   .. py:attribute:: request
      :type:  onegov.agency.request.AgencyRequest


   .. py:method:: include_editor() -> None


   .. py:property:: collection
      :type: onegov.agency.collections.ExtendedAgencyCollection



   .. py:property:: breadcrumbs
      :type: list[onegov.core.elements.Link]


      Returns the breadcrumbs for the current page. 



   .. py:property:: editbar_links
      :type: list[onegov.core.elements.Link | onegov.core.elements.LinkGroup] | None


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



   .. py:property:: move_membership_within_agency_url_template
      :type: str



.. py:class:: AgencyPathMixin

   .. py:attribute:: request
      :type:  onegov.agency.request.AgencyRequest


   .. py:method:: get_ancestors(item: onegov.agency.models.ExtendedAgency, with_item: bool = True, levels: collections.abc.Collection[int] | None = None) -> collections.abc.Iterator[onegov.core.elements.Link]


   .. py:method:: parent_path(agency: onegov.agency.models.ExtendedAgency) -> str


   .. py:method:: agency_path(agency: onegov.agency.models.ExtendedAgency) -> str


.. py:class:: MembershipLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)

   Bases: :py:obj:`onegov.org.layout.DefaultLayout`


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


   .. py:property:: breadcrumbs
      :type: list[onegov.core.elements.Link]


      Returns the breadcrumbs for the current page. 



   .. py:property:: editbar_links
      :type: list[onegov.core.elements.Link | onegov.core.elements.LinkGroup] | None


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



.. py:class:: ExtendedPersonCollectionLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)

   Bases: :py:obj:`onegov.org.layout.PersonCollectionLayout`, :py:obj:`AgencyPathMixin`


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


   .. py:attribute:: request
      :type:  onegov.agency.request.AgencyRequest


   .. py:property:: editbar_links
      :type: list[onegov.core.elements.Link | onegov.core.elements.LinkGroup] | None


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



.. py:class:: ExtendedPersonLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)

   Bases: :py:obj:`PersonLayout`, :py:obj:`AgencyPathMixin`


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


   .. py:attribute:: request
      :type:  onegov.agency.request.AgencyRequest


   .. py:property:: collection
      :type: onegov.agency.collections.ExtendedPersonCollection



   .. py:property:: move_membership_within_person_url_template
      :type: str



   .. py:property:: default_membership_title
      :type: str



.. py:class:: AgencySearchLayout(model: Any, request: onegov.org.request.OrgRequest, edit_mode: bool = False)

   Bases: :py:obj:`onegov.org.layout.DefaultLayout`, :py:obj:`AgencyPathMixin`


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


   .. py:attribute:: request
      :type:  onegov.agency.request.AgencyRequest