Updating documentation for version SNAPSHOT

Author: opfabtech

documentation/archives/SNAPSHOT/docs/single_page_doc.html

@@ -531,7 +531,7 @@
 <h1>OperatorFabric Documentation</h1>
 <div class="details">
 <span id="revnumber">version SNAPSHOT,</span>
-<span id="revdate">17 December 2024</span>
+<span id="revdate">18 December 2024</span>
 </div>
 <div id="toc" class="toc2">
 <div id="toctitle">Table of Contents</div>
@@ -913,20 +913,22 @@ <h1>OperatorFabric Documentation</h1>
 <li><a href="#_function_hideloadingspinner">24.5.2. Function hideLoadingSpinner</a></li>
 <li><a href="#_function_getchildcards">24.5.3. Function getChildCards</a></li>
 <li><a href="#_function_getcard">24.5.4. Function getCard()</a></li>
-<li><a href="#_function_getdisplaycontext">24.5.5. Function getDisplayContext</a></li>
-<li><a href="#_function_getentitiesallowedtorespond">24.5.6. Function getEntitiesAllowedToRespond</a></li>
-<li><a href="#_function_getentitiesusableforuserresponse">24.5.7. Function  getEntitiesUsableForUserResponse</a></li>
-<li><a href="#_function_isresponselocked">24.5.8. Function isResponseLocked</a></li>
-<li><a href="#_function_isuserallowedtorespond">24.5.9. Function isUserAllowedToRespond</a></li>
-<li><a href="#_function_isusermemberofanentityrequiredtorespond">24.5.10. Function isUserMemberOfAnEntityRequiredToRespond</a></li>
-<li><a href="#_function_listentoresponselock">24.5.11. Function listenToResponseLock</a></li>
-<li><a href="#_function_listentoresponseunlock">24.5.12. Function listenToResponseUnlock</a></li>
-<li><a href="#_function_listentochildcards">24.5.13. Function listenToChildCards</a></li>
-<li><a href="#_function_listentolttdexpired">24.5.14. Function listenToLttdExpired</a></li>
-<li><a href="#_function_listentostylechange">24.5.15. Function listenToStyleChange</a></li>
-<li><a href="#_function_listentoscreensize">24.5.16. Function listenToScreenSize</a></li>
-<li><a href="#_function_listentotemplaterenderingcomplete">24.5.17. Function listenToTemplateRenderingComplete</a></li>
-<li><a href="#_function_registerfunctiontogetuserresponse">24.5.18. Function registerFunctionToGetUserResponse</a></li>
+<li><a href="#_function_isuserallowedtoedit">24.5.5. Function isUserAllowedToEdit</a></li>
+<li><a href="#_function_editcard">24.5.6. Function editCard</a></li>
+<li><a href="#_function_getdisplaycontext">24.5.7. Function getDisplayContext</a></li>
+<li><a href="#_function_getentitiesallowedtorespond">24.5.8. Function getEntitiesAllowedToRespond</a></li>
+<li><a href="#_function_getentitiesusableforuserresponse">24.5.9. Function  getEntitiesUsableForUserResponse</a></li>
+<li><a href="#_function_isresponselocked">24.5.10. Function isResponseLocked</a></li>
+<li><a href="#_function_isuserallowedtorespond">24.5.11. Function isUserAllowedToRespond</a></li>
+<li><a href="#_function_isusermemberofanentityrequiredtorespond">24.5.12. Function isUserMemberOfAnEntityRequiredToRespond</a></li>
+<li><a href="#_function_listentoresponselock">24.5.13. Function listenToResponseLock</a></li>
+<li><a href="#_function_listentoresponseunlock">24.5.14. Function listenToResponseUnlock</a></li>
+<li><a href="#_function_listentochildcards">24.5.15. Function listenToChildCards</a></li>
+<li><a href="#_function_listentolttdexpired">24.5.16. Function listenToLttdExpired</a></li>
+<li><a href="#_function_listentostylechange">24.5.17. Function listenToStyleChange</a></li>
+<li><a href="#_function_listentoscreensize">24.5.18. Function listenToScreenSize</a></li>
+<li><a href="#_function_listentotemplaterenderingcomplete">24.5.19. Function listenToTemplateRenderingComplete</a></li>
+<li><a href="#_function_registerfunctiontogetuserresponse">24.5.20. Function registerFunctionToGetUserResponse</a></li>
 </ul>
 </li>
 <li><a href="#_currentusercard_api">24.6. CurrentUserCard API</a>
