Skip to content

Commit a378feb

Browse files
authored
Merge pull request mendix#6091 from mendix/ctl-prop-pane-updates
Properties Pane Text and Screenshot Updates
2 parents 8b9734c + 1f4a463 commit a378feb

42 files changed

Lines changed: 751 additions & 631 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

content/en/docs/refguide/modeling/pages/data-widgets/data-view.md

Lines changed: 56 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -10,36 +10,64 @@ tags: ["page", "data view", "widget", "studio pro"]
1010

1111
The data view is a starting point for showing the contents of exactly one object. For example, if you want to show the details of a single program item, you can use a data view to do this:
1212

13-
{{< figure src="/attachments/refguide/modeling/pages/data-widgets/data-view/data-view-example-structure-mode.png" >}}
13+
{{< figure src="/attachments/refguide/modeling/pages/data-widgets/data-view/data-view-example-structure-mode.png" width="350" >}}
1414

1515
In a more complex example, a data view can contain customer information and [tab containers](/refguide/tab-container/) per specific topic (for example, addresses and payment information) with nested data grids for related objects:
1616

17-
{{< figure src="/attachments/refguide/modeling/pages/data-widgets/data-view/data-view-complex-example.png" >}}
17+
{{< figure src="/attachments/refguide/modeling/pages/data-widgets/data-view/data-view-complex-example.png" width="350" >}}
1818

1919
## 2 Data View Footer
2020

2121
The footer of the data view is the section at the bottom of the data view that often contains buttons to confirm or cancel changes.
2222

23-
## 3 Properties
23+
## 3 Properties Pane
2424

25-
An example of data view properties is represented in the image below:
25+
The properties pane is divided into two major sections by a toggle at the top of the pane: **Properties** and **Styling**. Data view properties consist of the following sections:
2626

