Javascript wizard

L'objet Javascript wizard permet de gérer un wizard à l'aide d'un script.

Il fournit les méthodes :

Il fournit les attributs :

  • title qui permet de gérer le titre du wizard.
  • description qui permet de gérer la description du wizard.
  • currentPage qui donne une référence à la page wizardpage actuellement affichée.

Vous pouvez trouvez des examples d'utilisation de cet objet Javascript dans le catalogue par défaut d'Akrogen dans usecases-catalog/Components/Script/Wizard.

pageid

Un wizard page est défini par son pageid, autrement dit la description du XML Wizard doit définir pour chacun des élements wizardpages l'attribut pageid : 

<?xml version="1.0"?>
<wizard 
  xmlns="http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul">
  ...
  <!-- Wizard page sequences -->
  <wizardpage pageid="myPageID" 
    uri="..." >

Methode getPageById

Cette méthode permet de récupérer un wizardpage par son pageid. Pour récupérer l'objet Javascript wizardpage de pageid myPageID, vous devez écrire le script suivant : 

  <script type="text/javascript">
    
    var /* wizardpage */ page0 = wizard.getPageById('myPageId');        
    
  </script>

Methode addPage

Cette méthode permet d'ajouter un wizardpage identifié par son pageid. Le deuxième paramètre attendu est l'uri d'un XML component du catalogue. Elle retourne le wizardpage ajouté. Pour ajouter le wizardpage de pageid myPageID, qui fait référence au XML component MyComponent.akgncpt.xml vous devez écrire le script suivant : 

  <script type="text/javascript">
    
    wizard.addPage('myPageId', 'MyComponent.akgncpt.xml');      
    
  </script>

Methode removePage

Cette méthode permet de supprimer un wizardpage par son pageid. Elle retourne le wizardpage supprimé. Pour supprimer le wizardpage de pageid myPageID, vous devez écrire le script suivant : 

  <script type="text/javascript">
    
    wizard.removePage('myPageId');      
    
  </script>

Attribut title

title est un attribut en lecture/écriture. Il est possible de mettre à jour le titre du wizard à l'aide du script : 

  <script type="text/javascript">
  
    wizard.title = "MyTitle";
    
  </script>

Attribut description

description est un attribut en lecture/écriture. Il est possible de mettre à jour le description du wizard à l'aide du script : 

  <script type="text/javascript">
  
    wizard.description = "MyDescription";
    
  </script>

Attribut currentPage

currentPage est un attribut en lecture qui donne une référence à la page wizardpage actuellement affichée : 

  <script type="text/javascript">
  
    var /* wizardpage */ currentWizardPage = wizard.currentPage;
    
  </script>