org.layout

Module Contents

Classes

Layout	Contains methods to render a page inheriting from layout.pt.
DefaultLayoutMixin
DefaultLayout	The default layout meant for the public facing parts of the site.
DefaultMailLayoutMixin
DefaultMailLayout	A special layout for creating HTML E-Mails.
AdjacencyListMixin	Provides layouts for models inheriting from
AdjacencyListLayout	The default layout meant for the public facing parts of the site.
SettingsLayout	The default layout meant for the public facing parts of the site.
PageLayout	The default layout meant for the public facing parts of the site.
NewsLayout	The default layout meant for the public facing parts of the site.
EditorLayout	The default layout meant for the public facing parts of the site.
FormEditorLayout	The default layout meant for the public facing parts of the site.
FormSubmissionLayout	The default layout meant for the public facing parts of the site.
FormCollectionLayout	The default layout meant for the public facing parts of the site.
PersonCollectionLayout	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.
TicketsLayout	The default layout meant for the public facing parts of the site.
ArchivedTicketsLayout	The default layout meant for the public facing parts of the site.
TicketLayout	The default layout meant for the public facing parts of the site.
TicketNoteLayout	The default layout meant for the public facing parts of the site.
TicketChatMessageLayout	The default layout meant for the public facing parts of the site.
TextModulesLayout	The default layout meant for the public facing parts of the site.
TextModuleLayout	The default layout meant for the public facing parts of the site.
ResourcesLayout	The default layout meant for the public facing parts of the site.
FindYourSpotLayout	The default layout meant for the public facing parts of the site.
ResourceRecipientsLayout	The default layout meant for the public facing parts of the site.
ResourceRecipientsFormLayout	The default layout meant for the public facing parts of the site.
ResourceLayout	The default layout meant for the public facing parts of the site.
ReservationLayout	The default layout meant for the public facing parts of the site.
AllocationRulesLayout	The default layout meant for the public facing parts of the site.
AllocationEditFormLayout	Same as the resource layout, but with different editbar links, because
EventLayoutMixin
OccurrencesLayout	The default layout meant for the public facing parts of the site.
OccurrenceLayout	The default layout meant for the public facing parts of the site.
EventLayout	The default layout meant for the public facing parts of the site.
NewsletterLayout	The default layout meant for the public facing parts of the site.
RecipientLayout	The default layout meant for the public facing parts of the site.
ImageSetCollectionLayout	The default layout meant for the public facing parts of the site.
ImageSetLayout	The default layout meant for the public facing parts of the site.
UserManagementLayout	The default layout meant for the public facing parts of the site.
UserLayout	The default layout meant for the public facing parts of the site.
UserGroupCollectionLayout	The default layout meant for the public facing parts of the site.
UserGroupLayout	The default layout meant for the public facing parts of the site.
ExportCollectionLayout	The default layout meant for the public facing parts of the site.
PaymentProviderLayout	The default layout meant for the public facing parts of the site.
PaymentCollectionLayout	The default layout meant for the public facing parts of the site.
MessageCollectionLayout	The default layout meant for the public facing parts of the site.
DirectoryCollectionLayout	The default layout meant for the public facing parts of the site.
DirectoryEntryMixin
DirectoryEntryCollectionLayout	The default layout meant for the public facing parts of the site.
DirectoryEntryLayout	The default layout meant for the public facing parts of the site.
PublicationLayout	The default layout meant for the public facing parts of the site.
DashboardLayout	The default layout meant for the public facing parts of the site.
GeneralFileCollectionLayout	The default layout meant for the public facing parts of the site.
ImageFileCollectionLayout	The default layout meant for the public facing parts of the site.
ExternalLinkLayout	The default layout meant for the public facing parts of the site.
HomepageLayout	The default layout meant for the public facing parts of the site.

Attributes

_T
capitalised_name

org.layout._T

org.layout.capitalised_name

class org.layout.Layout(model: Any, request: onegov.core.request.CoreRequest)