27-
{{< figure src="/attachments/refguide/modeling/pages/data-widgets/data-view/data-view-properties.png" width="250" >}}
28-
29-
Data view properties consist of the following sections:
30-
31-
* [Common](#common)
27+
Properties:
28+
* [General](#general)
3229
* [Data source](#data-source)
33-
* [Design Properties](#design-properties)
3430
* [Editability](#editability)
35-
* [General](#general)
3631
* [Visibility](#visibility)
32+
* [Common](#common)
3733

38-
### 3.1 Common Section {#common}
34+
Styling:
35+
* [Design Properties](#design-properties)
36+
* [Common](#common-styling)
3937

40-
{{% snippet file="/static/_includes/refguide/common-section-link.md" %}}
38+
## 4 Properties
39+
40+
### 4.1 General Section {#general}
41+
42+
#### 4.1.1 Form Orientation
43+
44+
With this property, you can specify the position of the input widget labels inside the data view. If the orientation is horizontal, the labels will be placed next to the input elements. If the orientation is vertical, the labels will be placed above the input elements.
45+
46+
Note that form groups are responsive and the labels may be placed above input elements, even if the orientation is set to horizontal, depending on the viewport size. Also, note that a data view with a vertical orientation cannot be nested inside a data view with a horizontal orientation. In that case, the form groups will be rendered horizontally, regardless of the value of the orientation property.
47+
48+
Default: *Horizontal*
49+
50+
#### 4.1.2 Label Width (Weight)
51+
52+
If the form orientation is set to horizontal, this property can be used to specify the width of the input widget labels inside the data view. The width is specified using column weights from the [Bootstrap grid system](http://getbootstrap.com/css/#grid). For more details, see [Layout Grid](/refguide/layout-grid/).
53+
54+
Default: *3*
55+
56+
#### 4.1.3 Show Footer
57+
58+
With this property, you can specify whether you want the footer of the data view to be visible. The footer of nested data views is always invisible, regardless of the value of this property.
59+
60+
Default: *True*
61+
62+
#### 4.1.4 Empty Entity Message
63+
64+
If this message is specified, a data view that receives no source data will show this message instead of its content. Otherwise, the data view will show its static content and disabled input elements. This property is a translatable text. For more details, see [Language Menu](/refguide/translatable-texts/).
4165

42-
### 3.2 Data Source Section {#data-source}
66+
There are a number of ways a data view can end up without source data. For instance, a data view with a **Listen to widget** data source will remain empty until an object is selected in the target grid. In this scenario, **Empty entity message** can be used to guide the user to select an item from the grid.
67+
68+
Default: *empty*
69+
70+
### 4.2 Data Source Section {#data-source}
4371

4472
The data source determines which object will be shown in the data view. For more information on data sources, see [Data Sources](/refguide/data-sources/).
4573

@@ -52,13 +80,9 @@ The data view supports the following types of data source: context, microflow, n
5280
| Nanoflow | A data source that runs a selected nanoflow and displays a return value. For more information on the nanoflow source, see [Nanoflow Source](/refguide/nanoflow-source/). |
5381
| Listen to widget | A data source that allows a data view to display detailed information on an object in the list widget on the same page. For more information on listen to widget source, see [Listen To Widget Source](/refguide/microflow-source/). |
5482

55-
### 3.3 Design Properties Section{#design-properties}
83+
### 4.3 Editability Section {#editability}
5684

57-
{{% snippet file="/static/_includes/refguide/design-section-link.md" %}}
58-
59-
### 3.4 Editability Section {#editability}
60-
61-
#### 3.4.1 Editable {#editable}
85+
#### 4.3.1 Editable {#editable}
6286

6387
The editable property indicates whether the data view as a whole is editable or not.
6488

@@ -68,7 +92,7 @@ The editable property indicates whether the data view as a whole is editable or
6892
| Inherited from snippet call | Set to **Yes** or **No** by the containing data container of the snippet call (default value for data views inside a snippet). |
6993
| No | The data view is not editable: no widget inside the data view will be editable.|
7094

71-
#### 3.4.2 Read-Only Style
95+
#### 4.3.2 Read-Only Style
7296

7397
This property determines how input elements are rendered if they are read-only.
7498

@@ -79,49 +103,33 @@ This property determines how input elements are rendered if they are read-only.
79103

80104
{{% alert color="info" %}}Read-only style is not supported on native mobile pages.{{% /alert %}}
81105

82-
### 3.5 General Section {#general}
83-
84-
#### 3.5.1 Form Orientation
85-
86-
With this property, you can specify the position of the input widget labels inside the data view. If the orientation is horizontal, the labels will be placed next to the input elements. If the orientation is vertical, the labels will be placed above the input elements.
87-
88-
Note that form groups are responsive and the labels may be placed above input elements, even if the orientation is set to horizontal, depending on the viewport size. Also, note that a data view with a vertical orientation cannot be nested inside a data view with a horizontal orientation. In that case, the form groups will be rendered horizontally, regardless of the value of the orientation property.
89-
90-
Default: *Horizontal*
91-
92-
#### 3.5.2. Label Width (Weight)
106+
### 4.4 Visibility Section {#visibility}
93107

94-
If the form orientation is set to horizontal, this property can be used to specify the width of the input widget labels inside the data view. The width is specified using column weights from the [Bootstrap grid system](http://getbootstrap.com/css/#grid). For more details, see [Layout Grid](/refguide/layout-grid/).
95-
96-
Default: *3*
97-
98-
#### 3.5.3 Show Footer
99-
100-
With this property, you can specify whether you want the footer of the data view to be visible. The footer of nested data views is always invisible, regardless of the value of this property.
108+
{{% snippet file="/static/_includes/refguide/visibility-section-link.md" %}}
101109

102-
Default: *True*
110+
### 4.5 Common Section {#common}
103111

104-
#### 3.5.4 Empty Entity Message
112+
{{% snippet file="/static/_includes/refguide/common-section-link.md" %}}
105113

106-
If this message is specified, a data view that receives no source data will show this message instead of its content. Otherwise, the data view will show its static content and disabled input elements. This property is a translatable text. For more details, see [Language Menu](/refguide/translatable-texts/).
114+
## 5 Styling
107115

108-
There are a number of ways a data view can end up without source data. For instance, a data view with a **Listen to widget** data source will remain empty until an object is selected in the target grid. In this scenario, **Empty entity message** can be used to guide the user to select an item from the grid.
116+
### 5.1 Design Properties Section {#design-properties}
109117

110-
Default: *empty*
118+
{{% snippet file="/static/_includes/refguide/design-section-link.md" %}}
111119

112-
### 3.6 Visibility Section {#visibility}
120+
### 5.2 Common Section {#common-styling}
113121

114-
{{% snippet file="/static/_includes/refguide/visibility-section-link.md" %}}
122+
{{% snippet file="/static/_includes/refguide/common-section-link.md" %}}
115123

116-
## 4 Performing Specific Actions
124+
## 6 Performing Specific Actions
117125

118126
To perform actions on a data view, select it on a page and right-click it. The list of possible actions opens. While some actions from this list, such as **Select data source**, **Edit condition for visible**, are a quick way to set the properties, the following actions are specific actions that you can perform:
119127

120128
* **Go to entity** – opens a domain model and highlights an an entity that is used as the data source
121129
* **Go to data source** **microflow**– this action is only displayed when a microflow is set as the data source and opens this microflow
122130
* **Go to data source nanoflow** – this action is only displayed when a nanoflow is set as the data source and opens this nanoflow
123131

124-
## 5 Read More
132+
## 7 Read More
125133

126134
* [Page](/refguide/page/)
127135
* [Snippet](/refguide/snippet/)

content/en/docs/refguide/modeling/pages/input-widgets/check-box.md

Lines changed: 40 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -18,74 +18,86 @@ For example, this checkbox allows you to see, and set, whether someone is subscr
1818

1919
{{< figure src="/attachments/refguide/modeling/pages/input-widgets/check-box/check-box.png" >}}
2020

21-
## 2 Properties
21+
## 2 Properties Pane
2222

23-
An example of checkbox properties is represented in the image below:
23+
The properties pane is divided into two major sections by a toggle at the top of the pane: **Properties** and **Styling*. Checkbox properties consist of the following sections:
2424

25-
{{< figure src="/attachments/refguide/modeling/pages/input-widgets/check-box/check-box-properties.png" width="250" >}}
26-
27-
Checkbox properties consist of the following sections:
28-
29-
* [Common](#common)
25+
Properties:
3026
* [Data source](#data-source)
31-
* [Design Properties](#design-properties)
32-
* [Editability](#editability)
33-
* [Events](#events)
34-
* [Formatting](#formatting)
3527
* [Label](#label)
28+
* [Editability](#editability)
3629
* [Visibility](#visibility)
30+
* [Common](#common)
31+
* [Events](#events)
3732

38-
### 2.1 Common Section{#common}
33+
Styling:
34+
* [Design Properties](#design-properties)
35+
* [Common](#common-styling)
3936

40-
{{% snippet file="/static/_includes/refguide/common-section-link.md" %}}
37+
Miscellaneous:
38+
* [Formatting](#formatting)
39+
40+
## 3 Properties
4141

42-
### 2.2 Data Source Section{#data-source}
42+
### 3.1 Data Source Section{#data-source}
4343

4444
{{% snippet file="/static/_includes/refguide/data-source-section-link.md" %}}
4545

46-
### 2.3 Design Properties Section{#design-properties}
46+
### 3.2 Label Section{#label}
4747

48-
{{% snippet file="/static/_includes/refguide/design-section-link.md" %}}
48+
{{% snippet file="/static/_includes/refguide/label-section-link.md" %}}
4949

50-
### 2.4 Editability Section{#editability}
50+
### 3.3 Editability Section{#editability}
5151

5252
{{% snippet file="/static/_includes/refguide/editability-section-link.md" %}}
5353

54-
### 2.5 Events Section{#events}
54+
### 3.4 Visibility Section{#visibility}
55+
56+
{{% snippet file="/static/_includes/refguide/visibility-section-link.md" %}}
57+
58+
### 3.5 Common Section{#common}
5559

56-
#### 2.5.1 On Change{#on-change}
60+
{{% snippet file="/static/_includes/refguide/common-section-link.md" %}}
61+
62+
### 3.6 Events Section{#events}
63+
64+
#### 3.6.1 On Change{#on-change}
5765

5866
The on-change property specifies an action that will be executed when leaving the widget, either by using the <kbd>Tab</kbd> key or by clicking another widget, after the value has been changed.
5967

6068
{{% snippet file="/static/_includes/refguide/events-section-link.md" %}}
6169

62-
#### 2.5.2 On Enter
70+
#### 3.6.2 On Enter
6371

6472
The on-enter property specifies an action that will be executed when the widget is entered, either by using the <kbd>Tab</kbd> key or by clicking it with the mouse.
6573

6674
{{% snippet file="/static/_includes/refguide/events-section-link.md" %}}
6775

68-
#### 2.5.3 On Leave
76+
#### 3.6.3 On Leave
6977

7078
The on-leave property specifies an action that will be executed when leaving the widget, either by using the <kbd>Tab</kbd> key or by clicking another widget.
7179

7280
This differs from the [On change](#on-change) property in that the event will always be triggered, even if the value has not been changed.
7381

7482
{{% snippet file="/static/_includes/refguide/events-section-link.md" %}}
7583

76-
### 2.6 Formatting Section{#formatting}
84+
## 4 Styling
7785

78-
The render mode property determines whether the widget renders as a switch or a checkbox.
86+
### 4.1 Design Properties Section{#design-properties}
7987

80-
### 2.7 Label Section{#label}
88+
{{% snippet file="/static/_includes/refguide/design-section-link.md" %}}
8189

82-
{{% snippet file="/static/_includes/refguide/label-section-link.md" %}}
90+
### 4.2 Common Section{#common-styling}
8391

84-
### 2.8 Visibility Section{#visibility}
92+
{{% snippet file="/static/_includes/refguide/common-section-link.md" %}}
8593

86-
{{% snippet file="/static/_includes/refguide/visibility-section-link.md" %}}
94+
## 5 Miscellaneous
95+
96+
### 5.1 Formatting Section{#formatting}
97+
98+
The render mode property determines whether the widget renders as a switch or a checkbox.
8799

88-
## 3 Read More
100+
## 6 Read More
89101

90102
* [Data View](/refguide/data-view/)
91103
* [Attributes](/refguide/attributes/)

0 commit comments

Comments
 (0)