@@ -7650,7 +7652,29 @@ <h4 id="_function_getcard"><a class="anchor" href="#_function_getcard"></a>24.5.
 </div>
 </div>
 <div class="sect3">
-<h4 id="_function_getdisplaycontext"><a class="anchor" href="#_function_getdisplaycontext"></a>24.5.5. Function getDisplayContext</h4>
+<h4 id="_function_isuserallowedtoedit"><a class="anchor" href="#_function_isuserallowedtoedit"></a>24.5.5. Function isUserAllowedToEdit</h4>
+<div class="paragraph">
+<p>To check if current user has the permission to edit the current card, you can call the isUserAllowedToEdit() method.</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay highlight"><code>   const editAllowed = opfab.currentCard.isUserAllowedToEdit()</code></pre>
+</div>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_function_editcard"><a class="anchor" href="#_function_editcard"></a>24.5.6. Function editCard</h4>
+<div class="paragraph">
+<p>It is possible to open current card edition modal, if current user has the permission, by calling the editCard() method.</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="CodeRay highlight"><code>    opfab.currentCard.editCard()</code></pre>
+</div>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_function_getdisplaycontext"><a class="anchor" href="#_function_getdisplaycontext"></a>24.5.7. Function getDisplayContext</h4>
 <div class="paragraph">
 <p>To adapt the template content to the display context it is possible to get from OperatorFabric the page context where the template will be rendered by calling the javascript function getDisplayContext(). The function returns a string with one of the following values :</p>
 </div>
@@ -7674,7 +7698,7 @@ <h4 id="_function_getdisplaycontext"><a class="anchor" href="#_function_getdispl
 </div>
 </div>
 <div class="sect3">
-<h4 id="_function_getentitiesallowedtorespond"><a class="anchor" href="#_function_getentitiesallowedtorespond"></a>24.5.6. Function getEntitiesAllowedToRespond</h4>
+<h4 id="_function_getentitiesallowedtorespond"><a class="anchor" href="#_function_getentitiesallowedtorespond"></a>24.5.8. Function getEntitiesAllowedToRespond</h4>
 <div class="paragraph">
 <p>If inside your template, you want to get the ids of the entities allowed to send a response, you can call the method getEntitiesAllowedToRespond. This method returns an array containing the ids.</p>
 </div>
@@ -7685,7 +7709,7 @@ <h4 id="_function_getentitiesallowedtorespond"><a class="anchor" href="#_functio
 </div>
 </div>
 <div class="sect3">
-<h4 id="_function_getentitiesusableforuserresponse"><a class="anchor" href="#_function_getentitiesusableforuserresponse"></a>24.5.7. Function  getEntitiesUsableForUserResponse</h4>
+<h4 id="_function_getentitiesusableforuserresponse"><a class="anchor" href="#_function_getentitiesusableforuserresponse"></a>24.5.9. Function  getEntitiesUsableForUserResponse</h4>
 <div class="paragraph">
 <p>If inside your template, you want to get the ids of the entities the user can answer on behalf of, you can call the method getEntitiesUsableForUserResponse. This method will return an array containing the entities' ids.</p>
 </div>
@@ -7696,7 +7720,7 @@ <h4 id="_function_getentitiesusableforuserresponse"><a class="anchor" href="#_fu
 </div>
 </div>
 <div class="sect3">
