ADOBE Dreamweaver CS3 MAC User Manual [fr]

ADOBE® DREAMWEAVER® CS

GUIDE DES API DE DREAMWEAVER

Adobe® Dreamweaver® pour Windows® et Macintosh

S'il est distrib ué avec u n logiciel i ncluant un co ntrat de l icence d'utili sateur f inal, le présent e guide, ainsi qu e le logicie l qu'il décrit sont fournis sous licence et peuvent être utilisés ou copiés uniquement en conformité avec les dispositions de ladite licence. Sauf indication contraire dans le contrat de licence, aucune partie du présent guide ne peut être reproduite, conservée dans un système d'archivage, ou transmise, sous quelque forme ou par quelque moyen que ce soit, électronique, mécanique, magnétique ou autre, sans autorisation écrite préalable de Adobe Systems Incorporated. Veuillez noter que le contenu de ce guide est protégé par les lois de protection de la propriété intellectuelle même s'il n'est pas distribué avec un logiciel incluant un contrat de licence d'utilisateur final. Le contenu de ce guide est uniquement fournit à titre informatif. Il peut être modifié sans préavis et ne doit pas être considéré comme un engagement de la part de AdobeSystems Incorporated. Adobe Systems Incorporated ne peut en aucun cas être tenu responsable des erreurs ou inexactitudes que le contenu informatif de ce guide pourrait présenter.

Veuillez garder à l'esprit que certains dessins ou images que vous souhaitez inclure dans votre projet peuvent être protégés par les lois de protection de la propriété intellectuelle. L'intégration de ce type d'éléments à votre travail sans autorisation préalable peut constituer une violation des droits du titulaire du copyright. Veillez à obtenir toute autorisation adéquate auprès du titulaire du copyright. Toute référence à des noms de société dans des exemples de modèles n'est citée qu'à des fins de démonstration et ne doit pas être interprétée comme une référence à une société réelle.

Adobe, le logo Adobe, ActionScript, Adobe Bridge, ColdFusion, Cre ative Suite, Director, Dre amweaver, Fireworks, Flash, FlashPaper, HomeSite, JRun, Photoshop, Shockwave et Version Cue sont des marques déposées ou des marques commerciales d'Adobe Systems Incorporated aux Etats-Unis.

ActiveX, Microsoft et Windows sont des marques commerciales ou des marques déposées de Microsoft aux Etats-Unis et/ou dans d'autres pays. Apple et Mac OS sont des marques commerciales d'Apple Inc., déposées aux Etats-Unis et dans d'autres pays. Java et Solaris sont des marques commerciales ou des marques déposées de Sun Microsystems, Inc. aux États-Unis et/ou dans d'autres pays. Linux est la marque déposée de Linus Torvalds aux Etats-Unis et dans d'autres pays. UNIX est une marque dép osée aux Etats-Unis et dans d'autres pays, elle est licenciée exclusivement par X/Open Company, Ltd. Toutes les autres marques commerciales sont la propriété de leurs titulaires respectifs.

Ce produit contient des logiciels développés par Apache Software Foundation (http://www.apache.org/). Le format Graphics Interchange Format © est la propriété protégée par droit d'auteur de CompuServe Incorporated. GIF(sm) est une propriété de marque de service de CompuServe Incorporated. La technologie de compression audio MPEG Layer3 est sous licence Fraunhofer IIS et Thomson Multimedia (http://www.mp3licensing.com). Vous ne pouvez pas utiliser de fichiers audio comprimés au format MP3 dans le Logiciel pour des diffusions en temps réel ou en direct. Si vous avez besoin d'un décodeur MP3 pour effectuer des diffusions en temps réel ou en direct, vous êtes tenu de vous procurer cette licence d'utilisation de la technologie MP3. La technologie de compression et de décompression audio discours est utilisée sous licence de Nellymoser, Inc. (www.nellymoser.com) Flash CS3 video est mis en oeuvre par la technologie vidéo On2 TrueMotion. © 1992-2005 On2 Technologies, Inc. Tous droits réservés. http://www.on2.com. Ce produit contient des logiciels développés par OpenSymphony Group (http://www.opensymphony.com/) La technologie de compression et décompression vidéo Sorenson SparkTM est sous licence Sorenson Media, Inc.

Adobe Systems Incorporated, 345 Park Avenue, San Jose, California 95110, USA.

No tic e to U.S . G ove rnm ent En d Us ers . T he S of twa re a nd Doc um ent ati on are “Co mme rc ial Ite ms,” a s t hat ter m i s de fi ne d at 48 C .F.R . §2.101, consisting of “Commercial Computer Software” and “Commercial Computer Software Documentation,” as such terms are used in 48 C.F.R. §12.212 or 48 C.F.R. §227.7202, as applicable. Consistent with 48 C.F.R.

§12.212 or 48 C.F.R. §§227.7202-1 through 227.7202-4, as applicable, the Commercial Computer Software and Commercial Computer Software Documentation are being licensed to U.S. Government end users (a) only as Commercial Items and (b) with only those rights as are granted to all other end users pursuant to the terms and conditions herein. Unpublishedrights reserved under the copyright laws of the United States. Adobe Systems Incorporated, 345 Park Avenue, San Jose, CA 95110-2704, USA. For U.S. Government End Users, Adobe agrees to comply with all applicable equal opportunity l aws including, if appropriate, the provisions of Executive Order 11246, as amended, Section 402 of the Vietnam Era Veterans Readjustment Assistance Act of 1974 (38 USC 4212), and Section 503 of the Rehabilitation Act of 1973, as amended, and the regulations at 41 CFR Parts 60-1 through 60-60, 60-250, and 60-741. The affirmative action clause and regulations contained in the preceding sentence shall be incorporated by reference.

Table des matières

Chapitre 1 : Introduction

Acquis préalables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Extension de Dreamweaver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Ressources supplémentaires pour les créateurs d'extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Nouvelles fonctions de Dreamweaver CS3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Fonctions supprimées . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Errata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Conventions utilisées dans ce manuel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Chapitre 2 : API d'E/S des fichiers

Accès aux fichiers de configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

API d'E/S des fichiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Chapitre 3 : API HTTP

Fonctionnement de l'API HTTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

API HTTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

iii

Chapitre 4 : API de Design Notes

Fonctionnement de Design Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

API JavaScript de Design Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

API C de Design Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Chapitre 5 : Intégration de Fireworks

L'API FWLaunch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Chapitre 6 : Intégration de Flash

Fonctionnement des éléments Flash . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Insertion d'éléments Flash . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

L'API des objets Flash . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38

Chapitre 7 : API de base de données

Fonctionnement de l'API de bases de données . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Fonctions de connexion à une base de données . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42

Fonctions d'accès à la base de données . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Chapitre 8 : API de connectivité à une base de données

Développement d'un nouveau type de connexion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

L'API de connexion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

Fichier inclus généré . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

Fichier de définition pour votre type de connexion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .70

Chapitre 9 : API JavaBeans

L'API JavaBeans . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Chapitre 10 : API d'intégration de commande source

Fonctionnement de l'intégration des commandes source avec Dreamweaver . . . . . . . . . . . . . . 77

Ajout d'une fonctionnalité de système de commande source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Fonctions facultatives de l'API d'intégration de commande source . . . . . . . . . . . . . . . . . . . . . . . . . 78

Fonctions facultatives de l'API d'intégration de commande source . . . . . . . . . . . . . . . . . . . . . . . . . 84

Activateurs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Chapitre 11 : Application

Fonctions relatives aux applications externes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .97

Fonctions globales relatives aux applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .105

Fonctions de communication avec Bridge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .109

Chapitre 12 : Espace de travail

Fonctions d'historique . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .113

Fonctions d'insertion d'objets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .120

Fonctions relatives au clavier . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .123

Fonctions relatives aux menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .129

Fonctions relatives à la fenêtre de résultats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .130

Fonctions de bascule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .141

Fonctions relatives aux barres d'outils . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .158

Fonctions relatives aux fenêtres . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .163

Fonctions relatives au fractionnement des codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .172

Fonctions relatives aux barres d'outils du mode Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .178

Chapitre 13 : Site

Fonctions relatives aux rapports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .183

Fonctions relatives aux sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .184

Chapitre 14 : Document

Fonctions relatives aux conversions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .215

Fonctions relatives aux commandes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .216

Fonctions relatives aux manipulations de fichiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .217

Fonctions relatives à l'ensemble d'un document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .231

Fonctions relatives aux chemins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .240

Fonctions relatives à la sélection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .243

Fonctions de manipulation de chaînes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .249

Fonctions relatives à la traduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .252

Fonctions XSLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .253

Chapitre 15 : Contenu de page

Fonctions du panneau Actifs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .257

Fonctions relatives aux comportements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .266

Fonctions relatives au Presse-papiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .274

Fonctions relatives aux éléments de bibliothèque et aux modèles . . . . . . . . . . . . . . . . . . . . . . . .278

Fonctions du panneau Fragments de code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .282

Fonctions de modification de widgets Spry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .286

Insertion de fonctions relatives aux widgets Spry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .288

Fonctions de vérification de la compatibilité avec les navigateurs . . . . . . . . . . . . . . . . . . . . . . . . .290

Chapitre 16 : Documents dynamiques

Fonctions de composants de serveur . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .297

Fonctions relatives aux sources de données . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .298

Fonctions de l'Extension Data Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .299

Fonctions Live data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .301

Fonctions relatives aux comportements de serveur . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .305

Fonctions de modèle de serveur . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .307

Chapitre 17 : Conception

Fonctions relatives aux mises en forme CSS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .313

Fonctions relatives aux cadres et aux jeux de cadres . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .330

Fonctions relatives aux calques et aux cartes graphiques . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .332

Fonctions d'environnement de mise en forme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .334

Fonctions relatives au mode de Mise en forme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .339

Fonctions relatives aux zooms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .347

Propriétés et fonctions de repère . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .350

Fonctions de modification des tableaux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .356

Chapitre 18 : Code

Fonctions de code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .365

Fonctions relatives à la recherche et au remplacement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .369

Fonctions de modifications générales . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .373

Fonction relative à l'impression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .387

Fonctions relatives à Quick Tag Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .388

Fonctions relatives au mode Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .390

Fonctions de l'éditeur de balises et de la bibliothèque de balises . . . . . . . . . . . . . . . . . . . . . . . . . .404

Chapitre 19 : Activateurs

Fonctions d'activateur . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .409

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .443

Chapitre 1 : Introduction

Le Guide des API de Adobe Dreamweaver CS3 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® CS3 et ajoutez des codes de programme à vos pages Web Dreamweaver. Ces API sont notamment la principale API JavaScript, qui permet d'accéder à la majeure partie des fonctionnalités de base de Dreamweaver (généralement, tout ce qui peut être effectué à l'aide d'un menu, entres autres), et différentes API d'utilitaires permettant d'exécuter des tâches courantes, telles que la lecture et l'écriture de fichiers, le transfert d'informations à l'aide de HTTP et la communication avec Fireworks et Flash.

Les API d'utilitaires contiennent des sous-ensembles de fonctions liées qui permettent d'effectuer des types de tâches spécifiques. Les API d'utilitaires sont les suivantes :

• l'API d'E/S des fichiers, qui permet un accès en lecture et en écriture aux fichiers du système local ;

• l'API HTTP, qui permet d'envoyer et de recevoir des informations à partir d'un serveur Web ;

• l'API de Design Notes, qui permet de stocker et d'extraire les notes relatives aux documents Dreamweaver ;

• l'API d'intégration de Fireworks, qui permet de communiquer avec Adobe Fireworks ;

• l'intégration Flash, qui contient des informations concernant l'ajout d'éléments Flash à l'interface utilisateur Dream-

weaver et sur l'API des objets Flash (qui permet de créer des objets pour le contenu Adobe Flash) ;

• l'API de base de données, qui permet d'accéder aux informations stockées dans les bases de données et de gérer les

connexions à ces bases de données ;

• l'API de connectivité à une base de données, qui permet de créer un nouveau type de connexion et les boîtes de dialogue

correspondantes pour les modèles de serveur nouveaux et existants ;

• l'API JavaBeans, qui extrait les noms de classe, les méthodes, les propriétés et les évènements définis pour JavaBeans ;

• l'API d'intégration de contrôle source, qui permet d'écrire des bibliothèques partagées pour étendre la fonction

Archiver/Extraire de Dreamweaver.

L'API JavaScript permet d'effectuer plusieurs tâches mineures généralement effectuées par l'utilisateur lors de la création ou de la modification de 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. Ces fonctions vous permettent d'effectuer des tâches telles que, ouvrir un nouveau document, obtenir ou définir une taille de police, trouver l'occurrence d'une chaîne de recherche en code HTML, afficher une barre d'outils, etc.

Acquis préalables

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 sur au moins une plate-forme telle que Active Server Pages (ASP), ASP.net, PHP : Hypertext Preprocessor (PHP), 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

ADOBE DREAMWEAVER 9.0

Guide des API

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.

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 pouvez accéder au site Web de ce forum en allant à l'adresse www.adobe.com/support/dream-

weaver/extend/form/.

Nouvelles fonctions de Dreamweaver CS3

Les nouvelles fonctions suivantes ont été ajoutées à l'API JavaScript de Dreamweaver CS3. Les en-têtes désignent les chapitres et les sections qui contiennent les nouvelles fonctions :

Application

Les fonctions suivantes ont été ajoutées au chapitre Application.

Fonctions relatives aux applications externes

• « dom.insertFiles() », page 103

• « dreamweaver.activateApp() », page 104

• « dreamweaver.printDocument() », page 104

• « dreamweaver.revealDocument() », page 104

Fonctions de modifications générales

• « dw.registerIdleHandler() », page 108

• « dw.revokeIdleHandler() », page 109

Communication avec Bridge

• « BridgeTalk.bringToFront() », page 109

• « Bridgetalk.send() », page 110

• « BridgeTalk.suppressStartupScreen() », page 110

• « dw.browseInBridge() », page 111

Espace de travail

Les nouvelles fonctions suivantes relatives au Contenu actif et au mode Code ci-dessous ont été ajoutées au chapitre « Espace de travail », page 113.

Contenu actif

• « dom.convertNextActiveContent() », page 122

• « dom.convertActiveContent() », page 122

mode Code

• « dom.source.refreshVariableCodeHints() », page 180

ADOBE DREAMWEAVER 9.0

Guide des API

Site

Les nouvelles fonctions suivantes relatives au Site ont été ajoutées au chapitre « Site », page 183.

• « site.displaySyncInfoForFile() », page 193

• « site.canDisplaySyncInfoForFile() », page 436

Documents

La nouvelle fonction suivante relative aux ensembles de données XML a été ajoutée au chapitre « Document », page 215.

• « MMXSLT.getXML() », page 253

Contenu de page

Les nouvelles fonctions suivantes ont été ajoutées au chapitre « Contenu de page », page 257. Elles concernent la création d'ensembles de données XML Spry, la modification avancée de widgets Spry et d'autres widgets, l'insertion de widgets Spry et la vérification de la compatibilité avec les navigateurs.

Modification de widgets Spry

• « element.removeTranslatedAttribute() », page 286

• « element.setTranslatedAttribute() », page 287

• « element.translatedClassName », page 287

• « element.translatedStyle », page 287

Insertion de widgets Spry

• « dom.addJavaScript() », page 288

• « dom.copyAssets() », page 288

• « dom.getDefaultAssetFolder() », page 290

Problèmes de vérification de la compatibilité avec les navigateurs

• « elem.getComputedStyleProp() », page 290

• « window.getDeclaredStyle() », page 291

• « dom.getMinDisplayWidth() », page 292

• « dom.getBlockElements() elem.getBlockElements() », page 292

• « dom.getInlineElements() elem.getInlineElements() », page 293

• « dom.getHeaderElements() elem.getHeaderElements() », page 294

• « dom.getListElements() elem.getListElements() », page 294

• « elem.isBlockElement() », page 295

• « elem.isInlineElement() », page 295

• « elem.isHeaderElement() », page 296

• « elem.isListElement() », page 296

Documents dynamiques

La nouvelle fonction suivante relative aux sources de données a été ajoutée au chapitre « Documents dynamiques », page 297.

• « dw.dbi.setExpanded() », page 299

ADOBE DREAMWEAVER 9.0

Guide des API

Conception

Les nouvelles fonctions suivantes relatives aux mises en forme CSS ont été ajoutées au chapitre « Conception », page 313.

Mise en forme CSS

• « dom.applyLayout() », page 313

• « dom.canApplyLayout() », page 314

• « dw.getLayoutNames() », page 315

• « dw.getLayoutDescriptions() », page 315

• « dw.getFilesForLayout() », page 315

Fonctions supprimées

Les fonctions suivantes ont été supprimées de l'API Dreamweaver CS3 car les fonctions associées ont été supprimées du produit.

• « dreamweaver.exportCSS() (déconseillé) », page 222

• « dreamweaver.canExportCSS() (déconseillé) », page 420

Errata

Vous trouverez une liste des problèmes connus dans la section Extensibility (Extension) du centre de support de Dreamweaver (www.adobe.com/support/dreamweaver/extend/extending_dwmx_errata).

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.

• 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 nombreux exemples, le préfixe

dreamweaver. complet dans les définitions de fonctions et dans l'index. Toutefois, dans de

dw. est utilisé.

Convention d'attribution de nom

Les conventions d'attribution de nom suivantes sont utilisées dans ce manuel :

• Vous — le développeur responsable de la rédaction des extensions

• L'utilisateur — la personne utilisant Dreamweaver

Chapitre 2 : API d'E/S des fichiers

Adobe® Dreamweaver® CS3 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.

Accès aux fichiers 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. Chaque fois que 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.

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 et false dans le cas contraire.

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);

