XML Wizards

Un wizard Akrogen XML Wizard est un fichier XML stocké dans le répertoire Wizards d'un catalogue.

Il est constitué d'une séquence de wizardpage qui fait référence à un XML component du catalogue. Autrement dit un XML Wizard permet d'enchaîner plusieurs XML component dans un même Wizard.

L'écriture XML d'un XML Wizard doit suivre une grammaire XML qui ressemble très fortement à celle de l'écriture d'un Wizard XUL.

Il est possible d'ajouter des scripts pour gérer les wizards pages constituants le Wizard, comme :

  • mettre à jour le titre, la description d'un Wizard page à l'aide d'un script.
  • synchroniser la valeur d'un contrôle XUL d'un Wizard page à l'aide d'une autre valuer d'un contrôle XUL d'un autre wizard page.

Grammaire XML

Un XML wizard suit la grammaire suivante : 

<?xml version="1.0"?>
<wizard 
  xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul">
  <!-- Scripts to execute --> 
  <script type="text/javascript">
    ... Scripts
  </script>
  ...
  <!-- Wizard page sequences -->
  <wizardpage pageid="..." 
    uri="..." >
  <wizardpage pageid="..." 
    uri="..." >
  ...    
  
</wizard>

wizard

L'element racine wizard doit obligatoirement définir le namespace XUL http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul, comme ceci : 

  <wizard 
       xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul">

Il est constitué d'elements :

  • wizardpage qui font références à un XML component du catalogue avec l'attribut uri.
  • script qui sont les scripts qui peuvent être éxécutés :
    • au chargement du wizard.
    • sur les évenements des wizardpage (évenements onpageadvanced,...).

wizardpage

Un element wizardpage permet de référencer un XML component à l'aide de l'attribut uri. Il est identifié par l'attribut pageid (non obligatoire) qui est utilisé dans un script pour récupérer le wizardpage.

Attributs de wizardpage

Nom attributDescriptionObligatoire ?
uriURI du XML component du catalogue. Cette uri est le chemin du XML component dans le catalogue (sans le répertoire Components).Oui
pageidIdentifiant du Wizard page qui est utilisé dans un script pour récupérer le wizardpage à l'aide de la méthode getPageID(pageID) de l'objet wizard.Non
onpageadvancedScript à éxecuter lors d'un clic sur le bouton Next du Wizard Eclipse. Ce script peut être utilisé pour par exemple mettre à jour des valeurs de contrôles XUL d'autres Wizard page avec les valeurs de contrôles XUL du Wizard page courantNon

script

L'élement script contient les scripts (de syntaxe Javascript) à executer. Il doit être déclaré comme ceci : 

  <script type="text/javascript">
  ....
  </script>

Les scripts permettent de gérer les wizardpage du wizard comme le titre, la description du wizardpage ou les valeurs des contrôles XUL du wizardpage.

Pour plus d'informations, veuillez vous référer à la section Wizard & Javascript.