PropertiesPage¶
-
/libs/granite/ui/components/shell/propertiespage Properties page is a page showing the properties of a resource.
It also supports resource filtering using FilteringResourceWrapper and acts as its container.
It has the following content structure:
- granite:ShellPropertiesPage
- consoleIdstringel
A general purpose ID to uniquely identify the console.
The recommended value is hierarchical separated by “-“. e.g. “cq-commerce-report”
- jcr:titlestring
The base title of the page.
e.g. “AEM Sites”
- backHrefstringel
The URL to navigate to when closing this page, e.g., when the user presses “Close”.
- formIdstring
The id of the form component.
The intention of propertiespage is to standardize the property screen, including the behaviour of form success handler whether the page is reloaded or redirected or otherwise. Thus, it is RECOMMENDED that the form is a foundation-form without any success handler configured. propertiespage will manage the form success handler behaviour internally.
-
simpleSaveboolean
- true
When
formIdis specified,trueto indicate if a simple “Save” button is rendered,falseto render a more complex form actions (currently “Save & Close” and “Save”).Note that this flag is only temporary for compatibility, since the intention is to standardize the UX as the behaviour when the value is
false.
- redirector
To redirect the page, this resource can be specified. It will be included, where the redirect can be performed.
- head
A folder to specify the content of
<head>of the page. Its child resources are iterated and included as is.
- title
The component to render the title.
This is optional, and if not specified, the value of
jcr:titleis used. If the title is just a simple string, Title can be used.The only requirement of the component is to generate a simple text without any wrapping markup. E.g. To have a title of “My Page”, just make the component do something like
out.print("My Page").
- header
The header area just above the properties view. Any component can be used here.
- editcondition
The render condition component to check if the form is editable by the current session.
By default the form is assumed to be editable, even though the form submission may fail and handled accordingly.
- content
The component to render the properties view (the content area).
- footer
The footer area just below the properties view. Any component can be used here.
- actions
The folder for the actions applicable in the context of the properties page.
The action can be any action component such as Button, AnchorButton, Pulldown,
The
actionBarvariant of the components above SHOULD be used, unlessprimaryvariant is used.
- rails
A folder to specify the panels of the rail.
Its child resources are considered as the panels, where each MUST be a RailPanel (or its derivative).
By default the rail is closed. To make it always open,
alwaysActiveboolean property can be specified. One of the railpanel then must be configured to be active.
Example:
+ mypage - sling:resourceType = "granite/ui/components/shell/propertiespage" - jcr:title = "My Properties" - formId = "myFormId" - backHref = '${empty header.Referer ? granite:concat("/mycollection.html", granite:encodeURIPath(granite:relativeParent(param.item, 1))) : header.Referer}' + content - sling:resourceType = "granite/ui/components/coral/foundation/form" - granite:id = "myFormId" + rails - alwaysActive = true + panel1 - sling:resourceType = "granite/ui/components/coral/foundation/panel/railpanel" - jcr:title = "Panel 1" - active = true + panel2 - sling:resourceType = "granite/ui/components/coral/foundation/panel/railpanel" - jcr:title = "Panel 2"