ADOBE DREAMWEAVER 9.0

Guide des API

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.

Valeurs renvoyées

Valeur booléenne : true si la création du dossier a réussi et false dans le cas contraire.

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("Création de " + folderURL);

}else{

alert("Impossible de créer " + 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 et false dans le cas contraire.

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 + " existe !");

}else{

alert(fileURL + " n'existe pas.");

}

ADOBE DREAMWEAVER 9.0

Guide des API

DWfile.getAttributes()

Disponibilité

Dreamweaver 2.

Description

Cette fonction obtient les attributs du fichier ou dossier spécifié.

Arguments

fileURL

• 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

• R signifie lecture seule.

• D signifie dossier.

• H signifie masqué.

• S indique un fichier ou dossier système.

null. Les caractères suivants de la chaîne représentent les attributs :

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 + " est en lecture seule !");

}

DWfile.getModificationDate()

Disponibilité

Dreamweaver 2.

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 1er janvier 1600.

ADOBE DREAMWEAVER 9.0

Guide des API

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 plate-forme 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 :

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 et file2 ont été enregistrés en même temps");

}else if (time1 < time2){

alert("file1 est plus ancien que file2");

}else{

alert("file1 est plus récent que 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

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 n'a pas été modifié depuis sa création");

}else if (time1 < time2){

alert("file1 a été modifié pour la dernière fois à " + time2);

}

ADOBE DREAMWEAVER 9.0

Guide des API

DWfile.getCreationDateObj()

Disponibilité

Dreamweaver MX.

Description

Cette fonction obtient l'objet JavaScript représentant l'heure de création du fichier.

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 Date JavaScript représentant l'heure de la dernière modification du fichier.

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.

Valeurs renvoyées

Obtient un objet Date JavaScript représentant la date et l'heure de la dernière modification du fichier spécifié.

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.

ADOBE DREAMWEAVER 9.0

Guide des API

DWfile.listFolder()

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 + " contient : " + list.join("\n"));

}

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 null si la lecture échoue.

Exemple

Le code suivant lit le fichier mydata.txt et, s'il réussit, affiche un message d'avertissement renfermant le contenu du fichier :

var fileURL = "file:///c|/temp/mydata.txt"; var str = DWfile.read(fileURL); if (str){

alert(fileURL + " contient : " + str);

}

ADOBE DREAMWEAVER 9.0

Guide des API

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 et false dans le cas contraire.

Exemple

L'exemple suivant utilise la fonction DWfile.getAttributes() pour déterminer si le fichier est accessible en lecture seule et la fonction

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){

}

confirm() pour afficher à l'utilisateur une boîte de dialogue de type Oui/Non :

delAnyway = confirm('Ce fichier est en lecture seule. Voulez-vous quand même le supprimer ?'); if (delAnyway){

DWfile.remove(selFile);

}

DWfile.setAttributes()

Disponibilité

Dreamweaver MX.

Description

Cette fonction définit les attributs système d'un fichier donné.

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 Lecture seule

H Masqué

V Visible (annule H)

Les valeurs acceptables pour la chaîne

Accessible en écriture (annule R)

strAttrs sont : R, W, H, V, RH, RV, WH ou WV.

ADOBE DREAMWEAVER 9.0

Guide des API

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 ( l'autre. Si vous les associez,

H perd tout son sens et le fichier est défini comme étant visible (V).

W). N'utilisez pas H et V conjointement, car ils s'excluent aussi l'un

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

R ou W sans spécifier un attribut de visibilité H ou V, l'attribut

de visibilité existant pour le fichier reste inchangé.

Valeurs renvoyées

Aucune.

DWfile.write()

Disponibilité

Dreamweaver 2.

Description

Cette fonction rédige 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.

• L'argument text est la chaîne qui doit être écrite.

• L'argument mode, s'il est fourni, doit être "append". Si cet argument est omis, le contenu du fichier est écrasé par la chaîne.

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.

Exemple

Le code suivant tente d'écrire la chaîne "xxx" dans le fichier mydata.txt et affiche un message d'avertissement si l'opération d'écriture réussit. Il essaie ensuite d'annexer la chaîne cette opération réussit. Après l'exécution de ce script, le fichier mydata.txt contient uniquement le texte

var fileURL = "file:///c|/temp/mydata.txt"; if (DWfile.write(fileURL, "xxx")){

alert("Ecriture de xxx dans " + fileURL); } if (DWfile.write(fileURL, "aaa", "append")){

alert("aaa annexé à " + fileURL); }

"aaa" au fichier et affiche un deuxième message d'avertissement si

xxxaaa.

Chapitre 3 : API HTTP

Les extensions ne fonctionnent pas uniquement dans le système de fichiers local. Adobe® Dreamweaver® CS3 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.

La propriété statusCode indique l'état de l'opération ; les valeurs possibles sont notamment :

• 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é des fonctions 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.

data varie selon la fonction ; les valeurs possibles sont spécifiées dans les listes

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.

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.

ADOBE DREAMWEAVER 9.0

Guide des API

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é data de cet objet est une chaîne englobant le contenu des scripts supprimés. Si une erreur se produit, Dreamweaver la consigne dans la propriété

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 :

<html> <head> <TITLE>Suppression des scripts de serveur</TITLE> <SCRIPT SRC="ClearServerScripts.js"></SCRIPT> <SCRIPT LANGUAGE="javascript"> </SCRIPT> <body onLoad="MMHttp.clearServerScriptsFolder()"> </body> </html>

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 :

<html> <head> <title>Suppression des fichiers temporaires à la fermeture</title> </head> <body onLoad="MMHttp.clearTemp()"> </body> </html>

ADOBE DREAMWEAVER 9.0

Guide des API

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}

• 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 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'enregis-

trement.

true ou si saveURL est en dehors du

Valeurs renvoyées

Un objet représentant la réponse du serveur. La propriété data de cet objet est une chaîne contenant l'emplacement où le fichier a été enregistré, exprimé sous la forme d'une URL de type file://. Normalement, la propriété 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é de l'opération :

statusCode contient un entier représentant l'un des codes d'erreur suivants en cas d'échec

statusCode de l'objet

• 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

• 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

ADOBE DREAMWEAVER 9.0

Guide des API

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); }

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

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 dossier Configuration/Temp, l'utilisateur peut remplacer

• L'argument facultatif titleBarLabel est le libellé qui doit figurer dans la barre de titre de la boîte de dialogue d'enregis-

trement.

saveURL spécifie un emplacement en dehors du dossier Configuration/Temp, une valeur de prompt égale à

true ou si saveURL est en dehors du

saveURL dans la boîte de dialogue d'enregistrement.

Valeurs renvoyées

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() », page 15 pour une liste des codes d'erreur possibles.

MMHttp.getText()

Disponibilité

Dreamweaver UltraDev 4, améliorée dans la version Dreamweaver MX.

Description

Extrait le contenu du document situé à l'URL spécifiée.

ADOBE DREAMWEAVER 9.0

Guide des API

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 Configu-

ration 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é.

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 Configu-

ration 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

Si une erreur survient, Dreamweaver MX la consigne dans la propriété

callbackFunc.

statusCode de l'objet renvoyé.

MMHttp.postText()

Disponibilité

Dreamweaver UltraDev 4, améliorée dans la version 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"

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 Configu-

ration 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é

ou s'il n'est pas spécifié, dataToPost doit être codé en formulaire conformément à la section 8.2.1 de la

"application/x-www-form-urlencoded".

statusCode de l'objet renvoyé.

ADOBE DREAMWEAVER 9.0

Guide des API

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.

MMHttp.postTextCallback()

Disponibilité

Dreamweaver UltraDev 4, améliorée dans la version 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"

