5.7.3.1 actionClick

5.7.3.1.1 Déclenchement

Un lien interne de type événement est sélectionné. Ces liens sont de 2 formes :

un élément de type <a> ou <button> qui possède un attribut data-action

Dans ce cas, l'action est la valeur de l'attribut data-action, et doit être de la forme <type_event>:<option1>:<option2>:…
un élément de type <a> dont l'attribut href commence par #action/

Dans ce cas, l'action est la valeur de l'attribut href, et doit être de la forme #action/<type_event>:<option1>:<option2>:…

Ces éléments peuvent être présents partout dans la page (menu, template, atribut, lien sur un attribut, etc.)

Lorsqu'un élément de type <a> contient à la fois un attribut data-action=<type_event>… et un attribut href=#action/<type_event>…, alors c'est le type d'événement et les options contenus dans l'attribut data-action qui sont pris en compte.

5.7.3.1.2 Éléments passés au callback

event

objet événement standard de jQuery,

documentObject

un objet document décrivant le document courant.

options

objet décrivant l'action. Il contient les propriétés suivantes :

target: élément jquery DOM ayant déclenché l'événement,
eventId: identifiant du type d'événément (soit le <type_event> du lien présenté ci-dessus),
options: array d'options de cet événément

5.7.3.1.3 Annulable

Oui. Dans ce cas l'événement associé n'est pas déclenché.

5.7.3.1.4 Liste des événements standards

Les actions prédéfinies sur le widget document sont :

Identifiant	options	Description	Exemple
`document.close`	`[viewId]`	Demande d'affichage en mode consultation du document courant en utilisant la vue `viewId` (si `viewId` n'est pas renseigné, la vue `!defaultConsultation` est utilisée)	`#action/document.close`
`document.create`		Demande de sauvegarde du document courant et de retour en mode modification	`#action/document.create`
`document.createAndClose`	`[viewId]`	Demande de sauvegarde du document courant et de retour en mode consultation en utilisant la vue `viewId` (si `viewId` n'est pas renseigné, la vue `!defaultConsultation` est utilisée)	`#action/document.createAndClose`
`document.delete`		Demande de suppression du document courant	`#action/document.delete`
`document.edit`		Demande d'affichage en mode modification du document courant	`#action/document.edit`
`document.help`	`helpId[:rubriqueId]`	Demande daffichage de l'aide `helpId` avec un focus sur l'entrée `rubriqueId` (si `rubriqueId` n'est pas renseigné, le focus est en haut de l'aide	`#action/document.helpid:MY_FAMILY:my_attribute`
`document.history`	`[initid]`	Demande d'affichage de l'historique du document ayant la référence `initid` (si `initid` n'est pas renseigné, c'est l'historique de document courant qui est affiché)	`#action/document.history`
`document.load`	`initid[:viewId[:revision]]`	Demande d'affichage du document ayant la référence `initid` à la place du document courant	`#action/document.load:1234:!defaultConsultation:0`
`document.lock`		Demande de verrouillage du document courant	`#action/document.lock`
`document.properties`	`[initid]`	Demande d'affichage des propriétés du document ayant la référence `initid` (si `initid` n'est pas renseigné, ce sont les propriétés du document courant qui sont affichées)	`#action/document.properties`
`document.restore`		Demande de restauration du document courant	`#action/document.restore`
`document.save`		Demande de sauvegarde du document courant	`#action/document.save`
`document.saveAndClose`	`[viewId]`	Demande de sauvegarde du document courant et de retour en mode consultation en utilisant la vue `viewId` (si `viewId` n'est pas renseigné, la vue `!defaultConsultation` est utilisée)	`#action/document.saveAndClose`
`document.transition`	`transitionId:nextStateId`	Demande de passage de la transition `transitionId` pour arriver à l'état `nextStateId`	`#action/document.transition:my_transition:my_nextstate`
`document.transitionGraph`		Demande d'affichage du graphe de transitions	`#action/document.transitionGraph`
`document.unlock`		Demande de déverrouillage du document courant	`#action/document.unlock`

5.7.3.1.5 Exemple

Cet exemple affiche un confirm demandant de valider pour sauvegarder.

window.dcp.document.documentController("addEventListener",
    "actionClick",
    {
        "name": "doubleCheck"
    },
    function changeDisplayError(event, documentObject, options) {
        //identify the good click
        if (options.eventId === "document.save") {
            if (!confirm("Voulez vous sauver ?")) {
                event.preventDefault();
            }
        }
    }
);

Source : client/ui/events/eventsdocument/actionClick.md Dynacase Platform 3.2 | Document User Interface Manuel de référence, version 1.0 édition 2, © Labs <labs@anakeen.com>