Bases: onegov.core.layout.ChameleonLayout, onegov.org.open_graph.OpenGraphMixin

Contains methods to render a page inheriting from layout.pt.

All pages inheriting from layout.pt rely on this class being present as ‘layout’ variable:

@OrgApp.html(model=Example, template='example.pt', permission=Public)
   def view_example(self, request):
       return { 'layout': DefaultLayout(self, request) }

It is meant to be extended for different parts of the site. For example, the DefaultLayout includes the top navigation defined by onegov.page.

It’s possible though to have a different part of the website use a completely different top navigation. For that, a new Layout class inheriting from this one should be added.

property name: str

Takes the class name of the layout and generates a name which can be used as a class.

property org: onegov.org.models.Organisation

An alias for self.request.app.org.

property primary_color: str

property custom_links: list[tuple[str, str]]

property file_link_target: str | None

Use with tal:attributes=’target layout.file_link_target’

app: onegov.org.app.OrgApp

request: onegov.org.request.OrgRequest

date_long_without_year_format = 'E d. MMMM'

datetime_long_without_year_format = 'E d. MMMM HH:mm'

datetime_short_format = 'E d.MM.Y HH:mm'

event_format = 'EEEE, d. MMMM YYYY'

event_short_format = 'EE d. MMMM YYYY'

isodate_format = 'y-M-d'

Markup

file_extension_fa_icon_mapping

has_model_permission(permission: type[onegov.core.security.permissions.Intent] | None) → bool

favicon_apple_touch_url() → str | None

favicon_pinned_tab_safari_url() → str | None

favicon_win_url() → str | None

favicon_mac_url() → str | None

default_map_view() → dict[str, Any]

svg() → chameleon.PageTemplateFile

font_awesome_path() → str

sentry_init_path() → str

static_file_path(path: str) → str

with_hashtags(text: str | None) → str | None

page_id() → str

Returns the unique page id of the rendered page. Used to have a useful id in the body element for CSS/JS.

body_classes() → Iterator[str]

Yields a list of body classes used on the body.

top_navigation() → Sequence[Link] | None

Returns a list of onegov.org.elements.Link objects. Those links are used for the top navigation.

If nothing is returned, no top navigation is displayed.

breadcrumbs() → Sequence[Link] | None

Returns a list of onegov.org.elements.Link objects. Those links are used for the breadcrumbs.

If nothing is returned, no top breadcrumbs are displayed.

sidebar_links() → Sequence[Link | LinkGroup] | None

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

editbar_links() → Sequence[Link | LinkGroup] | None

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.

locales() → list[tuple[str, str]]

file_upload_url() → str

Returns the url to the file upload action.

file_upload_json_url() → str

Adds the json url for file uploads.

file_list_url() → str

Adds the json url for file lists.

image_upload_url() → str

Returns the url to the image upload action.

image_upload_json_url() → str

Adds the json url for image uploads.

image_list_url() → str

Adds the json url for image lists.

sitecollection_url() → str

Adds the json url for internal links lists.

homepage_url() → str

Returns the url to the main page.

search_url() → str

Returns the url to the search page.

suggestions_url() → str

Returns the url to the suggestions json view.

events_url() → str

directories_url() → str

news_url() → str

newsletter_url() → str

login_to_url(to: str | None, skip: bool = False) → str

login_from_path() → str

export_formatter(format: str) → Callable[[object], Any]

Returns a formatter function which takes a value and returns the value ready for export.

thumbnail_url(url: str | None) → str | None

Takes the given url and returns the thumbnail url for it.

Uses some rough heuristic to determine if a url is actually served by onegov.file or not. May possibly fail.

include_editor() → None

include_code_editor() → None

file_data_download_link(file_data: dict[str, Any] | None) → str | None

file_data_file(file_data: dict[str, Any] | None) → onegov.file.File | None

field_download_link(field: wtforms.Field) → list[str | None] | str | None