cation RFC 1866 (disponible à l'adresse www.faqs.org/rfcs/rfc1866.html).

ou s'il n'est pas spécifié, data doit être codé en formulaire conformément à la section 8.2.1 de la spécifi-

• 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

"application/x-www-form-urlencoded".

• 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

Si une erreur se produit, Dreamweaver la consigne dans la propriété statusCode de l'objet renvoyé.

callbackFunc.

Chapitre 4 : API de Design Notes

Adobe® Dreamweaver® CS3, Fireworks et Flash permettent aux concepteurs et développeurs de sites Web de stocker et de récupérer des informations complémentaires sur les documents (telles que des commentaires de révision, des notes de modification ou le fichier source d'un document GIF ou JPEG) dans des fichiers appelés Design Notes.

MMNotes est une bibliothèque C partagée qui permet aux auteurs d'extensions de lire et d'écrire dans les fichiers Design Notes. A l'instar de la bibliothèque partagée DWfile, MMNotes possède une API JavaScript qui permet d'appeler les fonctions contenues dans la bibliothèque à partir d'objets, de commandes, de comportements, de panneaux flottants, d'inspecteurs de propriétés et de traducteurs de données.

MMNotes possède également une API C qui donne à d'autres applications la possibilité de lire et d'écrire dans les fichiers Design Notes. La bibliothèque partagée MMNotes peut être utilisée indépendamment de Dreamweaver, que celui-ci soit installé ou non.

Pour plus d'informations sur l'utilisation de la fonctionnalité Design Notes dans Dreamweaver, consultez le manuel Utilisation de Dreamweaver.

Fonctionnement de 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.

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

foghorn.png" /> <infoitem key="Auteur" value="Heidi B." /> <infoitem key="Status" value="Version finale, approuvée par Jay L." />

</info>

_source" value="file:///C|sites/dreamcentral/images/sourceFiles/¬

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.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.

Remarque : Appelez toujours la fonction weaver écrive dans le fichier.

MMNotes.close() une fois le travail sur les Design Notes terminé, afin que Dream-

Arguments

fileHandle

• L'argument fileHandle est l'identificateur de fichier renvoyé par la fonction MMNotes.open().

Valeurs renvoyées

Aucune.

Exemple

Consultez « MMNotes.set() », page 23.

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é.

ADOBE DREAMWEAVER 9.0

Guide des API

Exemple

Un appel à la fonction MMNotes.filePathToLocalURL('C:/sites/webdev/index.htm') renvoie

"file:///c|sites/webdev/index.htm".

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é.

Valeurs renvoyées

Une chaîne contenant la valeur de la clé.

Exemple

Consultez « MMNotes.getKeys() », page 21.

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é.

ADOBE DREAMWEAVER 9.0

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; // toujours fermer noteHandle MMNotes.close(noteHandle);

Guide des API

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 lo cal pour le site, exprimé sous la forme d'une URL de type file://, ou une chaîne v ide 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.

Arguments

Aucun.

Valeurs renvoyées

Une chaîne contenant le nom de l'application qui a implémenté la bibliothèque partagée MMNotes.

ADOBE DREAMWEAVER 9.0

Exemple

L'appel de la fonction MMNotes.getVersionName() à partir d'une commande, d'un objet, d'un comportement, d'un inspecteur Propriétés, d'un panneau flottant ou d'un traducteur de données Dreamweaver renvoie de la fonction

MMNotes.getVersionName() à partir de Fireworks renvoie également la valeur "Dreamweaver" étant donné

"Dreamweaver". L'appel

que Fireworks utilise la même version de la bibliothèque (celle qui a été créée par l'équipe technique de Dreamweaver).

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.

MMNotes.localURLToFilePath()

Description

Cette fonction convertit l'URL de type file:// spécifiée en un chemin d'accès du lecteur local.

Guide des API

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 MMNotes.localURLToFilePath('file:///MacintoshHD/images/moon.gif') renvoie "Macin-

toshHD:images:moon.gif"

MMNotes.open()

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

Valeurs renvoyées

L'identificateur du fichier Design Notes ou zéro (0) si le fichier n'a pas été ouvert ni créé.

filePath n'est associé à aucun site.

Exemple

Consultez « MMNotes.set() », page 23.

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.

Valeurs renvoyées

Valeur booléenne : true indique que l'opération a réussi ; false indique un échec.

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.

ADOBE DREAMWEAVER 9.0

Guide des API

Valeurs renvoyées

Valeur booléenne : true indique que l'opération a réussi ; false indique un échec.

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 de Design Notes :

var noteHandle = MMNotes.open('file:///c|/sites/dreamcentral/peakhike99/

index.html',true);

if(noteHandle > 0){

MMNotes.set(noteHandle,"Auteur","M. G. Miller"); MMNotes.set(noteHandle,"Dernière modification","28 août 1999"); MMNotes.close(noteHandle);

}

ADOBE DREAMWEAVER 9.0

Guide des API

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é.

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.

Valeurs renvoyées

Valeur booléenne : true indique que l'opération a réussi ; false indique un échec. L'argument localURLBuf reçoit la valeur de l'URL de type file://.

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.

ADOBE DREAMWEAVER 9.0

Guide des API

Valeurs renvoyées

Valeur booléenne : true indique que l'opération a réussi ; false indique un échec. L'argument valueBuf reçoit la valeur de la clé.

Exemple

Le code suivant obtient la valeur de la clé commentaires dans le fichier Design Notes associé au fichier welcome.html :

FileHandle noteHandle = OpenNotesFile("file:///c|/sites/avocado8/iwjs/welcome.html"); if(noteHandle > 0){

int valueLength = GetNoteLength( noteHandle, "commentaires"); char* valueBuffer = new char[valueLength + 1]; GetNote(noteHandle, "commentaires", valueBuffer, valueLength + 1); printf("Commentaires : %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é.

Valeurs renvoyées

Un nombre entier représentant la longueur de la valeur.

Exemple

Consultez « BOOL GetNote() », page 24.

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é.

ADOBE DREAMWEAVER 9.0

Guide des API

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().

• 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 indique que l'opération a réussi ; false indique un échec. 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("La clé est : %s\n", keys[i]); printf("La valeur est : %s\n\n", GetNote(noteHandle, keys[i]);

} } delete []keys;

} CloseNotesFile(noteHandle);

BOOL GetSiteRootForFile()

Description

Cette fonction détermine la racine du site pour le fichier Design Notes spécifié.

Arguments

const char* filePath, char* siteRootBuf, int siteRootBufMaxLen, {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 : true indique que l'opération a réussi ; false indique un échec. L'argument siteRootBuf reçoit l'adresse de la mémoire tampon qui stocke la racine du site. Si vous spécifiez l'argument les préférences de Design Notes pour le site. Le struct

signNotes

, toutes deux de type BOOL.

InfoPrefs possède deux variables : bUseDesignNotes et bUploadDe-

infoPrefs, la fonction renvoie également

ADOBE DREAMWEAVER 9.0

Guide des API

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, int versionNameBufMaxLen

• 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 : true indique que l'opération a réussi ; false indique un échec. Dreamweaver stocke "Dreamweaver" dans l'argument

versionNameBuf.

BOOL GetVersionNum()

Description

Ce tte fo nctio n renvoi e le nu méro de version de l a bibl iothè que pa rta gée MM Note s, c e qui v ous pe rme t de sa voir s i cert ain es fonctions sont disponibles.

Arguments

char* versionNumBuf, int versionNumBufMaxLen

• 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 : true indique que l'opération a réussi ; false indique un échec. L'argument versionNumBuf stocke le numéro de version.

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.

Valeurs renvoyées

Valeur booléenne : true indique que l'opération a réussi ; false indique un échec. L'argument drivePathBuf reçoit le chemin de fichier local.

ADOBE DREAMWEAVER 9.0

Guide des API

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 à aucun site.

localFileURL n'est associé

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 est

false. Cet argument est facultatif, mais vous devez le définir si vous spécifiez le troisième argument.

• 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 MMNotes.dll.

false. Vous pouvez spécifier l'argument bReadOnly disponible à partir de la version 2 du fichier

BOOL RemoveNote()

Description

Cette fonction supprime la clé spécifiée (et sa valeur) du fichier Design Notes indiqué.

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é à supprimer.

Valeurs renvoyées

Valeur booléenne : true indique que l'opération a réussi ; false indique un échec.

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 indique que l'opération a réussi ; false indique un échec.

ADOBE DREAMWEAVER 9.0

Guide des API

ADOBE DREAMWEAVER 9.0

Guide des API

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 (IU) 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 des informations générales sur l'interaction des bibliothèques C avec l'interpréteur JavaScript dans Adobe® Dreamweaver® CS3, voir Extension de Dream- weaver pour plus de détails sur les extensions C.

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.

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.

ADOBE DREAMWEAVER 9.0

Guide des API

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 de notification de Dreamweaver ; l'utilisateur n'exécute pas une version valide de Dreamweaver (version 3 ou

ultérieure).

• Erreur de lancement 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.

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

FWLaunch.execJsInFireworks(), que l'exécution du script se soit terminée avec succès ou qu'une erreur se soit produite.

Arguments

progressTrackerCookie

• L'argument progressTrackerCookie est l'objet cookie renvoyé par la fonction FWLaunch.execJsInFireworks().

Valeurs renvoyées

Une chaîne contenant le rés ultat du s cript transm is à FWLaunch.execJsInFireworks() si l'opération se termine avec succès, la valeur 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 de notification de Dreamweaver ; l'utilisateur n'exécute pas une version valide de Dreamweaver (version 3 ou

• Erreur lors du démarrage de Fireworks, ce qui indique que la fonction n'ouvre pas une version valide de Fireworks

• L'utilisateur a annulé l'opération.

null si Fireworks est toujours en train d'exécuter le code JavaScript, ou un code d'erreur non nul indiquant que

ultérieure).

(version 3 ou ultérieure).

Exemple

Le code suivant transmet la chaîne "prompt('Veuillez entrer votre nom :')" à la fonction

FWLaunch.execJsInFireworks(), puis il vérifie le résultat :

var progressCookie = FWLaunch.execJsInFireworks("prompt('Veuillez entrer votre nom :')"); var doneFlag = false; while (!doneFlag){

// vérifier l'achèvement toutes les 1/2 secondes setTimeout('checkForCompletion()',500);

}

function checkForCompletion(){

if (progressCookie != null) {

var response = FWLaunch.getJsResponse(progressCookie);

if (response != null) {

if (typeof(response) == "number") {

// erreur ou annulation de l'utilisateur, moment de fermer la fenêtre // et d'informer l'utilisateur qu'une erreur s'est produite window.close(); alert("Une erreur s'est produite.");

}else{

// réponse valide obtenue ! alert("Enchanté de vous rencontrer, " + response); window.close();

}

doneFlag = true;

} }

}

ADOBE DREAMWEAVER 9.0

Guide des API

FWLaunch.mayLaunchFireworks()

Disponibilité

Dreamweaver 2, Fireworks 2.

Description

Cette fonction détermine s'il est possible d'ouvrir une session d'optimisation de Fireworks.

Arguments

Aucun.

Valeurs renvoyées

Une 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.

ADOBE DREAMWEAVER 9.0

Guide des API

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.

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 de notification de Dreamweaver ; 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.

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 ou une version ultérieure est installé.");

}else{

alert("Fireworks 6.0 n'est pas installé.");

}

ADOBE DREAMWEAVER 9.0

Guide des API

Un exemple simple de communication FWLaunch

La commande suivante demande à Fireworks d'inviter l'utilisateur à entrer son nom, puis renvoie le nom à Dreamweaver.

<html> <head> <title>Invite dans 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("Vous devez avoir installé Fireworks 3.0 ou une version supérieure pour utiliser cette ¬

commande"); return;

}

// Cette commande demande à Fireworks d'exécuter la fonction prompt(). gProgressTrackerCookie = FWLaunch.execJsInFireworks¬ ("prompt('Veuillez entrer votre nom :')");

// une valeur nulle indique qu'il n'a pas été lancé, un nombre indique un code d'erreur if (gProgressTrackerCookie == null || ¬ typeof(gProgressTrackerCookie) == "nombre") {

window.close();

alert("une erreur s'est produite");

gProgressTrackerCookie = null; } else {

// afficher Fireworks au premier plan

FWLaunch.bringFWToFront();

// lancer la vérification pour voir si Fireworks a terminé

checkOneMoreTime(); }

}

function checkOneMoreTime() {

// Appeler checkJsResponse() toutes les 1/2 secondes pour voir si Fireworks // a terminé window.setTimeout("checkJsResponse();", 500);

}

function checkJsResponse() {

var response = null;

// L'utilisateur a cliqué sur le bouton d'annulation, fermer la fenêtre if (gCancelClicked) {

window.close();

alert("bouton d'annulation cliqué"); } else {

// Procédure toujours en cours, interroger Fireworks sur son état

if (gProgressTrackerCookie != null)

response = FWLaunch.getJsResponse(gProgressTrackerCookie);

if (response == null) {

// toujours en attente de réponse, rappelez-nous dans 1/2 // seconde checkOneMoreTime();

} else if (typeof(response) == "number") {

// si la réponse est un nombre, cela indique qu'une erreur s'est produite // l'utilisateur a cliqué sur le bouton d'annulation dans Fireworks window.close(); alert("une erreur s'est produite.");

} else {

// réponse valide obtenue !Cette valeur renvoyée n'est pas // toujours utile, étant donné que les fonctions de Fireworks // ne renvoient pas toutes une chaîne, mais nous savons que c'est le cas de celle-ci, // nous pouvons donc montrer à l'utilisateur ce que nous avons obtenu. window.close(); FWLaunch.bringDWToFront();// afficher Dreamweaver au premier plan alert("Enchanté de vous rencontrer, " + response + "!");

} }

}

