Added ME and ET, additional cleanup

This commit is contained in:
Nathan Byrd 2022-01-26 17:22:13 -06:00
parent 742418daeb
commit 19a708c248
7 changed files with 95 additions and 15 deletions

View File

@ -23,8 +23,8 @@ A button view supports displaying a button on a screen.
| `submit` | If set to `true` any `accept` action upon this view will submit the encompassing **form** | | `submit` | If set to `true` any `accept` action upon this view will submit the encompassing **form** |
| `argName` | Sets the argument name for this selection in the form | | `argName` | Sets the argument name for this selection in the form |
| `justify` | Sets the justification of each item in the list. Options: left (default), right, center | | `justify` | Sets the justification of each item in the list. Options: left (default), right, center |
| `fillChar` | Specifies a character to fill extra space in the menu with. Defaults to an empty space | | `fillChar` | Specifies a character to fill extra space longer than the text length. Defaults to an empty space |
| `textOverflow` | If a single column cannot be displayed due to `width`, set overflow characters. See **Text Overflow** below | | `textOverflow` | If the button text cannot be displayed due to `width`, set overflow characters. See **Text Overflow** below |
### Text Overflow ### Text Overflow

View File

@ -0,0 +1,41 @@
---
layout: page
title: Edit Text View
---
## Edit Text View
An edit text view supports editing form values on a screen. This can be for new entry as well as editing existing values defined by the module.
## General Information
:information_source: An edit text view is defined with a percent (%) and the characters ET, followed by the view number. For example: `%ET1`. This is generally used on a form in order to allow a user to enter or edit a text value.
:information_source: See [Art](../general.md) for general information on how to use views and common configuration properties available for them.
### Properties
| Property | Description |
|-------------|--------------|
| `textStyle` | Sets the standard (non-focus) text style. See **Text Styles** in [Art](../general.md) |
| `width` | Sets the width of a view for the text edit (default 15)|
| `argName` | Sets the argument name for this value in the form |
| `maxLength` | Sets the maximum number of characters that can be entered |
| `focus` | Set to true to capture initial focus |
| `justify` | Sets the justification of the text entry. Options: left (default), right, center |
| `fillChar` | Specifies a character to fill extra space in the text entry with. Defaults to an empty space |
## Example
![Example](../../assets/images/edit_text_view_example1.png "Text label")
<details>
<summary>Configuration fragment (expand to view)</summary>
<div markdown="1">
```
ET1: {
maxLength: @config:users.usernameMax
argName: username
focus: true
}
```
</div>
</details>

View File

@ -0,0 +1,40 @@
---
layout: page
title: Mask Edit Text View
---
## Mask Edit Text View
A mask edit text view supports editing form values on a screen. This can be for new entry as well as editing existing values defined by the module. Unlike a edit text view, the mask edit text view does not show the current value until the field is focused.
## General Information
:information_source: A mask edit text view is defined with a percent (%) and the characters ME, followed by the view number. For example: `%ME1`. This is generally used on a form in order to allow a user to enter or edit a text value.
:information_source: See [Art](../general.md) for general information on how to use views and common configuration properties available for them.
### Properties
| Property | Description |
|-------------|--------------|
| `textStyle` | Sets the standard (non-focus) text style. See **Text Styles** in [Art](../general.md) |
| `width` | Sets the width of a view for the text edit (default 15)|
| `argName` | Sets the argument name for this value in the form |
| `maxLength` | Sets the maximum number of characters that can be entered |
| `focus` | Set to true to capture initial focus |
| `justify` | Sets the justification of the text entry. Options: left (default), right, center |
| `fillChar` | Specifies a character to fill extra space in the text entry with. Defaults to an empty space |
## Example
![Example](../../assets/images/mask_edit_text_view_example1.gif "Masked Text Edit View")
<details>
<summary>Configuration fragment (expand to view)</summary>
<div markdown="1">
```
ME1: {
maxLength: @config:users.webMax
argName: web
}
```
</div>
</details>

View File

@ -1,8 +1,8 @@
--- ---
layout: page layout: page
title: Full Menu View title: Predefined Label View
--- ---
## Full Menu View ## Predefined Label View
A predefined label view supports displaying a predefined MCI label on a screen. A predefined label view supports displaying a predefined MCI label on a screen.
## General Information ## General Information
@ -18,10 +18,10 @@ A predefined label view supports displaying a predefined MCI label on a screen.
| Property | Description | | Property | Description |
|-------------|--------------| |-------------|--------------|
| `textStyle` | Sets the standard (non-focus) text style. See **Text Styles** in [Art](../general.md) | | `textStyle` | Sets the standard (non-focus) text style. See **Text Styles** in [Art](../general.md) |
| `justify` | Sets the justification of each item in the list. Options: left (default), right, center | | `justify` | Sets the justification of the MCI value text. Options: left (default), right, center |
| `fillChar` | Specifies a character to fill extra space in the menu with. Defaults to an empty space | | `fillChar` | Specifies a character to fill extra space in the view. Defaults to an empty space |
| `width` | Specifies the width that the value should be displayed in (default 3) | | `width` | Specifies the width that the value should be displayed in (default 3) |
| `textOverflow` | If a single column cannot be displayed due to `width`, set overflow characters. See **Text Overflow** below | | `textOverflow` | If the MCI is wider than width, set overflow characters. See **Text Overflow** below |
### Text Overflow ### Text Overflow

View File

@ -1,8 +1,8 @@
--- ---
layout: page layout: page
title: Full Menu View title: Text View
--- ---
## Full Menu View ## Text View
A text label view supports displaying simple text on a screen. A text label view supports displaying simple text on a screen.
## General Information ## General Information
@ -15,13 +15,12 @@ A text label view supports displaying simple text on a screen.
| Property | Description | | Property | Description |
|-------------|--------------| |-------------|--------------|
| `text` | Sets the text to display on the button | | `text` | Sets the text to display on the label |
| `textStyle` | Sets the standard (non-focus) text style. See **Text Styles** in [Art](../general.md) | | `textStyle` | Sets the standard (non-focus) text style. See **Text Styles** in [Art](../general.md) |
| `width` | Sets the width of a view to display one or more columns horizontally (default 15)| | `width` | Sets the width of a view to display horizontally (default 15)|
| `argName` | Sets the argument name for this selection in the form - *Not normally used for text labels* | | `justify` | Sets the justification of the text in the view. Options: left (default), right, center |
| `justify` | Sets the justification of each item in the list. Options: left (default), right, center | | `fillChar` | Specifies a character to fill extra space in the view with. Defaults to an empty space |
| `fillChar` | Specifies a character to fill extra space in the menu with. Defaults to an empty space | | `textOverflow` | Set overflow characters to display in case the text length is less than the width. See **Text Overflow** below |
| `textOverflow` | If a single column cannot be displayed due to `width`, set overflow characters. See **Text Overflow** below |
### Text Overflow ### Text Overflow

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.0 KiB