field_file(field: wtforms.Field) → list[onegov.file.File | None] | onegov.file.File | None

move_person_url_template() → str

get_user_color(username: str) → str

get_user_title(username: str) → str

to_timezone(date: datetime.datetime, timezone: sedate.types.TzInfoOrName) → datetime.datetime

format_time_range(start: datetime.datetime | datetime.time, end: datetime.datetime | datetime.time) → str

format_date_range(start: datetime.date | datetime.datetime, end: datetime.date | datetime.datetime) → str

format_datetime_range(start: datetime.datetime, end: datetime.datetime, with_year: bool = False) → str

format_timedelta(delta: datetime.timedelta) → str

format_seconds(seconds: float) → str

password_reset_url(user: User | None) → str | None

linkify(text: None) → None

linkify(text: str) → str

linkify_field(field: wtforms.Field, rendered: markupsafe.Markup) → markupsafe.Markup

get_fa_file_icon(filename: str) → str

Returns the font awesome file icon name for the given file according its extension.

NOTE: Currently, org and town6 are using different font awesome versions, hence this only works for town6.

class org.layout.DefaultLayoutMixin

hide_from_robots() → None

Returns a X-Robots-Tag:noindex header on secret pages.

This is probably not where you would expect this to happen, but it ensures that this works on all pages without having to jump through hoops.

class org.layout.DefaultLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: Layout, DefaultLayoutMixin

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

request: onegov.org.request.OrgRequest

show_label(field: wtforms.Field) → bool

breadcrumbs() → Sequence[Link] | None

Returns the breadcrumbs for the current page.

exclude_invisible(items: Iterable[_T]) → Sequence[_T]

root_pages() → Sequence[Page]

top_navigation() → Sequence[Link] | None

Returns a list of onegov.org.elements.Link objects. Those links are used for the top navigation.

If nothing is returned, no top navigation is displayed.

qr_endpoint() → str

class org.layout.DefaultMailLayoutMixin

unsubscribe_link(username: str) → str

paragraphify(text: str) → str

class org.layout.DefaultMailLayout(model: Any, request: onegov.core.request.CoreRequest)

Bases: Layout, DefaultMailLayoutMixin

A special layout for creating HTML E-Mails.

base() → chameleon.PageTemplateFile

Returns the layout, which defines the base layout of all pages.

See templates/layout.pt.

macros() → onegov.core.templates.MacrosLookup

Returns the macros, which offer often used html constructs. See templates/macros.pt.

contact_html() → str

Returns the contacts html, but instead of breaking it into multiple lines (like on the site footer), this version puts it all on one line.

class org.layout.AdjacencyListMixin

Provides layouts for models inheriting from onegov.core.orm.abstract.AdjacencyList

sortable_url_template() → str

get_breadcrumbs(item: onegov.core.orm.abstract.AdjacencyList) → Iterator[Link]

Yields the breadcrumbs for the given adjacency list item.

get_sidebar(type: str | None = None) → Iterator[Link | LinkGroup]

Yields the sidebar for the given adjacency list item.

class org.layout.AdjacencyListLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout, AdjacencyListMixin

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

request: onegov.org.request.OrgRequest

class org.layout.SettingsLayout(model: Any, request: onegov.org.request.OrgRequest, setting: str | None = None)

Bases: DefaultLayout

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

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

Returns the breadcrumbs for the current page.

class org.layout.PageLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: AdjacencyListLayout

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

og_image_source() → str | None

breadcrumbs() → Sequence[Link]

Returns the breadcrumbs for the current page.

sidebar_links() → Sequence[Link | LinkGroup]

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

class org.layout.NewsLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: AdjacencyListLayout

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

og_image_source() → str | None

breadcrumbs() → Sequence[Link]

Returns the breadcrumbs for the current page.

class org.layout.EditorLayout(model: onegov.org.models.Editor, request: onegov.org.request.OrgRequest, site_title: str | None)

Bases: AdjacencyListLayout

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

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

Returns the breadcrumbs for the current page.