</script > </head> <body> <form> <table width="313" nowrap> <tr> <td>Cette commande demande à Fireworks d'exécuter la fonction prompt() ¬ . Lorsque vous cliquez sur Prompt, Fireworks s'affiche au premier plan et ¬ vous demande d'entrer une valeur dans une boîte de dialogue. Cette valeur est alors ¬ renvoyée à Dreamweaver et affichée dans une alerte.</td> </tr> </table> </form> </body> </html>

ADOBE DREAMWEAVER 9.0

Guide des API

Chapitre 6 : Intégration de Flash

Adobe® Dreamweaver® CS3 prend maintenant en charge les éléments Flash, en plus de l'API d'objet Flash, qui s'appuie sur le modèle Flash Generator pour créer de nouveaux objets Flash. Ce chapitre décrit comment utiliser les éléments Flash (fichiers SWC), et explique en détail comment créer des objets Flash (fichiers SWF) à partir des 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.

Fonctionnement des éléments Flash

Les éléments Flash se présentent sous forme de fichiers SWC. Un fichier SWC est un clip vidéo compilé généré par Flash pour être utilisé par Adobe et des produits tiers. Dreamweaver peut rendre ces composants accessibles aux utilisateurs via la barre Insertion, le menu Insérer ou une barre d'outils. Vous créez des éléments Flash à l'aide de l'outil de création Web Flash, mais Dreamweaver peut analyser les propriétés d'un élément Flash et les exprimer via la balise balise

object). Les utilisateurs peuvent ensuite modifier les attributs de la balise param, de façon à changer les propriétés de

l'élément au moment de l'édition (pour plus d'informations sur l'utilisation des propriétés des composants dans Dreamweaver, voir Utilisation de Dreamweaver).

param (enfant de la

Insertion d'éléments Flash

Les éléments Flash sont installés via Extension Manager. Dreamweaver ajoute des éléments Flash aux documents de la même façon que les objets de la barre Insertion ou du menu Insérer (pour plus d'informations sur l'utilisation d'objets Dreamweaver, voir Objets de la barre Insertion dans Extension de Dreamweaver). Les utilisateurs peuvent ajouter des chaînes de code aux documents en cliquant sur les objets de la barre Insertion ou en sélectionnant les options dans le menu Insérer. Les utilisateurs peuvent accéder aux éléments Flash via la barre Insertion ou le menu Insérer (ce qui signifie que vous pouvez ajouter à la barre Insérer ou au menu Insérer un fichier d'élément Flash valide déjà installé dans le dossier Configuration/Objects/FlashElements ou l'un de ses sous-dossiers). Les développeurs d'extensions peuvent utiliser la fonction JavaScript « dom.insertFlashElement() », page 120 du fichier de définition de l'objet pour ajouter des éléments Flash disponibles à un document. Lorsque l'utilisateur sélectionne l'objet de l'élément Flash, Dreamweaver ouvre le fichier SWC, qui contient le contenu Flash (fichier SWF) et un fichier détaillant les paramètres que l'utilisateur peut modifier. Dreamweaver insère ensuite le fichier SWF dans le document de l'utilisateur.

Ajout d'un élément Flash à la barre Insertion

De même que pour tout autre objet, l'ajout d'un élément Flash à la barre Insertion se fait via la balise button. Toutefois, une balise

button pour un élément Flash doit avoir des attributs file et command pour être correctement ajoutée au document

(pour plus d'informations sur la balise button, voir « Objets de la barre Insertion » dans Extension de Dreamweaver). Les attributs Objects. Utilisez ensuite l'attribut lorsque l'utilisateur clique sur le bouton de la barre Insertion.

L'exemple suivant représente le code qui doit être écrit dans le fichier inserbar.xml (en tant qu'enfant de la balise ou

file permettent d'indiquer à Dreamweaver où se trouve le fichier source de l'élément par rapport au dossier

command pour indiquer à Dreamweaver d'utiliser la fonction dom.insertFlashElement()

Ajout d'un élément Flash à un menu

Un élément Flash peut également être situé dans le menu Insérer ou dans d'autres menus de Dreamweaver. Utilisez la fonction JavaScript « dom.insertFlashElement() », page 120 avec le format de fichier menus.xml (voir « Menus et commandes de menus » dans Extension de Dreamweaver) pour indiquer l'emplacement de l'élément de menu Flash. L'exemple suivant est un code qui permet, au sein du fichier menus.xml, d'intégrer l'élément Navigation Flash dans le menu Insertion > Elément Flash :

<menuitem name="Navigation" key=""command="dw.getDocumentDOM().insertFlashElement('nav.swc')" enabled="(dw.getFocus() != 'browser') && (dw.getDocumentDOM() != null && ¬

dw.getDocumentDOM().getParseMode() == 'html')"

id="DWMenu_Insert_FlashElement_Nav" />

L'API des objets Flash

L'API des objets Flash permet aux développeurs d'extensions de construire des objets pour créer un contenu Flash simple 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. Les fonctionnalités bouton Flash et texte Flash sont construites à l'aide de cette API.

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 vous permettent de créer un nouveau fichier SWF (ou fichier d'image) à partir d'un fichier SWT 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.

SWFFile.createFile()

Description

Cette fonction génère un nouveau fichier Objet Flash à partir du modèle et du tableau des paramètres spécifiés. Elle crée également une version 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 représentant le nom du type d'objet, telle que

"Flash Text".

• 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.

• 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.

"dwType". Sa valeur doit être une chaîne

ADOBE DREAMWEAVER 9.0

Guide des API

• 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

-defaultsize Largeur, hauteur Définit la taille de l'image de sortie en fonction

des largeur et hauteur indiquées.

-exactFit 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 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 "myType", qui remplace toutes les occurrences de la chaîne

"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.

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");

SWFFile.getNaturalSize()

Description

Cette fonction renvoie la taille naturelle de tout contenu Flash non compressé.

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 valeur

null si le fichier n'est pas un fichier Flash non compressé.

ADOBE DREAMWEAVER 9.0

Guide des API

SWFFile.getObjectType()

Description

Cette fonction renvoie le type d'objet Flash, c'est-à-dire la valeur transmise dans le paramètre dwType lorsque le fichier a été créé par la fonction

Arguments

fileName

• L'argument fileName, exprimé sous la forme d'une URL de type file://, correspond au chemin d'accès à un fichier 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 Objet Flash ou s'il est introuvable.

Exemple

Le code suivant vérifie si le fichier test.swf est un objet Flash de type myType :

if ( SWFFile.getObjectType("file:///MyMac/test.swf") == "myType" ){

alert ("Il s'agit d'un objet myType.");

}else{

alert ("Il ne s'agit pas d'un objet myType.");

}

SWFFile.createFile().

SWFFile.readFile()

Description

Cette fonction lit un fichier 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 Objet

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 ou s'il ne s'agit pas d'un fichier 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" // fichier de modèle utilisé pour créer ce fichier .swf "dwType" // premier paramètre "myType" // valeur du premier paramètre "text" // deuxième paramètre "Hello World" // valeur du deuxième paramètre

"dwType", suivie par sa valeur. La fonction renvoie une valeur null si le fichier est introuvable

Chapitre 7 : 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 : la gestion des connexions et l'accès aux bases de données.

La gestion des connexions aux bases de données permet, par exemple, d'obtenir le nom d'utilisateur et le mot de passe nécessaires pour établir une connexion à une base de données ou d'ouvrir une boîte de dialogue de connexion à une 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).

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 de Adobe® Dreamweaver® CS3 utilisent toutes ces fonctions de base de données.

Les fonctions décrites dans ce chapitre sont regroupées dans les sections suivantes :

• « Fonctions de connexion à une base de données », page 42

• « Fonctions d'accès à la base de données », page 53

ADOBE DREAMWEAVER 9.0

Guide des API

Fonctionnement de l'API de bases 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

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;

// supprimer les commentaires SQL 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; } }

MMDB.getColumnAndTypeList() :

var statement = replaceParamsWithVals(statement, pa, serverModel);

}

bindingsAndTypeArray = MMDB.getColumnAndTypeList(connName, statement); return bindingsAndTypeArray;

}

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, consultez la section « Fonctions d'accès à la base de données », page 53.

MMDB.deleteConnection()

Disponibilité

Dreamweaver MX.

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(); }

}

MMDB.getColdFusionDsnList()

Disponibilité

Dreamweaver UltraDev 4.

ADOBE DREAMWEAVER 9.0

Guide des API

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ée dans la version Dreamweaver MX.

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

string Chaîne de connexion ADO d'exécution ou URL JDBC

à une base de données en exécution.

Propriété Description

dsn DSN ColdFusion

driver Pilote JDBC d'exécution

username Nom d'utilisateur d'exécution

password Mot de passe d'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).

includePattern Expression régulière utilisée pour trouver l'instruction d'inclusion de fichier sur la p age

pendant Live Data et Aperçu dans le navigateur

ADOBE DREAMWEAVER 9.0

Guide des API

variables Tableau de noms de variables de pages et leurs valeurs correspondantes, utilisé pen-

catalog Utilisé pour restreindre les métadonnées qui apparaissent (pour plus d'informations,

schema Utilisé pour restreindre les métadonnées qui apparaissent (pour plus d'informations,

filename Nom de fichier de boîte de dialogue qui était utilisé pour créer la connexion

dant Live Data et Aperçu dans le navigateur

consultez la section « MMDB.getProcedures() », page 57)

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"].

ADOBE DREAMWEAVER 9.0

Guide des API

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 (IU) à 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 :

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 nom de connexion que vous souhaitez obtenir.

TdsDriver. Vous devez transmettre le nom du pilote à cette fonction pour définir complètement le

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" :

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.

ADOBE DREAMWEAVER 9.0

Guide des API

Exemple

Le code var connectionString = MMDB.getConnectionString ("EmpDB") renvoie différentes chaînes pour une connexion ADO ou JDBC.

• Pour une connexion ADO, la chaîne suivante peut renvoyer :

"dsn=EmpDB;uid=;pwd=";

• Pour une connexion JDBC, la chaîne suivante peut renvoyer :

"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.

Exemple

L'instruction MMDB.getDriverName ("EmpDB"); peut renvoyer la chaîne suivante :

"jdbc/oracle/driver/JdbcOracle"

MMDB.getDriverUrlTemplateList() (déconseillé)

Disponibilité

Dreamweaver UltraDev 4, déconseillée dans Dreamweaver MX.

Remarque : Pour Dreamweaver UltraDev 4, la liste des pilotes JDBC est stockée dans le fichier connections.xml résidant dans le dossier Configuration/Connections. Tous les pilotes ont un modèle d'URL associé. Cette fonction renvoie la liste des pilotes JDBC.

Pour Dreamweaver MX (ou version ultérieure), ces pilotes et les modèles d'URL sont codés dans les boîtes de dialogue JDBC. En outre, cette fonction est une définition de fonction vide utilisée pour éliminer les erreurs de fonctions non définies. L'exemple suivant indique la manière dont un lecteur JDBC et un modèle d'URL sont codés :

var DEFAULT_DRIVER = "COM.ibm.db2.jdbc.app.DB2Driver"; var DEFAULT

Dreamweaver dispose d'une boîte de dialogue pour chaque paire pilote/modèle d'URL.

En résumé, les développeurs qui utilisent Dreamweaver UltraDev 4 doivent ajouter une nouvelle entrée à XML et ceux qui utilisent Dreamweaver MX (ou version supérieure) doivent mettre en oeuvre une nouvelle boîte de dialogue.

_TEMPLATE = "jdbc:db2:[database name]";

Description

Extrait les pilotes JDBC et les modèles d'URL respectifs.

Arguments

Aucun.

ADOBE DREAMWEAVER 9.0

Valeurs renvoyées

Tableau contenant les pilotes JDBC détectés sur le système de l'utilisateur et leurs modèles d'URL respectifs, s'ils sont spécifiés. Le tableau dispose d'un nombre pair d'éléments contenant :

Driver1, UrlTemplate1, Driver2, UrlTemplate2, etc.

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()

Guide des API

Disponibilité

Dreamweaver UltraDev 1.

Description

Extrait le mot de passe utilisé pour la connexion spécifié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

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).

Arguments

Aucun.

Valeurs renvoyées

Chaîne contenant le mot de passe RDS.

ADOBE DREAMWEAVER 9.0

Guide des API

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ée dans la version Dreamweaver MX.

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 développeur fournit une chaîne de paramètre, cette fonction la transmet aux scripts de connectivité HTTP.

MMDB.getRemoteDsnList(). Si le

Arguments

{urlParams}

• L'argument facultatif urlParams est une chaîne contenant une liste des expressions name=value, séparées par des esper-

luettes (&). Les valeurs ne doivent pas être entourées de guillemets. Certains caractères, tels que l'espace dans la valeur «

Hello World », doivent être codés. Voici un exemple d'argument valide que vous pouvez transmettre dans

