Frame

Definition

The frame property allows to define an optional “frame” around the Screen or the Section.

Frame inside Screen	Frame inside Sections

Configuration

Properties

Property name	Type	Mandatory	Description	Values (default value in bold)
actions	-	NO	Allows to configure one or several actions (like Button Widget or Groovy action rule for example) that will be displayed in the header. If no action is configured, the header will be displayed even if the title property is set to false.	-
collapsible	`Boolean`	NO	Allows to define if the frame is collapsible or not. If the property is set to true, the frame will be folded by clicking on an arrow on the far right of the header.	true, false
display	`String`	NO		PORTLET, NONE
initiallyCollapsed	`Boolean`	NO	Allows to define if the frame will be closed or not when the feature opens. It can be expanded manually.	true, false
title	`Boolean`	NO	Allows to define if a title is displayed on the header. If the display property is set to NONE, a title cannot be displayed. Titles are defined in the following i18n keys: in the Screen: ui.features."id of the feature".frame.title in the Section: ui.features."id of the feature".views."id of the view".sections."id of the section".title	true, false

The accumulation is not necessarily recommended from an aesthetic point of view.

Example

Frame inside Screen

Frame inside Sections

CODE

<screen>
	<views></views>
	<frame>
		<actions></actions>
		<collapsible>true</collapsible>
		<display>PORTLET</display>
		<initiallyCollapsed>false</initiallyCollapsed>
		<title>true</title>
	</frame>
</screen>

CODE

<screen>
	<views>
		<view>
			<sections>
				<section id="test-section-1">
					<layout>SINGLE</layout>
					<frame>
						<actions>
							<action id="user-card-update" xsi:type="ctdbum:ButtonWidgetType">
                           </action>
                           <action id="user-card-read" xsi:type="ctdbum:ButtonWidgetType">
                           </action>
						</actions>
						<collapsible>true</collapsible>
						<display>PORTLET</display>
						<initiallyCollapsed>false</initiallyCollapsed>
						<title>true</title>
					</frame>
					<columns></columns>
				</section>
				<section id="test-section-2">
					<layout>SINGLE</layout>
					<frame>
						<actions/>
						<collapsible>false</collapsible>
						<display>PORTLET</display>
						<initiallyCollapsed>false</initiallyCollapsed>
						<title>false</title>
					</frame>
					<columns></columns>
				</section>
			</sections>
		</view>
	</views>
</screen>

Configuration

Properties

Example

Read next