dalbodeule/snap-admin
1
0
Fork 0
mirror of https://github.com/dalbodeule/snap-admin.git synced 2025-06-09 05:48:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation (#4)

Browse Source
This commit is contained in:
Francesco 2023-10-03 11:15:03 +02:00
parent 1c07dac910
commit 64af5e2856
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/index.html
View File

@ -228,14 +228,24 @@ private byte[] image;
<h4 id="hidde-column">3.1.6 @HiddenColumn</h4> <h4 id="hidde-column">3.1.6 @HiddenColumn</h4>
<h6>Code example</h6> <h6>Code example</h6>
<pre> <pre>
<code> <code>@HiddenColumn
@HiddenColumn
private String cardNumber; private String cardNumber;
</code> </code>
</pre> </pre>
<p>Marks a column as hidden. This column and its values will not be shown in the list and detail view for objects of this type. If the column is nullable, it will be hidden in the create and edit forms as well (and this will result in the column always being NULL when creating/editing objects). If, instead, it's not nullable column, it will be included in the create and edit forms as it would otherwise prevent the creation of items.</p> <p>Marks a field as hidden. This column and its values will not be shown in the list and detail view for objects of this type. If the column is nullable, it will be hidden in the create and edit forms as well (and this will result in the column always being NULL when creating/editing objects). If, instead, it's not nullable column, it will be included in the create and edit forms as it would otherwise prevent the creation of items.</p>
<p><strong>Please note that this is not meant as a security feature, </strong> but rather to hide uninformative columns that clutter the interface. In fact, since the create and edit form come pre-filled with all the information, these views <b>will</b> show the value of the hidden column (if it's not nullable).</p> <p><strong>Please note that this is not meant as a security feature, </strong> but rather to hide uninformative columns that clutter the interface. In fact, since the create and edit form come pre-filled with all the information, these views <b>will</b> show the value of the hidden column (if it's not nullable).</p>
<h4 id="read-only">3.1.7 @ReadOnly</h4>
<h6>Code example</h6>
<pre>
<code>@ReadOnly
private LocalDate createdAt;
</code>
</pre>
<p>Marks a field as read-only. The field can be filled at creation time, but it will be shown as disabled during edits, making it impossible to change its value after creation. </p>
<div class="separator"></div> <div class="separator"></div>
<h3 id="settings-panel">3.2 The Settings panel</h3> <h3 id="settings-panel">3.2 The Settings panel</h3>