class org.layout.FormEditorLayout(model: FormDefinition | FormCollection, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

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

model: FormDefinition | FormCollection

class org.layout.FormSubmissionLayout(model: FormSubmission | FormDefinition, request: onegov.org.request.OrgRequest, title: str | None = None)

Bases: DefaultLayout

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

model: FormSubmission | FormDefinition

form() → onegov.form.FormDefinition

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

Returns the breadcrumbs for the current page.

can_delete_form() → bool

editbar_links() → list[onegov.core.elements.Link | onegov.core.elements.LinkGroup] | None

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 org.layout.FormCollectionLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

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

property external_forms: onegov.org.models.external_link.ExternalLinkCollection

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

Returns the breadcrumbs for the current page.

editbar_links() → list[onegov.core.elements.Link | onegov.core.elements.LinkGroup] | None

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 org.layout.PersonCollectionLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

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

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

Returns the breadcrumbs for the current page.

editbar_links() → list[onegov.core.elements.Link | onegov.core.elements.LinkGroup] | None

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 org.layout.PersonLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

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

collection() → onegov.people.PersonCollection

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

Returns the breadcrumbs for the current page.

editbar_links() → list[onegov.core.elements.Link | onegov.core.elements.LinkGroup] | None

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 org.layout.TicketsLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

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

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

Returns the breadcrumbs for the current page.

class org.layout.ArchivedTicketsLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

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

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

Returns the breadcrumbs for the current page.

editbar_links() → list[onegov.core.elements.Link | onegov.core.elements.LinkGroup]

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 org.layout.TicketLayout(model: onegov.ticket.Ticket, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

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

model: onegov.ticket.Ticket

collection() → onegov.ticket.TicketCollection

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

Returns the breadcrumbs for the current page.

editbar_links() → list[onegov.core.elements.Link | onegov.core.elements.LinkGroup] | None

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.

has_submission_files() → bool

class org.layout.TicketNoteLayout(model: onegov.ticket.Ticket, request: onegov.org.request.OrgRequest, title: str, ticket: None = None)

class org.layout.TicketNoteLayout(model: Any, request: onegov.org.request.OrgRequest, title: str, ticket: onegov.ticket.Ticket)

Bases: DefaultLayout

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

ticket: onegov.ticket.Ticket

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

Returns the breadcrumbs for the current page.

class org.layout.TicketChatMessageLayout(model: onegov.ticket.Ticket, request: onegov.org.request.OrgRequest, internal: bool = False)

Bases: DefaultLayout

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

property internal_breadcrumbs: list[onegov.core.elements.Link]

property public_breadcrumbs: list[onegov.core.elements.Link]

model: onegov.ticket.Ticket

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

Returns the breadcrumbs for the current page.

class org.layout.TextModulesLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

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

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

Returns the breadcrumbs for the current page.

editbar_links() → list[onegov.core.elements.Link | onegov.core.elements.LinkGroup] | None

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 org.layout.TextModuleLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

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

collection() → onegov.chat.TextModuleCollection

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

Returns the breadcrumbs for the current page.

editbar_links() → list[onegov.core.elements.Link | onegov.core.elements.LinkGroup] | None

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 org.layout.ResourcesLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

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

property external_resources: onegov.org.models.external_link.ExternalLinkCollection

property resources_url: str

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

Returns the breadcrumbs for the current page.

editbar_links() → list[onegov.core.elements.Link | onegov.core.elements.LinkGroup] | None

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 org.layout.FindYourSpotLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

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

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

Returns the breadcrumbs for the current page.

class org.layout.ResourceRecipientsLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

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

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

Returns the breadcrumbs for the current page.

editbar_links() → list[onegov.core.elements.Link | onegov.core.elements.LinkGroup] | None

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 org.layout.ResourceRecipientsFormLayout(model: Any, request: onegov.org.request.OrgRequest, title: str)

Bases: DefaultLayout

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

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

Returns the breadcrumbs for the current page.

class org.layout.ResourceLayout(model: onegov.reservation.Resource, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

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

model: onegov.reservation.Resource

collection() → onegov.reservation.ResourceCollection

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

Returns the breadcrumbs for the current page.

editbar_links() → list[onegov.core.elements.Link | onegov.core.elements.LinkGroup] | None

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 org.layout.ReservationLayout(model: onegov.reservation.Resource, request: onegov.org.request.OrgRequest)

Bases: ResourceLayout

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

editbar_links

class org.layout.AllocationRulesLayout(model: onegov.reservation.Resource, request: onegov.org.request.OrgRequest)

Bases: ResourceLayout

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

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

Returns the breadcrumbs for the current page.

editbar_links() → list[onegov.core.elements.Link | onegov.core.elements.LinkGroup]

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 org.layout.AllocationEditFormLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

Same as the resource layout, but with different editbar links, because there’s not really an allocation view, but there are allocation forms.

collection() → onegov.reservation.ResourceCollection

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

Returns the breadcrumbs for the current page.

editbar_links() → list[onegov.core.elements.Link | onegov.core.elements.LinkGroup]

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 org.layout.EventLayoutMixin

request: onegov.org.request.OrgRequest

format_recurrence(recurrence: str | None) → str

Returns a human readable version of an RRULE used by us.

event_deletable(event: onegov.event.Event) → bool

class org.layout.OccurrencesLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout, EventLayoutMixin

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

property og_description: str

app: onegov.org.app.OrgApp

request: onegov.org.request.OrgRequest

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

Returns the breadcrumbs for the current page.

editbar_links() → list[onegov.core.elements.Link | onegov.core.elements.LinkGroup]

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 org.layout.OccurrenceLayout(model: onegov.event.Occurrence, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout, EventLayoutMixin

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

property og_description: str | None

app: onegov.org.app.OrgApp

request: onegov.org.request.OrgRequest

model: onegov.event.Occurrence

collection() → onegov.event.OccurrenceCollection

og_image() → onegov.file.File | None

File object to use for the site image.

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

Returns the breadcrumbs for the current page.

editbar_links() → list[onegov.core.elements.Link | onegov.core.elements.LinkGroup] | None

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 org.layout.EventLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: EventLayoutMixin, DefaultLayout

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

app: onegov.org.app.OrgApp

request: onegov.org.request.OrgRequest

model: onegov.event.Event

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

Returns the breadcrumbs for the current page.

editbar_links() → list[onegov.core.elements.Link | onegov.core.elements.LinkGroup] | None

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 org.layout.NewsletterLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

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

collection() → onegov.newsletter.NewsletterCollection

recipients() → onegov.newsletter.RecipientCollection

is_collection() → bool

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

Returns the breadcrumbs for the current page.

editbar_links() → list[onegov.core.elements.Link | onegov.core.elements.LinkGroup] | None

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 org.layout.RecipientLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

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

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

Returns the breadcrumbs for the current page.

editbar_links() → list[onegov.core.elements.Link | onegov.core.elements.LinkGroup] | None

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 org.layout.ImageSetCollectionLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

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

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

Returns the breadcrumbs for the current page.

editbar_links() → list[onegov.core.elements.Link | onegov.core.elements.LinkGroup] | None

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 org.layout.ImageSetLayout(model: onegov.org.models.ImageSet, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

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

property collection: onegov.org.models.ImageSetCollection

model: onegov.org.models.ImageSet

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

Returns the breadcrumbs for the current page.

editbar_links() → list[onegov.core.elements.Link | onegov.core.elements.LinkGroup] | None

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 org.layout.UserManagementLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

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

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

Returns the breadcrumbs for the current page.

editbar_links() → list[onegov.core.elements.Link | onegov.core.elements.LinkGroup]

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 org.layout.UserLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

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

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

Returns the breadcrumbs for the current page.

editbar_links() → list[onegov.core.elements.Link | onegov.core.elements.LinkGroup] | None

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 org.layout.UserGroupCollectionLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

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

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

Returns the breadcrumbs for the current page.

editbar_links() → list[onegov.core.elements.Link | onegov.core.elements.LinkGroup] | None

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 org.layout.UserGroupLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

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

collection() → onegov.user.UserGroupCollection[onegov.user.UserGroup]

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

Returns the breadcrumbs for the current page.

editbar_links() → list[onegov.core.elements.Link | onegov.core.elements.LinkGroup] | None

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 org.layout.ExportCollectionLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

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

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

Returns the breadcrumbs for the current page.

class org.layout.PaymentProviderLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

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

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

Returns the breadcrumbs for the current page.

editbar_links() → list[onegov.core.elements.Link | onegov.core.elements.LinkGroup] | None

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 org.layout.PaymentCollectionLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

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

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

Returns the breadcrumbs for the current page.

editbar_links() → list[onegov.core.elements.Link | onegov.core.elements.LinkGroup]

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 org.layout.MessageCollectionLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

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

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

Returns the breadcrumbs for the current page.

class org.layout.DirectoryCollectionLayout(model: DirectoryCollection[Any] | DirectoryEntryCollection[Any], request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

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

property og_description: str

model: DirectoryCollection[Any] | DirectoryEntryCollection[Any]

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

Returns the breadcrumbs for the current page.

editbar_links() → list[onegov.core.elements.Link | onegov.core.elements.LinkGroup] | None

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 org.layout.DirectoryEntryMixin

property directory: onegov.org.models.ExtendedDirectory

request: onegov.org.request.OrgRequest

model: ExtendedDirectoryEntry | ExtendedDirectoryEntryCollection

custom_body_attributes: dict[str, Any]

init_markers() → None

thumbnail_field_id() → str | None

thumbnail_file_id(entry: onegov.org.models.ExtendedDirectoryEntry) → str | None

thumbnail_link(entry: onegov.org.models.ExtendedDirectoryEntry) → str | None

thumbnail_file(entry: onegov.org.models.ExtendedDirectoryEntry) → onegov.file.File | None

class org.layout.DirectoryEntryCollectionLayout(model: onegov.org.models.directory.ExtendedDirectoryEntryCollection, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout, DirectoryEntryMixin

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

property publication_filters: dict[str, str]

property publication_filter_title: str

property publication_links: Iterator[Link]

request: onegov.org.request.OrgRequest

model: onegov.org.models.directory.ExtendedDirectoryEntryCollection

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

Returns the breadcrumbs for the current page.

editbar_links() → list[onegov.core.elements.Link | onegov.core.elements.LinkGroup]

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.

get_pub_link(text: str, filter: str | None = None, toggle_active: bool = True) → onegov.core.elements.Link

class org.layout.DirectoryEntryLayout(model: onegov.org.models.ExtendedDirectoryEntry, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout, DirectoryEntryMixin

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

property og_description: str | None

property thumbnail_field_ids: list[str]

request: onegov.org.request.OrgRequest

model: onegov.org.models.ExtendedDirectoryEntry

show_label(field: wtforms.Field) → bool

og_image() → onegov.file.File | None

File object to use for the site image.

field_download_link(field: wtforms.Field) → list[str | None] | str | None

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

Returns the breadcrumbs for the current page.

linkify(text: None) → None

linkify(text: str) → str

editbar_links() → list[onegov.core.elements.Link | onegov.core.elements.LinkGroup] | None

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 org.layout.PublicationLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

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

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

Returns the breadcrumbs for the current page.

class org.layout.DashboardLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

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

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

Returns the breadcrumbs for the current page.

class org.layout.GeneralFileCollectionLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

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

class org.layout.ImageFileCollectionLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

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

class org.layout.ExternalLinkLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

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

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

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 org.layout.HomepageLayout(model: Any, request: onegov.org.request.OrgRequest)

Bases: DefaultLayout

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

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

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.

sortable_url_template() → str