5.3.3 Méthodes de manipulation de l'affichage du document

5.3.3.1 hideAttribute

Cette méthode permet de cacher un attribut affiché.

Les attributs invisibles (en consultation : I, H, et O ; en modification : I, H et R) ne peuvent ni être cachés, ni montrés.

5.3.3.1.1 Arguments

attributeId (string)

nom de l'attribut à cacher

5.3.3.1.2 Retour

Pas de retour

5.3.3.1.3 Exception

Si le nom de l'attribut n'existe pas

5.3.3.1.4 Exemple

window.dcp.document.documentController("hideAttribute", "animal_title");

5.3.3.2 showAttribute

Cette méthode permet de montrer un attribut caché.

Les attributs invisibles (en consultation : I, H, et O ; en modification : I, H et R) ne peuvent ni être cachés, ni montrés.

5.3.3.2.1 Arguments

attributeId (string)

nom de l'attribut à montrer

5.3.3.2.2 Retour

Pas de retour

5.3.3.2.3 Exception

Si le nom de l'attribut n'existe pas

5.3.3.2.4 Exemple

window.dcp.document.documentController("showAttribute", "animal_title");

5.3.3.3 showMessage

Cette méthode permet d'afficher un message à l'utilisateur.

Il se présente dans une notification en haut à droite de l'écran.

5.3.3.3.1 Arguments

message (string|object)

soit une chaine de caractères, soit une structure contenant : type : l'importance du message parmi * info (valeur par défaut), * error, * warning * success * notice message (plein texte) : le contenu du message.

5.3.3.3.2 Retour

Pas de retour

5.3.3.3.3 Exception

Pas d'exception

5.3.3.3.4 Exemple

window.dcp.document.documentController("showMessage", "Bonjour utilisateur");

5.3.3.4 setAttributeErrorMessage

Cette méthode permet d'afficher un message d'erreur à l'utilisateur sous la même forme qu'une contrainte (c'est à dire faisant référence à un attribut).

5.3.3.4.1 Arguments

attributeId (string)

identifiant de l'attribut,

message (string) (plein texte)

contenu du message,

index (int)

numéro de ligne si l'attribut est dans un array.

5.3.3.4.2 Retour

Pas de retour

5.3.3.4.3 Exception

Si le nom de l'attribut n'existe pas

5.3.3.4.4 Exemple

window.dcp.document.documentController("setAttributeErrorMessage", "ba_title", "Le titre est obligatoire");

5.3.3.5 cleanAttributeErrorMessage

Cette méthode permet de supprimer tous les messages d'erreur affichés sur un attribut.

5.3.3.5.1 Arguments

attributeId (string)

identifiant de l'attribut,

index (int)

numéro de ligne si l'attribut est dans un array.

5.3.3.5.2 Retour

Pas de retour.

5.3.3.5.3 Exception

Si le nom de l'attribut n'existe pas.

5.3.3.5.4 Exemple

Supprime tous les messages d'erreur sur l'attribut ba_title.

window.dcp.document.documentController("cleanAttributeErrorMessage", "ba_title");
 

5.3.3.6 selectTab

Cette méthode permet de sélectionner un onglet du document.

Note : les événements attributeBeforeTabSelect et attributeAfterTabSelect sont déclenchés à la fin de la génération.

5.3.3.6.1 Arguments

attributeId (string)

identifiant de l'attribut (onglet) à sélectionner.

5.3.3.6.2 Retour

L'objet jQuery.

5.3.3.6.3 Exception

Si le nom de l'attribut n'existe pas. Si l'attribut n'est pas un onglet.

5.3.3.6.4 Exemple

Affiche l'onglet my_tab.

window.dcp.document.documentController("selectTag", "my_tab");

5.3.3.7 drawTab

Cette méthode permet de forcer la génération du contenu d'un onglet. Par défaut seul un des onglets est produit et affiché. Les autres onglets sont générés que lorsqu'ils sont sélectionnés.

Note : l'événement attributeReady est déclenché à la fin de la génération.

Si l'onglet est déjà généré ou en cours de génération, rien ne se passe.

5.3.3.7.1 Arguments

attributeId (string)

identifiant de l'attribut (onglet) à générer.

5.3.3.7.2 Retour

L'objet jQuery.

5.3.3.7.3 Exception

Si le nom de l'attribut n'existe pas. Si l'attribut n'est pas un onglet.

5.3.3.7.4 Exemple

Prépare la génération de tous les onglets.

window.dcp.document.documentController("addEventListener",
      "ready",
      function (event, documentObject, message) {
          var _this=this;
          var attrs=_this.documentController("getAttributes");
 
          attrs.forEach(function (attr) {
              if (attr.getProperties().type === "tab") {
                  _this.documentController("drawTab", attr.id);
              }
          });
      }
  );