-<h4 id="_function_isresponselocked"><a class="anchor" href="#_function_isresponselocked"></a>24.5.8. Function isResponseLocked</h4>
+<h4 id="_function_isresponselocked"><a class="anchor" href="#_function_isresponselocked"></a>24.5.10. Function isResponseLocked</h4>
 <div class="paragraph">
 <p>To know if template is locked (i.e. user can not respond unless he unlocks the card)</p>
 </div>
@@ -7707,7 +7731,7 @@ <h4 id="_function_isresponselocked"><a class="anchor" href="#_function_isrespons
 </div>
 </div>
 <div class="sect3">
-<h4 id="_function_isuserallowedtorespond"><a class="anchor" href="#_function_isuserallowedtorespond"></a>24.5.9. Function isUserAllowedToRespond</h4>
+<h4 id="_function_isuserallowedtorespond"><a class="anchor" href="#_function_isuserallowedtorespond"></a>24.5.11. Function isUserAllowedToRespond</h4>
 <div class="paragraph">
 <p>The template can know if the current user has the permission to send a response to the current card by calling the isUserAllowedToRespond() function.
 An example of usage can be found in the file
@@ -7720,7 +7744,7 @@ <h4 id="_function_isuserallowedtorespond"><a class="anchor" href="#_function_isu
 </div>
 </div>
 <div class="sect3">
-<h4 id="_function_isusermemberofanentityrequiredtorespond"><a class="anchor" href="#_function_isusermemberofanentityrequiredtorespond"></a>24.5.10. Function isUserMemberOfAnEntityRequiredToRespond</h4>
+<h4 id="_function_isusermemberofanentityrequiredtorespond"><a class="anchor" href="#_function_isusermemberofanentityrequiredtorespond"></a>24.5.12. Function isUserMemberOfAnEntityRequiredToRespond</h4>
 <div class="paragraph">
 <p>The template can know if the current user is member of an Entity required to respond by calling the isUserMemberOfAnEntityRequiredToRespond function.
 An example of usage can be found in the file <a href="https://github.com/opfab/operatorfabric-core/tree/master/src/test/resources/bundles/defaultProcess_V1/template/question.handlebars">src/test/resources/bundles/defaultProcess_V1/template/question.handlebars</a>.</p>
@@ -7732,7 +7756,7 @@ <h4 id="_function_isusermemberofanentityrequiredtorespond"><a class="anchor" hre
 </div>
 </div>
 <div class="sect3">
-<h4 id="_function_listentoresponselock"><a class="anchor" href="#_function_listentoresponselock"></a>24.5.11. Function listenToResponseLock</h4>
+<h4 id="_function_listentoresponselock"><a class="anchor" href="#_function_listentoresponselock"></a>24.5.13. Function listenToResponseLock</h4>
 <div class="paragraph">
 <p>Register a function to be informed when template is locked (i.e. user has responded to the current card)</p>
 </div>
@@ -7743,7 +7767,7 @@ <h4 id="_function_listentoresponselock"><a class="anchor" href="#_function_liste
 </div>
 </div>
 <div class="sect3">
-<h4 id="_function_listentoresponseunlock"><a class="anchor" href="#_function_listentoresponseunlock"></a>24.5.12. Function listenToResponseUnlock</h4>
+<h4 id="_function_listentoresponseunlock"><a class="anchor" href="#_function_listentoresponseunlock"></a>24.5.14. Function listenToResponseUnlock</h4>
 <div class="paragraph">
 <p>Register a function to be informed when template is unlocked (i.e. user has clicked the modify button to prepare a new response)</p>
 </div>
@@ -7754,7 +7778,7 @@ <h4 id="_function_listentoresponseunlock"><a class="anchor" href="#_function_lis
 </div>
 </div>
 <div class="sect3">
-<h4 id="_function_listentochildcards"><a class="anchor" href="#_function_listentochildcards"></a>24.5.13. Function listenToChildCards</h4>
+<h4 id="_function_listentochildcards"><a class="anchor" href="#_function_listentochildcards"></a>24.5.15. Function listenToChildCards</h4>
 <div class="paragraph">
 <p>Register a function to receive the child cards on card loading and when the childCards list changes</p>
 </div>