MMDB.getRemoteDsnList() : a=1&b=Hello%20World

Valeurs renvoyées

Renvoie un tableau contenant les DSN ODBC définis sur le serveur pour le site en cours.

MMDB.getRuntimeConnectionType()

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 une des valeurs suivantes : "ADO", "ADODSN",

"JDBC" ou "CFDSN".

ADOBE DREAMWEAVER 9.0

Guide des API

Exemple

Le code suivant renvoie la chaîne "ADO" pour une connexion ADO :

var connectionType = MMDB.getRuntimeConnectionType ("EmpDB")

MMDB.getUserName()

Disponibilité

Dreamweaver UltraDev 1.

Description

Renvoie un nom d'utilisateur pour la connexion spécifié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 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é.

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é ; false indique le contraire.

MMDB.needToPromptForRdsInfo()

Disponibilité

Dreamweaver MX.

Description

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.

ADOBE DREAMWEAVER 9.0

Guide des API

Valeurs renvoyées

Valeur booléenne : true indique que l'utilisateur doit être invité à saisir les informations de connexion RDS ; false indique le contraire.

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.

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

connRec

connrec, bDuplicate

• dialogFileName est une chaîne qui contient le nom d'un fichier HTML résidant dans le dossier Configuration/Connec-

tions/server-model. Ce fichier HTML définit la boîte de dialogue qui crée une connexion. Il doit implémenter trois fonctions API JavaScript : 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, consultez la section « API de connectivité à une base de données », page 65).

findConnection(), inspectConnection() et applyConnection(). En général, vous créez un

• 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.

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()

Disponibilité

Dreamweaver UltraDev 4.

ADOBE DREAMWEAVER 9.0

Guide des API

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 apparaît.

MMDB.showConnectionMgrDialog()

Disponibilité

Dreamweaver UltraDev 1.

Description

Affiche la boîte de dialogue Gestionnaire de connexions.

Arguments

Aucun.

ADOBE DREAMWEAVER 9.0

Guide des API

Valeurs renvoyées

Aucune. La boîte de dialogue Gestionnaire de connexions s'affiche.

MMDB.showOdbcDialog()

Disponibilité

Dreamweaver UltraDev 4 (Windows uniquement).

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 username et password. Si l'une des propriétés n'est pas définie, ceci indique que l'utilisateur a annulé la boîte de dialogue.

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 catalog et schema. Si l'une des propriétés n'est pas définie, ceci indique que l'utilisateur a annulé la boîte de dialogue.

ADOBE DREAMWEAVER 9.0

Guide des API

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 réussit ; false dans le cas contraire.

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. Pour l'ensemble des fonctions qui gèrent une connexion à une base de données, consultez la section « Fonctions de connexion à une base de données », page 42.

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

tionList()

. 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. Il existe deux façons de spécifier des valeurs de paramètre pour

les fonctions d'accès aux bases de données. En premier lieu, vous pouvez fournir un tableau de valeurs de paramètre (

paramValuesArray). Si vous ne spécifiez que des valeurs de paramètre, celles-ci doivent être dans 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 ( paramètres de la procédure stockée. Si vous fournissez des noms de paramètres, les valeurs spécifiées dans

paramValuesArray doivent être dans l'ordre dans lequel les noms ont été spécifiés dans paramNameArray.

paramNameArray). Vous pouvez utiliser la fonction MMDB.getSPParamsAsString() pour obtenir les

MMDB.getConnec-

ADOBE DREAMWEAVER 9.0

Guide des API

MMDB.getColumnAndTypeList()

Disponibilité

Dreamweaver UltraDev 1.

Description

Cette fonction extrait une liste de colonnes et leurs types respectifs d'une déclaration SQL SELECT exécutée.

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 SELECT, ou bien 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.getColumnAndTypeList("EmpDB","Sélectionner * dans Employés") 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 SELECT exécutée.

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 correspondant à la déclaration SELECT, ou une erreur si la décla- ration SQL n'est pas valide ou si la connexion n'a pas pu s'établir.

Exemple

Le code var columnArray = MMDB.getColumnList("EmpDB","Sélectionner * dans Employés") renvoie le tableau de chaînes suivant :

columnArray[0] = "EmpName" columnArray[1] = "EmpFirstName" columnArray[2] = "Age"

ADOBE DREAMWEAVER 9.0

Guide des API

MMDB.getColumns()

Disponibilité

Dreamweaver MX, arguments mis à jour dans MX 2004.

Description

Renvoie un tableau d'objets qui décrivent les colonnes du tableau spécifié.

Arguments

connName, tableName

• L'argument connName est le nom de la connexion. Cette valeur identifie la connexion qui contient la chaîne que Dream-

weaver doit utiliser pour établir une connexion de base de données à une source de données active.

• tableName est le tableau à 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'info bulle :

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)) {

// il s'agit déjà d'un nombre

typename = dwscripts.getDBColumnTypeAsString(typename, databaseType); }

var tooltiptext = typename;

}

ADOBE DREAMWEAVER 9.0

Guide des API

MMDB.getColumnsOfTable()

Disponibilité

Dreamweaver UltraDev 1.

Description

Cette fonction extrait une liste de toutes les colonnes du tableau spécifié.

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.

Valeurs renvoyées

Un tableau de chaînes dont chaque chaîne est le nom d'une colonne du tableau.

Exemple

L'instruction MMDB.getColumnsOfTable ("EmpDB","Employés"); renvoie les chaînes suivantes :

["EmpID", "FirstName", "LastName"]

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

• 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);

ADOBE DREAMWEAVER 9.0

Guide des API

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.

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

catalog Nom du catalogue associé à l'objet (qualificatif de propriétaire).

procedure Nom de la procédure.

a. 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.

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 getProcedures(). La base de données à laquelle accède cette fonction dépend du type de connexion.

• 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é dsn dans l'objet de co nnexion (connName) que vous transmettez à la fonction getProcedures().

• Pour les connexion à la BD OLE, la chaîne de connexion donne un nom à la base de données.

La valeur de la propriété catalog est définie par un attribut du pilote de la BD OLE. Cet attribut du pilote définit une propriété user.database par défaut à utiliser lorsque la chaîne de connexion à la BD OLE n'indique pas de base de données.

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);

}

ADOBE DREAMWEAVER 9.0

Guide des API

MMDB.getSPColumnList()

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, 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

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.

MMDB.getSPParamsAsString() pour obtenir les paramètres de la procédure stockée.

Exemple

Le code suivant pourrait 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 paramValueArray = new Array("2/1/2000", "50000") var columnArray = MMDB.getSPColumnList("EmpDB", ¬ "getNewEmployeesMakingAtLeast", paramValueArray) Les valeurs suivantes renvoient : columnArray[0] = "EmpID", columnArray[1] = "LastName", ¬ columnArray[2] ="startDate", columnArray[3] = "salary"

getNewEmployeesMakingAtLeast :

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.

• 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 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.

paramNameArray, spécifiez les valeurs de paramètre dans l'ordre dans lequel leurs

ADOBE DREAMWEAVER 9.0

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 pourrait 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 renvoient :

columnArray[0] = "EmpID", columnArray[1] = "LastName", ¬ columnArray[2] ="startDate", columnArray[3] = "salary"

MMDB.getSPParameters()

Disponibilité

Dreamweaver MX.

Guide des API

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 :

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.

ADOBE DREAMWEAVER 9.0

Guide des API

Exemple

L'exemple suivant extrait les objets de paramètre pour la procédure spécifiée et crée une info bulle 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);

}

MMDB.getSPParamsAsString()

Disponibilité

Dreamweaver UltraDev 1.

Description

Cette fonction extrait une chaîne délimitée par virgules 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 MMDB.getSPParamsAsString ("EmpDB","getNewEmployeesMakingAtLeast") peut renvoyer une chaîne de nom de formulaire

startDate;direction:in;datatype:date, salary;direction:in;datatype:integer

Dans cet exemple, la procédure stockée getNewEmployeesMakingAtLeast a deux paramètres : startDate et Salary. Pour

startDate, la direction est in et le type de données est date. Pour salary, la direction est in et le type de 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 a trois propriétés : table,

schema et catalog.

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

Un tableau d'objets dans lequel chaque objet a trois propriétés : table, schema et catalog. Table est le nom de la table.

Schema est le nom du schéma qui contient la table. Catalog est le catalogue qui contient la table.

ADOBE DREAMWEAVER 9.0

Guide des API

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:"Employés", schema:"personnel", catalog:"syscat"]

Les propriétés du premier 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

• 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.

catalog, schema et view.

Valeurs renvoyées

Un table d'objets d'affichage dans lequel chaque objet a 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, CONN_LIST.getValue() :

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))

}

ADOBE DREAMWEAVER 9.0

Guide des API

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","Sélectionner EmpName,EmpFirstName,Age ¬ from Employees")

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

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.getSPParamsAsString() pour obtenir les paramètres de la procédure stockée.

ADOBE DREAMWEAVER 9.0

Guide des API

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

MMDB.showSPResultset(), car vous pouvez spécifier les valeurs de paramètre par leur nom, au lieu de l'ordre attendu par la

procédure stockée.

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)

ADOBE DREAMWEAVER 9.0

Guide des API

Chapitre 8 : 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 de Adobe® Dreamweaver® CS3. Lorsqu'un utilisateur crée ensuite un site pour élaborer des pages, il ou elle crée un nouvel objet de connexion après avoir sélectionné le type particulier de connexion que vous avez créé.

L'utilisateur peut sélectionner votre nouveau type de connexion de plusieurs manières :

• Dans le panneau Application, cliquez sur le bouton Plus (+) et sélectionnez Jeu d'enregistrements. Il peut ensuite

agrandir la fenêtre de la liste Connexion dans la boîte de dialogue Jeu d'enregistrements.

• 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.

Développement 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 Bien démarrer avec Dreamweaver.

Vérifiez que ce fichier HTML inclut une référence au fichier de mise en oeuvre de JavaScript défini à l'étape 2, « Créez un fichier JavaScript qui implémente au moins les éléments suivants : », page 66, comme le montre l'exemple suivant :

<head>

</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 plate-forme 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 serveur. L'exemple suivant indique la fonction pour le type de document ASP JavaScript :

function getServerModelFolderName() {

return "ASP

}

_JS";

getServerModelFolderName() qui renvoie le nom du dossier associé au modèle de

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

ADOBE DREAMWEAVER 9.0

Guide des API

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 oeuvre, mais il doit comporter une extension .js (par exemple, myConnectionImpl.js). Vous pouvez stocker ce fichier de mise en oeuvre 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. », page 65, doit inclure ce fichier de mise en oeuvre 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

title, spécifiée dans le document

