5.7.5 Liste des événements déclenchés par l'option "addCreateDocumentButton"

L'option addCreateDocumentButton pour les attributs de type docid déclenche les événements suivants.

  1. attributeCreateDialogDocumentReady : lorsque le formulaire est affiché
  2. attributeCreateDialogDocumentBeforeSetFormValues : avant l'affectation des valeurs dans le formulaire
  3. attributeCreateDialogDocumentBeforeSetTargetValue : avant l'affectation de l'attribut dans le document principal
  4. attributeCreateDialogBeforeClose : avant la fermeture de la fenêtre de dialogue
  5. attributeCreateDialogBeforeDestroy : avant la destruction de la fenêtre de dialogue

5.7.5.1 attributeCreateDialogDocumentReady

5.7.5.1.1 Déclenchement

Déclenché lorsque le formulaire est prêt pour être affiché. Il est déclenché sur le "ready" du formulaire.

5.7.5.1.2 Éléments passés au callback

event
objet événement standard de jQuery,
documentObject
un objet document décrivant le document principal.
attributeObject
un objet attribut décrivant l'attribut courant.
options
Un objet contenant les valeurs de l'attribut en cours. Il contient les propriétés suivantes : index : Index de la relation en cas d'attribut multiple. Est égale à "-1" si Cela ne concerne pas un attribut multiple dialogWindow : Widget de la fenêtre de dialogue (de type dcpWindow) dialogDocument : Widget du document contenu dans la fenêtre de dialogue

5.7.5.1.3 Annulable

Oui. L'annulation annule la modification des menus ainsi que le déclenchement des affectations de valeur dans le formulaire. L'événement "attributeCreateDialogDocumentBeforeSetFormValues" ne sera pas déclenché.

5.7.5.1.4 Exemple

5.7.5.2 attributeCreateDialogDocumentBeforeSetFormValues

5.7.5.2.1 Déclenchement

Déclenché lorsque le formulaire de création est prêt à recevoir les données à modifier. Il n'est pas déclenché pour le formulaire de modification.

5.7.5.2.2 Éléments passés au callback

event
objet événement standard de jQuery,
documentObject
un objet document décrivant le document principal.
attributeObject
un objet attribut décrivant l'attribut courant.
options
Un objet contenant les valeurs de l'attribut en cours. Il contient les propriétés suivantes : getFormValues() : fonction qui retourne l'objet , setFormvalues(formValues) : enregistre les valeurs dans le formulaire, index : Index de la relation en cas d'attribut multiple. Est égale à "-1" si Cela ne concerne pas un attribut multiple dialogWindow : Widget de la fenêtre de dialogue (de type dcpWindow) dialogDocument : Widget du document contenu dans la fenêtre de dialogue

5.7.5.2.3 Annulable

Oui. L'annulation indique que les valeurs définies dans l'option formValue ne seront pas prises en compte. Le formulaire est affiché sans ces valeurs spécifiques.

5.7.5.2.4 Exemple

Ajout de 2 nouvelle valeurs dans le formulaire de création :

window.dcp.document.documentController("addEventListener",
    "attributeCreateDialogDocumentBeforeSetFormValues",
    {
        "name": "createChild.animal",
        "documentCheck": function(document) {
            return document.family.name === "ZOO_ANIMAL"
        },
        "attributeCheck": function(attribute, documentObject) {
            return attribute.id === "an_enfant";
        }
    }, function (event, document, attribut, options) {
        var formValues=options.getFormValues();
        formValues.an_tatouage={value:"007"};
        formValues.an_sexe={value:"F"};
        options.setFormValues(formValues);
 
        // Affichage d'un message dans le formulaire de création
        options.dialogDocument.documentController("showMessage", "Création d'un nouvel animal");
    }
);

5.7.5.3 attributeCreateDialogDocumentBeforeSetTargetValue

5.7.5.3.1 Déclenchement

Déclenché lorsque la valeur de l'attribut a été affecté en cliquant sur le bouton d'enregistrement du document de la fenêtre de dialogue.

5.7.5.3.2 Éléments passés au callback

event
objet événement standard de jQuery,
documentObject
un objet document décrivant le document principal.
attributeObject
un objet attribut décrivant l'attribut courant.
options

Un objet contenant les valeurs de l'attribut en cours. Il contient les propriétés suivantes :

index
Index de la relation en cas d'attribut multiple. Est égale à "-1" si Cela ne concerne pas un attribut multiple
dialogWindow
Widget de la fenêtre de dialogue (de type dcpWindow)
dialogDocument
Widget du document contenu dans la fenêtre de dialogue
attributeValue

Valeur de la relation à insérer dans l'attribut Cette valeur est un objet contenant les champs suivants :

  • displayValue : Titre du document
  • familyRelation : Nom logique de la famille
  • icon : Url de l'icone du document
  • value : Identifiant numérique du document

5.7.5.3.3 Annulable

Oui. Le formulaire est enregistré, mais la mise de l'attribut n'est pas effectuée. La fenêtre de dialogue n'est pas fermée.

5.7.5.3.4 Exemple

Afficher un message indiquant la sauvegarde.

