Affichage des messages dans le module de la barre d'état

Vous pouvez afficher des messages dans la barre d'état pour partager des informations importantes avec les utilisateurs.

Pourquoi et quand exécuter cette tâche

Accédez à Ajout d'un module de message pour en savoir plus sur la personnalisation des messages de barre d'état dans le thème simple.

Tous les profils de thème prêts à l'emploi incluent le module status_bar, qui fournit une zone sous l'en-tête pour l'affichage des messages d'erreur, d'avertissement et d'information. La figure suivante présente un exemple de message d'erreur en rouge.

Capture d'écran d'un exemple de message d'erreur en rouge

Procédure

  1. Ajoutez une ligne de JavaScript. Utilisez cette barre d'état dans vos thèmes et modules et les portlets peuvent utiliser cette barre d'état.
    L'exemple suivant présente le code JavaScript StatusMessage :
    i$.fireEvent("/portal/status",[{message: new com.ibm.widgets.StatusMessage
("error", "The specified name is in use. Please enter a unique name.", ""), uid: 'ibmStatusBox'}]);
    i$.fireEvent est la syntaxe recommandée. Si vous utilisez la syntaxe alternative dojo.publish, restructurez ce code pour utiliser la procédure i$.fireEvent.
    1. Le premier argument dans le StatusMessage peuvent être soit "error", "warning" ou "info" pour contrôler l'icône et la couleur de la boîte de message.
    2. Le second argument de StatusMessage est une chaîne représentant le message lui-même devant s'afficher dans la boîte de message.
    3. Le troisième argument de StatusMessage est une chaîne facultative représentant tous les détails supplémentaires sur le message. Les détails ne sont pas présentés à l'utilisateur par défaut, mais uniquement si l'utilisateur clique sur l'icône Afficher les détails pour développer la boîte de message.
  2. Si une erreur provient du serveur, vous pouvez définir un cookie ibm.portal.operations dans la réponse et le client affiche le message lorsque la réponse s'achève. Utilisez le code JSON analysable pour la valeur de chaîne du cookie, tel que :
    ibm.portal.operations.error={"errorType":"error","errorMessage":"The specified name is in use. Please enter a unique name.","errorDetails":""}
  3. Les messages sont effacés automatiquement lors du rechargement de la page. Si vous devez supprimer un ou plusieurs messages du client en utilisant JavaScript, vous pouvez utiliser le code suivant :
    i$.fireEvent("/portal/status/clear", [{message: mymessage, uid: 'ibmStatusBox'}]);
    où mymessage est l'instance StatusMessage que vous avez sauvegardée lors de l'affichage du message. Le code tel que celui de l'exemple suivant est correct également :
    i$.fireEvent("/portal/status/clear", [{message: new com.ibm.widgets.StatusMessage ("error", "The specified name is in use. Please enter a unique name.", ""), uid: 'ibmStatusBox'}]);
    L'événement efface les messages dont le type, le message et les chaînes détaillées StatusMessage correspondent, ce qui évite de réutiliser la même instance StatusMessage réelle.
    Si aucun StatusMessage n'est transmis, il efface tous les messages. Vous pouvez effacer tout avec l'exemple de code suivant :
    i$.fireEvent("/portal/status/clear", [{uid: 'ibmStatusBox'}]);