@@ -7765,7 +7789,7 @@ <h4 id="_function_listentochildcards"><a class="anchor" href="#_function_listent
 </div>
 </div>
 <div class="sect3">
-<h4 id="_function_listentolttdexpired"><a class="anchor" href="#_function_listentolttdexpired"></a>24.5.14. Function listenToLttdExpired</h4>
+<h4 id="_function_listentolttdexpired"><a class="anchor" href="#_function_listentolttdexpired"></a>24.5.16. Function listenToLttdExpired</h4>
 <div class="paragraph">
 <p>If the card has a last time to decide (lttd) configured, when the time is expired this information can be received by the template by registering a listener.</p>
 </div>
@@ -7776,7 +7800,7 @@ <h4 id="_function_listentolttdexpired"><a class="anchor" href="#_function_listen
 </div>
 </div>
 <div class="sect3">
-<h4 id="_function_listentostylechange"><a class="anchor" href="#_function_listentostylechange"></a>24.5.15. Function listenToStyleChange</h4>
+<h4 id="_function_listentostylechange"><a class="anchor" href="#_function_listentostylechange"></a>24.5.17. Function listenToStyleChange</h4>
 <div class="paragraph">
 <p>Card template can be informed when switching day/night mode by registering a listener as follows :</p>
 </div>
@@ -7790,7 +7814,7 @@ <h4 id="_function_listentostylechange"><a class="anchor" href="#_function_listen
 </div>
 </div>
 <div class="sect3">
-<h4 id="_function_listentoscreensize"><a class="anchor" href="#_function_listentoscreensize"></a>24.5.16. Function listenToScreenSize</h4>
+<h4 id="_function_listentoscreensize"><a class="anchor" href="#_function_listentoscreensize"></a>24.5.18. Function listenToScreenSize</h4>
 <div class="paragraph">
 <p>To adapt the template content on screen size it is possible to receive from OperatorFabric information on the size of the window where the template will be rendered. To receive screen size information you need to implement a listener function which will receive as input a string parameter with one of the following values :</p>
 </div>
@@ -7814,7 +7838,7 @@ <h4 id="_function_listentoscreensize"><a class="anchor" href="#_function_listent
 </div>
 </div>
 <div class="sect3">
-<h4 id="_function_listentotemplaterenderingcomplete"><a class="anchor" href="#_function_listentotemplaterenderingcomplete"></a>24.5.17. Function listenToTemplateRenderingComplete</h4>
+<h4 id="_function_listentotemplaterenderingcomplete"><a class="anchor" href="#_function_listentotemplaterenderingcomplete"></a>24.5.19. Function listenToTemplateRenderingComplete</h4>
 <div class="paragraph">
 <p>It is possible to be informed when opfab has finished all tasks regarding rendering template by registering a listener function .The function will be called after the call of the other listener (applyChildCard, lockAnswer ,lttdExpired and screenSize)</p>
 </div>
@@ -7828,7 +7852,7 @@ <h4 id="_function_listentotemplaterenderingcomplete"><a class="anchor" href="#_f
 </div>
 </div>
 <div class="sect3">
-<h4 id="_function_registerfunctiontogetuserresponse"><a class="anchor" href="#_function_registerfunctiontogetuserresponse"></a>24.5.18. Function registerFunctionToGetUserResponse</h4>
+<h4 id="_function_registerfunctiontogetuserresponse"><a class="anchor" href="#_function_registerfunctiontogetuserresponse"></a>24.5.20. Function registerFunctionToGetUserResponse</h4>
 <div class="paragraph">
 <p>Register the template function to call to get user response. This function will be called by opfab when user clicks on the "send response" button. More explanation can be found in the <a href="#response_cards">response card chapter</a>.</p>
 </div>