Référence des API
ADOBE® DREAMWEAVER® CS5 & CS5.5
d’
Mentions légales
Mentions légales
Vous trouverez des informations juridiques à l'adresse http://help.adobe.com/fr_FR/legalnotices/index.html.
Dernière mise à jour le 22/6/2011
Sommaire
Chapitre 1 : Introduction
A propos des extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Extension de Dreamweaver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Ressources supplémentaires pour les créateurs d'extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Nouvelles fonctions de Dreamweaver CS5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Conventions utilisées dans ce manuel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Chapitre 2 : API d'E/S des fichiers
A propos des dossiers de configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
A propos de l'API d'E/S des fichiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Chapitre 3 : API HTTP
Fonctionnement de l'API HTTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
L'API HTTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Chapitre 4 : API de Design Notes
Fonctionnement des Design Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
L'API JavaScript de Design Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
L'API C de Design Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
iii
Chapitre 5 : Intégration de Fireworks
L'API FWLaunch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Chapitre 6 : Intégration de Flash
L'API des objets Flash . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Fonctions des panneaux et des boîtes de dialogue de Flash . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Chapitre 7 : Intégration de Photoshop
Fonctionnement des objets dynamiques . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
L'API des objets dynamiques . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Chapitre 8 : API de base de données
Fonctionnement de l'API de base de données . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Fonctions de connexion à une base de données . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Fonctions d'accès à la base de données . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Chapitre 9 : API de connectivité à une base de données
Sélection d'un nouveau type de connexion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Création d'un nouveau type de connexion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
L'API de connexion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Fichier inclus généré . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Fichier de définition pour votre type de connexion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
Sommaire
Chapitre 10 : API d'intégration de commande source
Fonctionnement de l'intégration des commandes source avec Dreamweaver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Ajout d'une fonctionnalité de système de commande source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Fonctions requises de l'API d'intégration de commande source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Fonctions facultatives de l'API d'intégration de commande source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Activateurs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Chapitre 11 : Application
Fonctions relatives aux applications externes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Fonctions globales relatives aux applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Fonctions de communication avec Bridge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Chapitre 12 : Espace de travail
Fonctions d'historique . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Fonctions d'insertion d'objets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Fonctions relatives au clavier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Fonctions relatives aux menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Fonctions de la fenêtre de résultats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Fonctions de bascule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Fonctions relatives aux barres d'outils . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Fonctions relatives aux fenêtres . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Fonctions de la barre d'information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Fonctions des fichiers apparentés . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Fonctions du mode Fractionnement vertical . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Fonctions relatives au fractionnement des codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Fonctions relatives aux barres d'outils du mode Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Fonctions des couleurs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
iv
Chapitre 13 : Site
Fonctions relatives aux rapports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Fonctions relatives aux sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
Chapitre 14 : Document
Fonctions relatives aux conversions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
Fonctions relatives aux commandes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
Fonctions relatives aux manipulations de fichiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
Fonctions relatives à l'ensemble d'un document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
Fonctions relatives aux chemins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
Fonctions relatives à la sélection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
Fonctions de manipulation de chaînes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
Fonctions relatives à la traduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
Fonctions XSLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
Chapitre 15 : Contenu de page
Fonctions du panneau Actifs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
Fonctions relatives aux comportements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
Presse-papiers, fonctions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
Fonctions relatives aux éléments de bibliothèque et aux modèles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
Sommaire
Fonctions du panneau Fragments de code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
Fonctions de modification de widgets Spry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343
Insertion de fonctions relatives aux widgets Spry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
Fonctions de vérification de la compatibilité avec les navigateurs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
Chapitre 16 : Documents dynamiques
Fonctions de composants de serveur . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
Fonctions relatives aux sources de données . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
Fonctions de l'Extension Data Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
Fonctions Live data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
Fonctions relatives au mode En direct . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
Fonctions relatives aux comportements de serveur . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377
Fonctions de modèle de serveur . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
Chapitre 17 : Création
Fonctions relatives aux mises en forme CSS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385
Fonctions relatives aux cadres et aux jeux de cadres . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
Fonctions relatives aux calques et aux cartes d'images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
Fonctions d'environnement de mise en forme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413
Fonctions relatives au mode de Mise en forme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418
Fonctions de gestion de résolution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424
Requête multimédia . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426
Fonctions relatives aux zooms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
Propriétés et fonctions de repère . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431
Fonctions de modification des tableaux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
v
Chapitre 18 : Code
Fonctions de code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
Fonctions relatives à la recherche et au remplacement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
Fonctions de modifications générales . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459
Fonction relative à l'impression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
Fonctions relatives à Quick Tag Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
Fonctions relatives au mode Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
Fonctions du mode Code en direct . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
Fonctions de l'éditeur de balises et de la bibliothèque de balises . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496
Chapitre 19 : Activateurs
Fonctions d'activateur . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
Dernière mise à jour le 22/6/2011
Chapitre 1 : Introduction
Le Guide des API d'Adobe Dreamweaver CS5 décrit les interfaces de programmation d'applications (API) qui vous
permettent d'effectuer diverses tâches de prise en charge lorsque vous développez des extensions Adobe®
Dreamweaver® CS5 et ajoutez des codes de programme à vos pages Web Dreamweaver. Les API comprennent l'API
JavaScript principale, qui permet d'accéder à la plupart des fonctionnalités essentielles de Dreamweaver. Les
fonctionnalités essentielles de Dreamweaver sont à peu près tout ce qui peut être effectué via un menu, et bien plus
encore. Il s'agit aussi de diverses API utilitaires destinées à des tâches aussi courantes que la lecture de fichiers et leur
écriture, le transfert d'informations à l'aide de HTTP et la communication avec Fireworks et Flash.
L'API JavaScript vous permet d'exécuter un large éventail de tâches plus réduites. L'utilisateur exécute nombre de ces
tâches lorsqu'il crée ou modifie des documents Dreamweaver. Ces fonctions d'API sont regroupées selon les parties de
l'interface utilisateur de Dreamweaver auxquelles elles se rapportent. Ainsi, l'API JavaScript comprend les fonctions
relatives à l'espace de travail, aux documents, à la conception, etc. Les fonctions de l'API permettent de réaliser
quelques-unes des tâches suivantes, et bien plus encore :
• Ouverture d'un nouveau document
• Obtention ou définition d'une taille de police
• Recherche de l'occurrence d'une chaîne de recherche dans le code HTML
• Activation de la visibilité d'une barre d'outils
1
A propos des extensions
Ce manuel suppose une bonne maîtrise de Dreamweaver, HTML, XML, de la programmation JavaScript et, le cas
échéant, de la programmation C. Pour rédiger vos propres extensions afin de créer des applications Web, vous devez
connaître les langages de script côté serveur et au moins l'une des plates-formes suivantes : Active Server Pages (ASP),
ASP.NET, PHP: Hypertext Preprocessor (PHP), Adobe ColdFusion ou Java Server Pages (JSP).
Extension de Dreamweaver
Pour en savoir plus sur la plate-forme Dreamweaver et l'API permettant de développer des extensions de
Dreamweaver, voir Extension de Dreamweaver. Le manuel Extension de Dreamweaver décrit les fonctions des API que
Dreamweaver appelle pour implémenter les objets, menus, panneaux flottants, comportements de serveur, etc., qui
composent les diverses fonctionnalités de Dreamweaver. Ces API permettent d'ajouter des objets, des menus, des
panneaux flottants et d'autres fonctions au produit. Extension de Dreamweaver explique également comment
personnaliser Dreamweaver en modifiant et en ajoutant des balises à différents fichiers HTML et XML, de façon à
ajouter des éléments de menus ou des types de documents, etc.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
Introduction
Ressources supplémentaires pour les créateurs d'extensions
Pour entrer en contact avec d'autres développeurs d'extensions, rejoignez le forum de discussion consacré à
l'extensibilité de Dreamweaver. Vous trouverez ce forum à l'adresse
http://www.adobe.com/cfusion/webforums/forum/categories.cfm?forumid=12&catid=190&entercat=y.
Nouvelles fonctions de Dreamweaver CS5
Les nouvelles fonctions suivantes ont été ajoutées à l'API JavaScript de Dreamweaver CS5. Les en-têtes désignent les
chapitres et les sections qui contiennent les nouvelles fonctions :
Documents dynamiques
Les fonctions suivantes ont été ajoutées au chapitre Documents dynamiques.
Fonctions relatives au mode En direct
« dom.setLiveViewFollowsLinks() » à la page 368
2
« dom.getLiveViewFollowsLinks() » à la page 368
« dom.isLiveViewBrowsingHomeURI() » à la page 369
« dreamweaver.findSiteForURI() » à la page 369
« dom.browser.isPageNavigationHistoryEnabled() » à la page 371
« dom.browser.enablePageNavigationHistory() » à la page 371
« dom.browser.getPageNavigationHistoryLength() » à la page 372
« dom.browser.getPageNavigationHistoryPosition() » à la page 372
« dom.browser.goToPageNavigationHistoryPosition() » à la page 372
« dom.browser.getPageNavigationHistoryItem() » à la page 373
« dom.browser.setHomePage() » à la page 373
« dom.browser.getHomePage() » à la page 374
Espace de travail
Les fonctions suivantes ont été ajoutées au chapitre Espace de travail.
Fonctions des fichiers apparentés
« dreamweaver.getRelatedFilesFilter() » à la page 195
« dreamweaver.setRelatedFilesFilter() » à la page 196
« dreamweaver.getQuickRelatedFilesFilterStrings() » à la page 196
« dreamweaver.invokeRelatedFilesCustomFilterDialog() » à la page 196
« dreamweaver.getDynamicRelatedFilesDiscoverySetting() » à la page 197
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
Introduction
« dreamweaver.setDynamicRelatedFilesDiscoverySetting() » à la page 197
« dreamweaver.refreshRelatedFiles() » à la page 198
« dreamweaver.saveAllRelatedFiles() » à la page 198
« dreamweaver.canSaveAllRelatedFiles() » à la page 198
« document.isRelatedFileViewOpen() » à la page 199
« document.getRelatedFiles() » à la page 199
« document.addRelatedFile() » à la page 200
« document.removeRelatedFile() » à la page 201
« document.getDependentFiles() » à la page 201
...et bien d'autres encore.
Document
Les fonctions suivantes ont été ajoutées au chapitre Document.
« DWUri.isValidURI() » à la page 282
3
« DWUri.isAbsolute() » à la page 283
« DWUri.isRelative() » à la page 283
« DWUri.isDirectory() » à la page 283
« DWUri.isHierarchical() » à la page 284
« DWUri.isOfType() » à la page 284
« DWUri.isOfFileType() » à la page 284
...et bien d'autres encore.
Code
Les fonctions suivantes ont été ajoutées au chapitre Code.
« dom.getLiveCodeHighlightsChanges() » à la page 495
« dom.setLiveCodeHighlightsChanges() » à la page 495
...et bien d'autres encore.
Conventions utilisées dans ce manuel
Conventions typographiques
Ce manuel utilise les conventions typographiques suivantes :
• La police de code indique des fragments de code et des constantes d'API, notamment des noms de classe, des noms
de méthodes, des noms de fonctions, des noms de type, des scripts, des instructions SQL et des noms de balises et
d'attributs HTML et XML.
• La police de code en italique identifie les éléments remplaçables dans le code.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
Introduction
• Le symbole de continuation (¬) indique qu'une longue ligne de code a été fractionnée sur deux lignes ou plus. En
raison des limites de marge du format de ce manuel,une ligne de code continue doit ici être coupée. Lorsque vous
copiez les lignes de code, supprimez le symbole de continuation et entrez-les comme une seule ligne.
• Les accolades ({ }) placées avant et après un argument de fonction indiquent que cet argument est facultatif.
• Le nom des fonctions ayant le préfixe dreamweaver.nomfonc peut être abrégé en dw.nomfonc lorsque vous écrivez
le code. Ce manuel utilise le préfixe
Toutefois, dans de nombreux exemples, le préfixe
dreamweaver. complet dans les définitions de fonctions et dans l'index.
dw. est utilisé.
Conventions de dénomination
Ce manuel utilise les conventions de dénomination suivantes :
• Vous — le développeur responsable de la rédaction des extensions
• L'utilisateur — la personne utilisant Dreamweaver
4
Dernière mise à jour le 22/6/2011
Chapitre 2 : API d'E/S des fichiers
Adobe® Dreamweaver® CS5 comprend une bibliothèque partagée C, appelée DWfile, qui donne aux auteurs d'objets,
de commandes, de comportements, de traducteurs de données, de panneaux flottants et d'inspecteurs Propriétés la
possibilité de lire et d'écrire des fichiers sur le système de fichiers local. Ce chapitre décrit l'API d'entrée/sortie des
fichiers et son utilisation.
Pour obtenir des informations générales sur la façon dont les bibliothèques C interagissent avec l'interpréteur
JavaScript dans Dreamweaver, voir « Extensibilité de niveau C » dans le manuel Extension de Dreamweaver.
A propos des dossiers de configuration
Sur les plates-formes Microsoft Windows 2000, Windows XP et Mac OS X, les utilisateurs disposent de leur propre
copie des fichiers de configuration. Lorsque Dreamweaver écrit dans un fichier de configuration, il le fait dans le
dossier Configuration de l'utilisateur. De même, lorsqu'il lit un fichier de configuration, Dreamweaver commence par
rechercher ce fichier dans le dossier Configuration de l'utilisateur, puis dans le dossier Configuration de l'application.
Les fonctions DWfile procèdent de la même manière. En d'autres termes, si une extension lit ou écrit un fichier dans
le dossier Configuration de l'application, elle se reporte aussi au dossier Configuration de l'utilisateur. Pour plus
d'informations sur les dossiers Configuration dans un environnement multiutilisateur, voir Extension de
Dreamweaver.
5
A propos de l'API d'E/S des fichiers
Toutes les fonctions de l'API d'E/S des fichiers sont des méthodes associées à l'objet DWfile.
DWfile.copy()
Disponibilité
Dreamweaver 3.
Description
Cette fonction copie le fichier spécifié vers un nouvel emplacement.
Arguments
originalURL, copyURL
• L'argument originalURL, exprimé sous la forme d'une URL de type file://, représente le fichier que vous souhaitez
copier.
• L'argument copyURL, exprimé sous la forme d'une URL de type file://, représente l'emplacement où vous souhaitez
enregistrer le fichier copié.
Valeurs renvoyées
Valeur booléenne,
true si la copie réussit, false dans le cas contraire.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API d'E/S des fichiers
Exemple
Le code suivant copie un fichier appelé myconfig.cfg vers myconfig_backup.cfg :
var fileURL = "file:///c|/Config/myconfig.cfg";
var newURL ="file:///c|/Config/myconfig_backup.cfg";
DWfile.copy(fileURL, newURL);
DWfile.createFolder()
Disponibilité
Dreamweaver 2.
Description
Cette fonction crée un dossier à l'emplacement spécifié.
Arguments
folderURL
• L'argument folderURL, exprimé sous la forme d'une URL de type file://, représente l'emplacement dans lequel vous
souhaitez créer le dossier.
6
Valeurs renvoyées
Valeur booléenne :
true si le dossier est bien créé, false en cas d'échec.
Exemple
Le code suivant tente de créer un dossier nommé tempFolder à la racine du lecteur C et affiche un message
d'avertissement indiquant si l'opération a réussi.
var folderURL = "file:///c|/tempFolder";
if (DWfile.createFolder(folderURL)){
alert("Created " + folderURL);
}else{
alert("Unable to create " + folderURL);
}
DWfile.exists()
Disponibilité
Dreamweaver 2.
Description
Cette fonction vérifie l'existence du fichier spécifié.
Arguments
fileURL
• L'argument fileURL, exprimé sous la forme d'une URL de type file://, représente le fichier requis.
Valeurs renvoyées
Valeur booléenne :
true si le fichier existe, false dans le cas contraire.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API d'E/S des fichiers
Exemple
Le code suivant recherche le fichier mydata.txt et affiche un message d'avertissement indiquant à l'utilisateur si le
fichier existe :
var fileURL = "file:///c|/temp/mydata.txt";
if (DWfile.exists(fileURL)){
alert(fileURL + " exists!");
}else{
alert(fileURL + " does not exist.");
}
DWfile.getAttributes()
Disponibilité
Dreamweaver 2.
Description
Cette fonction obtient les attributs du fichier ou dossier spécifié.
Arguments
fileURL
7
• L'argument fileURL, exprimé sous la forme d'une URL de type file://, représente le fichier ou dossier dont vous
souhaitez obtenir les attributs.
Valeurs renvoyées
Chaîne représentant les attributs du fichier ou du dossier spécifié. Si le fichier ou le dossier n'existe pas, cette fonction
renvoie la valeur
null. Les caractères suivants de la chaîne représentent les attributs :
• R signifie lecture seule.
• D signifie dossier.
• H signifie masqué.
• S indique un fichier ou dossier système.
Exemple
Le code suivant obtient les attributs du fichier mydata.txt et affiche un message d'avertissement si le fichier est en
lecture seule :
var fileURL = "file:///c|/temp/mydata.txt";
var str = DWfile.getAttributes(fileURL);
if (str && (str.indexOf("R") != -1)){
alert(fileURL + " is read only!");
}
DWfile.getModificationDate()
Disponibilité
Dreamweaver 2.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API d'E/S des fichiers
Description
Cette fonction renvoie l'heure à laquelle le fichier a été modifié pour la dernière fois.
Arguments
fileURL
• L'argument fileURL, exprimé sous la forme d'une URL de type file://, représente le fichier dont vous vérifiez l'heure
de la dernière modification.
Valeurs renvoyées
Chaîne qui contient un nombre hexadécimal représentant le nombre d'unités de temps écoulées depuis une base de
temps donnée. La signification exacte des unités de temps et de la base de temps dépend de la plate-forme ; sous
Windows, par exemple, une unité de temps est égale à 100 ns et la base de temps est le 1 janvier 1600.
Exemple
Comme la valeur renvoyée par cette fonction n'est pas une date et une heure identifiables et qu'elle dépend de la plateforme employée, il est utile d'appeler la fonction deux fois pour comparer les valeurs renvoyées. L'exemple de code
suivant renvoie les dates de modification des fichiers file1.txt et file2.txt et affiche un message d'avertissement
indiquant le fichier le plus récent :
8
var file1 = "file:///c|/temp/file1.txt";
var file2 = "file:///c|/temp/file2.txt";
var time1 = DWfile.getModificationDate(file1);
var time2 = DWfile.getModificationDate(file2);
if (time1 == time2){
alert("file1 and file2 were saved at the same time");
}else if (time1 < time2){
alert("file1 older that file2");
}else{
alert("file1 is newer than file2");
}
DWfile.getCreationDate()
Disponibilité
Dreamweaver 4.
Description
Cette fonction renvoie l'heure à laquelle le fichier a été créé.
Arguments
fileURL
• L'argument fileURL, exprimé sous la forme d'une URL de type file://, représente le fichier dont vous vérifiez l'heure
de création.
Valeurs renvoyées
Chaîne qui contient un nombre hexadécimal représentant le nombre d'unités de temps écoulées depuis une base de
temps donnée. La signification exacte des unités de temps et de la base de temps dépend de la plate-forme ; sous
Windows, par exemple, une unité de temps est égale à 100 ns et la base de temps est le 1 janvier 1600.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API d'E/S des fichiers
Exemple
Vous pouvez appeler cette fonction ainsi que la
DWfile.getModificationDate() pour un fichier afin de comparer
les dates de modification et de création :
var file1 = "file:///c|/temp/file1.txt";
var time1 = DWfile.getCreationDate(file1);
var time2 = DWfile.getModificationDate(file1);
if (time1 == time2){
alert("file1 has not been modified since it was created");
}else if (time1 < time2){
alert("file1 was last modified on " + time2);
}
DWfile.getCreationDateObj()
Disponibilité
Dreamweaver MX.
Description
Cette fonction obtient l'objet JavaScript représentant l'heure de création du fichier.
9
Arguments
fileURL
• L'argument fileURL, exprimé sous la forme d'une URL de type file://, représente le fichier dont vous vérifiez l'heure
de création.
Valeurs renvoyées
Obtient un objet
Date JavaScript représentant la date et l'heure de création du fichier spécifié.
DWfile.getModificationDateObj()
Disponibilité
Dreamweaver MX.
Description
Cette fonction obtient l'objet
Arguments
fileURL
• L'argument fileURL, exprimé sous la forme d'une URL de type file://, représente le fichier dont vous vérifiez l'heure
de modification la plus récente.
Date JavaScript représentant l'heure de la dernière modification du fichier.
Valeurs renvoyées
Obtient un objet
Date JavaScript représentant la date et l'heure de la dernière modification du fichier spécifié.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API d'E/S des fichiers
DWfile.getSize()
Disponibilité
Dreamweaver MX.
Description
Cette fonction obtient la taille du fichier spécifié.
Arguments
fileURL
• L'argument fileURL, exprimé sous la forme d'une URL de type file://, représente le fichier dont vous vérifiez la taille.
Valeurs renvoyées
Nombre entier qui représente la taille réelle du fichier spécifié, exprimée en octets.
DWfile.listFolder()
10
Disponibilité
Dreamweaver 2.
Description
Cette fonction obtient une liste du contenu du dossier spécifié.
Arguments
folderURL, {constraint}
• L'argument folderURL est le dossier dont vous souhaitez obtenir le contenu, exprimé sous la forme d'une URL de
type file:// et d'un masque de fichier facultatif composé de caractères génériques. Les caractères génériques valides
sont les astérisques (*), qui représentent un ou plusieurs caractères, et les points d'interrogation (?), qui
représentent un seul caractère.
• L'argument constraint, s'il est fourni, doit être soit "files" (renvoyer uniquement les fichiers), soit
"directories" (renvoyer uniquement les dossiers). Si cet argument n'est pas spécifié, la fonction renvoie aussi
bien des fichiers que des dossiers.
Valeurs renvoyées
Tableau de chaînes représentant le contenu du dossier.
Exemple
Le code suivant obtient une liste de tous les fichiers texte (TXT) du dossier C:/Temp et affiche la liste dans un message
d'avertissement.
var folderURL = "file:///c|/temp";
var fileMask = "*.txt";
var list = DWfile.listFolder(folderURL + "/" + fileMask, "files");
if (list){
alert(folderURL + " contains: " + list.join("\n"));
}
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API d'E/S des fichiers
DWfile.read()
Disponibilité
Dreamweaver 2.
Description
Cette fonction lit le contenu du fichier spécifié dans une chaîne.
Arguments
fileURL
• L'argument fileURL, exprimé sous la forme d'une URL de type file://, représente le fichier que vous souhaitez lire.
Valeurs renvoyées
Soit une chaîne indiquant le contenu du fichier, soit la valeur
Exemple
Le code suivant lit le fichier mydata.txt et, s'il réussit, affiche un message d'avertissement renfermant le contenu du
fichier :
null si la lecture échoue.
11
var fileURL = "file:///c|/temp/mydata.txt";
var str = DWfile.read(fileURL);
if (str){
alert(fileURL + " contains: " + str);
}
DWfile.remove()
Disponibilité
Dreamweaver 3.
Description
Cette fonction permet de supprimer le fichier spécifié.
Arguments
fileURL
• L'argument fileURL, exprimé sous la forme d'une URL de type file://, représente le fichier que vous souhaitez
supprimer.
Valeurs renvoyées
Valeur booléenne,
true si l'opération réussit, false dans le cas contraire.
Exemple
L'exemple suivant utilise la fonction
seule et la fonction
confirm() pour afficher à l'utilisateur une boîte de dialogue de type Oui/Non :
DWfile.getAttributes() pour déterminer si le fichier est accessible en lecture
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API d'E/S des fichiers
function deleteFile(){
var delAnyway = false;
var selIndex = document.theForm.menu.selectedIndex;
var selFile = document.theForm.menu.options[selIndex].value;
if (DWfile.getAttributes(selFile).indexOf('R') != -1){
delAnyway = confirm('This file is read-only. Delete anyway?');
if (delAnyway){
DWfile.remove(selFile);
}
}
}
DWfile.setAttributes()
Disponibilité
Dreamweaver MX.
Description
Cette fonction définit les attributs système d'un fichier donné.
12
Arguments
fileURL, strAttrs
• L'argument fileURL, exprimé sous la forme d'une URL de type file://, identifie le fichier dont vous définissez les
attributs.
• L'argument strAttrs spécifie les attributs système du fichier identifié par l'argument fileURL. Le tableau suivant
décrit les valeurs d'attribut valides et leur signification :
Valeur d'attribut Description
R
W
H
V
Les valeurs acceptables pour la chaîne
N'utilisez pas
R et W conjointement, car ces attributs s'excluent l'un l'autre. Si vous les associez, R perd tout son sens
et le fichier est défini comme étant accessible en écriture (
aussi l'un l'autre. Si vous les associez,
Si vous spécifiez l'attribut
H ou V sans indiquer d'attribut de lecture/écriture R ou W, l'attribut de lecture/écriture
existant pour le fichier reste inchangé. De même, si vous spécifiez l'attribut
visibilité
H ou V, l'attribut de visibilité existant pour le fichier reste inchangé.
Lecture seule
Accessible en écriture (annule R)
Masqué
Visible (annule H)
strAttrs sont R, W, H, V, RH, RV, WH ou WV.
W). N'utilisez pas H et V conjointement, car ils s'excluent
H perd tout son sens et le fichier est défini comme étant visible (V).
R ou W sans spécifier un attribut de
Valeurs renvoyées
Aucune.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API d'E/S des fichiers
DWfile.write()
Disponibilité
Dreamweaver 2.
Description
Cette fonction écrit la chaîne spécifiée dans le fichier spécifié. Si le fichier spécifié n'existe pas, il est créé.
Arguments
fileURL, text, {mode}
• L'argument fileURL, exprimé sous la forme d'une URL de type file://, représente le fichier dans lequel vous écrivez
une chaîne.
Remarque : Si le chemin d'accès contient des espaces, cette fonction n'écrira pas les fichiers.
• L'argument text indique la chaîne que la fonction doit écrire.
• L'argument mode, s'il est fourni, doit être append. Si cet argument est omis, la chaîne écrase le contenu du fichier.
Valeurs renvoyées
Valeur booléenne :
true si l'écriture de la chaîne dans le fichier a réussi et false dans le cas contraire.
13
Exemple
Le code suivant tente d'écrire la chaîne
l'opération d'écriture réussit. Il essaie ensuite d'annexer la chaîne
xxx dans le fichier mydata.txt et affiche un message d'avertissement si
aaa au fichier et affiche un deuxième message
d'avertissement si cette opération réussit. Après l'exécution de ce script, le fichier mydata.txt contient uniquement le
xxxaaa.
texte
var fileURL = "file:///c|/temp/mydata.txt";
if (DWfile.write(fileURL, "xxx")){
alert("Wrote xxx to " + fileURL);
}
if (DWfile.write(fileURL, "aaa", "append")){
alert("Appended aaa to " + fileURL);
}
Dernière mise à jour le 22/6/2011
Chapitre 3 : API HTTP
Les extensions ne fonctionnent pas uniquement dans le système de fichiers local. Adobe® Dreamweaver® permet
d'échanger des informations avec un serveur Web via le protocole HTTP (Hypertext Transfer Protocol). Ce chapitre
décrit l'API HTTP et son utilisation.
Fonctionnement de l'API HTTP
Toutes les fonctions de l'API HTTP sont des méthodes associées à l'objet MMHttp. La plupart d'entre elles acceptent au
moins une URL comme argument et la plupart renvoient un objet. Le port par défaut pour les arguments URL est 80.
Pour spécifier un port différent, ajoutez deux points (:) et le numéro de port à la suite de l'URL, comme dans l'exemple
suivant :
MMHttp.getText("http://www.myserver.com:8025");
Pour les fonctions qui renvoient un objet, cet objet possède deux propriétés : statusCode et data.
14
La propriété
• 200 : Etat OK
• 400 : Demande inintelligible
• 404 : URL demandée introuvable
• 405 : Le serveur ne prend pas en charge la méthode demandée
• 500 : Erreur de serveur inconnue
• 503 : Capacité du serveur atteinte
Pour obtenir une liste complète des codes d'état pour votre serveur, consultez votre fournisseur d'accès Internet ou
votre administrateur système.
La valeur de la propriété
individuelles.
Les fonctions qui renvoient un objet ont également une version de rappel (« callback »). Les fonctions de rappel
permettent aux autres fonctions de s'exécuter pendant que le serveur Web traite une requête HTTP. Ceci est utile si
vous effectuez plusieurs requêtes HTTP à partir de Dreamweaver. La version de rappel d'une fonction transmet
directement son ID et sa valeur de renvoi à la fonction spécifiée sous forme de premier argument.
statusCode indique l'état de l'opération ; les valeurs possibles sont notamment :
data varie selon la fonction ; les valeurs possibles sont spécifiées dans les listes des fonctions
L'API HTTP
Cette section présente en détail les fonctions qui sont des méthodes de l'objet MMHttp.
MMHttp.clearServerScriptsFolder()
Disponibilité
Dreamweaver MX.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API HTTP
Description
Supprime le dossier _mmServerScripts (et tous ses fichiers) sous le dossier racine du site en cours, qu'il soit local ou
distant. Le dossier _mmServerScripts se trouve dans le dossier Configuration/Connections/Scripts/server-
model/_mmDBScripts.
Arguments
serverScriptsfolder
• L'argument serverScriptsfolder est une chaîne qui nomme un dossier donné, en liaison avec le dossier Configuration
du serveur d'application, à partir duquel vous pouvez extraire et supprimer les scripts de serveur.
Valeurs renvoyées
Un objet représentant la réponse du serveur. La propriété
scripts supprimés. Si une erreur se produit, Dreamweaver la consigne dans la propriété
data de cet objet est une chaîne englobant le contenu des
statusCode de l'objet renvoyé.
Exemple
Le code suivant, dans un fichier de commandes de menu du dossier Configuration/Menus, supprime tous les fichiers
du dossier _mmServerScripts lorsque celle-ci est appelée depuis un menu :
<!-- MENU-LOCATION=NONE -->
<html>
<head>
<TITLE>Clear Server Scripts</TITLE>
<SCRIPT SRC="ClearServerScripts.js"></SCRIPT>
<SCRIPT LANGUAGE="javascript">
</SCRIPT>
<body onLoad="MMHttp.clearServerScriptsFolder()">
</body>
</html>
15
MMHttp.clearTemp()
Description
Cette fonction supprime tous les fichiers du dossier Configuration/Temp situé dans le dossier de l'application
Dreamweaver.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Exemple
Le code suivant, lorsqu'il est enregistré dans un fichier du dossier Configuration/Shutdown, supprime tous les fichiers
du dossier Configuration/Temp lorsque l'utilisateur quitte Dreamweaver :
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API HTTP
<html>
<head>
<title>Clean Up Temp Files on Shutdown</title>
</head>
<body onLoad="MMHttp.clearTemp()">
</body>
</html>
MMHttp.getFile()
Description
Cette fonction obtient le fichier situé à l'URL spécifiée et l'enregistre dans le dossier Configuration/Temp situé dans le
dossier de l'application Dreamweaver. Dreamweaver crée automatiquement des sous-dossiers qui reproduisent la
structure de dossiers du serveur ; par exemple, si le fichier spécifié est dans
www.dreamcentral.com/people/index.html, Dreamweaver enregistre le fichier index.html dans le sous-dossier People
du dossier www.dreamcentral.com.
Arguments
URL, {prompt}, {saveURL}, {titleBarLabel}
16
• L'argument URL est une URL absolue sur un serveur Web ; si http:// n'est pas indiqué dans l'URL, Dreamweaver
considère qu'il s'agit du protocole HTTP.
• L'argument facultatif prompt est une valeur booléenne spécifiant s'il faut inviter l'utilisateur à enregistrer le fichier.
Si saveURL est en dehors du dossier Configuration/Temp, une valeur de prompt égale à
false n'est pas prise en
compte pour des raisons de sécurité.
• L'argument facultatif saveURL est l'emplacement sur le disque dur de l'utilisateur où le fichier doit être enregistré,
exprimé sous la forme d'une URL de type file://. Si l'argument prompt a pour valeur
true ou si saveURL est en
dehors du dossier Configuration/Temp, l'utilisateur peut remplacer saveURL dans la boîte de dialogue
d'enregistrement.
• L'argument facultatif titleBarLabel est le libellé qui doit figurer dans la barre de titre de la boîte de dialogue
d'enregistrement.
Valeurs renvoyées
Un objet représentant la réponse du serveur. La propriété
où le fichier a été enregistré, exprimé sous la forme d'une URL de type file://. Normalement, la propriété
data de cet objet est une chaîne contenant l'emplacement
statusCode
de l'objet contient le code d'état envoyé par le serveur. Toutefois, si une erreur de disque se produit lors de
l'enregistrement du fichier sur le lecteur local, la propriété
statusCode contient un entier représentant l'un des codes
d'erreur suivants en cas d'échec de l'opération :
• 1 : Erreur inconnue
• 2 : Fichier introuvable
• 3 : Chemin non valide
• 4 : La limite du nombre de fichiers ouverts est atteinte
• 5 : Accès refusé
• 6 : Identificateur de fichier non valide
• 7 : Impossible de supprimer le répertoire de travail en cours
• 8 : Plus d'entrées de dossier
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API HTTP
• 9 : Erreur lors de la définition du pointeur de fichier
• 10 : Erreur matérielle
• 11 : Violation de partage
• 12 : Violation de verrouillage
• 13 : Disque saturé
• 14 : Fin du fichier atteinte
Exemple
Le code suivant obtient un fichier HTML, enregistre tous les fichiers dans le dossier Configuration/Temp, puis ouvre
la copie locale du fichier HTML dans un navigateur :
var httpReply = MMHttp.getFile("http://www.dreamcentral.com/people/profiles/scott.html",
false);
if (Boolean == 200){
var saveLoc = httpReply.data;
dw.browseDocument(saveLoc);
}
17
MMHttp.getFileCallback()
Description
Cette fonction obtient le fichier situé à l'URL spécifiée, l'enregistre dans le dossier Configuration/Temp du dossier de
l'application Dreamweaver, puis appelle la fonction spécifiée avec l'ID et le résultat de la requête. Lorsque le fichier est
enregistré localement, Dreamweaver crée automatiquement des sous-dossiers qui reproduisent la structure de dossiers
du serveur ; par exemple, si le fichier spécifié est dans www.dreamcentral.com/people/index.html, Dreamweaver
enregistre le fichier index.html dans le sous-dossier People du dossier www.dreamcentral.com.
Arguments
callbackFunction, URL, {prompt}, {saveURL}, {titleBarLabel}
• L'argument callbackFunction est le nom de la fonction JavaScript à appeler lorsque la requête HTTP est terminée.
• L'argument URL est une URL absolue sur un serveur Web ; si http:// n'est pas indiqué dans l'URL, Dreamweaver
considère qu'il s'agit du protocole HTTP.
• L'argument facultatif prompt est une valeur booléenne spécifiant s'il faut inviter l'utilisateur à enregistrer le fichier.
Si l'argument saveURL spécifie un emplacement en dehors du dossier Configuration/Temp, une valeur de prompt
false n'est pas prise en compte pour des raisons de sécurité.
égale à
• L'argument facultatif saveURL est l'emplacement sur le disque dur de l'utilisateur où le fichier doit être enregistré,
exprimé sous la forme d'une URL de type file://. Si l'argument prompt a pour valeur
dehors du dossier Configuration/Temp, l'utilisateur peut remplacer saveURL dans la boîte de dialogue
d'enregistrement.
• L'argument facultatif titleBarLabel est le libellé qui doit figurer dans la barre de titre de la boîte de dialogue
d'enregistrement.
true ou si saveURL est en
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API HTTP
Valeurs renvoyées
Un objet représentant la réponse du serveur. La propriété
où le fichier a été enregistré, exprimé sous la forme d'une URL de type file://. Normalement, la propriété
data de cet objet est une chaîne contenant l'emplacement
statusCode
de l'objet contient le code d'état envoyé par le serveur. Toutefois, si une erreur disque se produit lors de
l'enregistrement du fichier sur le lecteur local, la propriété
statusCode contient un nombre entier représentant un
code d'erreur. Voir « MMHttp.getFile() » à la page 16 pour une liste des codes d'erreur possibles.
MMHttp.getText()
Disponibilité
Dreamweaver UltraDev 4, amélioré dans Dreamweaver MX.
Description
Extrait le contenu du document situé à l'URL spécifiée.
Arguments
URL, {serverScriptsFolder}
• L'argument URL est une URL absolue sur un serveur Web. Si http:// n'est pas indiqué dans l'URL, Dreamweaver
considère qu'il s'agit du protocole HTTP.
• L'argument serverScriptsFolder est une chaîne facultative qui nomme un dossier spécifique, lié au dossier
Configuration du serveur d'application, à partir duquel vous souhaitez extraire les scripts de serveur. Pour extraire
les scripts, Dreamweaver utilise le protocole de transfert approprié (par exemple, FTP, WebDAV ou Remote File
System). Dreamweaver copie ces fichiers dans le sous-dossier _mmServerScripts dans le dossier racine du site en
cours.
Si une erreur se produit, Dreamweaver la consigne dans la propriété
statusCode de l'objet renvoyé.
18
MMHttp.getTextCallback()
Disponibilité
Dreamweaver UltraDev 4, amélioré dans Dreamweaver MX.
Description
Extrait le contenu du document situé à l'URL spécifiée et le transmet à la fonction spécifiée.
Arguments
callbackFunc, URL, {serverScriptsFolder}
• L'argument callbackFunc est la fonction JavaScript à appeler lorsque la requête HTTP est terminée.
• L'argument URL est une URL absolue sur un serveur Web ; si http:// n'est pas indiqué dans l'URL, Dreamweaver
considère qu'il s'agit du protocole HTTP.
• L'argument serverScriptsFolder est une chaîne facultative qui nomme un dossier spécifique, lié au dossier
Configuration du serveur d'application, à partir duquel vous souhaitez extraire les scripts de serveur. Pour extraire
les scripts, Dreamweaver utilise le protocole de transfert approprié (par exemple, FTP, WebDAV ou Remote File
System). Dreamweaver extrait ces fichiers et les transmet à la fonction identifiée par callbackFunc.
Si une erreur se produit, Dreamweaver MX la consigne dans la propriété
Dernière mise à jour le 22/6/2011
statusCode de l'objet renvoyé.
RÉFÉRENCE DES API DE DREAMWEAVER
API HTTP
MMHttp.postText()
Disponibilité
Dreamweaver UltraDev 4, amélioré dans Dreamweaver MX.
Description
Exécute un envoi HTTP des données définies à l'URL spécifiée. En règle générale, les données associées à une opération
d'envoi se présentent sous la forme de texte codé en formulaire, mais il peut s'agir de tout type de données que le
serveur peut accepter.
Arguments
URL, dataToPost, {contentType}, {serverScriptsFolder}
• L'argument URL est une URL absolue sur un serveur Web ; si http:// n'est pas indiqué dans l'URL, Dreamweaver
considère qu'il s'agit du protocole HTTP.
• L'argument dataToPost représente les données à envoyer. Si le troisième argument est "application/x-www-
form-urlencoded" ou s'il n'est pas spécifié, dataToPost doit être codé en formulaire conformément à la section
8.2.1 de la spécification RFC 1866 (disponible à l'adresse www.faqs.org/rfcs/rfc1866.html).
• L'argument facultatif contentType est le type de contenu des données à envoyer. S'il n'est pas spécifié, il prend par
défaut la valeur
• L'argument serverScriptsFolder est une chaîne facultative qui nomme un dossier spécifique, lié au dossier
Configuration du serveur d'application, vers lequel vous souhaitez envoyer les données. Pour envoyer les données,
Dreamweaver utilise le protocole de transfert approprié (par exemple, FTP, WebDAV ou Remote File System).
Si une erreur se produit, Dreamweaver la consigne dans la propriété
"application/x-www-form-urlencoded".
statusCode de l'objet renvoyé.
19
Exemple
Dans l'exemple suivant d'appel de la fonction
MMHttp.postText(), supposons qu'un développeur a placé le fichier
myScripts.cfm dans un dossier nommé DeployScripts, qui se trouve dans le dossier Configuration sur l'ordinateur
local :
MMHttp.postText(
"http://ultraqa8/DeployScripts/myScripts.cfm",
"arg1=Foo",
"application/x-www-form-urlencoded",
"Configuration/DeployScripts/"
)
Voici ce qui se produit lorsque Dreamweaver effectue cet appel de fonction :
1 Le fichier myScripts.cfm du dossier Configuration/DeployScripts de l'ordinateur local est copié dans un autre
dossier nommé DeployScripts, qui constitue un sous-dossier du dossier racine du site Web ultraqa8. Pour déployer
les fichiers, Dreamweaver utilise le protocole spécifié dans les propriétés de configuration du site.
2 Dreamweaver utilise le protocole HTTP pour envoyer les données arg1=Foo vers le serveur Web.
3
En réponse à la requête d'envoi, le serveur Web sur ultraqa8 exécute le script myScripts.cfm à l'aide des données arg1.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API HTTP
MMHttp.postTextCallback()
Disponibilité
Dreamweaver UltraDev 4, amélioré dans Dreamweaver MX.
Description
Exécute un envoi HTTP du texte à l'URL spécifiée et transmet la réponse du serveur à la fonction spécifiée. En règle
générale, les données associées à une opération d'envoi se présentent sous la forme de texte codé en formulaire, mais
il peut s'agir de tout type de données que le serveur peut accepter.
Arguments
callbackFunc, URL, dataToPost, {contentType}, {serverScriptsFolder}
• L'argument callbackFunc est le nom de la fonction JavaScript à appeler lorsque la requête HTTP est terminée.
• L'argument URL est une URL absolue sur un serveur Web ; si http:// n'est pas indiqué dans l'URL, Dreamweaver
considère qu'il s'agit du protocole HTTP.
• L'argument dataToPost représente les données à envoyer. Si le troisième argument est "application/x-www-
form-urlencoded" ou s'il n'est pas spécifié, data doit être codé en formulaire conformément à la section 8.2.1 de
la spécification RFC 1866 (disponible à l'adresse www.faqs.org/rfcs/rfc1866.html).
• L'argument facultatif contentType correspond au type de contenu des données à envoyer. S'il n'est pas spécifié, il
prend par défaut la valeur
• L'argument serverScriptsFolder est une chaîne facultative. Il nomme un dossier donné, en liaison avec le dossier
Configuration du serveur d'application sur lequel vous voulez envoyer les données. Pour envoyer les données,
Dreamweaver utilise le protocole de transfert approprié (par exemple, FTP, WebDAV ou Remote File System).
Dreamweaver extrait ces données et les transmet à la fonction identifiée par callbackFunc.
Si une erreur se produit, Dreamweaver la consigne dans la propriété
"application/x-www-form-urlencoded".
statusCode de l'objet renvoyé.
20
Dernière mise à jour le 22/6/2011
Chapitre 4 : API de Design Notes
Adobe® Dreamweaver® , Adobe® Fireworks® et Adobe® Flash® offrent aux concepteurs et développeurs Web une méthode
permettant de stocker et de récupérer des informations supplémentaires sur les documents. Ces informations sont
stockées dans des fichiers baptisés « Design Notes ». Il peut s'agir d'informations supplémentaires sur les documents,
comme des commentaires de relecture, des notes de modification ou le fichier source d'une image GIF ou JPEG.
Pour plus d'informations sur l'utilisation de la fonctionnalité Design Notes dans Dreamweaver, consultez le manuel
Utilisation de Dreamweaver.
Fonctionnement des Design Notes
Chaque fichier Design Notes stocke des informations relatives à un seul document. Si un fichier Design Notes est
associé à un ou plusieurs documents dans un dossier, Dreamweaver crée un sous-dossier _notes pour y stocker les
fichiers Design Notes. Le dossier _notes et les fichiers Design Notes qu'il contient ne sont pas visibles dans la fenêtre
Site, mais ils s'affichent dans le Finder Macintosh ou dans l'Explorateur Windows. Un nom de fichier Design Notes est
composé du nom du fichier principal suivi de l'extension .mno. Par exemple, le fichier Design Notes associé à
avocado8.gif est avocado8.gif.mno.
21
Les fichiers Design Notes sont des fichiers XML stockant des informations sous la forme d'une série de paires
clé/valeur. La clé décrit le type des informations stockées et la valeur représente les informations. Les clés sont limitées
à 64 caractères.
L'exemple suivant illustre le fichier Design Notes associé au fichier foghorn.gif.mno :
<?xml version="1.0" encoding="iso-8859-1" ?>
<info>
<infoitem key="FW_source" value="file:///C|sites/dreamcentral/images/sourceFiles/¬
foghorn.png" />
<infoitem key="Author" value="Heidi B." />
<infoitem key="Status" value="Final draft, approved by Jay L." />
</info>
L'API JavaScript de Design Notes
Toutes les fonctions de l'API JavaScript de Design Notes sont des méthodes associées à l'objet MMNotes. MMNotes
est une bibliothèque C partagée qui permet aux auteurs d'extensions de lire et d'écrire dans les fichiers Design Notes.
Tout comme la bibliothèque partagée DWfile, MMNotes comprend une API JavaScript qui permet d'appeler les
fonctions. Ces fonctions sont appelées à partir d'objets, de commandes, de comportements, de panneaux flottants,
d'inspecteurs Propriétés et de traducteurs de données dans la bibliothèque. La bibliothèque partagée MMNotes peut
être utilisée indépendamment de Dreamweaver, que celui-ci soit installé ou non.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de Design Notes
MMNotes.close()
Description
Cette fonction ferme le fichier Design Notes spécifié et enregistre les modifications éventuelles. Si toutes les paires
clé/valeur ont été supprimées, Dreamweaver supprime le fichier Design Notes. S'il s'agit du dernier fichier Design
Notes dans le dossier _notes, Dreamweaver supprime également le dossier.
22
Remarque : Appelez toujours la fonction
Dreamweaver écrive dans le fichier.
Arguments
fileHandle
MMNotes.close() une fois le travail sur les Design Notes terminé, afin que
• L'argument fileHandle est l'identificateur de fichier renvoyé par la fonction MMNotes.open().
Valeurs renvoyées
Aucune.
Exemple
Voir « MMNotes.set() » à la page 26.
MMNotes.filePathToLocalURL()
Description
Cette fonction convertit le chemin d'accès du lecteur local spécifié en une URL de type file://.
Arguments
drivePath
• L'argument drivePath est une chaîne contenant le chemin d'accès complet du lecteur.
Valeurs renvoyées
Une chaîne contenant l'URL de type file:// du fichier spécifié.
Exemple
Un appel à la fonction
"file:///c|sites/webdev/index.htm".
MMNotes.filePathToLocalURL('C:/sites/webdev/index.htm') renvoie
MMNotes.get()
Description
Cette fonction obtient la valeur de la clé spécifiée dans le fichier Design Notes indiqué.
Arguments
fileHandle, keyName
• L'argument fileHandle est l'identificateur de fichier renvoyé par MMNotes.open().
• L'argument keyName est une chaîne contenant le nom de la clé.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de Design Notes
Valeurs renvoyées
Une chaîne contenant la valeur de la clé.
Exemple
Voir « MMNotes.getKeys() » à la page 23.
MMNotes.getKeyCount()
Description
Cette fonction obtient le nombre de paires clé/valeur du fichier Design Notes spécifié.
Arguments
fileHandle
• L'argument fileHandle est l'identificateur de fichier renvoyé par la fonction MMNotes.open().
Valeurs renvoyées
Un nombre entier représentant le nombre de paires clé/valeur du fichier Design Notes spécifié.
23
MMNotes.getKeys()
Description
Cette fonction renvoie une liste de toutes les clés d'un fichier Design Notes.
Arguments
fileHandle
• L'argument fileHandle est l'identificateur de fichier renvoyé par la fonction MMNotes.open().
Valeurs renvoyées
Un tableau de chaînes, chacune d'elles contenant le nom d'une clé.
Exemple
Le code suivant peut être utilisé dans un panneau flottant personnalisé afin d'afficher les informations Design Notes
relatives au document actif :
var noteHandle = MMNotes.open(dw.getDocumentDOM().URL);
var theKeys = MMNotes.getKeys(noteHandle);
var noteString = "";
var theValue = "";
for (var i=0; i < theKeys.length; i++){
theValue = MMNotes.get(noteHandle,theKeys[i]);
noteString +=0theKeys[i] + " = " theValue + "\n";
}
document.theForm.bigTextField.value = noteString;
// always close noteHandle
MMNotes.close(noteHandle);
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de Design Notes
MMNotes.getSiteRootForFile()
Description
Cette fonction détermine la racine du site pour le fichier Design Notes spécifié.
Arguments
fileURL
• L'argument fileURL, exprimé sous la forme d'une URL de type file://, est le chemin d'un fichier local.
Valeurs renvoyées
Une chaîne contenant le chemin du dossier racine local pour le site, exprimé sous la forme d'une URL de type file://,
ou une chaîne vide si Dreamweaver n'est pas installé ou si le fichier Design Notes se trouve en dehors de tout site défini
par Dreamweaver. Cette fonction recherche tous les sites définis dans Dreamweaver.
MMNotes.getVersionName()
Description
Cette fonction renvoie le nom de version de la bibliothèque partagée MMNotes indiquant l'application qui l'a
implémentée.
24
Arguments
Aucun.
Valeurs renvoyées
Une chaîne contenant le nom de l'application qui a implémenté la bibliothèque partagée MMNotes.
Exemple
L'appel de la fonction
inspecteur Propriétés, d'un panneau flottant ou d'un traducteur de données Dreamweaver renvoie
L'appel de la fonction
"Dreamweaver" étant donné que Fireworks utilise la même version de la bibliothèque (celle qui a été créée par l'équipe
technique de Dreamweaver).
MMNotes.getVersionName() à partir d'une commande, d'un objet, d'un comportement, d'un
"Dreamweaver".
MMNotes.getVersionName() à partir de Fireworks renvoie également la valeur
MMNotes.getVersionNum()
Description
Cette fonction obtient le numéro de version de la bibliothèque partagée MMNotes.
Arguments
Aucun.
Valeurs renvoyées
Une chaîne contenant le numéro de version.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de Design Notes
MMNotes.localURLToFilePath()
Description
Cette fonction convertit l'URL de type file:// spécifiée en un chemin d'accès du lecteur local.
Arguments
fileURL
• L'argument fileURL, exprimé sous la forme d'une URL de type file://, est le chemin d'un fichier local.
Valeurs renvoyées
Une chaîne contenant le chemin d'accès du lecteur local pour le fichier spécifié.
Exemple
Un appel à la fonction
"MacintoshHD:images:moon.gif".
MMNotes.localURLToFilePath('file:///MacintoshHD/images/moon.gif') renvoie
MMNotes.open()
25
Description
Cette fonction ouvre le fichier Design Notes associé au fichier spécifié ou crée un fichier Design Notes s'il n'en existe pas.
Arguments
filePath, {bForceCreate}
• L'argument filePath, exprimé sous la forme d'une URL de type file://, est le chemin du fichier principal auquel le
fichier Design Notes est associé.
• L'argument bForceCreate est une valeur booléenne indiquant si la note doit être créée même si la fonctionnalité
Design Notes est désactivée pour le site ou si l'argument filePath n'est associé à aucun site.
Valeurs renvoyées
L'identificateur du fichier Design Notes ou zéro (0) si le fichier n'a pas été ouvert ni créé.
Exemple
Voir « MMNotes.set() » à la page 26.
MMNotes.remove()
Description
Cette fonction supprime la clé spécifiée (et sa valeur) du fichier Design Notes indiqué.
Arguments
fileHandle, keyName
• L'argument fileHandle est l'identificateur de fichier renvoyé par la fonction MMNotes.open().
• L'argument keyName est une chaîne contenant le nom de la clé à supprimer.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de Design Notes
Valeurs renvoyées
Valeur booléenne :
true si l'opération a réussi, false dans le cas contraire.
MMNotes.set()
Description
Cette fonction crée ou met à jour une paire clé/valeur dans un fichier Design Notes.
Arguments
fileHandle, keyName, valueString
• L'argument fileHandle est l'identificateur de fichier renvoyé par la fonction MMNotes.open().
• L'argument keyName est une chaîne contenant le nom de la clé.
• L'argument valueString est une chaîne contenant la valeur.
Valeurs renvoyées
Valeur booléenne :
true si l'opération a réussi, false dans le cas contraire.
26
Exemple
L'exemple suivant ouvre le fichier Design Notes associé à un fichier situé sur le site dreamcentral appelé
peakhike99/index.html, ajoute une nouvelle paire clé/valeur, modifie la valeur d'une clé existante, puis ferme le fichier
Design Notes :
var noteHandle = MMNotes.open('file:///c|/sites/dreamcentral/peakhike99/
index.html',true);
if(noteHandle > 0){
MMNotes.set(noteHandle,"Author","M. G. Miller");
MMNotes.set(noteHandle,"Last Changed","August 28, 1999");
MMNotes.close(noteHandle);
}
L'API C de Design Notes
Outre l'API JavaScript, la bibliothèque partagée MMNotes affiche une API C permettant aux autres applications de
créer des fichiers Design Notes. Il n'est pas nécessaire d'appeler les fonctions C directement si vous utilisez la
bibliothèque partagée MMNotes dans Dreamweaver ; les versions JavaScript de ces fonctions les appellent pour vous.
Cette section décrit ces fonctions, leurs arguments et les valeurs qu'elles renvoient. Les définitions de toutes les
fonctions et de tous les types de données sont disponibles dans le fichier MMInfo.h du dossier Extending/c_files dans
le dossier de l'application Dreamweaver.
void CloseNotesFile()
Description
Cette fonction ferme le fichier Design Notes spécifié et enregistre les modifications éventuelles. Si toutes les paires
clé/valeur ont été supprimées du fichier Design Notes, Dreamweaver supprime ce dernier. Dreamweaver supprime le
dossier _notes lorsque le dernier fichier Design Notes est supprimé.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de Design Notes
Arguments
noteHandle
• L'argument noteHandle est l'identificateur de fichier renvoyé par la fonction OpenNotesFile().
Valeurs renvoyées
Aucune.
BOOL FilePathToLocalURL()
Description
Cette fonction convertit le chemin d'accès du lecteur local spécifié en une URL de type file://.
Arguments
const char* drivePath, char* localURLBuf, int localURLMaxLen
• L'argument drivePath est une chaîne contenant le chemin d'accès complet du lecteur.
• L'argument localURLBuf est la zone de mémoire tampon où l'URL de type file:// est stockée.
• L'argument localURLMaxLen est la taille maximale de localURLBuf.
27
Valeurs renvoyées
Valeur booléenne :
de l'URL de type file://.
true si l'opération a réussi, false dans le cas contraire. L'argument localURLBuf reçoit la valeur
BOOL GetNote()
Description
Cette fonction obtient la valeur de la clé spécifiée dans le fichier Design Notes indiqué.
Arguments
FileHandle noteHandle, const char keyName[64], char* valueBuf, int valueBufLength
• L'argument noteHandle est l'identificateur de fichier renvoyé par la fonction OpenNotesFile().
• L'argument keyName[64] est une chaîne contenant le nom de la clé.
• L'argument valueBuf est la zone de mémoire tampon où la valeur est stockée.
• L'argument valueBufLength est le nombre entier renvoyé par GetNoteLength(noteHandle, keyName), indiquant
la longueur maximale de la mémoire tampon des valeurs.
Valeurs renvoyées
Valeur booléenne : true si l'opération a réussi, false dans le cas contraire. L'argument valueBuf reçoit la valeur de la clé.
Exemple
Le code suivant obtient la valeur de la clé
comments dans le fichier Design Notes associé au fichier welcome.html :
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de Design Notes
FileHandle noteHandle = OpenNotesFile("file:///c|/sites/avocado8/iwjs/welcome.html");
if(noteHandle > 0){
int valueLength = GetNoteLength( noteHandle, "comments");
char* valueBuffer = new char[valueLength + 1];
GetNote(noteHandle, "comments", valueBuffer, valueLength + 1);
printf("Comments: %s",valueBuffer);
CloseNotesFile(noteHandle);
}
int GetNoteLength()
Description
Cette fonction obtient la longueur de la valeur associée à la clé spécifiée.
Arguments
FileHandle noteHandle, const char keyName[64]
• L'argument noteHandle est l'identificateur de fichier renvoyé par la fonction OpenNotesFile().
• L'argument keyName[64] est une chaîne contenant le nom de la clé.
28
Valeurs renvoyées
Un nombre entier représentant la longueur de la valeur.
Exemple
Voir « BOOL GetNote() » à la page 27.
int GetNotesKeyCount()
Description
Cette fonction obtient le nombre de paires clé/valeur du fichier Design Notes spécifié.
Arguments
FileHandle noteHandle
• L'argument noteHandle est l'identificateur de fichier renvoyé par la fonction OpenNotesFile().
Valeurs renvoyées
Un nombre entier représentant le nombre de paires clé/valeur du fichier Design Notes spécifié.
BOOL GetNotesKeys()
Description
Cette fonction renvoie une liste de toutes les clés d'un fichier Design Notes.
Arguments
FileHandle noteHandle, char* keyBufArray[64], int keyArrayMaxLen
• L'argument noteHandle est l'identificateur de fichier renvoyé par OpenNotesFile().
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de Design Notes
• L'argument keyBufArray[64] est le tableau en mémoire tampon où les clés sont stockées.
• L'argument keyArrayMaxLen est le nombre entier renvoyé par GetNotesKeyCount(noteHandle), indiquant le
nombre maximum d'éléments contenus dans le tableau en mémoire tampon des clés.
Valeurs renvoyées
Valeur booléenne :
true si l'opération a réussi, false dans le cas contraire. L'argument keyBufArray reçoit les noms
de clé.
Exemple
Le code suivant imprime les noms de clé et les valeurs de toutes les clés du fichier Design Notes associé au fichier
welcome.html :
typedef char[64] InfoKey;
FileHandle noteHandle = OpenNotesFile("file:///c|/sites/avocado8/iwjs/welcome.html");
if (noteHandle > 0){
int keyCount = GetNotesKeyCount(noteHandle);
if (keyCount <= 0)
return;
InfoKey* keys = new InfoKey[keyCount];
BOOL succeeded = GetNotesKeys(noteHandle, keys, keyCount);
if (succeeded){
for (int i=0; i < keyCount; i++){
printf("Key is: %s\n", keys[i]);
printf("Value is: %s\n\n", GetNote(noteHandle, keys[i]);
}
}
delete []keys;
}
CloseNotesFile(noteHandle);
29
BOOL GetSiteRootForFile()
Description
Cette fonction détermine la racine du site pour le fichier Design Notes spécifié.
Arguments
const char*filePath, char*siteRootBuf, intsiteRootBufMaxLen, {InfoPrefs* infoPrefs}
• L'argument filePath est l'URL de type file:// du fichier dont vous souhaitez obtenir la racine du site.
• L'argument siteRootBuf est la zone de mémoire tampon où la racine du site est stockée.
• L'argument siteRootBufMaxLen est la taille maximale de la mémoire tampon référencée par siteRootBuf.
• L'argument facultatif infoPrefs est une référence à un struct dans lequel les préférences du site sont stockées.
Valeurs renvoyées
Valeur booléenne :
la mémoire tampon qui stocke la racine du site. Si vous spécifiez l'argument infoPrefs, la fonction renvoie également
les préférences de Design Notes pour le site. La structure
bUploadDesignNotes, toutes deux de type BOOL.
true si l'opération a réussi, false dans le cas contraire. L'argument siteRootBuf reçoit l'adresse de
InfoPrefs possède deux variables : bUseDesignNotes et
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de Design Notes
BOOL GetVersionName()
Description
Cette fonction renvoie le nom de version de la bibliothèque partagée MMNotes indiquant l'application qui l'a
implémentée.
Arguments
char* versionNameBuf, intversionNameBufMaxLen
• L'argument versionNameBuf est la zone de mémoire tampon où le nom de version est stocké.
• L'argument versionNameBufMaxLen est la taille maximale de la mémoire tampon référencée par versionNameBuf.
Valeurs renvoyées
Valeur booléenne :
l'argument versionNameBuf.
true si l'opération a réussi, false dans le cas contraire. Dreamweaver stocke "Dreamweaver" dans
BOOL GetVersionNum()
30
Description
Cette fonction renvoie le numéro de version de la bibliothèque partagée MMNotes, ce qui vous permet de savoir si
certaines fonctions sont disponibles.
Arguments
char* versionNumBuf, intversionNumBufMaxLen
• L'argument versionNumBuf est la zone de mémoire tampon où le numéro de version est stocké.
• L'argument versionNumBufMaxLen est la taille maximale de la mémoire tampon référencée par versionNumBuf.
Valeurs renvoyées
Valeur booléenne :
numéro de version.
true si l'opération a réussi, false dans le cas contraire. L'argument versionNumBuf stocke le
BOOL LocalURLToFilePath()
Description
Cette fonction convertit l'URL de type file:// spécifiée en un chemin d'accès du lecteur local.
Arguments
const char* localURL, char* drivePathBuf, int drivePathMaxLen
• L'argument localURL, exprimé sous la forme d'une URL de type file://, est le chemin d'un fichier local.
• L'argument drivePathBuf est la zone de mémoire tampon où le chemin d'accès du lecteur local est stocké.
• L'argument drivePathMaxLen est la taille maximale de la mémoire tampon référencée par drivePathBuf.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de Design Notes
Valeurs renvoyées
Valeur booléenne :
de fichier local.
true si l'opération a réussi, false dans le cas contraire. L'argument drivePathBuf reçoit le chemin
FileHandle OpenNotesFile()
Description
Cette fonction ouvre le fichier Design Notes associé au fichier spécifié ou crée un fichier Design Notes s'il n'en existe pas.
Arguments
const char* localFileURL, {BOOL bForceCreate}
• L'argument localFileURL, exprimé sous la forme d'une URL de type file://, est une chaîne contenant le chemin du
fichier principal auquel le fichier Design Notes est associé.
• L'argument bForceCreate est une valeur booléenne indiquant si le fichier Design Notes doit être créé même si la
fonctionnalité Design Notes est désactivée pour le site ou si le chemin spécifié par l'argument localFileURL n'est
associé à aucun site.
31
FileHandle OpenNotesFilewithOpenFlags()
Description
Cette fonction ouvre le fichier Design Notes associé au fichier spécifié ou crée un fichier Design Notes s'il n'en existe
pas. Vous pouvez ouvrir le fichier en mode lecture seule.
Arguments
const char* localFileURL, {BOOL bForceCreate}, {BOOL bReadOnly}
• L'argument localFileURL, exprimé sous la forme d'une URL de type file://, est une chaîne contenant le chemin du
fichier principal auquel le fichier Design Notes est associé.
• L'argument bForceCreate est une valeur booléenne indiquant si le fichier Design Notes doit être créé même si la
fonctionnalité Design Notes est désactivée pour le site ou si le chemin n'est associé à aucun site. La valeur par défaut
false. Cet argument est facultatif, mais vous devez le définir si vous spécifiez le troisième argument.
est
• L'argument facultatif bReadOnly est une valeur booléenne indiquant si le fichier doit être ouvert en mode lecture
seule. La valeur par défaut est
2 du fichier MMNotes.dll.
false. Vous pouvez spécifier l'argument bReadOnly disponible à partir de la version
BOOL RemoveNote()
Description
Cette fonction supprime la clé spécifiée (et sa valeur) du fichier Design Notes indiqué.
Arguments
FileHandlenoteHandle, const char keyName[64]
• L'argument noteHandle est l'identificateur de fichier renvoyé par la fonction OpenNotesFile().
• L'argument keyName[64] est une chaîne contenant le nom de la clé à supprimer.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de Design Notes
Valeurs renvoyées
Valeur booléenne :
true si l'opération a réussi, false dans le cas contraire.
BOOL SetNote()
Description
Cette fonction crée ou met à jour une paire clé/valeur dans un fichier Design Notes.
Arguments
FileHandle noteHandle, const char keyName[64], const char* value
• L'argument noteHandle est l'identificateur de fichier renvoyé par la fonction OpenNotesFile().
• L'argument keyName[64] est une chaîne contenant le nom de la clé.
• L'argument value est une chaîne contenant la valeur.
Valeurs renvoyées
Valeur booléenne :
true si l'opération a réussi, false dans le cas contraire.
32
Dernière mise à jour le 22/6/2011
Chapitre 5 : Intégration de Fireworks
FWLaunch est une bibliothèque C partagée qui permet aux auteurs d'objets, de commandes, de comportements et
d'inspecteurs Propriétés de communiquer avec Adobe® Fireworks®. A l'aide de FWLaunch, vous rédigez du code
JavaScript pour ouvrir l'interface utilisateur de Fireworks et fournissez des commandes à Fireworks via sa propre API
JavaScript, au sujet duquel vous trouverez plus d'informations dans Extension de Fireworks. Pour obtenir des
informations générales sur l'interaction des bibliothèques avec l'interpréteur JavaScript dans Adobe® Dreamweaver®
CS5 et pour plus de détails sur les extensions C, voir Extension de Dreamweaver.
L'API FWLaunch
L'objet FWLaunch permet aux extensions d'ouvrir Fireworks, d'exécuter des opérations Fireworks à l'aide de l'API
JavaScript de Fireworks et de renvoyer les valeurs à Dreamweaver. Ce chapitre décrit l'API de communication
FWLaunch et son utilisation.
33
FWLaunch.bringDWToFront()
Disponibilité
Dreamweaver 3, Fireworks 3.
Description
Cette fonction affiche Dreamweaver au premier plan.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
FWLaunch.bringFWToFront()
Disponibilité
Dreamweaver 3, Fireworks 3.
Description
Cette fonction permet d'afficher Fireworks au premier plan s'il est en cours d'exécution.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
Intégration de Fireworks
FWLaunch.execJsInFireworks()
Disponibilité
Dreamweaver 3, Fireworks 3.
Description
Cette fonction transmet l'élément JavaScript spécifié (ou une référence à un fichier JavaScript) à Fireworks en vue de
son exécution.
Arguments
javascriptOrFileURL
• L'argument javascriptOrFileURL, exprimé sous la forme d'une URL de type file://, est soit une chaîne de
JavaScript littéral, soit le chemin d'accès d'un fichier JavaScript.
Valeurs renvoyées
Un objet cookie si le code JavaScript a été transmis avec succès ou un code d'erreur non nul indiquant que l'une des
erreurs suivantes s'est produite :
• Utilisation non valide, ce qui indique que le chemin du fichier JS ou JSF n'est pas valide ou que l'argument
javascriptOrFileURL est spécifié comme ayant la valeur null ou comme une chaîne vide.
• Erreur d'E/S de fichier, ce qui indique que Fireworks ne peut pas créer de fichier réponse car le disque est saturé.
• Erreur informant Dreamweaver que l'utilisateur n'exécute pas une version valide de Dreamweaver (version 3 ou
ultérieure).
• Erreur lors du démarrage de Fireworks, ce qui indique que la fonction n'ouvre pas une version valide de Fireworks
(version 3 ou ultérieure).
• L'utilisateur a annulé l'opération.
34
FWLaunch.getJsResponse()
Disponibilité
Dreamweaver 3, Fireworks 3.
Description
Cette fonction détermine si Fireworks est toujours en train d'exécuter le code JavaScript qui lui a été transmis par la
fonction
soit produite.
Arguments
progressTrackerCookie
• L'argument progressTrackerCookie est l'objet cookie renvoyé par la fonction
FWLaunch.execJsInFireworks(), que l'exécution du script se soit terminée avec succès ou qu'une erreur se
FWLaunch.execJsInFireworks().
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
Intégration de Fireworks
Valeurs renvoyées
Une chaîne contenant le résultat du script transmis à
succès, la valeur
null si Fireworks est toujours en train d'exécuter le code JavaScript, ou un code d'erreur non nul
FWLaunch.execJsInFireworks() si l'opération se termine avec
indiquant que l'une des erreurs suivantes s'est produite :
• Utilisation non valide, ce qui indique qu'une erreur JavaScript s'est produite pendant que Fireworks exécutait le
script.
• Erreur d'E/S de fichier, ce qui indique que Fireworks ne peut pas créer de fichier réponse car le disque est saturé.
• Erreur informant Dreamweaver que l'utilisateur n'exécute pas une version valide de Dreamweaver (version 3 ou
ultérieure).
• Erreur lors du démarrage de Fireworks, ce qui indique que la fonction n'ouvre pas une version valide de Fireworks
(version 3 ou ultérieure).
• L'utilisateur a annulé l'opération.
Exemple
Le code suivant transmet la chaîne
"prompt('Please enter your name:')" à FWLaunch.execJsInFireworks()
et vérifie le résultat :
var progressCookie = FWLaunch.execJsInFireworks("prompt('Please enter your name:')");
var doneFlag = false;
while (!doneFlag){
// check for completion every 1/2 second
setTimeout('checkForCompletion()',500);
}
function checkForCompletion(){
if (progressCookie != null) {
var response = FWLaunch.getJsResponse(progressCookie);
if (response != null) {
if (typeof(response) == "number") {
// error or user-cancel, time to close the window
// and let the user know we got an error
window.close();
alert("An error occurred.");
}else{
// got a valid response!
alert("Nice to meet you, " + response);
window.close();
}
doneFlag = true;
}
}
}
35
FWLaunch.mayLaunchFireworks()
Disponibilité
Dreamweaver 2, Fireworks 2.
Description
Cette fonction détermine s'il est possible d'ouvrir une session d'optimisation de Fireworks.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
Intégration de Fireworks
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne indiquant si la plate-forme est Windows ou Macintosh ; sur Macintosh, la valeur indique si une
autre session d'optimisation de Fireworks est déjà en cours d'exécution.
FWLaunch.optimizeInFireworks()
Disponibilité
Dreamweaver 2, Fireworks 2.
Description
Cette fonction ouvre une session d'optimisation de Fireworks pour l'image spécifiée.
Arguments
docURL, imageURL, {targetWidth}, {targetHeight}
• L'argument docURL est le chemin d'accès du document actif, exprimé sous la forme d'une URL de type file://.
• L'argument imageURL est le chemin de l'image sélectionnée. Si le chemin est relatif, sa référence sera le chemin
spécifié dans l'argument docURL.
• L'argument targetWidth (facultatif) définit la largeur par rapport à laquelle l'image doit être redimensionnée.
• L'argument targetHeight (facultatif) définit la hauteur par rapport à laquelle l'image doit être redimensionnée.
36
Valeurs renvoyées
Zéro (0) si une session d'optimisation de Fireworks a été lancée avec succès pour l'image spécifiée; sinon, un code
d'erreur non nul indiquant que l'une des erreurs suivantes s'est produite :
• Utilisation non valide, ce qui indique que l'argument docURL, l'argument imageURL, ou les deux, ont été spécifiés
comme étant
null ou sous forme d'une chaîne vide.
• Erreur d'E/S de fichier, ce qui indique que Fireworks ne peut pas créer de fichier réponse car le disque est saturé.
• Erreur informant Dreamweaver que l'utilisateur n'exécute pas une version valide de Dreamweaver (version 2 ou
ultérieure).
• Erreur lors du démarrage de Fireworks, ce qui indique que la fonction n'ouvre pas une version valide de Fireworks
(version 2 ou ultérieure).
• L'utilisateur a annulé l'opération.
FWLaunch.validateFireworks()
Disponibilité
Dreamweaver 2, Fireworks 2.
Description
Cette fonction recherche la version spécifiée de Fireworks sur le disque dur de l'utilisateur.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
Intégration de Fireworks
Arguments
{versionNumber}
• L'argument versionNumber est un nombre à virgule flottante supérieur ou égal à 2 ; il est facultatif et représente la
version requise de Fireworks. Si cet argument n'est pas défini, il prend par défaut la valeur 2.
Valeurs renvoyées
Une valeur booléenne indiquant si la version spécifiée de Fireworks a été trouvée.
Exemple
Le code suivant vérifie si Fireworks est installé :
if (FWLaunch.validateFireworks(6.0)){
alert("Fireworks 6.0 or later is installed.");
}else{
alert("Fireworks 6.0 is not installed.");
}
Un exemple simple de communication FWLaunch
La commande suivante demande à Fireworks d'inviter l'utilisateur à entrer son nom, puis renvoie le nom à
Dreamweaver.
37
<html>
<head>
<title>Prompt in Fireworks</title>
<meta http-equiv="Content-Type" content="text/html; ¬
charset=iso-8859-1">
<script>
function commandButtons(){
return new Array("Prompt", "promptInFireworks()", "Cancel", ¬
"readyToCancel()", "Close","window.close()");
}
var gCancelClicked = false;
var gProgressTrackerCookie = null;
function readyToCancel() {
gCancelClicked = true;
}
function promptInFireworks() {
var isFireworks3 = FWLaunch.validateFireworks(3.0);
if (!isFireworks3) {
alert("You must have Fireworks 3.0 or later to use this ¬
command");
return;
}
// Tell Fireworks to execute the prompt() method.
gProgressTrackerCookie = FWLaunch.execJsInFireworks¬
("prompt('Please enter your name:')");
// null means it wasn't launched, a number means an error code
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
Intégration de Fireworks
if (gProgressTrackerCookie == null || ¬
typeof(gProgressTrackerCookie) == "number") {
window.close();
alert("an error occurred");
gProgressTrackerCookie = null;
} else {
// bring Fireworks to the front
FWLaunch.bringFWToFront();
// start the checking to see if Fireworks is done yet
checkOneMoreTime();
}
}
function checkOneMoreTime() {
// Call checkJsResponse() every 1/2 second to see if Fireworks
// is done yet
window.setTimeout("checkJsResponse();", 500);
}
function checkJsResponse() {
var response = null;
// The user clicked the cancel button, close the window
if (gCancelClicked) {
window.close();
alert("cancel clicked");
} else {
// We're still going, ask Fireworks how it's doing
if (gProgressTrackerCookie != null)
response = FWLaunch.getJsResponse(gProgressTrackerCookie);
if (response == null) {
// still waiting for a response, call us again in 1/2 a
// second
checkOneMoreTime();
} else if (typeof(response) == "number") {
// if the response was a number, it means an error occurred
// the user cancelled in Fireworks
window.close();
alert("an error occurred.");
} else {
// got a valid response!This return value might not
// always be a useful one, since not all functions in
// Fireworks return a string, but we know this one does,
// so we can show the user what we got.
window.close();
FWLaunch.bringDWToFront();// bring Dreamweaver to the front
38
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
Intégration de Fireworks
alert("Nice to meet you, " + response + "!");
}
}
}
</script>
</head>
<body>
<form>
<table width="313" nowrap>
<tr>
<td>This command asks Fireworks to execute the prompt() ¬
function. When you click Prompt, Fireworks comes forward and ¬
asks you to enter a value into a dialog box. That value is then ¬
returned to Dreamweaver and displayed in an alert.</td>
</tr>
</table>
</form>
</body>
</html>
39
Dernière mise à jour le 22/6/2011
Chapitre 6 : Intégration de Flash
Adobe® Dreamweaver® prend en charger l'API d'objet Flash, qui s'appuie sur le modèle Flash Generator pour créer de
nouveaux objets Flash. La section L'API des objets Flash fournit des détails sur la création d'objets Flash (fichiers SWF)
à partir de modèles Flash Generator (fichiers SWT).
Pour plus d'informations sur l'ajout de contenu Flash à des objets ou des commandes Dreamweaver, voir Extension de
Dreamweaver.
L'API des objets Flash
L'API des objets Flash permet aux développeurs d'extensions de construire des objets pour créer des fichiers SWF
simples via Flash Generator. Cette API fournit un moyen de définir des paramètres dans un modèle Flash Generator
pour réaliser un fichier SWF ou d'image. Elle permet de créer de nouveaux objets Flash mais aussi de lire et de
manipuler des objets Flash existants.
Le fichier de modèle Flash Generator SWT contient toutes les informations indispensables à la construction d'un
fichier d'objet Flash. Ces fonctions d'API permettent de créer un fichier SWF (ou un fichier d'image) à partir d'un
fichier SWT. Le fichier SWF est créé en remplaçant les paramètres du fichier SWT par des valeurs réelles. Pour plus
d'informations sur Flash, consultez le manuel correspondant. Les fonctions suivantes sont des méthodes de l'objet
SWFFile.
40
SWFFile.createFile()
Description
Cette fonction génère un nouveau fichier d'objet Flash à partir du modèle et du tableau des paramètres spécifiés. Elle
crée également des versions GIF, PNG, JPEG et MOV du titre si les noms de fichier sous ces formats sont précisés.
Pour pouvoir spécifier un paramètre facultatif placé après des paramètres facultatifs que vous ne voulez pas spécifier,
vous devez insérer des chaînes vides dans ces paramètres. Par exemple, si vous souhaitez spécifier un fichier PNG, mais
pas de fichier GIF, vous devez insérer une chaîne vide avant de spécifier le nom du fichier PNG.
Arguments
templateFile, templateParams, swfFileName, {gifFileName}, {pngFileName}, {jpgFileName}, {movFileName},
{generatorParams}
• L'argument templateFile est le chemin d'accès du fichier modèle, exprimé sous la forme d'une URL de type file://. Il
peut s'agir d'un fichier SWT.
• L'argument templateParams est un tableau de paires nom/valeur dans lequel les noms identifient les paramètres du
fichier SWT et les valeurs correspondent à la définition que vous voulez leur attribuer. Pour que Dreamweaver
puisse reconnaître un fichier SWF comme objet Flash, le premier paramètre doit être
une chaîne représentant le nom du type d'objet, telle que
• L'argument swfFileName, exprimé sous forme d'une URL de type file://, correspond au nom de fichier de sortie d'un
fichier SWF ou d'une chaîne vide à ignorer.
• L'argument gifFileName, exprimé sous forme d'une URL de type file://, correspond au nom de fichier de sortie d'un
fichier GIF. Cet argument est facultatif.
"Flash Text".
"dwType". Sa valeur doit être
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
Intégration de Flash
• L'argument pngFileName, exprimé sous forme d'une URL de type file://, correspond au nom de fichier de sortie
d'un fichier PNG. Cet argument est facultatif.
• L'argument jpgFileName, exprimé sous forme d'une URL de type file://, correspond au nom de fichier de sortie d'un
fichier JPEG. Cet argument est facultatif.
• L'argument movFileName, exprimé sous forme d'une URL de type file://, correspond au nom de fichier de sortie
d'un fichier QuickTime. Cet argument est facultatif.
• L'argument generatorParams est un tableau de chaînes représentant les indicateurs facultatifs de la ligne de
commande de Generator. Cet argument est facultatif. Les éléments de données de toutes les balises doivent le suivre
dans le tableau. Les indicateurs couramment utilisés sont répertoriés dans le tableau suivant :
Indicateur d'option Données Description Exemple
41
-defaultsize
-exactFit
Largeur, hauteur Définit la taille de l'image de sortie en fonction des
largeur et hauteur indiquées.
Aucun Etend le contenu de l'image de sortie pour qu'il
s'adapte exactement à la taille de sortie indiquée.
"-defaultsize",
"640", "480"
"-exactFit"
Valeurs renvoyées
Chaîne qui contient l'une des valeurs suivantes :
• "noError" signifie que l'appel s'est déroulé sans anomalie.
• "invalidTemplateFile" signifie que le fichier de modèle choisi était incorrect ou introuvable.
• "invalidOutputFile" signifie qu'au moins un des noms de fichier de sortie spécifiés était incorrect.
• "invalidData" signifie qu'une ou plusieurs des paires nom/valeur de l'argument templateParams étaient
incorrectes.
• "initGeneratorFailed" signifie que Generator n'a pas pu être initialisé.
• "outOfMemory" signifie que l'opération n'a pas pu se terminer correctement faute de mémoire.
• "unknownError" signifie qu'une erreur inconnue s'est produite.
Exemple
Le code JavaScript suivant crée un fichier objet Flash de type
"text" à l'intérieur du fichier de modèle par la chaîne "Hello World". Il crée un fichier GIF et un fichier SWF.
chaîne
var params = new Array;
params[0] = "dwType";
params[1] = "myType";
params[2] = "text";
params[3] = "Hello World";
errorString = SWFFile.createFile( "file:///MyMac/test.swt", ¬
params, "file:///MyMac/test.swf", "file:///MyMac/test.gif");
"myType", qui remplace toutes les occurrences de la
SWFFile.getNaturalSize()
Description
Cette fonction renvoie la taille naturelle de tout contenu Flash non compressé.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
Intégration de Flash
Arguments
fileName
• L'argument fileName, exprimé sous la forme d'une URL de type file://, correspond au chemin d'accès au contenu
Flash.
Valeurs renvoyées
Un tableau contenant deux éléments qui représentent la largeur et la hauteur du contenu Flash non compressé ou une
null si le fichier n'est pas un fichier Flash non compressé.
valeur
SWFFile.getObjectType()
Description
Cette fonction renvoie le type d'objet Flash, c'est-à-dire la valeur transmise dans le paramètre
a été créé par la fonction
SWFFile.createFile().
Arguments
fileName
dwType lorsque le fichier
42
• L'argument fileName, exprimé sous la forme d'une URL de type file://, correspond au chemin d'accès à un fichier
d'objet Flash. Il s'agit généralement d'un fichier SWF.
Valeurs renvoyées
Une chaîne représentant le type d'objet ou contenant la valeur
null si le fichier n'est pas un fichier d'objet Flash ou s'il
est introuvable.
Exemple
Le code suivant vérifie si le fichier test.swf est un objet Flash de type
if ( SWFFile.getObjectType("file:///MyMac/test.swf") == "myType" ){
alert ("This is a myType object.");
}else{
alert ("This is not a myType object.");
}
myType :
SWFFile.readFile()
Description
Cette fonction lit un fichier d'objet Flash.
Arguments
fileName
• L'argument fileName, exprimé sous la forme d'une URL de type file://, correspond au chemin d'accès à un fichier
d'objet Flash.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
Intégration de Flash
Valeurs renvoyées
Un tableau de chaînes dans lequel le premier élément est le chemin d'accès complet du fichier modèle SWT. Les
chaînes suivantes représentent les paramètres (paires nom/valeur) de l'objet. Dans le tableau, chaque nom est suivi de
sa valeur. La première paire nom/valeur est
"dwType", suivie par sa valeur. La fonction renvoie une valeur null si le
fichier est introuvable ou s'il ne s'agit pas d'un fichier d'objet Flash.
Exemple
L'appel du code
var params = SWFFile.readFile("file:///MyMac/test.swf") renvoie les valeurs suivantes
dans le tableau des paramètres :
"file:///MyMac/test.swt" // template file used to create this .swf file
"dwType" // first parameter
"myType" // first parameter value
"text" // second parameter
"Hello World" // second parameter value
Fonctions des panneaux et des boîtes de dialogue de Flash
43
Les API suivantes permettent d'ajouter des fichiers SWF dans les panneaux et les boîtes de dialogue.
dreamweaver.flash.newControl()
Disponibilité
Dreamweaver CS4.
Description
Cette fonction permet de créer un contrôle Flash. Elle est prise en référence plus tard par l'intermédiaire du paramètre
controlID. Le contrôle affiche le fichier Flash (.swf) spécifié par le chemin d'accès SWF. Le contrôle possède une
position et une taille spécifiées dans le paramètre
Remarque : Dreamweaver affiche les contrôles Flash lorsque vous appelez
affiche les contrôles de boîte de dialogue
newControl ; il n'est pas nécessaire d'appeler flash.requestStateChange.
Arguments
controlID, controlType, controlData
• L'argument controlID est une valeur de chaîne.
• L'argument controlType spécifie si le panneau est une extension standard ("standard"), une extension standard
approuvée ("trusted") ou une extension plus (toute autre valeur). S'il s'agit d'une extension plus, la valeur est un
identificateur connu spécifiquement de l'application hôte et qui indique le type d'intégration personnalisée requise.
Si l'application ne comprend pas le type d'intégration personnalisée, elle renvoie une erreur.
• controlData est un objet. Voici quelques-unes des propriétés essentielles de cet argument :
defaultGeometry.
flash.requestStateChange. Dreamweaver
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
Intégration de Flash
Propriété Description Valeurs
44
controlData.swfUTF8Path Emplacement du fichier SWF. Cette propriété,
{controlData.scriptPath} Chemin d'accès au fichier .js contenant les
controlData.defaultGeometry Les valeurs defaultGeometry sont
obligatoire, est transmise sous la forme d'une
chaîne de caractères Unicode, car tous les
caractères dans JavaScript sont en format
Unicode.
fonctions à exécuter depuis .swf à l'aide d'un
appel d'interface externe. Cette propriété est
facultative. Si vous voulez effectuer un rappel
dans le code JavaScript de Dreamweaver à partir
du fichier .swf au moyen d'une interface externe,
vous pouvez fournir un fichier .js contenant des
fonctions que vous pourrez ensuite appeler
depuis le fichier .swf. Pour plus d'informations,
voir l'appel
représentées sous la forme de coordonnées
d'écran à partir du coin supérieur gauche de
l'écran. Cette propriété est obligatoire.
Object /*!< default creation
geometry, including positioning */
{ topleftx: Number, toplefty:
Number, width: Number, height:
Number }
dw.flash.executeScript.
Le tableau suivant énumère les spécifications de PanelWindow :
Valeurs admises pour
controlData.windowType
• PanelWindow.Le tableau qui suit
ce tableau énumère les
spécifications pour cette valeur.
• ModalDialogWindow
Options Type Descriptions
name Chaîne Le nom du panneau qui s'affiche dans l'onglet. Si vous ne le précisez pas,
controlData.minSize} Objet minSize ne s'applique qu'aux contrôles de type PanelWindow. Cette
{
{controlData.maxSize} Objet maxSize ne s'applique qu'aux contrôles de type
il est nommé « UNDEFINED ». Tous les noms de panneaux sont en
majuscules. Vous ne pouvez pas les convertir en minuscules.
option détermine la taille minimale à laquelle le panneau peut être réduit.
Cette option est facultative. Si la valeur
utilise par défaut la largeur et la hauteur définies dans
defaultGeometry. Il est dès lors impossible de redimensionner le
panneau.
{ width: Number, height: Number }
PanelWindow.
taille maximale à laquelle le panneau peut être agrandi. Si la valeur
maxSize n'est pas précisée, elle utilise par défaut la largeur et la hauteur
définies dans
redimensionner le panneau.
{ width: Number, height: Number }
Cette option est facultative. Cette option détermine la
defaultGeometry. Il est dès lors impossible de
minSize n'est pas précisée, elle
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
Intégration de Flash
Options Type Descriptions
45
{iconPathNormal} Chaîne Chemin d'accès à l'icône qui doit être employée dans le panneau flottant
{iconPathRollOver} Chaîne Chemin d'accès à l'icône qui doit être employée dans le panneau flottant
iconPathDisable} Chaîne Chemin d'accès à l'icône qui doit être employée dans le panneau flottant
{
lorsqu'il est réduit en icône. Cette option est facultative.
lorsqu'il est réduit en icône et que l'utilisateur le survole. Cette option est
facultative.
lorsqu'il est réduit en icône et désactivé. Cette option est facultative.
Valeurs renvoyées
L'un des codes de réussite ou d'erreur suivants :
• Le code PlugPlugErrorCode_success indique que la création du contrôle a réussi.
• Le code PlugPlugErrorCode_extensionRegistrationFailed indique que vous n'avez pas réussi à enregistrer
le contrôle.
dreamweaver.flash.requestStateChange()
Disponibilité
Dreamweaver CS4.
Description
Cette fonction modifie l'état du panneau flottant identifié par
uniqueID pour l'extension possédant l'ID extensionID.
Arguments
controlID, stateChange, stateData
• L'argument controlID est une valeur de chaîne.
• L'argument stateChange est une chaîne qui peut avoir l'une des valeurs suivantes :
Valeur Description
Move Modification d'origine, mais pas de taille
Resize Nouvelle taille et éventuellement nouvelle origine
Show Visibilité uniquement, mais pas de modifications géométriques
Hide Visibilité uniquement, mais pas de modifications géométriques
Minimize Similaire à hide, mais explique la raison du masquage.
Restore Similaire à show, mais explique la raison de l'affichage.
Open La fenêtre est créée et son extension est chargée.
Close L'extension contenue est déchargée.
• Les valeurs de l'argument stateData sont des chaînes, comme le montre le tableau suivant :
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
Intégration de Flash
Valeur de stateChange Valeur de stateData
46
Move
Resize
eventData = { topleftx: Number, toplefty: Number }
eventData = { width: Number, height: Number }
Valeurs renvoyées
Le tableau suivant contient les valeurs renvoyées, qui sont des chaînes :
Valeur Description
RequestPosted Un événement ou une commande d'exécution de la demande a été placé en file d'attente dans l'application
RequestComplete L'application hôte a terminé la demande.
RequestFailed L'application hôte a tenté de terminer la demande, mais a échoué.
RequestDenied L'application hôte a refusé la demande, généralement parce qu'elle ne prend pas en charge l'action
hôte.
demandée.
Exemple
controlData = {};
controlData.defaultGeometry = {topleftx : 100, toplefty : 100, width : 200, height : 200 };
controlData.minSize = {width : 100; height : 100 };
controlData.maxSize = {width : 300; height : 300 };
var swfPath = dw.getConfigurationPath();
swfPath += '/flash/PhotoAlbum.swf';
controlData.swfUTF8Path = swfPath;
// open the window
flash.requestStateChange("com.adobe.extension.foo","Open",controlData.defaultGeometry);
dreamweaver.flash.controlEvent()
Disponibilité
Dreamweaver CS4.
Description
Cette fonction permet de transmettre des événements à un contrôle Flash. Les appels d'événements sont transmis sous
la forme d'une chaîne XML qui capture la fonction et les paramètres appropriés. La chaîne XML capture la fonction à
démarrer dans le fichier SWF.
Arguments
inControlID, inXMLString
• L'argument inControlID est une chaîne.
• L'argument inXMLString est une chaîne. Transmettez le inXMLString suivant pour appeler la fonction dans le
fichier Flash flashCallback et transmettez une chaîne unique, 'Hello', en tant qu'argument.
<invoke name="flashCallback" returntype="xml">
<arguments>
<string>Hello</string>
</arguments>
</invoke>
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
Intégration de Flash
Valeurs renvoyées
Renvoie une chaîne XML.
Exemple
L'exemple suivant appelle la fonction
flashCallback depuis JavaScript. Dans cet exemple, vous transmettre le nom
de la fonction de rappel et ses arguments sous la forme d'une chaîne XML.
var xmlString = '<invoke name="flashCallback" returntype="xml">
<arguments>
<string>Hello</string>
</arguments>
</invoke>';
Dans cet exemple, vous utilisez dw.flash.controlEvent pour effectuer un rappel dans le fichier Flash (.swf) :
dw.flash.controlEvent('Flickr', xmlString);
Les arguments suivants sont utilisés dans cette fonction :
• Flickr, qui est l'ID de l'extension transmis lorsque le contrôle .swf a été créé avec dw.flash.newControl.
• La chaîne XML contenant la fonction de rappel et les arguments.
L'exemple suivant est la mise en oeuvre de la fonction
l'exemple suivant, ajoutez la fonction
flashcallback. Cette fonction doit être appelée à partir d'applications externes.
flashcallback implémentée dans flashcallback.mxml. Dans
47
public function initApp():void {
ExternalInterface.addCallback("flashCallback",flashCallback);
}
Cette fonction est rappelée depuis l'extérieur du fichier Flash (.swf).
Remarque : Veillez à appeler
ExternalInterface.addCallback ("flashCallback",flashCallback) avant de
tenter d'appeler cette fonction.
public function flashCallback(inputStr:String):String
{
out.text += inputStr + " got flashCallback!\n";
return "it worked!";
}
dreamweaver.flash.setMenu()
Disponibilité
Dreamweaver CS4.
Description
Cette fonction permet de fournir des commandes de survol pour les extensions de type "PanelWindow".
Arguments
inControlID, inMenuPosition, inMenu
• inControlID est un ID d'extension. L'appel de la fonction influe sur le menu de survol d'un panneau ouvert qui
héberge l'extension. Si cet argument n'est pas défini, l'appel influe sur les menus principaux de l'application.
• inMenuPosition est une chaîne qui décrit où les commandes données doivent être placées.
• Si cette chaîne n'est pas définie, un menu entier est remplacé.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
Intégration de Flash
• Si cette chaîne concerne un panneau, toute la zone définissable par l'utilisateur du menu de survol est remplacée.
L'application réserve certains éléments de survol fixes.
• Si cette chaîne concerne l'application, tout le sous-menu Contrôles par défaut du menu Fenêtre est remplacé.
• Si cette chaîne est une chaîne XML dans un schéma restant à déterminer pour la définition de sections de menus,
ce formulaire est fourni pour une compatibilité future.
• inMenu équivaut à MenuItem. Cet argument indique une liste de commandes qui sont ajoutées à l'emplacement
indiqué dans le menu. Il remplace tout élément antérieur qui a été ajouté à cet endroit par un appel précédent.
Valeurs renvoyées
L'un des codes de réussite ou d'erreur suivants :
• Le code PlugPlugErrorCode_success indique une réussite.
• Le code PlugPlugErrorCode_extensionMenuCreationFailed indique que la création du menu de l'extension a
échoué.
• Le code PlugPlugErrorCode_unknown indique que la fonction a échoué pour une raison inconnue.
Exemple
L'exemple suivant sert à configurer le menu :
48
function initializeMenuItem(menuID, menuName,extensionID, submenu)
{
var menuItem = {};
menuItem.menuId = menuID; //!< unique menu ID, if NULL menu is disabled
menuItem.nameUtf8 = menuName; //!< Item title, if "---" item is a separator
menuItem.extensionId = extensionID; //!< optional extension ID, used for panels only
menuItem.submenu = submenu; //!< if non-NULL, this is a submenu
return menuItem;
}
function setupMenu()
{
var menuItems = new Array();
menuItems.push(initializeMenuItem('id1','Call .swf
ActionScript',undefined,undefined));
menuItems.push(initializeMenuItem('id0','---',undefined,undefined));
menuItems.push(initializeMenuItem('id2','Call Dw JavaScript',undefined,undefined));
dw.flash.setMenu('Flickr',controlID,menuItems);
}
Remarque : Spécifiez une fonction nommée "onSelectMenuItem" dans le fichier JavaScript indiqué dans le
scriptPath de l'objet transmis à newControl.
onSelectMenuItem est un gestionnaire d'élément de menu. Il est appelé avec l'ID de menu correspondant lorsqu'une
commande est sélectionnée depuis le menu de survol de l'objet flottant.
L'exemple suivant spécifie la définition du gestionnaire de rappel dans « Configuration/flash/Flickr.js » :
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
Intégration de Flash
function onSelectMenuItem(menuID)
{
if (menuID == 'id1') {
var flashCallbackString = '<invoke name= " flash Callback"
returntype="xml">
<arguments><string>Hello</string></arguments></invoke>';
dw.flash.control Event('Flickr', flashCallbackString);
return("PlugPlugRequestCompleted");
} else {
alert ( ' You selected: menuID = ' + menuID);
return ( " PlugPlugRequestCompleted");
}
}
dreamweaver.flash.evalScript()
Disponibilité
Dreamweaver CS4.
Description
Cette fonction sert à appeler une fonction JavaScript dans l'un des buts suivants :
49
• Exécution d'une fonction JavaScript définie dans le fichier de script associé à l'extension (pour les extensions CSXS)
• Le fichier .js défini dans le paramètre scriptPath pour les extensions non basées sur CSXS.
Arguments
controlID, javascript function call
• controlID est l'ID de l'extension qui doit exécuter le script. Cet ID doit correspondre à l'ID spécifié comme
premier paramètre de
dw.flash.newControl().
• L'argument d'appel de fonction JavaScript permet à l'utilisateur d'appeler une fonction avec n'importe quel nombre
de paramètres.
Valeurs renvoyées
Valeur booléenne,
true si l'exécution de la fonction a réussi et false dans le cas contraire. dans le cas contraire.
dreamweaver.flash.executeScript()
Disponibilité
Dreamweaver CS4.
Description
Cette fonction sert à exécuter des fonctions dans un fichier .js. Le code ActionScript dans le fichier .swf démarre la
fonction
dreamweaver.flash.executeScript().
Arguments
javascript function call
Remarque : Définissez un chemin d'accès au fichier .js contenant les fonctions que vous voulez appeler.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
Intégration de Flash
Valeurs renvoyées
Chaîne XML qui se sérialise en un objet ActionScript.
Exemple
L'exemple suivant contient un fichier d'exemple, Sample.mxml, ainsi qu'une fonction JavaScript dans un fichier
JavaScript, Sample.js.
private function executeScript():void
{
if(ExternalInterface.available)
{
out.text += "SwfCalledHost\n";
var scriptText:String = "helloWorld('scott');\n";
var resultStr:Object =
ExternalInterface.call("dw.flash.executeScript",scriptText);
out.text += "Result: " + resultStr.strResult + '\n';
}
}
Le fichier JavaScript suivant contient une fonction JavaScript helloWorld() qui est appelée depuis le fichier .swf.
Cette fonction emploie l'appel
dw.getAppLanguage() pour renvoyer un code à cinq lettres de la langue dans laquelle
Dreamweaver s'exécute dans Sample.js.
50
function helloWorld(nameStr)
{
alert('hello ' + nameStr);
var appLanguage = dw.getAppLanguage();
var returnStr = '<object><property id="strResult"><string>Language: ' + appLanguage
+ '</string></property></object>'
alert(returnStr);
return (returnStr);
}
Voir aussi
« dreamweaver.flash.newControl() » à la page 43
dreamweaver.flash.controlExists
Disponibilité
Dreamweaver CS4.
Description
Cette fonction sert à vérifier l'existence des contrôles.
les lancements de Dreamweaver.
Arguments
controlID
Les contrôles PanelWindow sont enregistrés entre
Valeurs renvoyées
Valeur booléenne :
true si le contrôle a déjà été créé et false dans le cas contraire.
Dernière mise à jour le 22/6/2011
Chapitre 7 : Intégration de Photoshop
Adobe® Dreamweaver CS5® facilite une intégration compacte avec Adobe® Photoshop®. L'utilisateur peut insérer des
images Photoshop sous la forme d'objets dynamiques dans Dreamweaver. La fonctionnalité Objets dynamiques met
automatiquement à jour les images dans Dreamweaver si des modifications sont apportées aux images d'origine à
l'aide de Photoshop.
Fonctionnement des objets dynamiques
Les images Photoshop sont insérées dans Dreamweaver sous la forme d'objets dynamiques. Les objets dynamiques
restent liés aux images Photoshop d'origine. Lorsqu'un utilisateur modifie l'image dans Photoshop, il peut voir une
image mise à jour dans Dreamweaver. Un objet dynamique possède un état spécifique, qui résulte principalement de
la connexion de l'image Web à son fichier d'actif initial. L'utilisateur peut déterminer visuellement l'état d'un objet
dynamique. L'état de synchronisation d'un objet dynamique est indiqué par le badge Sync.
51
L'API des objets dynamiques
Les fonctions des objets dynamiques traitent des opérations relatives à l'intégration de Dreamweaver et de Photoshop.
Ces fonctions permettent d'effectuer les opérations suivantes :
• Récupération de l'état d'une image
• Récupération de la hauteur et de la largeur d'une image
dreamweaver.assetPalette.canUpdateSmartObjectFromOriginal()
Disponibilité
Dreamweaver CS4.
Description
Activateur : Cette fonction vérifie si un objet dynamique, sur lequel on peut émettre la commande Mettre à jour depuis
l'original, est sélectionné dans le panneau actif.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne :
false dans le cas contraire.
true si la commande Mettre à jour depuis l'original peut être appliquée à la sélection actuelle.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
Intégration de Photoshop
dreamweaver.assetPalette.updateSmartObjectFromOriginal()
Disponibilité
Dreamweaver CS4.
Description
Cette fonction recrée l'image Web sélectionnée sur la base du contenu actuel du fichier source d'origine connecté.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dreamweaver.getSmartObjectState()
Disponibilité
Dreamweaver CS4.
52
Description
Cette fonction renvoie l'état d'une image Web en termes de fonctionnalités d'objets dynamiques.
Arguments
URL locale absolue d'une image Web.
Valeurs renvoyées
L'état de l'objet dynamique sous la forme d'une valeur numérique, comme :
Valeur numérique Description
-10 Erreur inconnue
0 Pas d'objet dynamique.
1 Synchronisé avec le contenu du fichier d'actif d'origine.
100 Image Web modifiée après la dernière synchronisation.
200 Actif d'origine modifié après la dernière synchronisation.
+2 Les dimensions de l'actif d'origine diffèrent des attributs de largeur et de hauteur dans le code HTML.
+4 Les dimensions de l'image Web diffèrent des attributs de largeur et de hauteur dans le code HTML.
10 Impossible d'accéder au fichier d'actif d'origine.
20 Impossible d'accéder au fichier d'image Web.
dreamweaver.getSmartObjectOriginalWidth()
Disponibilité
Dreamweaver CS4.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
Intégration de Photoshop
Description
Cette fonction évalue et renvoie la largeur en pixels du fichier d'actif d'origine d'un objet dynamique.
Arguments
URL locale absolue de l'image Web.
Valeurs renvoyées
Largeur en pixels du fichier d'actif d'origine.
dreamweaver.getImageWidth()
Disponibilité
Dreamweaver CS4.
Description
Cette fonction évalue et renvoie la largeur en pixels d'une image.
Arguments
URL locale absolue d'une image Web.
53
Valeurs renvoyées
Largeur en pixels de l'image.
dreamweaver.getImageHeight()
Disponibilité
Dreamweaver CS4.
Description
Cette fonction évalue et renvoie la hauteur en pixels d'une image.
Arguments
URL locale absolue d'une image Web.
Valeurs renvoyées
Hauteur en pixels de l'image.
dreamweaver.resolveOriginalAssetFileURLToAbsoluteLocalFilePath()
Disponibilité
Dreamweaver CS4.
Description
Cette fonction résout un chemin d'accès de fichier à un fichier d'accès d'origine (tel que stocké dans les Design Notes).
Le chemin peut être vide, relatif au site ou absolu.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
Intégration de Photoshop
Arguments
URL locale absolue ou relative au site de l'image Web. Cette URL est requise pour la résolution du site.
Valeurs renvoyées
Chemin d'accès absolu au fichier local.
dreamweaver.canUpdateSmartObjectFromOriginal()
Disponibilité
Dreamweaver CS4.
Description
Cette fonction spécifie si un objet dynamique peut être mis à jour à partir de son fichier d'actif d'origine.
Arguments
Etat numérique de l'objet dynamique
Valeurs renvoyées
Valeur booléenne :
true si l'état autorise une mise à jour à partir de l'image d'origine, false
dans le cas contraire.
ImageManipulatorSettings : GetSmartObjectStatus() renvoie cet état.
54
dreamweaver.updateSmartObjectFromOriginal()
Disponibilité
Dreamweaver CS4.
Description
Cette fonction met à jour une image Web sur la base du contenu actuel d'un fichier source d'origine.
Arguments
URL locale absolue d'une image Web.
Valeurs renvoyées
Aucune.
Dernière mise à jour le 22/6/2011
Chapitre 8 : API de base de données
Les fonctions de l'API de base de données permettent de gérer les connexions aux bases de données et d'accéder aux
informations stockées dans ces dernières. L'API de base de données est divisée en deux fonctions distinctes : gestion
des connexions aux bases de données et accès aux connexions de bases de données.
Les fonctions de l'API de base de données sont utilisées au moment de la conception, lorsque les utilisateurs
développent leurs applications Web, et non au moment de l'exécution, c'est-à-dire lorsque l'application Web est
déployée.
Il est possible d'utiliser ces fonctions dans n'importe quelle extension. En fait, les API de comportement de serveur, de
format des données et de source de données d'Adobe® Dreamweaver® CS5 utilisent toutes ces fonctions de base de
données.
Fonctionnement de l'API de base de données
L'exemple suivant illustre la façon dont la fonction de comportement de serveur, getDynamicBindings(), est définie
pour Recordset.js. Cet exemple utilise la fonction
MMDB.getColumnAndTypeList() :
55
function getDynamicBindings(ss)
{
var serverModel = dw.getDocumentDOM().serverModel.getServerName();
var bindingsAndTypeArray = new Array();
var connName=ss.connectionName;
var statement = ss.source;
var rsName= ss.rsName;
// remove SQL comments
statement = statement.replace(/\/\*[\S\s]*?\*\//g, " ");
var bIsSimple = ParseSimpleSQL(statement);
statement = stripCFIFSimple(statement);
if (bIsSimple) {
statement = RemoveWhereClause(statement,false);
} else {
var pa = new Array();
if (ss.ParamArray != null) {
for (var i = 0; i < ss.ParamArray.length; i++) {
pa[i] = new Array();
pa[i][0] = ss.ParamArray[i].name;
pa[i][1] = ss.ParamArray[i].value;
}
}
var statement = replaceParamsWithVals(statement, pa, serverModel);
}
bindingsAndTypeArray = MMDB.getColumnAndTypeList(connName, statement);
return bindingsAndTypeArray;
}
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de base de données
Fonctions de connexion à une base de données
Les fonctions de connexion à une base de données vous permettent d'établir et de gérer toutes les connexions, y
compris les connexions ADO de Dreamweaver, ColdFusion et JDBC.
Ces fonctions interagissent avec le Gestionnaire de connexions uniquement ; elles n'accèdent pas aux bases de
données. Pour les fonctions qui accèdent aux bases de données, voir « Fonctions d'accès à la base de données » à la
page 68.
Dans le cadre de la gestion des connexions de bases de données, vous pouvez obtenir le nom d'utilisateur et le mot de
passe afin d'accomplir des activités telles que :
• Etablissement d'une connexion à une base de données
• Ouverture d'une boîte de dialogue de connexion à une base de données
MMDB.deleteConnection()
Disponibilité
Dreamweaver MX.
56
Description
Cette fonction permet de supprimer la connexion à la base de données nommée.
Arguments
connName
• L'argument connName est le nom de la connexion à la base de données tel qu'il est spécifié dans le Gestionnaire de
connexions. Cet argument identifie la connexion à la base de données à supprimer en fonction de son nom.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant supprime une connexion à une base de données :
function clickedDelete()
{
var selectedObj = dw.serverComponents.getSelectedNode();
if (selectedObj && selectedObj.objectType=="Connection")
{
var connRec = MMDB.getConnection(selectedObj.name);
if (connRec)
{
MMDB.deleteConnection(selectedObj.name);
dw.serverComponents.refresh();
}
}
}
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de base de données
MMDB.getColdFusionDsnList()
Disponibilité
Dreamweaver UltraDev 4.
Description
Cette fonction extrait les noms des sources de données (DSN) ColdFusion du serveur du site, en utilisant les fonctions
getRDSUserName() et getRDSPassword().
Arguments
Aucun.
Valeurs renvoyées
Tableau contenant les DSN ColdFusion définis sur le serveur pour le site en cours.
MMDB.getConnection()
Disponibilité
Dreamweaver UltraDev 4, amélioré dans Dreamweaver MX.
57
Description
Extrait un objet de connexion nommé.
Arguments
name
• L'argument name est une variable de chaîne qui spécifie le nom de la connexion à laquelle vous souhaitez faire
référence.
Valeurs renvoyées
Référence à un objet de connexion nommé. Les objets de connexion ont les propriétés suivantes :
Propriété Description
name Nom de connexion
type Indique, si useHTTP a pour valeur false, quel fichier DLL utiliser pour se connecter à une base de
string Chaîne de connexion ADO d'exécution ou URL JDBC
dsn DSN ColdFusion
driver Pilote JDBC d'exécution
username Nom d'utilisateur d'exécution
password Mot de passe d'exécution
données en exécution.
useHTTP Chaîne qui contient la valeur true ou false, indiquant si vous devez utiliser un pilote distant
(connexion HTTP) au moment de la conception ou un pilote local (DLL).
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de base de données
Propriété Description
58
includePattern Expression régulière utilisée pour trouver l'instruction d'inclusion de fichier sur la page pendant Live
variables Tableau de noms de variables de pages et leurs valeurs correspondantes, utilisé pendant Live Data
catalog Utilisé pour restreindre les métadonnées qui apparaissent (pour plus d'informations, voir
schema Utilisé pour restreindre les métadonnées qui apparaissent (pour plus d'informations, voir
filename Nom de fichier de boîte de dialogue qui était utilisé pour créer la connexion
Data et Aperçu dans le navigateur
et Aperçu dans le navigateur
« MMDB.getProcedures() » à la page 71)
« MMDB.getProcedures() » à la page 71)
Remarque : Il s'agit des propriétés standard implémentées par Dreamweaver. Les développeurs peuvent définir leurs
propres types de connexion et ajouter de nouvelles propriétés à cet ensemble standard, ou bien fournir un ensemble
différent de propriétés.
MMDB.getConnectionList()
Disponibilité
Dreamweaver UltraDev 1.
Description
Cette fonction extrait une liste de toutes les chaînes de connexion définies dans le Gestionnaire de connexions.
Arguments
Aucun.
Valeurs renvoyées
Tableau de chaînes, chaque chaîne correspondant au nom d'une connexion tel qu'il apparaît dans le Gestionnaire de
connexions.
Exemple
La fonction
MMDB.getConnectionList() peut renvoyer les chaînes ["EmpDB", "Test", "TestEmp"].
MMDB.getConnectionName()
Disponibilité
Dreamweaver UltraDev 1.
Description
Extrait un nom de connexion correspondant à la chaîne de connexion spécifiée. Cette fonction est utile lorsque vous
devez resélectionner un nom de connexion dans l'interface utilisateur (UI) à partir des données de la page.
Si vous avez une chaîne de connexion faisant référence à deux pilotes différents, vous pouvez spécifier à la fois la chaîne
de connexion et le pilote correspondant au nom de connexion que vous souhaitez obtenir. Par exemple, vous pourriez
avoir deux connexions :
• Connexion 1 possède les propriétés suivantes :
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de base de données
ConnectionString="jdbc:inetdae:velcro-qa-5:1433?database=pubs"
DriverName="com.inet.tds.TdsDriver"
• Connexion 2 possède les propriétés suivantes :
ConnectionString="jdbc:inetdae:velcro-qa-5:1433?database=pubs"
DriverName="com.inet.tds.TdsDriver2"
Les chaînes de connexion de Connexion 1 et Connexion 2 sont identiques. Connexion 2 établit une connexion avec
une version plus récente de
TdsDriver. Vous devez transmettre le nom du pilote à cette fonction pour définir
complètement le nom de connexion que vous souhaitez obtenir.
Arguments
connString, {driverName}
• connString est la chaîne de connexion qui extrait le nom de la connexion.
• L'argument facultatif driverName définit l'argument connString de manière plus précise.
Valeurs renvoyées
Chaîne de nom de connexion correspondant à la chaîne de connexion.
Exemple
Le code suivant renvoie la chaîne
"EmpDB" :
59
var connectionName = MMDB.getConnectionName ¬
("dsn=EmpDB;uid=;pwd=");
MMDB.getConnectionString()
Disponibilité
Dreamweaver UltraDev 1.
Description
Extrait la chaîne de connexion associée à la connexion nommée.
Arguments
connName
• connName est un nom de connexion spécifié dans le Gestionnaire de connexions. Il identifie la chaîne de connexion
que Dreamweaver doit utiliser pour connecter la base de données à une source de données active.
Valeurs renvoyées
Chaîne de connexion qui correspond à la connexion nommée.
Exemple
Le code
connexion ADO ou JDBC.
var connectionString = MMDB.getConnectionString ("EmpDB") renvoie différentes chaînes pour une
• Pour une connexion ADO, la chaîne suivante peut renvoyer :
"dsn=EmpDB;uid=;pwd=";
• Pour une connexion JDBC, la chaîne suivante peut renvoyer :
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de base de données
"jdbc:inetdae:192.168.64.49:1433?database=pubs&user=JoeUser&¬
password=joesSecret"
MMDB.getDriverName()
Disponibilité
Dreamweaver UltraDev 1.
Description
Extrait le nom du pilote associé à la connexion spécifiée. Seules les connexions JDBC ont des noms de pilote.
Arguments
connName
• connName est un nom de connexion spécifié dans le Gestionnaire de connexions. Il identifie la chaîne de connexion
que Dreamweaver doit utiliser pour connecter la base de données à une source de données active.
Valeurs renvoyées
Chaîne contenant le nom du pilote.
60
Exemple
L'instruction
"jdbc/oracle/driver/JdbcOracle"
MMDB.getDriverName ("EmpDB"); peut renvoyer la chaîne suivante :
MMDB.getLocalDsnList()
Disponibilité
Dreamweaver UltraDev 4.
Description
Extrait les DSN ODBC définis dans le système de l'utilisateur.
Arguments
Aucun.
Valeurs renvoyées
Tableau contenant les DSN ODBC définis sur le système de l'utilisateur.
MMDB.getPassword()
Disponibilité
Dreamweaver UltraDev 1.
Description
Extrait le mot de passe utilisé pour la connexion spécifiée.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de base de données
Arguments
connName
• connName est un nom de connexion spécifié dans le Gestionnaire de connexions. Il identifie la chaîne de connexion
que Dreamweaver doit utiliser pour connecter la base de données à une source de données active.
Valeurs renvoyées
Une chaîne de mot de passe associée au nom de connexion.
Exemple
L'instruction
MMDB.getPassword ("EmpDB"); peut renvoyer "joessecret".
MMDB.getRDSPassword()
Disponibilité
Dreamweaver UltraDev 4.
Description
Extrait le mot de passe Remote Development Services (RDS) (à utiliser avec les connexions ColdFusion).
61
Arguments
Aucun.
Valeurs renvoyées
Chaîne contenant le mot de passe RDS.
MMDB.getRDSUserName()
Disponibilité
Dreamweaver UltraDev 4.
Description
Extrait le nom d'utilisateur RDS (à utiliser avec les connexions ColdFusion).
Arguments
Aucun.
Valeurs renvoyées
Une chaîne contenant le nom d'utilisateur RDS.
MMDB.getRemoteDsnList()
Disponibilité
Dreamweaver UltraDev 4, amélioré dans Dreamweaver MX.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de base de données
Description
Extrait les DSN ODBC du serveur de site. Les fonctions
getRDSUserName() et getRDSPassword() sont utilisées
lorsque le modèle de serveur du site en cours est ColdFusion. Cette fonction offre aux développeurs la possibilité de
spécifier une chaîne de paramètre URL à annexer à l'URL Remote Connectivity générée par
MMDB.getRemoteDsnList(). Si le développeur fournit une chaîne de paramètre, cette fonction la transmet aux scripts
de connectivité HTTP.
Arguments
{urlParams}
• L'argument facultatif urlParams est une chaîne contenant une liste d'expressions nom=valeur, séparées par des
esperluettes (&). Les valeurs ne doivent pas être entourées de guillemets. Certains caractères, tels que l'espace dans
la valeur
MMDB.getRemoteDsnList(): a=1&b=Hello%20World
Hello World, doivent être codés. Voici un exemple d'argument valide que vous pouvez transmettre dans
Valeurs renvoyées
Renvoie un tableau contenant les DSN ODBC définis sur le serveur pour le site en cours.
MMDB.getRuntimeConnectionType()
62
Disponibilité
Dreamweaver UltraDev 1.
Description
Renvoie le type de connexion d'exécution du nom de connexion spécifié.
Arguments
connName
• connName est un nom de connexion spécifié dans le Gestionnaire de connexions. Il identifie la chaîne de connexion
que Dreamweaver doit utiliser pour connecter la base de données à une source de données active.
Valeurs renvoyées
Chaîne correspondant au type de connexion. Cette fonction peut renvoyer l'une des valeurs suivantes :
"ADODSN", "JDBC" ou "CFDSN".
"ADO",
Exemple
Le code suivant renvoie la chaîne
var connectionType = MMDB.getRuntimeConnectionType ("EmpDB")
"ADO" pour une connexion ADO :
MMDB.getUserName()
Disponibilité
Dreamweaver UltraDev 1.
Description
Renvoie un nom d'utilisateur pour la connexion spécifiée.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de base de données
Arguments
connName
• connName est un nom de connexion spécifié dans le Gestionnaire de connexions. Il identifie la chaîne de connexion
que Dreamweaver doit utiliser pour connecter la base de données à une source de données active.
Valeurs renvoyées
Chaîne de nom d'utilisateur associée au nom de connexion.
Exemple
L'instruction
MMDB.getUserName ("EmpDB"); peut renvoyer "amit".
MMDB.hasConnectionWithName()
Disponibilité
Dreamweaver UltraDev 4.
Description
Détermine l'existence de la connexion d'un nom donné.
63
Arguments
name
• name est le nom de la connexion.
Valeurs renvoyées
Renvoie une valeur booléenne :
true indique l'existence d'une connexion ayant le nom spécifié et false indique le
contraire.
MMDB.needToPromptForRdsInfo()
Disponibilité
Dreamweaver MX.
Description
Cette fonction détermine si Dreamweaver doit ouvrir la boîte de dialogue des informations de connexion RDS.
Arguments
bForce
• L'argument bForce est une valeur booléenne ; true indique que l'utilisateur ayant précédemment annulé la boîte de
dialogue RDS doit toujours être invité à saisir les informations de connexion RDS.
Valeurs renvoyées
Valeur booléenne :
indique le contraire.
true indique que l'utilisateur doit être invité à saisir les informations de connexion RDS ; false
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de base de données
MMDB.needToRefreshColdFusionDsnList()
Disponibilité
Dreamweaver MX.
Description
Ordonne au Gestionnaire de connexions de vider la mémoire cache et d'extraire la liste des sources des données
ColdFusion du serveur d'application la prochaine fois qu'un utilisateur demande la liste.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
MMDB.popupConnection()
Disponibilité
Dreamweaver MX.
64
Description
Cette fonction lance une boîte de dialogue de connexion. Cette fonction a les trois signatures suivantes :
• Si la liste d'arguments ne comporte que dialogFileName (une chaîne), popupConnection() provoque le lancement
de la boîte de dialogue de connexion dans Dreamweaver, pour que vous puissiez y définir une nouvelle connexion.
• Si la liste d'arguments ne comporte que connRec (une référence de connexion), popupConnection() provoque le
lancement de la boîte de dialogue de connexion en mode d'édition dans Dreamweaver, pour que vous puissiez y
modifier la connexion nommée. Dans ce mode, la zone de texte du nom s'affiche en grisé.
• Si la liste d'arguments ne comporte que connRec et la valeur booléenne bDuplicate, popupConnection() provoque
le lancement de la boîte de dialogue en mode dupliqué dans Dreamweaver. Dans ce mode, la zone de texte du nom
s'affiche en grisé et les propriétés restantes sont copiées pour définir une connexion dupliquée.
Arguments
dialogFileName ou connRec ou connrec, bDuplicate
• dialogFileName est une chaîne qui contient le nom d'un fichier HTML résidant dans le dossier
Configuration/Connections/server-model. Ce fichier HTML définit la boîte de dialogue qui crée une connexion. Ce
fichier doit déployer trois fonctions d'API JavaScript :
applyConnection(). En général, vous créez un fichier JavaScript qui implémente ces fonctions, puis vous intégrez
ce fichier au fichier HTML. Pour plus d'informations sur la création d'une connexion, voir « API de connectivité à
une base de données » à la page 80.
findConnection(), inspectConnection() et
• connRec est une référence à un objet de connexion existant.
• bDuplicate est une valeur booléenne.
Valeurs renvoyées
Aucune. La boîte de dialogue de connexion définie s'ouvre.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de base de données
MMDB.setRDSPassword()
Disponibilité
Dreamweaver UltraDev 4.
Description
Définit le mot de passe RDS.
Arguments
password
• password est une chaîne contenant le mot de passe RDS.
Valeurs renvoyées
Aucune.
MMDB.setRDSUserName()
65
Disponibilité
Dreamweaver UltraDev 4.
Description
Définit le nom d'utilisateur RDS.
Arguments
username
• L'argument username est le nom d'un utilisateur RDS valide.
Valeurs renvoyées
Aucune.
MMDB.showColdFusionAdmin()
Disponibilité
Dreamweaver MX.
Description
Affiche la boîte de dialogue ColdFusion Administrator.
Arguments
Aucun.
Valeurs renvoyées
Aucune. La boîte de dialogue ColdFusion Administrator s'affiche.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de base de données
MMDB.showConnectionMgrDialog()
Disponibilité
Dreamweaver UltraDev 1.
Description
Affiche la boîte de dialogue Gestionnaire de connexions.
Arguments
Aucun.
Valeurs renvoyées
Aucune. La boîte de dialogue Gestionnaire de connexions s'affiche.
MMDB.showOdbcDialog()
Disponibilité
Dreamweaver UltraDev 4 (Windows uniquement).
66
Description
Affiche la boîte de dialogue d'administration ODBC système ou Administrateur de source de données ODBC.
Arguments
Aucun.
Valeurs renvoyées
Aucune. La boîte de dialogue d'administration ODBC système ou Administrateur de source de données ODBC
apparaît.
MMDB.showRdsUserDialog()
Disponibilité
Dreamweaver UltraDev 4.
Description
Affiche la boîte de dialogue demandant le nom d'utilisateur et du mot de passe RDS.
Arguments
username, password
• username est le nom d'utilisateur initial.
• password est le mot de passe initial.
Valeurs renvoyées
Objet contenant les nouvelles valeurs dans les propriétés
définie, ceci indique que l'utilisateur a annulé la boîte de dialogue.
username et password. Si l'une des propriétés n'est pas
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de base de données
MMDB.showRestrictDialog()
Disponibilité
Dreamweaver UltraDev 4.
Description
Affiche la boîte de dialogue Restreindre.
Arguments
catalog, schema
• catalog est la valeur de catalogue initiale.
• L'argument schema est la valeur de schéma initiale.
Valeurs renvoyées
Objet contenant les nouvelles valeurs dans les propriétés
ceci indique que l'utilisateur a annulé la boîte de dialogue.
67
catalog et schema. Si l'une des propriétés n'est pas définie,
MMDB.testConnection()
Disponibilité
Dreamweaver UltraDev 4.
Description
Teste les paramètres de connexion. Affiche une boîte de dialogue modale qui décrit les résultats.
Arguments
serverPropertiesArray
Cette fonction attend un seul argument, un objet de tableau contenant les valeurs de la liste suivante adaptées au
modèle de serveur en cours. Pour les propriétés qui ne s'appliquent pas à la connexion testée, laissez-les vides (
• type indique, lorsque useHTTP est une valeur false, quelle DLL utiliser pour se connecter à une base de données
au moment de la conception, pour tester les paramètres de connexion.
• string est la chaîne de connexion ADO ou l'URL JDBC.
• dsn est le nom de la source de données.
• driver est le pilote JDBC.
• username est le nom d'utilisateur.
• L'argument password est le mot de passe.
• L'argument useHTTP est une valeur booléenne. Une valeur true spécifie que Dreamweaver doit utiliser une
connexion HTTP au moment de la conception ; dans le cas contraire, Dreamweaver utilise une DLL.
"").
Valeurs renvoyées
Valeur booléenne,
true si le test de connexion est réussi, false dans le cas contraire.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de base de données
Fonctions d'accès à la base de données
Les fonctions d'accès à la base de données vous permettent de faire une recherche dans la base de données.
L'accès aux informations de base de données permet par exemple d'extraire les métadonnées qui décrivent le schéma
ou la structure d'une base de données. Ces métadonnées incluent des informations telles que les noms des tables, des
colonnes, des procédures stockées et des affichages. Vous pouvez également afficher les résultats de l'exécution d'une
requête de base de données ou d'une procédure stockée. Lorsque vous accédez à une base de données par le biais de
cette API, vous utilisez des instructions SQL (Structured Query Language).
Pour l'ensemble des fonctions qui gèrent une connexion à une base de données, voir « Fonctions de connexion à une
base de données » à la page 56.
La liste suivante décrit certains des arguments communs à toutes les fonctions disponibles :
• La plupart des fonctions d'accès à une base de données utilisent un nom de connexion comme argument. Pour
obtenir une liste des noms de connexion valides, utilisez le Gestionnaire de connexions ou la fonction
MMDB.getConnectionList(). Cette dernière vous permet d'obtenir par programmation une liste de tous les noms
de connexion.
• Les procédures stockées exigent souvent des paramètres. Vous pouvez spécifier des valeurs de paramètre pour les
fonctions d'accès à la base de données de deux façons. En premier lieu, vous pouvez fournir un tableau de valeurs
de paramètre (
l'ordre dans lequel la procédure stockée les demande. Spécifiez ensuite les valeurs de paramètre pour fournir un
tableau des noms de paramètre (
MMDB.getSPParamsAsString() pour obtenir les paramètres de la procédure stockée. Si vous fournissez des noms
de paramètres, les valeurs spécifiées dans
spécifiés dans
paramValuesArray). Si vous ne spécifiez que des valeurs de paramètre, celles-ci doivent être dans
paramNameArray). Vous pouvez utiliser la fonction
paramValuesArray doivent être dans l'ordre dans lequel les noms ont été
paramNameArray.
68
MMDB.getColumnAndTypeList()
Disponibilité
Dreamweaver UltraDev 1.
Description
Cette fonction extrait une liste de colonnes et leurs types respectifs d'une déclaration SQL
Arguments
connName, déclaration
• connName est un nom de connexion spécifié dans le Gestionnaire de connexions. Il identifie la chaîne de connexion
que Dreamweaver doit utiliser pour connecter la base de données à une source de données active.
• L'argument statement est la déclaration SQL SELECT à exécuter.
Valeurs renvoyées
Un tableau de chaînes qui représente une liste de colonnes (et leur type) qui correspondent à la déclaration
ou bien une erreur si la déclaration SQL n'est pas valide ou si la connexion n'a pas pu s'établir.
SELECT exécutée.
SELECT,
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de base de données
Exemple
Le code
var columnArray = MMDB.getColumnAndTypeList("EmpDB","Select * from Employees") renvoie le
tableau de chaînes suivant :
columnArray[0] = "EmpName"
columnArray[1] = "varchar"
columnArray[2] = "EmpFirstName"
columnArray[3] = "varchar"
columnArray[4] = "Age"
columnArray[5] = "integer"
MMDB.getColumnList()
Disponibilité
Dreamweaver UltraDev 1.
Description
Cette fonction extrait la liste de colonnes d'une déclaration SQL
Arguments
connName, déclaration
69
SELECT exécutée.
• connName est un nom de connexion spécifié dans le Gestionnaire de connexions. Il identifie la chaîne de connexion
que Dreamweaver doit utiliser pour connecter la base de données à une source de données active.
• L'argument statement est la déclaration SQL SELECT à exécuter.
Valeurs renvoyées
Un tableau de chaînes qui représente une liste de colonnes correspondant à la déclaration
SELECT, ou une erreur si la
déclaration SQL n'est pas valide ou si la connexion n'a pas pu s'établir.
Exemple
Le code
var columnArray = MMDB.getColumnList("EmpDB","Select * from Employees") renvoie le tableau
de chaînes suivant :
columnArray[0] = "EmpName"
columnArray[1] = "EmpFirstName"
columnArray[2] = "Age"
MMDB.getColumns()
Disponibilité
Dreamweaver MX, arguments mis à jour dans MX 2004.
Description
Renvoie un tableau d'objets qui décrivent les colonnes de la table spécifiée.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de base de données
Arguments
connName, tableName
• L'argument connName est le nom de la connexion. Cette valeur identifie la connexion qui contient la chaîne que
Dreamweaver doit utiliser pour établir une connexion de base de données à une source de données active.
• tableName est la table à interroger.
Valeurs renvoyées
Un tableau d'objets, à raison d'un objet par colonne. Chaque objet définit les trois propriétés suivantes pour la colonne
à laquelle il est associé.
Nom de propriété Description
name Nom de la colonne (par exemple, price)
datatype Type de données de la colonne (par exemple, small money)
definedsize Taille définie de la colonne (par exemple, 8)
nullable Indique si la colonne peut contenir des valeurs null
Exemple
L'exemple suivant utilise
MMDB.getColumns() pour définir la valeur du texte de l'infobulle :
70
var columnNameObjs = MMDB.getColumns(connName,tableName);
var databaseType = MMDB.getDatabaseType(connName);
for (i = 0; i < columnNameObjs.length; i++)
{
var columnObj = columnNameObjs[i];
var columnName = columnObj.name;
var typename = columnObj.datatype;
if (dwscripts.isNumber(typename))
{
// it already is a num
typename = dwscripts.getDBColumnTypeAsString(typename, databaseType);
}
var tooltiptext = typename;
}
MMDB.getColumnsOfTable()
Disponibilité
Dreamweaver UltraDev 1.
Description
Cette fonction extrait une liste de toutes les colonnes de la table spécifiée.
Arguments
connName, tableName
• connName est un nom de connexion spécifié dans le Gestionnaire de connexions. Il identifie la chaîne de connexion
que Dreamweaver doit utiliser pour connecter la base de données à une source de données active.
• L'argument tableName est le nom d'une table de la base de données désignée par l'argument connName.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de base de données
Valeurs renvoyées
Un tableau de chaînes dont chaque chaîne est le nom d'une colonne de la table.
Exemple
L'instruction
["EmpID", "FirstName", "LastName"]
MMDB.getColumnsOfTable ("EmpDB","Employees"); renvoie les chaînes suivantes :
MMDB.getPrimaryKeys()
Disponibilité
Dreamweaver MX.
Description
Renvoie les noms de colonne qui s'associent pour former la clé primaire de la table nommée. Une clé primaire sert
d'identificateur unique pour une ligne de base de données et se compose d'une colonne minimum.
Arguments
connName, tableName
71
• connName est un nom de connexion spécifié dans le Gestionnaire de connexions. Il identifie la chaîne de connexion
que Dreamweaver doit utiliser pour connecter la base de données à une source de données active.
• L'argument tableName est le nom de la table pour laquelle vous souhaitez restituer l'ensemble des colonnes
comprenant la clé primaire de cette table.
Valeurs renvoyées
Tableau de chaînes. Le tableau contient une chaîne pour chaque colonne comprenant la clé primaire.
Exemple
L'exemple suivant renvoie la clé primaire de la table spécifiée.
var connName = componentRec.parent.parent.parent.name;
var tableName = componentRec.name;
var primaryKeys = MMDB.getPrimaryKeys(connName,tableName);
MMDB.getProcedures()
Disponibilité
Dreamweaver MX.
Description
Cette fonction renvoie un tableau d'objets de procédure associés à une connexion nommée.
Arguments
connName
• connName est un nom de connexion spécifié dans le Gestionnaire de connexions. Il identifie la chaîne de connexion
que Dreamweaver doit utiliser pour connecter la base de données à une source de données active.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de base de données
Valeurs renvoyées
Un tableau d'objets de procédure dans lequel chaque objet de procédure a les trois propriétés suivantes :
Nom de propriété Description
schema Nom du schéma associé à l'objet.
Cette propriété identifie l'utilisateur associé à la procédure stockée dans la base de données SQL et à laquelle
accède la fonction
de connexion.
getProcedures(). La base de données à laquelle accède cette fonction dépend du type
• Pour les connexions ODBC, la source de données ODBC définit la base de données. Le DSN est spécifié par
la propriété
getProcedures().
dsn dans l'objet de connexion (connName) que vous transmettez à la fonction
• Pour les connexion à la BD OLE, la chaîne de connexion donne un nom à la base de données.
catalog Nom du catalogue associé à l'objet (qualificatif de propriétaire).
La valeur de la propriété
définit une propriété
n'indique pas de base de données.
procedure Nom de la procédure.
catalog est définie par un attribut du pilote de la BD OLE. Cet attribut du pilote
user.database par défaut à utiliser lorsque la chaîne de connexion à la BD OLE
Remarque : Dreamweaver se connecte à la base de données et en extrait toutes les tables chaque fois que vous modifiez
un jeu d'enregistrements. Si la base de données contient de nombreuses tables, la procédure de leur extraction par
Dreamweaver sur certains systèmes peut prendre beaucoup de temps. Si votre base de données contient un schéma ou un
catalogue, vous pouvez l'utiliser pour limiter le nombre d'éléments de base de données que Dreamweaver récupère au
moment de la conception. Pour commencer, créez un schéma ou un catalogue dans votre application de base de données
de façon à pouvoir ensuite l'appliquer dans Dreamweaver. Consultez la documentation de votre système de base de
données ou consultez votre administrateur système.
72
Exemple
Le code suivant extrait une liste de procédures :
var procObjects = MMDB.getProcedures(connectionName);
for (i = 0; i < procObjects.length; i++)
{
var thisProcedure = procObjects[i]
thisSchema =Trim(thisProcedure.schema)
if (thisSchema.length == 0)
{
thisSchema = Trim(thisProcedure.catalog)
}
if (thisSchema.length > 0)
{
thisSchema += "."
}
var procName = String(thisSchema + thisProcedure.procedure);
}
MMDB.getSPColumnList()
Disponibilité
Dreamweaver UltraDev 1.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de base de données
Description
Cette fonction extrait une liste de colonnes de jeu de résultats générées par un appel à la procédure stockée spécifiée.
Arguments
connName, statement, paramValuesArray
• connName est un nom de connexion spécifié dans le Gestionnaire de connexions. Il identifie la chaîne de connexion
que Dreamweaver doit utiliser pour connecter la base de données à une source de données active.
• L'argument statement est le nom de la procédure stockée qui renvoie le jeu de résultats lorsqu'elle est exécutée.
• L'argument paramValuesArray est un tableau contenant une liste de valeurs tests de paramètre au moment de la
conception. Spécifiez les valeurs de paramètre dans l'ordre attendu par la procédure stockée. Vous pouvez utiliser
la fonction
MMDB.getSPParamsAsString() pour obtenir les paramètres de la procédure stockée.
Valeurs renvoyées
Tableau de chaînes représentant la liste des colonnes. Cette fonction renvoie une erreur lorsque l'instruction SQL ou
la chaîne de connexion est incorrecte.
Exemple
Le code suivant peut renvoyer une liste de colonnes de jeux de résultats générées à partir de la procédure stockée
exécutée,
getNewEmployeesMakingAtLeast :
73
var paramValueArray = new Array("2/1/2000", "50000")
var columnArray = MMDB.getSPColumnList("EmpDB", ¬
"getNewEmployeesMakingAtLeast", paramValueArray)
The following values return:
columnArray[0] = "EmpID", columnArray[1] = "LastName", ¬
columnArray[2] ="startDate", columnArray[3] = "salary"
MMDB.getSPColumnListNamedParams()
Disponibilité
Dreamweaver UltraDev 1.
Description
Cette fonction extrait une liste de colonnes de jeu de résultats générées par un appel à la procédure stockée spécifiée.
Arguments
connName, statement, paramNameArray, paramValuesArray
• connName est un nom de connexion spécifié dans le Gestionnaire de connexions. Il identifie la chaîne de connexion
que Dreamweaver doit utiliser pour connecter la base de données à une source de données active.
• L'argument statement est le nom de la procédure stockée qui renvoie le jeu de résultats lorsqu'elle est exécutée.
• L'argument paramNameArray est un tableau contenant une liste de noms de paramètres. Vous pouvez utiliser la
fonction
MMDB.getSPParamsAsString() pour obtenir les paramètres de la procédure stockée.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de base de données
• L'argument paramValuesArray est un tableau contenant une liste de valeurs tests de paramètre au moment de la
conception. Vous pouvez spécifier si oui ou non la procédure requiert des paramètres pendant l'exécution. Si vous
avez fourni des noms de paramètre dans paramNameArray, spécifiez les valeurs de paramètre dans l'ordre dans
lequel leurs noms apparaissent dans paramNameArray. Si vous n'avez pas indiqué paramNameArray, spécifiez les
valeurs dans l'ordre attendu par la procédure stockée.
Valeurs renvoyées
Tableau de chaînes représentant la liste des colonnes. Cette fonction renvoie une erreur lorsque l'instruction SQL ou
la chaîne de connexion est incorrecte.
Exemple
Le code suivant peut renvoyer une liste de colonnes de jeux de résultats générées à partir de la procédure stockée
exécutée,
var paramNameArray = new Array("startDate", "salary")
var paramValueArray = new Array("2/1/2000", "50000")
var columnArray = MMDB.getSPColumnListNamedParams("EmpDB", ¬
"getNewEmployeesMakingAtLeast", paramNameArray, paramValueArray)
getNewEmployeesMakingAtLeast :
Les valeurs suivantes sont retournées :
columnArray[0] = "EmpID", columnArray[1] = "LastName",¬
columnArray[2] ="startDate", columnArray[3] = "salary"
74
MMDB.getSPParameters()
Disponibilité
Dreamweaver MX.
Description
Cette fonction renvoie un tableau d'objets de paramètre pour une procédure nommée.
Arguments
connName, procName
• connName est un nom de connexion spécifié dans le Gestionnaire de connexions. Il identifie la chaîne de connexion
que Dreamweaver doit utiliser pour connecter la base de données à une source de données active.
• L'argument procName est le nom de la procédure.
Valeurs renvoyées
Tableau d'objets de paramètre, chacun d'entre eux spécifiant l'ensemble de propriétés suivant :
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de base de données
Nom de la propriété Description
name Nom du paramètre (par exemple, @@lolimit)
datatype Type de données du paramètre (par exemple, smallmoney)
direction Direction du paramètre :
1 : Le paramètre est utilisé uniquement pour l'entrée.
2 : Le paramètre est utilisé uniquement pour la sortie. Dans ce cas, vous transmettez le paramètre
par référence et la méthode place une valeur dedans. Vous pouvez utiliser la valeur une fois la
méthode renvoyée.
3 : Le paramètre est utilisé pour l'entrée et la sortie.
4 : Le paramètre contient une valeur de retour.
Exemple
L'exemple suivant extrait les objets de paramètre pour la procédure spécifiée et crée une infobulle pour chaque objet
qui utilise ses propriétés.
var paramNameObjs = MMDB.getSPParameters(connName,procName);
for (i = 0; i < paramNameObjs.length; i++)
{
var paramObj = paramNameObjs[i];
var tooltiptext = paramObj.datatype;
tooltiptext+=" ";
tooltiptext+=GetDirString(paramObj.directiontype);
}
75
MMDB.getSPParamsAsString()
Disponibilité
Dreamweaver UltraDev 1.
Description
Cette fonction extrait une chaîne délimitée par des virgules et contenant la liste des paramètres pris par la procédure
stockée.
Arguments
connName, procName
• connName est un nom de connexion spécifié dans le Gestionnaire de connexions. Il identifie la chaîne de connexion
que Dreamweaver doit utiliser pour connecter la base de données à une source de données active.
• L'argument procName est le nom de la procédure stockée.
Valeurs renvoyées
Chaîne délimitée par virgules contenant la liste des paramètres requis par la procédure stockée. Les noms, la direction
et le type de données des paramètres sont inclus, séparés par des points-virgules (;).
Exemple
Le code
de nom de formulaire
MMDB.getSPParamsAsString ("EmpDB","getNewEmployeesMakingAtLeast") peut renvoyer une chaîne
startDate;direction:in;datatype:date, salary;direction:in;datatype:integer.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de base de données
Dans cet exemple, la procédure stockée getNewEmployeesMakingAtLeast a deux paramètres: startDate et Salary.
startDate, la direction est in et le type de données est date. Pour salary, la direction est in et le type de
Pour
données est
date.
MMDB.getTables()
Disponibilité
Dreamweaver UltraDev 1.
Description
Extrait une liste de toutes les tables définies pour la base de données spécifiée. Chaque objet de table possède trois
propriétés :
Arguments
connName
• connName est un nom de connexion spécifié dans le Gestionnaire de connexions. Il identifie la chaîne de connexion
que Dreamweaver doit utiliser pour connecter la base de données à une source de données active.
table, schema et catalog.
76
Valeurs renvoyées
Tableau d'objets possédant chacun trois propriétés :
est le nom du schéma qui contient la table.
Catalog est le catalogue qui contient la table.
table, schema et catalog. Table est le nom de la table. Schema
Exemple
L'instruction
MMDB.getTables ("EmpDB"); pourrait produire un tableau de deux objets. Les propriétés du premier
objet peuvent ressembler à l'exemple suivant :
object1[table:"Employees", schema:"personnel", catalog:"syscat"]
Les propriétés du second objet peuvent ressembler à l'exemple suivant :
object2[table:"Departments", schema:"demo", catalog:"syscat2"]
MMDB.getViews()
Disponibilité
Dreamweaver UltraDev 4.
Description
Extrait une liste de tous les modes d'affichage définis pour la base de données spécifiée. Chaque objet mode d'affichage
a les propriétés
Arguments
connName
catalog, schema et view.
• connName est un nom de connexion spécifié dans le Gestionnaire de connexions. Il identifie la chaîne de connexion
que Dreamweaver doit utiliser pour connecter la base de données à une source de données active.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de base de données
Valeurs renvoyées
Tableau d'objets de mode possédant chacun trois propriétés :
catalog, schema et view. Catalog ou schema permet
de restreindre/filtrer le nombre de modes d'affichage rattachés à un nom de schéma individuel ou à un nom de
catalogue défini comme faisant partie des informations de connexion.
Exemple
L'exemple suivant renvoie les modes pour une valeur de connexion donnée,
var viewObjects = MMDB.getViews(CONN_LIST.getValue())
for (i = 0; i < viewObjects.length; i++)
{
thisView = viewObjects[i]
thisSchema = Trim(thisView.schema)
if (thisSchema.length == 0)
{
thisSchema = Trim(thisView.catalog)
}
if (thisSchema.length > 0)
{
thisSchema += "."
}
views.push(String(thisSchema + thisView.view))
}
CONN_LIST.getValue() :
77
MMDB.showResultset()
Disponibilité
Dreamweaver UltraDev 1.
Description
Affiche une boîte de dialogue contenant les résultats de l'exécution de la déclaration SQL spécifiée. La boîte de dialogue
contient une grille dont l'en-tête reflète les informations de colonnes qui décrivent le jeu de résultats. Si la chaîne de
connexion ou l'instruction SQL n'est pas valide, une erreur apparaît. Cette fonction valide l'instruction SQL.
Arguments
connName, SQLstatement
• connName est un nom de connexion spécifié dans le Gestionnaire de connexions. Il identifie la chaîne de connexion
que Dreamweaver doit utiliser pour connecter la base de données à une source de données active.
• L'argument SQLstatement désigne l'instruction SQL SELECT.
Valeurs renvoyées
Aucune. Cette fonction renvoie une erreur lorsque l'instruction SQL ou la chaîne de connexion est incorrecte.
Exemple
Le code suivant affiche le résultat de l'instruction SQL exécutée :
MMDB.showResultset("EmpDB","Select EmpName,EmpFirstName,Age ¬
from Employees")
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de base de données
MMDB.showSPResultset()
Disponibilité
Dreamweaver UltraDev 1.
Description
Affiche une boîte de dialogue contenant les résultats de l'exécution de la procédure stockée spécifiée. La boîte de
dialogue contient une grille dont l'en-tête reflète les informations de colonne qui décrivent le jeu de résultats. Si la
chaîne de connexion ou la procédure stockée n'est pas valide, une erreur apparaît. Cette fonction valide la procédure
stockée.
Arguments
connName, procName, paramValuesArray
• connName est un nom de connexion spécifié dans le Gestionnaire de connexions. Il identifie la chaîne de connexion
que Dreamweaver doit utiliser pour connecter la base de données à une source de données active.
• L'argument procName est le nom de la procédure stockée à exécuter.
• L'argument paramValuesArray est un tableau contenant une liste de valeurs tests de paramètre au moment de la
conception. Spécifiez les valeurs de paramètre dans l'ordre attendu par la procédure stockée. Vous pouvez utiliser
la fonction
MMDB.getSPParamsAsString() pour obtenir les paramètres de la procédure stockée.
78
Valeurs renvoyées
Cette fonction renvoie une erreur lorsque l'instruction SQL ou la chaîne de connexion est incorrecte, sinon, elle ne
renvoie rien.
Exemple
Le code suivant affiche le résultat de la procédure stockée exécutée :
var paramValueArray = new Array("2/1/2000", "50000")
MMDB.showSPResultset("EmpDB", "getNewEmployeesMakingAtLeast", ¬
paramValueArray)
MMDB.showSPResultsetNamedParams()
Disponibilité
Dreamweaver UltraDev 1.
Description
Affiche une boîte de dialogue contenant le jeu de résultats de la procédure stockée spécifiée. La boîte de dialogue
contient une grille dont l'en-tête reflète les informations de colonne qui décrivent le jeu de résultats. Si la chaîne de
connexion ou la procédure stockée n'est pas valide, une erreur apparaît. Cette fonction valide la procédure stockée.
Cette fonction diffère de
au lieu de l'ordre attendu par la procédure stockée.
MMDB.showSPResultset(), car vous pouvez spécifier les valeurs de paramètre par leur nom,
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de base de données
Arguments
connName, procName, paramNameArray, paramValuesArray
• connName est un nom de connexion spécifié dans le Gestionnaire de connexions. Il identifie la chaîne de connexion
que Dreamweaver doit utiliser pour connecter la base de données à une source de données active.
• L'argument procName est le nom de la procédure stockée qui renvoie le jeu de résultats lorsqu'elle est exécutée.
• L'argument paramNameArray est un tableau contenant une liste de noms de paramètres. Vous pouvez utiliser la
fonction
MMDB.getSPParamsAsString() pour obtenir les paramètres de la procédure stockée.
• L'argument paramValuesArray est un tableau contenant une liste de valeurs tests de paramètre au moment de la
conception.
Valeurs renvoyées
Cette fonction renvoie une erreur lorsque l'instruction SQL ou la chaîne de connexion est incorrecte, sinon, elle ne
renvoie rien.
Exemple
Le code suivant affiche le résultat de la procédure stockée exécutée :
var paramNameArray = new Array("startDate", "salary")
var paramValueArray = new Array("2/1/2000", "50000")
MMDB.showSPResultsetNamedParams("EmpDB","getNewEmployees¬
MakingAtLeast", paramNameArray, paramValueArray)
79
Dernière mise à jour le 22/6/2011
Chapitre 9 : API de connectivité à une base de données
En tant que développeur, vous pouvez créer de nouveaux types de connexion et les boîtes de dialogue correspondantes
pour les modèles de serveur nouveaux et existants d'Adobe® Dreamweaver®. L'utilisateur peut ensuite créer un objet de
connexion lors de la configuration d'un site afin d'entamer la création de pages. Pour créer un objet de connexion,
l'utilisateur doit tout d'abord sélectionner le type de connexion spécifique que vous avez créé.
Sélection d'un nouveau type de connexion
L'utilisateur peut sélectionner votre nouveau type de connexion de plusieurs manières :
• Dans le panneau Application, l'utilisateur peut cliquer sur le bouton Plus (+) et sélectionner Jeu d'enregistrements.
Dans la boîte de dialogue Jeu d'enregistrements, il peut agrandir la fenêtre de la liste Connexion.
• Il peut cliquer sur le bouton Plus (+) et sélectionner Nom de la source de données dans l'onglet Base de données du
panneau Bases de données.
80
Création d'un nouveau type de connexion
Les étapes suivantes expliquent le processus de création d'un nouveau type de connexion :
1 Définissez la mise en forme de la boîte de dialogue de connexion.
Créez un fichier HTML mettant en forme l'interface utilisateur de votre boîte de dialogue de connexion. Donnez
un nom à ce fichier en utilisant le nom de la connexion (par exemple myConnection.htm). Pour plus
d'informations sur la création d'une boîte de dialogue, voir Prise en main de Dreamweaver.
Assurez-vous que ce fichier HTML contient bien une référence au fichier de mise en œuvre JavaScript défini à
l'étape 2, Créez un fichier JavaScript mettant en œuvre au moins les éléments suivants, comme le montre l'exemple
suivant :
<head>
<script SRC="../myConnectionImpl.js"></script>
</head>
Stockez ce fichier HTML, qui définit votre boîte de dialogue de connexion, dans le dossier
Configuration/Connections/modèle_serveur/plate-forme (où la plate-forme est Windows ou Macintosh).
Par exemple, la boîte de dialogue de connexion ADO par défaut pour un document ASP JavaScript sur une plateforme Windows est stockée dans le dossier ASP_Js/Win et est intitulée Connection_ado_conn_string.htm.
Remarque : Pendant l'exécution, Dreamweaver établit de manière dynamique la liste des types de connexion
disponibles dans l'ensemble des boîtes de dialogue présentes dans le dossier ASP_Js/Win.
Le dossier Configuration/ServerModels contient des fichiers HTML qui définissent chaque modèle de serveur.
Chaque fichier HTML contient la fonction
au modèle de serveur. L'exemple suivant indique la fonction pour le type de document ASP JavaScript :
getServerModelFolderName() qui renvoie le nom du dossier associé
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de connectivité à une base de données
function getServerModelFolderName()
{
return "ASP_JS";
}
Vous pouvez également consulter le fichier MMDocumentTypes.xml, situé dans le dossier
Configuration/DocumentTypes, pour déterminer la correspondance entre les modèles de serveur et les types de
documents.
2 Créez un fichier JavaScript qui implémente au moins les éléments suivants :
Elément Description Exemples
81
Un ensemble de variables Chaque variable définit une propriété de
connexion spécifique.
Un ensemble de boutons Tous les boutons apparaissent dans la boîte de
dialogue de connexion.
Fonctions de connectivité Ensemble, ces fonctions définissent l'API de
connectivité.
Type de connexion, nom de la source de
données, etc.
Tester, Aide, etc. (OK et Annuler sont
automatiquement inclus)
• findConnection()
• applyConnection()
• inspectConnection()
Vous pouvez choisir n'importe quel nom pour ce fichier de mise en œuvre, mais il doit comporter une extension
.js (par exemple, myConnectionImpl.js). Vous pouvez stocker ce fichier de mise en œuvre sur votre ordinateur local
ou distant. Si vous le souhaitez, vous pouvez également le stocker dans le sous-dossier approprié du dossier
Configuration/Connections.
Remarque : Le fichier HTML défini à l'étape 1, Définissez la mise en forme de la boîte de dialogue de connexion, doit
contenir ce fichier de mise en œuvre du type de connexion.
Ces deux étapes constituent les conditions minimales pour créer une nouvelle boîte de dialogue de connexion, sauf si
vous avez besoin de définir des paramètres de connexion autres que ceux fournis dans le fichier standard
connection_includefile.edml.
Remarque : Le titre de la boîte de dialogue que voit l'utilisateur se trouve dans la balise
document HTML.
title, spécifiée dans le
Les fonctions répertoriées dans la section suivante permettent de créer une boîte de dialogue de connexion. En plus
d'implémenter les appels pour la génération des fichiers inclus réservés à l'utilisateur, vous pouvez enregistrer votre
type de connectivité dans la section du modèle de serveur du fichier XML de connexion.
Pour plus d'informations sur l'API de connectivité à une base de données, associée à la création d'une nouvelle
connexion, voir « Fonctions de connexion à une base de données » à la page 56.
L'API de connexion
Pour créer un nouveau type de connexion, y compris la boîte de dialogue avec laquelle les utilisateurs interagissent,
vous devez implémenter les trois fonctions suivantes :
applyConnection(). Vous devez rédiger ces trois fonctions et les inclure dans le fichier de mise en œuvre JavaScript
associé à votre nouveau type de connexion (voir Etape 2, Créez un fichier JavaScript qui implémente au moins les
éléments suivants).
Dernière mise à jour le 22/6/2011
findConnection(), inspectConnection() et
RÉFÉRENCE DES API DE DREAMWEAVER
API de connectivité à une base de données
La fonction applyConnection() renvoie une source HTML dans un fichier inclus. Vous trouverez des exemples de
source HTML dans la section « Fichier inclus généré » à la page 84. La fonction
HTML et en extrait les propriétés. Vous pouvez mettre en œuvre
findConnection() pour utiliser les modèles de
recherche dans les fichiers XML afin d'extraire les informations renvoyées à partir de
findConnection() prend la source
applyConnection(). Si vous
souhaitez voir un exemple de ce type de mise en œuvre, étudiez les deux fichiers JavaScript suivants :
• Le fichier connection_ado_conn_string.js se trouve dans le dossier Configuration/Connections/ASP_Js.
• Le fichier connection_common.js se trouve dans le dossier Configuration/Connections/Shared.
Lorsque l'utilisateur ouvre un site, Dreamweaver parcourt tous les fichiers dans le dossier Connections, les ouvre et
transmet leur contenu à la fonction
connexion valide,
findConnection() renvoie un objet de connexion. Dreamweaver répertorie ensuite tous les objets
findConnection(). Si le contenu d'un fichier correspond aux critères d'une
de connexion dans le panneau Explorateur de base de données.
Lorsque l'utilisateur ouvre une boîte de dialogue de connexion et choisit de créer une nouvelle connexion ou de
dupliquer ou encore de modifier une connexion existante, Dreamweaver déclenche la fonction
inspectConnection() et retransmet le même objet de connexion créé par findConnection(). Ce processus permet
à Dreamweaver de renseigner la boîte de dialogue en utilisant les informations de connexion.
Lorsque l'utilisateur clique sur OK dans une boîte de dialogue de connexion, Dreamweaver déclenche la fonction
applyConnection() pour construire la page HTML, placée dans le fichier inclus de connexion résidant dans le
dossier Configuration/Connections. La fonction
applyConnection() renvoie une chaîne vide qui indique une erreur
dans l'un des champs. La boîte de dialogue ne doit pas être fermée. Le fichier inclus a un type d'extension de fichier par
défaut pour le modèle de serveur en cours.
82
Lorsque l'utilisateur ajoute à une page un comportement de serveur qui utilise la connexion, tel qu'un jeu
d'enregistrements ou une procédure stockée, Dreamweaver ajoute une instruction à la page qui comprend le fichier
inclus de connexion.
findConnection()
Disponibilité
Dreamweaver UltraDev 4.
Description
Dreamweaver appelle cette fonction pour détecter une connexion dans la source HTML spécifiée et analyser les
paramètres de la connexion. Si le contenu de ce fichier source respecte les critères permettant une connexion valide,
findConnection() renvoie un objet de connexion ; dans le cas contraire, cette fonction renvoie une valeur null.
Argument
htmlSource
L'argument htmlSource est la source HTML d'une connexion.
Valeurs renvoyées
Objet de connexion qui fournit les valeurs d'une combinaison particulière de propriétés répertoriées dans le tableau
suivant. Les propriétés pour lesquelles cette fonction renvoie une valeur dépendent du type de document.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de connectivité à une base de données
Propriété Description
name Nom de la connexion.
83
type Si useHTTP est false, indique quelle DLL doit être utilisée pour la connexion à des bases de
string Chaîne de connexion d'exécution. Pour ADO, il s'agit d'une chaîne de paramètres de connexion ;
dsn Nom de la source de données utilisé pour les connexions de d'exécution ODBC ou Cold Fusion
driver Nom d'un pilote JDBC utilisé pendant l'exécution
username Nom d'utilisateur employé pour la connexion d'exécution.
password Mot de passe utilisé pour la connexion d'exécution.
designtimeString Chaîne de connexion au moment de la conception (voir string).
designtimeDsn Nom de la source de données au moment de la conception (voir dsn)
designtimeDriver Nom d'un pilote JDBC utilisé au moment de la conception
designtimeUsername Nom de l'utilisateur employé pour la connexion au moment de la conception.
designtimePassword Mot de passe utilisé pour la connexion au moment de la conception.
designtimeType Type de connexion utilisée au moment de la conception.
usesDesigntimeInfo En cas de valeur false, Dreamweaver utilise les propriétés d'exécution au moment de la
useHTTP Chaîne contenant true ou false ; true indique d'utiliser la connexion HTTP au moment de la
includePattern Expression régulière utilisée pour trouver l'instruction d'inclusion de fichier sur la page pendant Live
données au moment de l'exécution.
pour JDBC, il s'agit d'une URL de connexion.
conception ; dans le cas contraire, Dreamweaver utilise les propriétés au moment de la conception.
conception, et
Data et Aperçu dans le navigateur.
false d'utiliser une DLL.
variables Objet ayant une propriété pour chaque variable de page définie sur sa valeur correspondante. Cet
catalog Chaîne contenant un identificateur de base de données qui restreint la quantité de métadonnées
schema Chaîne contenant un identificateur de base de données qui restreint la quantité de métadonnées
filename Nom de la boîte de dialogue utilisée pour créer la connexion.
objet est utilisé pendant Live Data et Aperçu dans le navigateur.
qui apparaissent.
qui apparaissent.
Si une connexion n'est pas trouvée dans htmlSource, une valeur null est renvoyée.
Remarque : Les développeurs peuvent ajouter des propriétés personnalisées (par exemple, métadonnées) à la source
HTML, qui renvoie
applyConnection() avec les propriétés standard.
inspectConnection()
Disponibilité
Dreamweaver UltraDev 4.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de connectivité à une base de données
Description
Dreamweaver appelle cette fonction pour initialiser les données de la boîte de dialogue pour définir une connexion
lorsque l'utilisateur modifie une connexion existante. Ce processus permet à Dreamweaver de renseigner la boîte de
dialogue en utilisant les informations de connexion appropriées.
Argument
paramètres
84
L'argument parameters est le même objet que celui qui est renvoyé par la fonction
Valeurs renvoyées
Aucune.
findConnection().
applyConnection()
Disponibilité
Dreamweaver UltraDev 4.
Description
Dreamweaver déclenche cette fonction lorsque l'utilisateur clique sur OK dans la boîte de dialogue de connexion. La
fonction
fichier inclus Configuration/Connections/nom-connexion.ext, où nom-connexion est le nom de votre connexion (voir
« Création d'un nouveau type de connexion » à la page 80) et .ext est l'extension par défaut associée au modèle de
serveur.
Arguments
Aucun.
Valeurs renvoyées
Source HTML pour une connexion. Dreamweaver ferme également la boîte de dialogue de connexion. Si une erreur
de validation d'un champ se produit,
indiquer que la boîte de dialogue doit rester ouverte.
applyConnection() génère la source HTML pour une connexion. Dreamweaver écrit le HTML dans le
applyConnection() affiche un message d'erreur et renvoie une chaîne vide pour
Fichier inclus généré
Le fichier inclus que applyConnection() génère déclare toutes les propriétés d'une connexion. Le nom du fichier
inclus est le nom de la connexion. Il possède l'extension définie pour le modèle de serveur associé au site actuel.
Remarque : Les connexions étant partagées, définissez la valeur
de connexion n'est inclus qu'une fois dans le document. En outre, elle garantit que le script de serveur reste sur la page si
d'autres comportements de serveur l'utilisent.
Vous trouverez quelques exemples de fichiers inclus que
par défaut illustrés dans les sections suivantes.
Remarque : Pour créer un format de fichier inclus de connexion, définissez un nouveau fichier de mappage EDML,
similaire à connection_includefile.edml, comme l'explique la section « Fichier de définition pour votre type de
connexion » à la page 85.
Dernière mise à jour le 22/6/2011
allowMultiple sur false. Elle garantit que le fichier
applyConnection() génère pour divers modèles de serveur
RÉFÉRENCE DES API DE DREAMWEAVER
API de connectivité à une base de données
ASP JavaScript
Le fichier inclus ASP et JavaScript doit être nommé MyConnection1.asp, où MyConnection1 est le nom de la
connexion. L'exemple suivant est un fichier inclus pour une chaîne de connexion ADO :
<%
// Filename="Connection_ado_conn_string.htm"
// Type="ADO"
// HTTP="true"
// Catalog=""
// Schema=""
var MM_MyConnection1_STRING = "dsn=pubs";
%>
Le fichier du comportement de serveur inclut cette connexion en utilisant l'instruction d'inclusion de fichier relative,
comme le montre l'exemple suivant :
<!--#include file="../Connections/MyConnection1.asp"-->
ColdFusion
Lorsque vous utilisez UltraDev 4 ColdFusion, Dreamweaver s'appuie sur un fichier inclus ColdFusion pour extraire
une liste des sources de données.
85
Remarque : Avec Dreamweaver ColdFusion standard, Dreamweaver ignore tous les fichiers inclus et utilise les RDS pour
récupérer la liste des sources de données à partir de ColdFusion.
Le fichier inclus UltraDev 4 ColdFusion doit être nommé MyConnection1.cfm, où MyConnection1 est le nom de votre
connexion. L'exemple suivant illustre le fichier inclus pour une connexion ColdFusion à un tableau de produits :
<!-- FileName="Connection_cf_dsn.htm" "dsn=products" -->
<!-- Type="ADO" -->
<!-- Catalog="" -->
<!-- Schema="" -->
<!-- HTTP="false" -->
<CFSET MM_MyConnection1_DSN = "products">
<CFSET MM_MyConnection1_USERNAME = "">
<CFSET MM_Product_USERNAME = "">
<CFSET MM_MyConnection1_PASSWORD = "">
Le fichier du comportement de serveur inclut cette connexion en utilisant l'instruction cfinclude, comme le montre
l'exemple suivant :
<cfinclude template="Connections/MyConnection1.cfm">
Fichier de définition pour votre type de connexion
Pour tous les modèles de serveur, il existe un fichier connection_includefile.edml qui définit le type de connexion et
associe les propriétés définies dans le fichier inclus aux éléments de l'interface Dreamweaver.
Par défaut, Dreamweaver fournit des fichiers de définition, un pour chacun des modèles de serveur prédéfinis, comme
l'illustre le tableau suivant.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de connectivité à une base de données
Modèle de serveur Sous-dossier du dossier Configuration/Connections
ASP JavaScript ASP_Js
ASP.NET CSharp ASP.NET_Csharp
ASP.NET VBScrip ASP.NET_VB
ASP VBScript ASP_Vbs
ColdFusion ColdFusion
JavaServer Page JSP
PHP MySql PHP_MySql
Dreamweaver utilise les paramètres quickSearch et searchPattern pour reconnaître les blocs de connexion et le
paramètre
insertText afin de créer des blocs de connexion. Pour plus d'informations sur les balises et les attributs
EDML et sur les modèles de recherche d'expression régulière, voir « Comportements de serveur » dans Extension de
Dreamweaver.
Remarque : Si vous changez le format de votre fichier inclus ou si vous définissez un fichier inclus pour un nouveau
modèle de serveur, vous devez associer les paramètres de connexion avec l'interface utilisateur de Dreamweaver, Live
Data et Aperçu dans le navigateur. L'exemple suivant de fichier EDML, associé au modèle de serveur ASP JS par défaut,
met en correspondance toutes les variables de page de connexion avec leurs valeurs dynamiques respectives avant
d'envoyer la page au serveur. Pour plus d'informations sur EDML et les modèles de recherche d'expression régulière, voir
« Comportements de serveur » dans Extension de Dreamweaver.
86
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API de connectivité à une base de données
<participant name="connection_includefile" version="5.0">
<quickSearch>
<![CDATA[// HTTP=]]></quickSearch>
<insertText location="">
<![CDATA[<%
// FileName="@@filename@@"
// Type="@@type@@" @@designtimeString@@
// DesigntimeType="@@designtimeType@@"
// HTTP="@@http@@"
// Catalog="@@catalog@@"
// Schema="@@schema@@"
var MM_@@cname@@_STRING = @@string@@
%>
]]>
</insertText>
<searchPatterns whereToSearch="directive">
<searchPattern paramNames="filename">
<![CDATA[/\/\/\s*FileName="([^"]*)"/]]></searchPattern>
<searchPattern paramNames="type,designtimeString">
<![CDATA[/\/\/\s+Type="(\w*)"([^\r\n]*)/]]></searchPattern>
<searchPattern paramNames="designtimeType" isOptional="true">
<![CDATA[/\/\/\s*DesigntimeType="(\w*)"/]]></searchPattern>
<searchPattern paramNames="http">
<![CDATA[/\/\/\s*HTTP="(\w+)"/]]></searchPattern>
<searchPattern paramNames="catalog">
<![CDATA[/\/\/\s*Catalog="(\w*)"/]]></searchPattern>
<searchPattern paramNames="schema">
<![CDATA[/\/\/\s*Schema="(\w*)"/]]></searchPattern>
<searchPattern paramNames="cname,string">
<![CDATA[/var\s+MM_(\w*)_STRING\s*=\s*([^\r\n]+)/]]></searchPattern>
</searchPatterns>
</participant>
87
Les expressions d'un fichier EDML, telles que @@filename@@ dans cet exemple, associent les valeurs du fichier inclus
avec les propriétés d'un objet de connexion. Les propriétés des objets de connexion sont définies dans le fichier de mise
en œuvre JavaScript.
Toutes les boîtes de dialogue de connexion par défaut de Dreamweaver utilisent le fichier de correspondance
connection_includefile.edml. Pour permettre à Dreamweaver de trouver ce fichier, son nom est défini dans le fichier
de mise en œuvre JavaScript, comme le montre l'exemple suivant :
var PARTICIPANT_FILE = "connection_includefile";
Lors de la création d'un type de connexion personnalisée, vous pouvez utiliser n'importe quel fichier de
correspondance dans vos boîtes de dialogue personnalisées. Si vous créez un fichier de correspondance, vous pouvez
utiliser un nom différent de connection_includefile pour votre fichier EDML. Si vous utilisez un autre nom, vous devez
l'utiliser dans votre fichier de mise en œuvre JavaScript lorsque vous indiquez la valeur assignée à la variable
PARTICIPANT_FILE comme le montre l'exemple suivant :
var PARTICIPANT_FILE = "myConnection_mappingfile";
Dernière mise à jour le 22/6/2011
Chapitre 10 : API d'intégration de commande source
L'API d'intégration de commande source permet de rédiger des bibliothèques partagées. Ces API vous permettent
d'étendre la fonctionnalité Archivage/Extraction d'Adobe® Dreamweaver® à l'aide de systèmes de commande source
(tels que Sourcesafe ou CVS).
Vos bibliothèques doivent prendre en charge un minimum de fonctions API pour que Dreamweaver puisse être
intégré au système de commande source. En outre, vos bibliothèques doivent se trouver dans le dossier Program
Files/Adobe/Adobe Dreamweaver CS5/Configuration/SourceControl.
Lorsque vous démarrez Dreamweaver, celui-ci charge toutes les bibliothèques. Il détermine les fonctionnalités prises
en charge par chaque bibliothèque en appelant la fonction
n'existe pas, Dreamweaver suppose que la bibliothèque ne prend pas en charge l'API. Si l'adresse existe, Dreamweaver
utilise la version de la fonction qui se trouve dans la bibliothèque pour prendre en charge la fonctionnalité. Lorsqu'un
utilisateur Dreamweaver définit ou modifie un site, puis choisit l'onglet SCS du serveur Web, les choix correspondant
aux DLL s'affichent dans l'onglet. Ces choix s'affichent en plus des éléments standard de l'onglet. Ces DLL sont
chargées depuis le dossier Program Files/Adobe/Adobe Dreamweaver CS5/Configuration/SourceControl.
GetProcAddress() pour chaque API. Si une adresse
88
Pour créer un menu Site > Commande source auquel vous pouvez ajouter des éléments personnalisés, ajoutez le code
suivant. Ajoutez le code dans le menu Site, dans le fichier menus.xml :
<menu name="Source Control" id="DWMenu_MainSite_Site_Source¬
Control"><menuitem dynamic name="None"file="Menus/MM/¬
File_SCSItems.htm" id="DWMenu_MainSite_Site_NewFeatures_¬
Default" />
</menu>
Fonctionnement de l'intégration des commandes source avec Dreamweaver
Lorsqu'un utilisateur Dreamweaver choisit des fonctions de connexion au serveur, de transfert de fichiers ou de Design
Notes, Dreamweaver appelle la version de la DLL de la fonction API correspondante (
Get(), Put(), Checkin(), Checkout(), Undocheckout() et Synchronize()). La DLL est responsable de la gestion
de la requête, notamment de l'affichage des boîtes de dialogue qui rassemblent les informations ou qui permettent à
l'utilisateur d'interagir avec la DLL. La DLL affiche également des informations ou des messages d'erreur.
Le système de commande source peut éventuellement prendre en charge les Design Notes et la fonction
d'archivage/extraction. Pour activer les Design Notes dans les systèmes de commande source, l'utilisateur
Dreamweaver doit choisir l'onglet Design Notes dans la boîte de dialogue Modifier les sites et cocher la case qui permet
d'activer cette fonctionnalité (cette procédure s'applique également aux systèmes FTP et de réseau local). Si le système
de commande source ne prend pas en charge les Design Notes et que l'utilisateur souhaite les utiliser, Dreamweaver
transporte les fichiers Design Note (.mno) pour gérer les Design Notes (de la même façon qu'avec les systèmes FTP et
de réseau local).
Connect(), Disconnect(),
Les fonctions d'archivage et d'extraction sont traitées différemment ; si le système de commande source les prend en
charge, l'utilisateur ne peut pas éviter leur utilisation dans la boîte de dialogue Design Notes. Si l'utilisateur essaie de
court-circuiter le système de commande source, un message d'erreur s'affiche.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API d'intégration de commande source
Ajout d'une fonctionnalité de système de commande source
Pour ajouter une fonctionnalité de système de commande source à Dreamweaver, rédigez un gestionnaire
GetNewFeatures qui renvoie un jeu d'éléments de menu et les fonctions C correspondantes. Si, par exemple, vous
rédigez une bibliothèque Sourcesafe et que vous souhaitez permettre aux utilisateurs de Dreamweaver de consulter
l'historique d'un fichier, vous pouvez rédiger un gestionnaire
Historique et le nom de la fonction C
la souris sur un fichier, l'élément Historique s'affiche dans le menu. Si l'utilisateur choisit alors l'élément de menu
Historique, Dreamweaver appelle la fonction correspondante, qui se charge de transmettre les fichiers sélectionnés à
la DLL. La DLL affiche ensuite la boîte de dialogue Historique, ce qui permet à l'utilisateur d'interagir avec elle de la
même façon que Sourcesafe.
history. Ainsi, sous Windows, si un utilisateur clique avec le bouton droit de
GetNewFeatures qui renvoie l'élément de menu
Fonctions requises de l'API d'intégration de commande source
L'API d'intégration de commande source comporte des fonctions obligatoires et facultatives. Les fonctions
répertoriées dans cette section sont obligatoires.
89
bool SCS_GetAgentInfo()
Description
Demande à la DLL de renvoyer son nom et sa description, qui sont affichés dans la boîte de dialogue Modifier les sites.
Le nom apparaît dans le menu déroulant Accès (par exemple, Sourcesafe, WebDav, Perforce) et la description s'affiche
juste en dessous du menu.
Arguments
char name[32], char version[32], char description[256], const char *dwAppVersion
• name est le nom du système de commande source. Ce nom s'affiche dans la zone de liste modifiable permettant de
sélectionner un système de commande source, dans l'onglet Commande source de la boîte de dialogue Modifier les
sites. Le nom du ne doit pas compter plus de 32 caractères.
• version est une chaîne qui indique la version de la DLL. La version apparaît dans l'onglet Commande source de la
boîte de dialogue Modifier les sites. La version ne doit pas compter plus de 32 caractères.
• description est une chaîne qui décrit le système de commande source. La description apparaît dans l'onglet
Commande source de la boîte de dialogue Modifier les sites. La description ne doit pas compter plus de 256
caractères.
• dwAppVersion est une chaîne qui décrit la version de Dreamweaver appelant la DLL. La DLL peut utiliser cette
chaîne pour déterminer la version et la langue de Dreamweaver.
Valeur renvoyée
Valeur booléenne :
true en cas de réussite, false dans le cas contraire.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API d'intégration de commande source
bool SCS_Connect()
Description
Connecte l'utilisateur à son système de commande source. Si la DLL ne dispose pas d'informations de connexion, elle
doit afficher une boîte de dialogue invitant l'utilisateur à entrer des informations, et elle doit stocker les données pour
une utilisation ultérieure.
Arguments
void **connectionData, const char siteName[64]
• connectionData est un descripteur des données que l'agent souhaite recevoir de Dreamweaver lorsqu'il appelle
d'autres fonctions API.
• L'argument siteName est une chaîne qui pointe vers le nom du site. Le nom du site ne doit pas compter plus de 64
caractères.
Valeur renvoyée
Valeur booléenne :
true en cas de réussite, false dans le cas contraire.
bool SCS_Disconnect()
90
Description
Déconnecte l'utilisateur du système de commande source.
Arguments
void *connectionData
• L'argument connectionData est un pointeur vers les données de l'agent transférées à Dreamweaver pendant l'appel
de la fonction
Valeur renvoyée
Valeur booléenne :
Connect().
true en cas de réussite, false dans le cas contraire.
bool SCS_IsConnected()
Description
Détermine l'état de la connexion.
Arguments
void *connectionData
• L'argument connectionData est un pointeur vers les données de l'agent transférées à Dreamweaver pendant l'appel
de la fonction
Connect().
Valeur renvoyée
Valeur booléenne :
true en cas de réussite, false dans le cas contraire.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API d'intégration de commande source
int SCS_GetRootFolderLength()
Description
Renvoie la longueur du nom du dossier racine.
Arguments
void *connectionData
• L'argument connectionData est un pointeur vers les données de l'agent transférées à Dreamweaver pendant l'appel
de la fonction
Valeur renvoyée
Nombre entier qui indique la longueur du nom du dossier racine. Si la fonction renvoie
cette réponse comme une erreur et tente de récupérer le message d'erreur de la DLL si elle est prise en charge.
Connect().
< 0, Dreamweaver considère
bool SCS_GetRootFolder()
Description
Renvoie le nom du dossier racine.
91
Arguments
void *connectionData, char remotePath[], const int folderLen
• L'argument connectionData est un pointeur vers les données de l'agent transférées à Dreamweaver pendant l'appel
de la fonction
Connect().
• remotePath est une mémoire tampon dans laquelle est enregistré le chemin distant complet du dossier racine.
• folderLen est un nombre entier qui indique la longueur de l'argument remotePath. Il s'agit de la valeur renvoyée par
la fonction GetRootFolderLength.
Valeur renvoyée
Valeur booléenne :
true en cas de réussite, false dans le cas contraire.
int SCS_GetFolderListLength()
Description
Renvoie le nombre d'éléments dans le dossier transmis.
Arguments
void *connectionData, const char *remotePath
• L'argument connectionData est un pointeur vers les données de l'agent transférées à Dreamweaver pendant l'appel
de la fonction
• remotePath est le chemin d'accès et le nom complets du dossier distant dont la DLL vérifie le nombre d'éléments.
Connect().
Valeur renvoyée
Nombre entier qui indique le nombre d'éléments dans le dossier en cours. Si la fonction renvoie
considère cette réponse comme une erreur et tente de récupérer le message d'erreur de la DLL si elle est prise en charge.
< 0, Dreamweaver
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API d'intégration de commande source
bool SCS_GetFolderList()
Description
Renvoie une liste de fichiers et de dossiers dans le dossier transmis, notamment des informations pertinentes telles que
la date de modification, la taille et si l'élément est un dossier ou un fichier.
Arguments
void *connectionData, const char *remotePath, itemInfo itemList[ ], const int numItems
• L'argument connectionData est un pointeur vers les données de l'agent transférées à Dreamweaver pendant l'appel
de la fonction
• remotePath est le nom du chemin d'accès au dossier distant dont la DLL vérifie le nombre d'éléments.
• L'argument itemList est une liste pré-allouée de structures itemInfo :
nom char[256] nom de fichier ou de dossier
Connect().
92
isFolder
month
day
year
hour
minutes
seconds
type
size
bool true si c'est un dossier, false si c'est un fichier
int Composant mois de la date de modification, de 1 à 12
int Composant jour de la date de modification, de 1 à 31
int Composant année de la date de modification, 1900+
int Composant heure de la date de modification, de 0 à 23
int Composant minute de la date de modification, de 0 à 59
int Composant seconde de la date de modification, de 0 à 59
char[256] Type de fichier (s'il n'est pas défini par la DLL, Dreamweaver utilise l'extension de
fichier pour déterminer le type, comme il le fait à présent)
int En octets
• numItems est le nombre d'éléments alloués à l'argument itemList (renvoyé par la fonction
GetFolderListLength).
Valeur renvoyée
Valeur booléenne :
true en cas de réussite, false dans le cas contraire.
bool SCS_Get()
Description
Extrait une liste de fichiers ou de dossiers et les stocke localement.
Arguments
void *connectionData, const char *remotePathList[], constchar*localPathList[], const int numItems
• L'argument connectionData est un pointeur vers les données de l'agent transférées à Dreamweaver pendant l'appel
de la fonction
Connect().
• remotePathList est une liste des fichiers ou dossiers distants à extraire, exprimée sous la forme de noms et de
chemins d'accès complets.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API d'intégration de commande source
• L'argument localPathList est une liste miroir des noms de chemin d'accès aux fichiers ou aux dossiers locaux.
• L'argument numItems est le nombre d'éléments dans chaque liste.
Valeur renvoyée
Valeur booléenne :
true en cas de réussite, false dans le cas contraire.
bool SCS_Put()
Description
Place une liste de fichiers ou de dossiers locaux dans le système de commande source.
Arguments
void *connectionData, const char *remotePathList[], const char *localPathList[], const int numItems
• L'argument connectionData est un pointeur vers les données de l'agent transférées à Dreamweaver pendant l'appel
de la fonction
• L'argument localPathList est la liste des noms de fichiers locaux ou des chemins de fichiers à placer dans le système
de commande source.
• L'argument remotePathList est une liste miroir de noms de chemin d'accès aux fichiers ou aux dossiers distants.
• L'argument numItems est le nombre d'éléments dans chaque liste.
Connect().
93
Valeur renvoyée
Valeur booléenne :
true en cas de réussite, false dans le cas contraire.
bool SCS_NewFolder()
Description
Crée un nouveau dossier.
Arguments
void *connectionData, const char *remotePath
• L'argument connectionData est un pointeur vers les données de l'agent transférées à Dreamweaver pendant l'appel
de la fonction
Connect().
• remotePath est le chemin d'accès complet du dossier distant que la DLL crée.
Valeur renvoyée
Valeur booléenne :
true en cas de réussite, false dans le cas contraire.
bool SCS_Delete()
Description
Supprime une liste de fichiers ou de dossiers du système de commande source.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API d'intégration de commande source
Arguments
void *connectionData, const char *remotePathList[], const int numItems
• L'argument connectionData est un pointeur vers les données de l'agent transférées à Dreamweaver pendant l'appel
de la fonction
Connect().
• L'argument remotePathList est une liste de noms de chemin d'accès aux fichiers ou aux dossiers distants à
supprimer.
• numItems est le nombre d'éléments dans remotePathList.
Valeur renvoyée
Valeur booléenne :
true en cas de réussite, false dans le cas contraire.
bool SCS_Rename()
Description
Renomme ou déplace un fichier ou un dossier selon les valeurs spécifiées dans les arguments oldRemotePath et
newRemotePath. Ainsi, si les valeurs de oldRemotePath et
"$/folder1/renamefile1", le fichier file1 se voit attribuer le nouveau nom renamefile1 et reste dans le dossier
folder1.
newRemotePath sont respectivement "$/folder1/file1" et
94
Si les valeurs de oldRemotePath et de
"$/folder1/subfolder1/file1", le fichier file1 est alors déplacé dans le sous-dossier subfolder1.
newRemotePath sont respectivement "$/folder1/file1" et
Pour savoir si l'invocation de cette fonction constitue un déplacement ou l'attribution d'un nouveau nom, vérifiez les
chemins parents des deux valeurs d'entrée ; s'ils sont identiques, il s'agit de l'opération « renommer ».
Arguments
void *connectionData, const char *oldRemotePath, const char *newRemotePath
• L'argument connectionData est un pointeur vers les données de l'agent transférées à Dreamweaver pendant l'appel
de la fonction
Connect().
• oldRemotePath est le nom du chemin d'accès au fichier ou dossier distant à renommer.
• newRemotePath est le nom du chemin d'accès au nouveau fichier ou dossier distant.
Valeur renvoyée
Valeur booléenne :
true en cas de réussite, false dans le cas contraire.
bool SCS_ItemExists()
Description
Détermine si un fichier ou un dossier existe sur le serveur.
Arguments
void *connectionData, const char *remotePath
• L'argument connectionData est un pointeur vers les données de l'agent transférées à Dreamweaver pendant l'appel
de la fonction
Connect().
• remotePath est le chemin d'accès d'un fichier ou d'un dossier distant.
Dernière mise à jour le 22/6/2011
RÉFÉRENCE DES API DE DREAMWEAVER
API d'intégration de commande source
Valeur renvoyée
Valeur booléenne :
true en cas de réussite, false dans le cas contraire.
Fonctions facultatives de l'API d'intégration de commande source
L'API d'intégration de commande source comporte des fonctions obligatoires et facultatives. Les fonctions
répertoriées dans cette section sont facultatives.
bool SCS_GetConnectionInfo()
Description
Affiche une boîte de dialogue qui permet à l'utilisateur de modifier ou de définir les informations de connexion du site.
N'établit pas la connexion. Cette fonction est appelée lorsque l'utilisateur clique sur le bouton Paramètres dans la
section Infos distantes de la boîte de dialogue Modifier les sites.
Arguments
void **connectionData, const char siteName[64]
95
• L'argument connectionData est un descripteur des données que l'agent veut recevoir de Dreamweaver lorsqu'il
appelle d'autres fonctions API.
• L'argument siteName est une chaîne qui pointe vers le nom du site. Ce nom ne peut pas comporter plus de 64
caractères.
Valeur renvoyée
Valeur booléenne :
true en cas de réussite, false dans le cas contraire.
bool SCS_SiteDeleted()
Description
Informe la DLL que le site a été supprimé ou qu'il n'est plus lié à ce système de commande source. Cette fonction
indique au système de commande source qu'il peut supprimer les informations persistantes du site.
Arguments
const char siteName[64]
• L'argument siteName est une chaîne qui pointe vers le nom du site. Ce nom ne peut pas comporter plus de 64
caractères.
Valeur renvoyée
Valeur booléenne :
true en cas de réussite, false dans le cas contraire.
Dernière mise à jour le 22/6/2011
Loading...