From 19a708c2483d71483836720179d2eff6a638fa9e Mon Sep 17 00:00:00 2001 From: Nathan Byrd Date: Wed, 26 Jan 2022 17:22:13 -0600 Subject: [PATCH] Added ME and ET, additional cleanup --- docs/art/views/button_view.md | 4 +- docs/art/views/edit_text_view.md | 41 ++++++++++++++++++ docs/art/views/mask_edit_text_view.md | 40 +++++++++++++++++ docs/art/views/predefined_label_view.md | 10 ++--- docs/art/views/text_view.md | 15 +++---- .../assets/images/edit_text_view_example1.gif | Bin 0 -> 4346 bytes .../images/mask_edit_text_view_example1.gif | Bin 0 -> 7117 bytes 7 files changed, 95 insertions(+), 15 deletions(-) create mode 100644 docs/art/views/edit_text_view.md create mode 100644 docs/art/views/mask_edit_text_view.md create mode 100644 docs/assets/images/edit_text_view_example1.gif create mode 100644 docs/assets/images/mask_edit_text_view_example1.gif diff --git a/docs/art/views/button_view.md b/docs/art/views/button_view.md index 23f52229..b9b9a128 100644 --- a/docs/art/views/button_view.md +++ b/docs/art/views/button_view.md @@ -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** | | `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 | -| `fillChar` | Specifies a character to fill extra space in the menu with. Defaults to an empty space | -| `textOverflow` | If a single column cannot be displayed due to `width`, set overflow characters. See **Text Overflow** below | +| `fillChar` | Specifies a character to fill extra space longer than the text length. Defaults to an empty space | +| `textOverflow` | If the button text cannot be displayed due to `width`, set overflow characters. See **Text Overflow** below | ### Text Overflow diff --git a/docs/art/views/edit_text_view.md b/docs/art/views/edit_text_view.md new file mode 100644 index 00000000..e8eb779d --- /dev/null +++ b/docs/art/views/edit_text_view.md @@ -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") + +
+Configuration fragment (expand to view) +
+``` +ET1: { + maxLength: @config:users.usernameMax + argName: username + focus: true +} +``` +
+
diff --git a/docs/art/views/mask_edit_text_view.md b/docs/art/views/mask_edit_text_view.md new file mode 100644 index 00000000..da1ca06e --- /dev/null +++ b/docs/art/views/mask_edit_text_view.md @@ -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") + +
+Configuration fragment (expand to view) +
+``` +ME1: { + maxLength: @config:users.webMax + argName: web +} +``` +
+
diff --git a/docs/art/views/predefined_label_view.md b/docs/art/views/predefined_label_view.md index 45d2d1cd..c17275f6 100644 --- a/docs/art/views/predefined_label_view.md +++ b/docs/art/views/predefined_label_view.md @@ -1,8 +1,8 @@ --- 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. ## General Information @@ -18,10 +18,10 @@ A predefined label view supports displaying a predefined MCI label on a screen. | Property | Description | |-------------|--------------| | `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 | -| `fillChar` | Specifies a character to fill extra space in the menu with. Defaults to an empty space | +| `justify` | Sets the justification of the MCI value text. Options: left (default), right, center | +| `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) | -| `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 diff --git a/docs/art/views/text_view.md b/docs/art/views/text_view.md index ad2e0855..6f7f36b8 100644 --- a/docs/art/views/text_view.md +++ b/docs/art/views/text_view.md @@ -1,8 +1,8 @@ --- 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. ## General Information @@ -15,13 +15,12 @@ A text label view supports displaying simple text on a screen. | 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) | -| `width` | Sets the width of a view to display one or more columns 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 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 | -| `textOverflow` | If a single column cannot be displayed due to `width`, set overflow characters. See **Text Overflow** below | +| `width` | Sets the width of a view to display horizontally (default 15)| +| `justify` | Sets the justification of the text in the view. Options: left (default), right, center | +| `fillChar` | Specifies a character to fill extra space in the view 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 | ### Text Overflow diff --git a/docs/assets/images/edit_text_view_example1.gif b/docs/assets/images/edit_text_view_example1.gif new file mode 100644 index 0000000000000000000000000000000000000000..1917d297214ff0a9cf969288000ed5b8b2f4b0d2 GIT binary patch literal 4346 zcmeH}YfzI{8plr(E(r-GG75?;4!8xRilr(zQQsht z2oz#M5D_o|qY<^-1JkZbATA+Lbx|uW;9{xR^$O^))LF-Uad)9#n6Yc^_JilsJ9Fke z=ehiU|L3d`MsfqT+9Eu_KM=kEUatTGfj}aWC=|-d%F5c>+Q!Dl*47q{Mq@A-EEbEy z;T#+s@OV6dKp>GwWHQ;w$%#UtP^nZJjkb94VrOS(7Z(>-S64STH#(ipU@+X>-B~P_ zhlhu!r>B>fm$$dKkB<+B!}0a?UAb~4m&*+Z2nY-e3=R$s2?<%fdNq&7b7xjo*6!WA_w3oTckkYu zoE(WnvVZ^ng9i^n5G0jKb8~a^^YaS|3S=^wTrNL+_;68CQE_o`Nl8g*Y3Y$8N0dsX zN~J0*D^si0<>lp-m6cUhRn^tiH8nL_t+uwdwyv&Dr_<^6`uh6%^XJbuG&D3dH8nRk zx3;#nwY3=xhK`Po3l}b2ym--QG@48%v)OF1So-?6l)trm z(0YJCI|~{$#zSZ#JHgzj?Uv!0qAEdC?d2lMiu7S~Q(aFfonPoIY(CkmVy&-F=xx^Z z9pxljs)Q}4zB$g#dNADEa{B6t&_i}EqE`K1>I5qG7E9}y>!)MtMAf3U`kQCtTGB@> zZD(&aBy|_ML>bQAZb`jfzopM`eyBZj%u*fI{^iKm+0Pz~^tCtq?Gl8-x~}bLyxT1& zE>G<5Xd3HLFr!XU@$>N7AXqTNFwbZ!0FSk|*$4nsfCDJ_C=&38sDeg1MQUT8sOf6d z^4SQ)+Z_E1M!Dco^Wo#>+lWH`_QOU4CqRO$UI6(2qzV*C3IMAwykcvgR<_wtmJ^qv zy`1OZz(`0MkGWj5XazeZ8I@v|Axf6|V*JLe{CCDB_Rnxm_2*NmtxY*ZriISm$0m7@ z+%0*YAE7^_L9(9XHr^?J%4FDFKE5&S-BI9!A7e__kZXaw(?%mhwuK zvJ%V+Eg@L8WcoI7odqhOkZE$t8orgkvQ< z-@qyR%?2-u7grc_EUMjG1^wj3vY-d-0{?|64R%BP;E1iLzSE$g$BoyukFN@6j}dl4unRw6gaFBDVguj>}0ix8=Gwa-463=i$l%iK4Ar2e*2F>uPY1sxT;B-u1@lnNi8~9R z&^R!D^~9{Wao4_Abm!x33wF(LzU!i949=WMb*!b9xR4J7kp`G%C2CDADd#htMUDPL z7l}pu@DSE%fNRP@Z2O=vR9Lj2KlpsNwS9p^X;{;S;6@IPl5^j7YA|2g#Z8m literal 0 HcmV?d00001 diff --git a/docs/assets/images/mask_edit_text_view_example1.gif b/docs/assets/images/mask_edit_text_view_example1.gif new file mode 100644 index 0000000000000000000000000000000000000000..443d2868de13424a671d70e892d89da35a8fe789 GIT binary patch literal 7117 zcmeHLXH=8vx_wiCfFJ=vH5md@BPzX@1f&;3l_t^z1e6jo2qF*y0R$uz1*M771Rbe5 z*oGh-K}3j%41$OvNLQ(vn>p*=GxOulTKC6Y>)f-h@3;RwKfZVEZ$JCl-(zlRrmf?{ zfGC0uvI<}y2n0X@fCIq60k{A_uz>))0PF>T9{@o?AOwI20HUHm3;;1PAPxW;01O65 zN&+kZSS*kRKw28?-w)&fkdp(7iU0=y4hIe#07?KHJO~aS2JBasE-v60 z0IsgU9RPQC-~qsKHjaZ60Qdsn=LZ4-2x21$gaUB-G&lo57y#knAQFJ6C_n}vnvH01 z4uEs#Ks*46Y$O5-1tbALWrGTmlR*jqsQ{#>gA4#J0+5{z=yZ?+z$E~#0B{w6A~uRZ zNeL(e;2HoG0900jY5;BmP|HRwU;!xmz@TtAoP&ddlarH+iwl83aC39>@bK{R^78TV z?cKYVpPyeyNC<^O2@4C0h=_=aii(MeNk~ZS+qVyc!CBeM3V-JRVOV5KK%=%*@OzEG(?7tZZy- zY;A3cM52R(gR`@oD5)u*;6B8*E3YAJtPEMxLXzA(c z85tQ_Sy|cH*>pNRCnqN_FYof@%LN4mSFT(sE-o%DExmT_T6uYSMMXt*b#+Zm&CQ!P zYin!o+_}@#)O7dm-CuwGwY9bN!Gi~nA3yHs=;-R|>hA9D>FMe3?;jW#7#tjY{`~py z@bJjU2$RWt`SRtfSFc{bemyxkIW;vkJ3IUS{rkDOx%v6|rKP3i<>i%?mG$-Yjg5`X z&CRW?t?ljY-QC@9-@bkS{+-2QNwN0WnL0U|5QwI#hm>Iu0D#mMoP&q05Vmpw_@hnO z68O<1KbqwKZ<8Qc0D?eU)L&yz5kff6p8E19smT3S#TE_MJ2S-8f+ueWp@7_lhWqs1Q{J`Z5BMo=Q*VCm#zCW_JoQ>rYi#zprQ|HgaNg zr8wW7U8J-xNWxSeEXsBtS}dd} zLomzF1B&7vo%WWDfBmJ)B!Po3vPTL5X`IGzEjIW_a&gp`V-cra5yrI8G&=TBBnnGW zf9sEpsy|6EN39ra!i1utRLXz$dg{^znG}HYoIp6Yzm(*XZ9lf3YnpLP4zX&=V_c;i zGbHDAM%^#Ve=zDs?45=c2{b`_b6gEwCT<9 z@-xyG6jCn8waP~bJ{J@_l;l#I%TK%MJsg|mvf*8wsaY%U6laIB_O5ZQ#aZf!RY9x_ z9$u<~0rQ7nlkmaA<#3?+P$U^Iev6PQ4CsIhbCmwd+PhA3CkH}ny(S3Hf*?T)+ z00Isc;P5{!{72zmLP-oeQu6+hC=qBNZYg0=KZW%j6U2GC@=Uj}g6gv*f$2_VJC8AK|wawVmE; zs*wRL^Y2bFUl8yUpM*bi41Q`(OMkqj=Am-w)iJ;RQsLT+MTS*G^zgU9ms9r=V)yJ_ z(`%6Qxj$oEQf8 zvq#-7y?!S9J7b==-?rX$?F7>HgkD$vwcvkYGZEidwQ1rlJ<{^oS|y#F+wA2O_3>>@8i1dPR2H5NcU-G?}$xLe~PqLc5OPg`i_tbx=4hIr;S1zJu{G*-O<0QS75wT- zkch^{?`hYK9*wAExK$zYp9Mlk11=jjXuX5n60mRS%jV7j1f(>iy=#^vRn%;HGg`=}3b{%wtHHmks$0^8UisSl z)62rn!5cY?kpYzZUeMN$pKCrlK|=;G~)*hFK_l;F61ohX*FZ zLafr{ks$omZD<5fV?(0cLY3Q~*PcZ@*)HUA%h>iQCN5=H$U=#-)G%i>eRh4e90$`4 z!z>ww)CEVTP-koE$j}@&_)DJ^qe{W3+V;ZRec~O0{Z@6IWdvUl)rUzsL*4N73A)={ z=G(8Ye^)75D^{}BL$)Zh@)pa~U$ZjTjjCm!8d$PF=?o@Je(COuBYGn0kLtK9)O#{A zRm(KbYs1M5E{~FW!k#C0$sP5v$5(qqUrK#7@+XCUz0+BHu>Jy~_uDNR`S8yh{m+&R zNCR42xJ@HNk$7zrQzI`wf3nS)A=TFJjy>ZrlAT6-zK`t<{3iF2?T)5WJK}uZy-8ws zV7FJOarfSQ8`YNLiBF5q=i}vqeA=vM!?7K6P6U5fMuJ#iuyg;^ zhpHeEpSX|I##JvwSx}}-z(+L!)w1VKoA-6&Y<_}nz3vfIRgzUXMf)s-NHso!lv%S# zs1xhqU%>OkTUhKH4stf}m63`>KqIAc&8zxqWOl;s-Jq}F2Ko7&*BS<}8N}4&F-Dp$ z(ZslEYckAuB(s0lM2S3Wo~)oDZ_Sqa(J>bD>2pEE?X+eJ3yIBg>I0xF2IZK(Rt%X_co(rGm!z( zcdG3Is+zDgWL3-Fa_UhER=V(KBti{_O!M|7m2g=G5F{8+?bfD?H{Nl}9+A3W@QJQ2 zRUTATpZ5GBE!iDsY<9?CT%hSGOej6gOWv~2A-$ezz8ZAO+?^uLy=7d5^Wo6^x$i}( zZ=h^UeF`zfU9s4uLfAyO*52{@i&EV$)z(?HPUhEnLR`Ppx_&YJYt~4Hh_PoIjP1+3 zf2Lv>^#6M1`19Jrz|ChLdn6yGa0q>OIC+~L<{v}zxQxzeJuOqEI;vfIC+&HHi##C;)3iQZCPlWfL6j5}fB71;mUxbR= zps0;gh!k1(J{bj{L9~<_$*{w>OAbLbZ5z|S>G*-KjEm1H!ZEyCq{!MG*CyRvHHgym zK%I75f6u%F%O2c1Ro_mmSMAI_n09jSizM!AgST`)1iLh!T{m+&H}na8J@(#soVD^& zagFLn&iJ!_X*1nCaKm5nW+FN%D#_YE*@w5yNRgei4-uzVEhR5xDw8MO`s7Ll-G?~iPqkU)Fo-y!ZSK4qLP?_T*99X;M5ZSFb{QG`DMSEO?W zkEC)CbeIh@=o8G<8T@f>H?ADgk${hAb7syvK8dFhjJ?)8aGJPZ<}_zMw1tIRxaEwf zU;^TpzuD!$^b|7;_rq8-lAwh${)h`t@(emm5EV!uwQE$u$xb?{rEyG(G~t3u_+(o0 zT+PvQi=~@5?@9>S0uq8bEWg-~_&NOzGECjOMB@lS*P}qO`1s z_`#gpDszFPy01MPQenD;8h+FUzV4YoY(+zp_0D9G7w+&g(q`P@=?~6Bj2Pfp{GPtj z+%;NGBy$T5aK42V6)HPd>M z?~tT65r%Hilr#Ulds}FGZjy4M&;3|Op+Rb4qkWa3Sx`UPH}@`=c)4$oP+G>47TwdJ z#*FOU2K(C6?H3W24Q6KWC?v#CFc1q-mcj7Vn_uTn&fyRDhi$q7$ft-%0YakGVI4Xo zbPX~j)FaRDMmL~2VDlzs1Z6bowxyBuxX<}eUq!l`;Zz#!7EGo|vyX~s#NM2^A!6{c zuk&fw$@q#JDh0g)1?Q`io@Q35+qWySY;aC5p2~5)4u^2)bCbq-tF^g?^R{<`i^n|) x$kW3TQTIt#p=lKTS+|?fRwRz~{Az