window.dcp.document.documentController("addEventListener",
    "attributeCreateDialogDocumentBeforeSetTargetValue",
    {
        "name": "setChild.animal",
        "documentCheck": function(document) {
            return document.family.name === "ZOO_ANIMAL"
        },
        "attributeCheck": function(attribute, documentObject) {
            return attribute.id === "an_espece";
        }
    }, function (event, document, attribut, options) {
    options.dialogDocument.documentController("showMessage",
        "Valeur [" + options.attributeValue.displayValue+ "] en cours d'affectation");
    }
);

5.7.5.4 attributeCreateDialogBeforeClose

5.7.5.4.1 Déclenchement

Déclenché avant la fermeture de la fenêtre. Soit lorsque l'utilisateur a demandé la mise à jour, soit lorsque l'utilisateur a demandé la fermeture sans enregistrer.

5.7.5.4.2 Éléments passés au callback

event
objet événement standard de jQuery,
documentObject
un objet document décrivant le document principal.
attributeObject
un objet attribut décrivant l'attribut courant.
options
Un objet contenant les valeurs de l'attribut en cours.
Il contient les propriétés suivantes :
index
Index de la relation en cas d'attribut multiple. Est égale à "-1" si Cela ne concerne pas un attribut multiple dialogWindow
Widget de la fenêtre de dialogue (de type dcpWindow) dialogDocument
Widget du document contenu dans la fenêtre de dialogue attributeValue

Valeur de la relation à insérer dans l'attribut. Cette valeur est vide (non définie) lorsque l'affectation n'a pas eu lieu. Cette valeur est un objet contenant les champs suivants en cas d'enregistrement :

  • displayValue : Titre du document
  • familyRelation : Nom logique de la famille
  • icon : Url de l'icone du document
  • value : Identifiant numérique du document

5.7.5.4.3 Annulable

Oui. L'annulation annule la fermeture de la fenêtre de dialogue. Cela annule aussi la demande de confirmation de fermeture lorsque le document n'a pas été enregistré.

5.7.5.4.4 Exemple

Bloquer la fermeture automatique de la fenêtre après l'enregistrement.

window.dcp.document.documentController("addEventListener",
    "attributeCreateDialogDocumentBeforeClose",
    {
        "name": "closeEspece.animal",
        "attributeCheck": function(attribute, documentObject) {
            return attribute.id === "an_espece";
        }
    }, function (event, document, attribut, options) {
        if (options.attributeValue) { // En cas d'enregistrement
            event.preventDefault();
            options.dialogDocument.documentController("showMessage", "Valeur enregistrée");
        }
    }
);

5.7.5.5 attributeCreateDialogBeforeDestroy

5.7.5.5.1 Déclenchement

Déclenché lorsque la fenêtre de dialogue est détruite (après la fermeture).

5.7.5.5.2 Éléments passés au callback

event
objet événement standard de jQuery,
documentObject
un objet document décrivant le document principal.
attributeObject
un objet attribut décrivant l'attribut courant.
options
Un objet contenant les valeurs de l'attribut en cours. Il contient les propriétés suivantes : index : Index de la relation en cas d'attribut multiple. Est égale à "-1" si Cela ne concerne pas un attribut multiple dialogWindow : Widget de la fenêtre de dialogue (de type dcpWindow) dialogDocument : Widget du document contenu dans la fenêtre de dialogue

5.7.5.5.3 Annulable

Oui. Cela empêche la destruction de la fenêtre et du formulaire.

5.7.5.5.4 Exemple

Affichage d'un message après la fermeture de la fenêtre de dialogue.

window.dcp.document.documentController("addEventListener",
    "attributeCreateDialogDocumentBeforeDestroy",
    {
        "name": "acloseEspece.animal",
        "documentCheck": function(document) {
            return document.family.name === "ZOO_ANIMAL"
        },
        "attributeCheck": function(attribute, documentObject) {
            return attribute.id === "an_espece";
        }
    }, function displayArrayModified(event, document, attribut, options) {
        this.documentController("showMessage",
            "Fenêtre ["+
            options.dialogDocument.documentController("getProperty","title")+
            "] a été fermée");
    }
);
Source : client/ui/events/eventsdocidcreate.md Dynacase Platform 3.2 | Document User Interface Manuel de référence, version 1.0 édition 2, © Labs <labs@anakeen.com>
×
Publié sous licence CC (http://creativecommons.org/licenses/by-nc-sa/2.0/fr/) par Anakeen [www.anakeen.com]
Attribution Vous devez créditer l'Oeuvre, intégrer un lien vers la licence et indiquer si des modifications ont été effectuées à l'Oeuvre. Vous devez indiquer ces informations par tous les moyens possibles mais vous ne pouvez pas suggérer que l'Offrant vous soutient ou soutient la façon dont vous avez utilisé son Oeuvre.
Pas d’Utilisation Commerciale Vous n'êtes pas autoriser à faire un usage commercial de cette Oeuvre, tout ou partie du matériel la composant.
Partage dans les Mêmes Conditions Dans le cas où vous effectuez un remix, que vous transformez, ou créez à partir du matériel composant l'Oeuvre originale, vous devez diffuser l'Oeuvre modifiée dans les même conditions, c'est à dire avec la même licence avec laquelle l'Oeuvre originale a été diffusée.