HTML.

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 », page 42.

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 : ces trois fonctions et incluez-les dans le fichier de mise en oeuvre JavaScript associé à votre nouveau type de connexion (voir l'étape 2 « Créez un fichier JavaScript qui implémente au moins les éléments suivants : », page 66).

La fonction

applyConnection() renvoie une source HTML dans un fichier inclus. Consultez les exemples de source HTML

à la section « Fichier inclus généré », page 69. La fonction propriétés. Vous pouvez mettre en oeuvre afin d'extraire les informations renvoyées à partir de mise en oeuvre, étudiez les deux fichiers JavaScript suivants :

• connection_ado_conn_string.js se trouve dans le dossier Configuration/Connections/ASP_Js.

• 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 valide,

findConnection() renvoie un objet de connexion. Dreamweaver répertorie ensuite tous les objets 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 le même objet de connexion créé par dialogue en utilisant les informations de connexion.

findConnection(). Si le contenu d'un fichier correspond aux critères d'une connexion

findConnection(). Ce processus permet à Dreamweaver de renseigner la boîte de

findConnection(), inspectConnection() et applyConnection(). Ecrivez

findConnection() prend la source HTML et en extrait les

findConnection() pour utiliser les modèles de recherche dans les fichiers XML

applyConnection(). Si vous souhaitez voir un exemple de ce type de

inspectConnection() et retransmet

ADOBE DREAMWEAVER 9.0

Guide des API

Lorsque l'utilisateur clique sur OK dans une boîte de dialogue de connexion, Dreamweaver déclenche la fonction apply-

Connection()

ration/Connections. La fonction

pour construire la page HTML, placée dans le fichier inclus de connexion résidant dans le dossier Configu-

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.

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, 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.

findConnection()

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.

Propriété Description

name Nom de la connexion

type Si useHTTP est false, indique quelle DLL doit être utilisée pour la connexion à des

string Chaîne de connexion d'exécution. Pour ADO, il s'agit d'une chaîne de paramètres de

dsn Nom de la source de données utilisé pour les connexions de d'exécution ODBC ou Cold

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

bases de données au moment de l'exécution.

connexion ; pour JDBC, il s'agit d'une URL de connexion.

Fusi on

la conception ; dans le cas contraire, Dreamweaver utilise les propriétés au moment de la conception.

useHTTP Chaîne contenant true ou false : true indique qu'il faut utiliser une connexion

HTTP au moment de la conception ; false indique qu'il faut utiliser DLL

Propriété Description

ADOBE DREAMWEAVER 9.0

Guide des API

includePattern Expression régulière utilisée pour trouver l'instruction d'inclusion de fichier sur la page

variables Objet ayant une propriété pour chaque variable de page définie sur sa valeur corres-

catalog Chaîne contenant un identificateur de base de données qui restreint la quantité de

schema Chaîne contenant un identificateur de base de données qui restreint la quantité de

filename Nom de la boîte de dialogue utilisée pour créer la connexion

pendant Live Data et Aperçu dans le navigateur

pondante. Cet objet est utilisé pendant Live Data et Aperçu dans le navigateur.

métadonnées 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.

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

L'argument parameters est le même objet que celui qui est renvoyé par la fonction findConnection().

Valeurs renvoyées

Aucune.

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 inclus Configuration/Connections/nom-connexion.ext, où nom-connexion est le nom de votre connexion (voir

« Définissez la mise en forme de la boîte de dialogue de connexion. », page 65) 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, 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 fichier

applyConnection() affiche un message d'erreur et renvoie une chaîne vide pour indiquer

ADOBE DREAMWEAVER 9.0

Fichier inclus généré

Le fichier inclus généré par applyConnection() déclare toutes les propriétés d'une connexion. Le nom du fichier inclus correspond au nom de connexion avec l'extension de fichier définie pour le modèle de serveur associé au site en cours.

Guide des API

Remarque : Les connexions étant partagées, définissez la valeur

allowMultiple sur false. Le fichier de connexion est ainsi

inclus dans le document une fois seulement et le script de serveur reste dans la page si un autre comportement de serveur l'utilise.

Les sections suivantes illustrent certains exemples de fichiers inclus générés par

applyConnection() pour divers modèles

de serveur par défaut.

Remarque : Pour créer un nouveau format de fichier inclus de connexion, vous devez définir un nouveau fichier de correspondance EDML, qui doit ressembler à connection_includefile.edml, comme dans « Fichier de définition pour votre type de connexion », page 70.

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 // Type="ADO" // HTTP="true" // Catalog="" // Schema=""

_MyConnection1_STRING = "dsn=pubs";

var MM

Le fichier du comportement de serveur inclut cette connexion en utilisant l'instruction d'inclusion de fichier relative, comme le montre l'illustration suivante :

_ado_conn_string.htm"

ColdFusion

Lorsque vous utilisez UltraDev 4 ColdFusion, Dreamweaver s'appuie sur un fichier inclus ColdFusion pour extraire une liste des sources de données.

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 :

<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'illustration suivante :

ADOBE DREAMWEAVER 9.0

Guide des API

JSP

Le fichier inclus JSP doit être nommé MyConnection1.jsp, où MyConnection1 est le nom de votre connexion. L'exemple suivant est le fichier inclus pour une connexion JDBC à une base de données :

// Filename="Connection_jdbc_conn1.htm" // Type="JDBC" // HTTP="false" // Catalog="" // Schema="" String MM_MyConnection1_DRIVER = "com.inet.tds.TdsDriver"; String MM_MyConnection1_USERNAME = "testadmin"; String MM_MyConnection1_PASSWORD = "velcro"; String MM_MyConnection1_URL = "jdbc:server:test-3:1433?database=pubs";

Le fichier du comportement de serveur inclut cette connexion en utilisant l'instruction d'inclusion de fichier relative, comme le montre l'illustration suivante :

<%@ include file="Connections/MyConnection1.jsp" %>

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 sept fichiers de définition, un pour chacun des modèles de serveur prédéfinis, comme l'illustre le tableau suivant.

Modèle de serveur Sous-dossier du dossier Configuration/Connections

ASP JavaScript ASP_Js

ASP.NET CSharp ASP.NET_Csharp

ASP.NET VBScript ASP.NET_VB

ASP VBScript ASP_Vbs

ColdFusion ColdFusion

Page JS P (JavaServer Page) JSP

PHP MySql PHP_MySql

Dreamweaver utilise les paramètres

insertText afin de créer des blocs de connexion. Pour plus d'informations sur les balises et les attributs EDML et sur les

quickSearch et searchPattern pour reconnaître les blocs de connexion et le paramètre

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.

<![CDATA[// HTTP=]]></quickSearch>

<insertText location=""> <![CDATA[<% // FileName="@@filename@@" // Type="@@type@@" @@designtimeString@@ // DesigntimeType="@@designtimeType@@" // HTTP="@@http@@" // Catalog="@@catalog@@" // Schema="@@schema@@"

_@@cname@@_STRING = @@string@@

var MM %> ]]>

</insertText>

<![CDATA[/\/\/\s*FileName="([^"]*)"/]]></searchPattern>

<![CDATA[/\/\/\s+Type="(\w*)"([^\r\n]*)/]]></searchPattern>

<![CDATA[/\/\/\s*DesigntimeType="(\w*)"/]]></searchPattern>

<![CDATA[/\/\/\s*HTTP="(\w+)"/]]></searchPattern>

<![CDATA[/\/\/\s*Catalog="(\w*)"/]]></searchPattern>

<![CDATA[/\/\/\s*Schema="(\w*)"/]]></searchPattern>

<![CDATA[/var\s+MM

</searchPatterns> </participant>

_(\w*)_STRING\s*=\s*([^\r\n]+)/]]></searchPattern>

ADOBE DREAMWEAVER 9.0

Guide des API

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 oeuvre 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 oeuvre JavaScript, comme le montre l'illustration suivante :

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 oeuvre JavaScript lorsque vous indiquez la valeur assignée à la variable

PARTICIPANT_FILE comme le

montre l'illustration suivante :

var PARTICIPANT_FILE = "myConnection_mappingfile";

ADOBE DREAMWEAVER 9.0

Guide des API

Chapitre 9 : API JavaBeans

Ce chapitre présente les API des composants JavaBeans. Les fonctionsMMJB*() sont des accroches JavaScript qui lancent des introspections Java pour la prise en charge des JavaBeans. Ces fonctions extraient des noms de classe, des méthodes, des propriétés et des événements à partir des JavaBeans, qui peuvent être affichés dans l'interface utilisateur Dreamweaver. Pour utiliser ces fonctions JavaScript et permettre à Adobe® Dreamweaver® CS3 d'accéder à des JavaBeans, ces derniers doivent se trouver dans le dossier Configuration/Classes.

Remarque : Les arguments de fonction décrits dans ce chapitre contiennent parfois un argument appelé

packageName.className, qui représente une valeur unique.

L'API JavaBeans

Les fonctions suivantes sont des méthodes de l'objet MMJB.

MMJB.getClasses()

Disponibilité

Dreamweaver UltraDev 4.

Description

Lit tous les noms de classe des JavaBeans dans le dossier Configuration/Classes.

Arguments

Aucun.

Valeurs renvoyées

Tableau de chaînes des noms de classe résidant dans le dossier Configuration/Classes ; une erreur renvoie un tableau vide.

MMJB.getClassesFromPackage()

Disponibilité

Dreamweaver UltraDev 4.

Description

Lit toutes les classes JavaBeans du paquet.

Arguments

packageName.pathName

• packageName.pathName correspond au chemin du paquet. Il doit s'agir d'une archive Java JAR ou ZIP (par exemple,

C:/jdbcdrivers/Una2000_Enterprise.zip).

Valeurs renvoyées

Tableau de chaînes des noms de classe à l'intérieur du fichier JAR ou ZIP ; une erreur renvoie un tableau vide.

MMJB.getErrorMessage()

Disponibilité

Dreamweaver UltraDev 4.

Description

Extrait le dernier message d'erreur de Dreamweaver envoyé pendant l'utilisation de l'interface MMJB.

Arguments

Aucun.

Valeurs renvoyées

Une chaîne du message Dreamweaver de la dernière erreur.

MMJB.getEvents()

Disponibilité

Dreamweaver UltraDev 4, améliorée dans la version Dreamweaver MX.

Description

Introspecte la classe des JavaBeans et en renvoie les événements.

ADOBE DREAMWEAVER 9.0

Guide des API

Arguments

packageName.className, {packagePath}

• packageName.className est le nom de la classe. La classe doit être située dans une archive Java JAR ou ZIP. Si

packagePath est omis, l'archive doit être située dans le classpath de votre système, ou doit être un fichier de classe

installé dans le dossier Configuration/Classes.

• L'argument PackagePath est une chaîne facultative qui pointe vers l'emplacement de l'archive Java JAR ou ZIP qui

contient

className.

Valeurs renvoyées

Un tableau de chaînes des évènements associés à className ; une erreur renvoie un tableau vide.

MMJB.getIndexedProperties()

Disponibilité

Dreamweaver UltraDev 4, améliorée dans la version Dreamweaver MX.

Description

Introspecte la classe des JavaBeans et en renvoie les propriétés indexées, qui correspondent à des modèles de conception dont le comportement est identique à celui des ensembles.

Arguments

packageName.className, {packagePath}

• packageName.className est le nom de la classe. La classe doit être située dans une archive Java JAR ou ZIP. Si

packagePath est omis, l'archive doit être située dans le classpath de votre système, ou doit être un fichier de classe

installé dans le dossier Configuration/Classes.

• L'argument packagePath, argument facultatif, est une chaîne qui pointe vers l'archive Java JAR ou ZIP contenant

className.

Valeurs renvoyées

Tableau de chaînes relatives aux propriétés indexées de className ; une erreur renvoie un tableau vide.

ADOBE DREAMWEAVER 9.0

MMJB.getMethods()

Disponibilité

Dreamweaver UltraDev 4, améliorée dans la version Dreamweaver MX.

Description

Introspecte la classe des JavaBeans et en renvoie les méthodes.

Arguments

packageName.className, {packagePath}

• packageName.className est le nom de la classe. La classe doit être située dans une archive Java JAR ou ZIP. Si

packagePath est omis, l'archive doit être située dans le classpath de votre système, ou doit être un fichier de classe

installé dans le dossier Configuration/Classes.

• L'argument PackagePath est une chaîne facultative qui pointe vers l'emplacement de l'archive Java JAR ou ZIP qui

contient

className.

Valeurs renvoyées

Tableau de chaînes relatives aux méthodes associées à className ; une erreur renvoie un tableau vide.

MMJB.getProperties()

Guide des API

Disponibilité

Dreamweaver UltraDev 4, améliorée dans la version Dreamweaver MX.

Description

Introspecte la classe des JavaBeans et en renvoie les propriétés.

Arguments

packageName.className, {packagePath}

• packageName.className est le nom de la classe. La classe doit être située dans une archive Java JAR ou ZIP. Si

packagePath est omis, l'archive doit être située dans le classpath de votre système, ou doit être un fichier de classe

installé dans le dossier Configuration/Classes.

• L'argument PackagePath est une chaîne facultative qui pointe vers l'emplacement de l'archive Java JAR ou ZIP qui

contient

className.

Valeurs renvoyées

Tableau de chaînes relatives aux propriétés associées à className ; une erreur renvoie un tableau vide.

MMJB.getReadProperties()

Disponibilité

Dreamweaver MX.

Description

Extrait les propriétés en lecture seule des JavaBeans prenant en charge les appels d'accès définis.

Arguments

packageName.className, {packagePath}

• packageName.className est le nom de la classe. La classe doit être située dans une archive Java JAR ou ZIP. Si

packagePath est omis, l'archive doit être située dans le classpath de votre système, ou doit être un fichier de classe

installé dans le dossier Configuration/Classes.

• L'argument packagePath, argument facultatif, est une chaîne qui pointe vers l'archive Java JAR ou ZIP contenant

className.

ADOBE DREAMWEAVER 9.0

Valeurs renvoyées

Tableau de chaînes de propriétés en lecture seule associées à className ; une erreur renvoie un tableau vide.

MMJB.getWriteProperties()

Disponibilité

Dreamweaver MX.

Description

Propriétés en écriture seule pour les JavaBeans prenant en charge les appels de méthodes définies.

Arguments

packageName.className, {packagePath}

• packageName.className est le nom de la classe. La classe doit être située dans une archive Java JAR ou ZIP. Si

packagePath est omis, l'archive doit être située dans le classpath de votre système, ou doit être un fichier de classe

installé dans le dossier Configuration/Classes.

• L'argument packagePath, argument facultatif, est une chaîne qui pointe vers l'archive Java JAR ou ZIP contenant

className.

Valeurs renvoyées

Tableau de chaînes relatives aux propriétés en écriture seule associées à className ; une erreur renvoie un tableau vide.

Guide des API

Chapitre 10 : API d'intégration de commande source

L'API d'intégration de commande source vous permet de rédiger des bibliothèques partagées afin d'accroître les fonctionnalités d'archivage et d'extraction de Adobe® Dreamweaver® CS3 à 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 CS3/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 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 chargées depuis le dossier Program Files/Adobe/Adobe Dreamweaver CS3/Configuration/SourceControl s'affichent (en plus des éléments standard) dans l'onglet.

GetProcAddress() pour chaque API. Si une adresse n'existe pas,

Pour créer un menu Site > Commande source auquel vous pouvez ajouter des éléments personnalisés, ajoutez le code suivant au fichier :

Les fonctions décrites dans ce chapitre sont regroupées dans les sections suivantes :

• « Fonctions facultatives de l'API d'intégration de commande source », page 78

• « Fonctions facultatives de l'API d'intégration de commande source », page 84

• « Activateurs », page 91

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 (

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(), Get(),

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.

ADOBE DREAMWEAVER 9.0

Guide des API

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

history. Ainsi, sous Windows, si un utilisateur clique avec le bouton droit de 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.

GetNewFeatures qui renvoie l'élément de menu Historique et le nom de la fonction C

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 obligatoires.

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élec-

tionner un système de commande source, dans l'onglet Commande source de la boîte de dialogue Modifier les sites. Le nom 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.

Valeurs renvoyées

Valeur booléenne : true en cas de succès et false dans le cas contraire.

ADOBE DREAMWEAVER 9.0

Guide des API

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.

Valeurs renvoyées

Valeur booléenne : true en cas de succès et false dans le cas contraire.

bool SCS_Disconnect()

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

Connect().

Valeurs renvoyées

Valeur booléenne : true en cas de succès et 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

Valeurs renvoyées

Valeur booléenne : true en cas de succès et false dans le cas contraire.

Connect().

ADOBE DREAMWEAVER 9.0

Guide des API

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

Connect().

Valeurs renvoyées

Nombre entier qui indique la longueur du nom du dossier racine. Si la fonction renvoie < 0, Dreamweaver 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.

bool SCS_GetRootFolder()

Description

Renvoie le nom du dossier racine.

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

• 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

Connect().

GetRootFolderLength.

Valeurs renvoyées

Valeur booléenne : true en cas de succès et 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.

Valeurs renvoyées

Nombre entier qui indique le nombre d'éléments dans le dossier en cours. Si la fonction renvoie < 0, Dreamweaver 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.

Connect().

ADOBE DREAMWEAVER 9.0

Guide des API

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 :

name char[256] nom de fichier ou de dossier

isFolder bool true si c'est un dossier, false si c'est un fichier

month int Composant mois de la date de modification, de 1 à 12

day int Composant jour de la date de modification, de 1 à 31

year int Composant année de la date de modification, 1900+

hour int Composant heure de la date de modification, de 0 à 23

Connect().

minutes int Composant minute de la date de modification, de 0 à 59

seconds int Composant seconde de la date de modification, de 0 à 59

type char[256] Type de fichier (s'il n'est pas défini par la DLL, DW utilise l'extension de

taille int En octets

fichier pour déterminer le type, comme il le fait à présent)

• numItems est le nombre d'éléments alloués à l'argument itemList (renvoyé par la fonction GetFolderListLength).

Valeurs renvoyées

Valeur booléenne : true en cas de succès et 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[], 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

• remotePathList est une liste des fichiers ou dossiers distants à extraire, exprimée sous la forme de noms et de chemins

d'accès complets.

• 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.

Connect().

Valeurs renvoyées

Valeur booléenne : true en cas de succès et false dans le cas contraire.

ADOBE DREAMWEAVER 9.0

Guide des API

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

Connect().

• 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.

Valeurs renvoyées

Valeur booléenne : true en cas de succès et 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.

Valeurs renvoyées

Valeur booléenne : true en cas de succès et false dans le cas contraire.

bool SCS_Delete()

Description

Supprime une liste de fichiers ou de dossiers du système 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

• 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.

Connect().

Valeurs renvoyées

Valeur booléenne : true en cas de succès et false dans le cas contraire.

ADOBE DREAMWEAVER 9.0

Guide des API

bool SCS_Rename()

Description

Renomme ou déplace un fichier ou un dossier selon les valeurs spécifiées dans les arguments oldRemotePath et newRe-

motePath

"$/folder1/renamefile1", le fichier file1 se voit attribuer le nouveau nom renamefile1 et reste dans le dossier folder1.

Si les valeurs de oldRemotePath et de newRemotePath sont respectivement "$/folder1/file1" et

"$/folder1/subfolder1/file1", le fichier file1 est alors déplacé dans le sous-dossier subfolder1.

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

• 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.

Valeurs renvoyées

Valeur booléenne : true en cas de succès et false dans le cas contraire.

. Ainsi, si les valeurs de oldRemotePath et newRemotePath sont respectivement "$/folder1/file1" et

fonction

Connect().

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

• remotePath est le chemin d'accès d'un fichier ou d'un dossier distant.

Valeurs renvoyées

Valeur booléenne : true en cas de succès et false dans le cas contraire.

Connect().

ADOBE DREAMWEAVER 9.0

Guide des API

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]

• 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.

Valeurs renvoyées

Valeur booléenne : true en cas de succès et 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.

Valeurs renvoyées

Valeur booléenne : true en cas de succès et false dans le cas contraire.

bool SCS_SiteRenamed()

Description

Notifie à la DLL que l'utilisateur a renommé le site, pour qu'il puisse mettre à jour les informations persistantes relatives à ce site.

Arguments

const char oldSiteName[64], const char newSiteName[64]

• oldSiteName est une chaîne qui pointe vers le nom initial du site, avant qu'il ne soit renommé. Ce nom ne peut pas

comporter plus de 64 caractères.

• newSiteName est une chaîne qui pointe vers le nouveau nom du site, après qu'il a été renommé. Ce nom ne peut pas

comporter plus de 64 caractères.

Valeurs renvoyées

Valeur booléenne : true en cas de succès et false dans le cas contraire.

ADOBE DREAMWEAVER 9.0

Guide des API

int SCS_GetNumNewFeatures()

Description

Renvoie le nombre de nouvelles fonctions à ajouter à Dreamweaver (comme Historique de fichier, Différences, etc.).

Arguments

Aucun.

Valeurs renvoyées

Nombre entier qui indique le nombre de nouvelles fonctionnalités à ajouter à Dreamweaver. Si la fonction renvoie < 0, Dreamweaver 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.

bool SCS_GetNewFeatures()

Description

Renvoie une liste d'éléments à ajouter aux menus principaux et contextuels de Dreamweaver. Par exemple, la DLL Sourcesafe peut ajouter Historique et Différences de fichiers au menu principal.

Arguments

char menuItemList[][32], scFunction functionList[], scFunction enablerList[], const int numNewFeatures

• menuItemList est une liste de chaînes complétée par la DLL et indiquant les éléments à ajouter aux menus principaux et

contextuels. Chaque chaîne peut contenir 32 caractères maximum.

• functionList est renseigné par la DLL ; il indique les routines de la DLL à appeler lorsque l'utilisateur choisit l'élément

de menu correspondant.

• enablerList est renseigné par la DLL ; il indique les routines de la DLL à appeler lorsque Dreamweaver a besoin de

déterminer si l'élément de menu correspondant est activé.

• numNewFeatures est le nombre d'éléments ajoutés par la DLL ; cette valeur est récupérée en appelant la fonction GetNu-

mNewFeatures()

La signature de fonction suivante définit les fonctions et les activateurs transmis par appel de la fonction

SCS_GetNewFeatures() dans les arguments functionlist et enablerList.

bool (*scFunction)(void *connectionData, const char *remotePathList[],

const char *localPathList[], const int numItems)

Valeurs renvoyées

Valeur booléenne : true en cas de succès et false dans le cas contraire.

bool SCS_GetCheckoutName()

Description

Renvoie le nom d'extraction de l'utilisateur en cours. Si le système de commande source ne prend pas en charge cette fonction et que l'utilisateur a activé l'extraction, la fonction utilise la fonctionnalité interne d'archivage et d'extraction de Dreamweaver qui transporte les fichiers LCK depuis et vers le système de commande source.

Arguments

void *connectionData, char checkOutName[64], char emailAddress[64]

• L'argument connectionData est un pointeur vers les données de l'agent transférées à Dreamweaver pendant l'appel de la

fonction

• checkOutName est le nom de l'utilisateur en cours.

• emailAddress est l'adresse électronique de l'utilisateur en cours.

Connect().

ADOBE DREAMWEAVER 9.0

Guide des API

Valeurs renvoyées

Valeur booléenne : true en cas de succès et false dans le cas contraire.

bool SCS_Checkin()

Description

Archive une liste de fichiers ou de dossiers locaux dans le système de commande source. La DLL doit configurer le fichier en lecture seule. Si le système de commande source ne prend pas en charge cette fonction et que l'utilisateur a activé l'extraction, la fonction utilise la fonctionnalité interne d'archivage et d'extraction de Dreamweaver qui transporte les fichiers LCK depuis et vers le système de commande source.

Arguments

void *connectionData, const char *localPathList[], const char *remotePathList[], bool successList[], 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 une liste de noms de chemin d'accès aux fichiers ou aux dossiers locaux à archiver.

• L'argument remotePathList est une liste miroir de noms de chemin d'accès aux fichiers ou aux dossiers distants.

• successList est une liste de valeurs booléennes complétée par la DLL pour permettre à Dreamweaver de connaître les

fichiers dont l'archivage a réussi.

• L'argument numItems est le nombre d'éléments dans chaque liste.

Connect().

Valeurs renvoyées

Valeur booléenne : true en cas de succès et false dans le cas contraire.

bool SCS_Checkout()

Description

Extrait une liste de fichiers ou de dossiers locaux du système de commande source. La DLL se charge d'accorder les droits d'accès en écriture au fichier. Si le système de commande source ne prend pas en charge cette fonction et que l'utilisateur a activé l'extraction, la fonction utilise la fonctionnalité interne d'archivage et d'extraction de Dreamweaver qui transporte les fichiers LCK depuis et vers le système de commande source.

Arguments

void *connectionData, const char *localPathList[], const char *remotePathList[], bool successList[], 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

• remotePathList est une liste de noms de chemin d'accès aux fichiers et aux dossiers distants à extraire.

• L'argument localPathList est une liste miroir des noms de chemin d'accès aux fichiers ou aux dossiers locaux.

• successList est une liste de valeurs booléennes complétée par la DLL pour permettre à Dreamweaver de connaître les

fichiers dont l'extraction a réussi.

• L'argument numItems est le nombre d'éléments dans chaque liste.

Valeurs renvoyées

Valeur booléenne : true en cas de succès et false dans le cas contraire.

Connect().

ADOBE DREAMWEAVER 9.0

Guide des API

bool SCS_UndoCheckout()

Description

Annule l'état d'extraction d'une liste de fichiers ou de dossiers. La DLL doit configurer le fichier en lecture seule. Si le système de commande source ne prend pas en charge cette fonction et que l'utilisateur a activé l'extraction, la fonction utilise la fonctionnalité interne d'archivage et d'extraction de Dreamweaver qui transporte les fichiers LCK depuis et vers le système de commande source.

Arguments

void *connectionData, const char *localPathList[], const char *remotePathList[], bool successList[], 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

• remotePathList est une liste de chemins aux fichiers ou dossiers distants dont l'extraction doit être annulée.

• L'argument localPathList est une liste miroir des noms de chemin d'accès aux fichiers ou aux dossiers locaux.

• successList est une liste de valeurs booléennes complétée par la DLL pour permettre à Dreamweaver de connaître les

fichiers dont l'extraction a été annulée avec succès.

• L'argument numItems est le nombre d'éléments dans chaque liste.

Valeurs renvoyées

Valeur booléenne : true en cas de succès et false dans le cas contraire.

Connect().

int SCS_GetNumCheckedOut()

Description

Renvoie le nombre d'utilisateurs dont un fichier a été extrait.

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 nom du chemin d'accès au fichier ou dossier distant à vérifier pour connaître le nombre d'utilisateurs

ayant procédé à son extraction.

Valeurs renvoyées

Nombre entier qui représente le nombre de personnes disposant du fichier extrait. Si la fonction renvoie < 0, Dreamweaver 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.

Connect().

ADOBE DREAMWEAVER 9.0

Guide des API

bool SCS_GetFileCheckoutList()

Description

Renvoie une liste d'utilisateurs dont un fichier a été extrait. Si cette liste est vide, c'est que personne n'a de fichier extrait.

Arguments

void *connectionData, const char *remotePath, char checkOutList[][64], char emailAddressList[][64], const int numCheckedOut

• 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 fichier ou dossier distant à vérifier pour connaître le nombre d'utilisateurs

ayant procédé à son extraction.

• checkOutList est une liste de chaînes qui correspond aux utilisateurs disposant du fichier extrait. Chaque chaîne ne doit

pas avoir plus de 64 caractères.

• emailAddressList est une liste de chaînes correspondant aux adresses électroniques des utilisateurs. Chaque adresse ne

doit pas dépasser 64 caractères.

• numCheckedOut est le nombre de personnes qui ont le fichier extrait. Il est renvoyé par GetNumCheckedOut().

Valeurs renvoyées

Valeur booléenne : true en cas de succès et false dans le cas contraire.

Connect().

int SCS_GetErrorMessageLength()

Description

Renvoie la longueur du message d'erreur interne en cours de la DLL. Permet d'allouer la mémoire tampon transmise dans la fonction ou

GetErrorMessage(). Cette fonction doit être appelée uniquement si une fonction d'API renvoie la valeur false

<0, ce qui indique un échec.

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().

Valeurs renvoyées

Nombre entier représentant la longueur du message d'erreur.

bool SCS_GetErrorMessage()

Description

Renvoie le dernier message d'erreur. Si vous implémentez getErrorMessage(), Dreamweaver l'appelle à chaque fois qu'une de vos fonctions d'API renvoie

Si une routine renvoie -1 ou false, cela indique qu'un message d'erreur doit être disponible.

Arguments

void *connectionData, char errorMsg[], const int *msgLength

L'argument connectionData est un pointeur vers les données de l'agent transférées à Dreamweaver pendant l'appel de la fonction

Connect().

false.

• errorMsg est une chaîne pré-allouée de la DLL dans laquelle vient se placer le message d'erreur.

• msgLength est la longueur de la mémoire tampon représentée par l'argument errorMsg[].

Valeurs renvoyées

Valeur booléenne : true en cas de succès et false dans le cas contraire.

ADOBE DREAMWEAVER 9.0

Guide des API

int SCS_GetNoteCount()

Description

Renvoie le nombre de clés Design Note pour le chemin de dossier ou de fichier distant spécifié. Si cela n'est pas pris en charge par le système de commande source, Dreamweaver obtient ces informations du fichier compagnon MNO.

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 nom du chemin d'accès au fichier ou dossier distant dont la DLL vérifie le nombre de Design Notes

jointes.

Valeurs renvoyées

Nombre entier qui indique le nombre de Design Notes associées au fichier. Si la fonction renvoie < 0, Dreamweaver 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.

int SCS_GetMaxNoteLength()

Description

Renvoie la longueur de la Design Note la plus longue pour le fichier ou le dossier spécifié. Si cette fonction n'est pas prise en charge par le système de commande source, Dreamweaver obtient ces informations du fichier MNO.

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 nom du chemin d'accès au fichier ou dossier distant dont la DLL vérifie la Design Note la plus longue.

Valeurs renvoyées

Nombre entier qui indique la taille de la Design Note la plus longue associée au fichier. Si la fonction renvoie < 0, Dreamweaver 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.

ADOBE DREAMWEAVER 9.0

Guide des API

bool SCS_GetDesignNotes()

Description

Récupère des paires clé-valeur des méta-informations pour le fichier ou le dossier spécifié. Si cette fonction n'est pas prise en charge par le système de commande source, Dreamweaver récupère ces informations dans le fichier MNO correspondant.

Arguments

void *connectionData, const char *remotePath, char keyList[][64], char *valueList[], bool showColumnList[], const int noteCount, const int noteLength

• 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 fichier ou dossier distant dont la DLL vérifie le nombre d'éléments.

• L'argument keyList est une liste de clés de Design Note, comme "Status".

• valueList est une liste de valeurs de Design Note correspondant aux clés de Design Note, comme "Awaiting Signoff".

• L'argument showColumnList est une liste de valeurs booléennes correspondant aux clés de Design Note, qui indiquent si

Dreamweaver peut afficher une clé sous forme de colonne dans le panneau Site.

• noteCount correspond au nombre de Design Notes jointes à un fichier ou dossier ; cette valeur est renvoyée par la

fonction

• noteLength est la longueur maximale d'une Design Note ; cette valeur est renvoyée par la fonction GetMaxNoteLength().

Connect().

GetNoteCount().

Valeurs renvoyées

Valeur booléenne : true en cas de succès et false dans le cas contraire.

bool SCS_SetDesignNotes()

Description

Enregistre les paires clé-valeur dans les méta-informations du fichier ou du dossier spécifié. Cela remplace le jeu de métainformations du fichier. Si cette fonction n'est pas prise en charge par le système de commande source, Dreamweaver enregistre les Design Notes dans des fichiers MNO.

Arguments

void *connectionData, const char *remotePath, const char keyList[][64], const char *valueList[], bool showColumnList[], const int noteCount, const int noteLength

• 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 fichier ou dossier distant dont la DLL vérifie le nombre d'éléments.

• L'argument keyList est une liste de clés de Design Note, comme "Status".

• valueList est une liste de valeurs de Design Note correspondant aux clés de Design Note, comme "Awaiting Signoff".

• L'argument showColumnList est une liste de valeurs booléennes correspondant aux clés de Design Note, qui indiquent si

Dreamweaver peut afficher une clé sous forme de colonne dans le panneau Site.

• noteCount correspond au nombre de Design Notes jointes à un fichier ou dossier ; ce nombre permet à la DLL de

connaître la taille des listes spécifiées. Si

• noteLength est la longueur de la Design Note la plus longue pour le fichier ou le dossier spécifié.

Connect().

noteCount a pour valeur 0, toutes les Design Notes sont supprimées du fichier.

Valeurs renvoyées

Valeur booléenne : true en cas de succès et false dans le cas contraire.

ADOBE DREAMWEAVER 9.0

Guide des API

bool SCS_IsRemoteNewer()

Description

Vérifie chaque chemin distant spécifié pour voir si la copie distante est plus récente. Si cette fonction n'est pas prise en charge par le système de commande source, Dreamweaver utilise son algorithme interne

Arguments

void *connectionData, const char *remotePathList[], const char *localPathList[], int remoteIsNewerList[], 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 de noms de chemin d'accès aux fichiers ou aux dossiers à comparer pour connaître ceux

dotés des états les plus récents.

• L'argument localPathList est une liste miroir des noms de chemin d'accès aux fichiers ou aux dossiers locaux.

• remoteIsNewerList est une liste de nombres entiers complétée par la DLL pour permettre à Dreamweaver d'identifier le

fichier le plus récent du côté distant. Les valeurs suivantes sont valides : 1 indique que la version distante est la plus récente ; -1 indique que la version locale est la plus récente ; 0 indique que les deux versions sont identiques.

• L'argument numItems est le nombre d'éléments dans chaque liste.

Valeurs renvoyées

Valeur booléenne : true en cas de succès et false dans le cas contraire.

isRemoteNewer .

Activateurs

Si les activateurs facultatifs ne sont pas pris en charge par le système de commande source ou que l'application n'est pas connectée au serveur, Dreamweaver détermine le moment où les éléments de menu sont activés, en fonction des informations dont il dispose concernant les fichiers distants.

bool SCS_canConnect()

Description

Indique si l'élément de menu Connecter doit être activé.

Arguments

Aucun.

Valeurs renvoyées

Valeur booléenne : true en cas de succès et false dans le cas contraire.

ADOBE DREAMWEAVER 9.0

Guide des API

bool SCS_canGet()

Description

Indique si l'élément de menu Acquérir doit être activé.

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

Connect().

• remotePathList est une liste de noms de chemin d'accès aux fichiers et aux dossier distant à obtenir.

• 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.

Valeurs renvoyées

Valeur booléenne : true en cas de succès et false dans le cas contraire.

bool SCS_canCheckout()

Description

Indique si l'élément de menu Extraire doit être activé.

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

Connect().

• L'argument remotePathList est une liste de noms de chemin d'accès aux fichiers et aux dossiers distant à extraire.

• 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.

Valeurs renvoyées

Valeur booléenne : true en cas de succès et false dans le cas contraire.

bool SCS_canPut()

Description

Indique si l'élément de menu Placer doit être activé.

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

• localPathList est une liste de noms de chemin d'accès aux fichiers ou aux dossiers à placer dans le système de

commande source.

• remotePathList est une liste miroir de noms de chemin d'accès aux fichiers ou aux dossiers à placer dans le système de

commande source.

• L'argument numItems est le nombre d'éléments dans chaque liste.

Connect().

Valeurs renvoyées

Valeur booléenne : true en cas de succès et false dans le cas contraire.

ADOBE DREAMWEAVER 9.0

Guide des API

bool SCS_canCheckin()

Description

Indique si l'élément de menu Archiver doit être activé.

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

Connect().

• L'argument localPathList est une liste de noms de chemin d'accès aux fichiers ou aux dossiers locaux à archiver.

• 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.

Valeurs renvoyées

Valeur booléenne : true en cas de succès et false dans le cas contraire.

bool SCS_CanUndoCheckout()

Description

Indique si l'élément de menu Annuler l'extraction doit être activé.

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

Connect().

• L'argument remotePathList est une liste de noms de chemin d'accès aux fichiers et aux dossiers distant à extraire.

• localPathList est une liste de noms de chemin d'accès aux fichiers ou aux dossiers locaux à placer dans le système de

commande source.

• L'argument numItems est le nombre d'éléments dans chaque liste.

Valeurs renvoyées

Valeur booléenne : true en cas de succès et false dans le cas contraire.

bool SCS_canNewFolder()

Description

Indique si l'élément de menu Nouveau dossier doit être activé.

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 une liste de noms de chemin d'accès aux fichiers ou aux dossiers distants que l'utilisateur a sélectionné

pour indiquer l'emplacement de création du nouveau dossier.

Connect().

Valeurs renvoyées

Valeur booléenne : true en cas de succès et false dans le cas contraire.

ADOBE DREAMWEAVER 9.0

Guide des API

bool SCS_canDelete()

Description

Indique si l'élément de menu Supprimer doit être activé.

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.

• L'argument numItems est le nombre d'éléments dans chaque liste.

Valeurs renvoyées

Valeur booléenne : true en cas de succès et false dans le cas contraire.

bool SCS_canRename()

Description

Indique si l'élément de menu Renommer doit être activé.

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().

• remotePathList est une liste des noms de chemin d'accès aux fichiers ou aux dossiers distants qui peuvent être

renommés.

Valeurs renvoyées

Valeur booléenne : true en cas de succès et false dans le cas contraire.

bool SCS_BeforeGet()

Description

Dreamweaver appelle cette fonction avant d'acquérir ou d'extraire un ou plusieurs fichiers. Cette fonction permet à la DLL d'effectuer une opération sur un groupe de fichiers, telle que l'ajout d'un commentaire d'extraction.

Arguments

*connectionData

• L'argument *connectionData est un pointeur vers les données de l'agent transférées à Dreamweaver pendant l'appel de

la fonction

Valeurs renvoyées

Valeur booléenne : true en cas de succès et false dans le cas contraire.

Connect().

Exemple

Pour acquérir un groupe de fichiers, Dreamweaver effectue des appels vers la DLL dans l'ordre suivant :

SCS_BeforeGet(connectionData); SCS_Get(connectionData,remotePathList1,localPathList1,successList1); SCS_Get(connectionData,remotePathList2,localPathList2,successList2); SCS_Get(connectionData,remotePathList3,localPathList3,successList3); SCS_AfterGet(connectionData);

ADOBE Dreamweaver CS3 MAC User Manual [fr]

Specifications and Main Features

Frequently Asked Questions

User Manual

Table des matières

Chapitre 1 : Introduction

Acquis préalables

Extension de Dreamweaver

Ressources supplémentaires pour les créateurs d'extensions

Nouvelles fonctions de Dreamweaver CS3

Application

Fonctions relatives aux applications externes

Fonctions de modifications générales

Communication avec Bridge

Espace de travail

Contenu actif

mode Code

Site

Documents

Contenu de page

Modification de widgets Spry

Insertion de widgets Spry

Problèmes de vérification de la compatibilité avec les navigateurs

Documents dynamiques

Conception

Mise en forme CSS

Fonctions supprimées

Errata

Conventions utilisées dans ce manuel

Conventions typographiques

Convention d'attribution de nom

Chapitre 2 : API d'E/S des fichiers

Accès aux fichiers de configuration

API d'E/S des fichiers

DWfile.copy()

DWfile.createFolder()

DWfile.exists()

DWfile.getAttributes()

DWfile.getModificationDate()

DWfile.getCreationDate()

DWfile.getCreationDateObj()

DWfile.getModificationDateObj()

DWfile.getSize()

DWfile.listFolder()

DWfile.read()

DWfile.remove()

DWfile.setAttributes()

DWfile.write()

Chapitre 3 : API HTTP

Fonctionnement de l'API HTTP

API HTTP

MMHttp.clearServerScriptsFolder()

MMHttp.clearTemp()

MMHttp.getFile()

MMHttp.getFileCallback()

MMHttp.getText()

MMHttp.getTextCallback()

MMHttp.postText()

MMHttp.postTextCallback()

Chapitre 4 : API de Design Notes

Fonctionnement de Design Notes

API JavaScript de Design Notes

MMNotes.close()

MMNotes.filePathToLocalURL()

MMNotes.get()

MMNotes.getKeyCount()

MMNotes.getKeys()

MMNotes.getSiteRootForFile()

MMNotes.getVersionName()

MMNotes.getVersionNum()

MMNotes.localURLToFilePath()

MMNotes.open()

MMNotes.remove()

MMNotes.set()

API C de Design Notes

void CloseNotesFile()

BOOL FilePathToLocalURL()

BOOL GetNote()

int GetNoteLength()

int GetNotesKeyCount()