Manuel du propriétaire | Adobe DREAMWEAVER CS3 Manuel utilisateur

ADOBE DREAMWEAVER CS3
®
®
GUIDE DES API DE DREAMWEAVER
© 2007 Adobe Systems Incorporated. Tous droits réservés.
Copyright
Adobe® Dreamweaver® pour Windows® et Macintosh
S'il est distribué avec un logiciel incluant un contrat de licence d'utilisateur final, le présente guide, ainsi que le logiciel 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, Creative Suite, Director, Dreamweaver, 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éposé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.
Notice to U.S. Government End Users. The Software and Documentation are “Commercial Items,” as that term is defined 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 laws 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.
iii
Table des matières
Chapitre 1 : Introduction
Acquis préalables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Extension de Dreamweaver
................................................................1
Ressources supplémentaires pour les créateurs d'extensions
Nouvelles fonctions de Dreamweaver CS3
Fonctions supprimées
Errata
................................2
..................................................2
.....................................................................4
.....................................................................................4
Conventions utilisées dans ce manuel
Chapitre 2 : API d'E/S des fichiers
Accès aux fichiers de configuration
API d'E/S des fichiers
........................................................5
......................................................................5
Chapitre 3 : API HTTP
Fonctionnement de l'API HTTP
API HTTP
......................................................4
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Chapitre 4 : API de Design Notes
Fonctionnement de Design Notes
API JavaScript de Design Notes
API C de Design Notes
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Chapitre 5 : Intégration de Fireworks
L'API FWLaunch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Chapitre 6 : Intégration de Flash
Fonctionnement des éléments Flash
Insertion d'éléments Flash
L'API des objets Flash
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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
Fichier inclus généré
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Fichier de définition pour votre type de connexion
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Chapitre 9 : API JavaBeans
L'API JavaBeans . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
iv
Chapitre 10 : API d'intégration de commande source
Fonctionnement de l'intégration des commandes source avec Dreamweaver
Ajout d'une fonctionnalité de système de commande source
. . . . . . . . . . . . . . 77
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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
Fonctions de bascule
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .130
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .141
Fonctions relatives aux barres d'outils
Fonctions relatives aux fenêtres
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .158
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .163
Fonctions relatives au fractionnement des codes
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .172
Fonctions relatives aux barres d'outils du mode Code
Chapitre 13 : Site
Fonctions relatives aux rapports
Fonctions relatives aux sites
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .178
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .183
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .184
Chapitre 14 : Document
Fonctions relatives aux conversions
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .215
Fonctions relatives aux commandes
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .216
Fonctions relatives aux manipulations de fichiers
Fonctions relatives à l'ensemble d'un document
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .217
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .231
Fonctions relatives aux chemins
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .240
Fonctions relatives à la sélection
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .243
Fonctions de manipulation de chaînes
Fonctions relatives à la traduction
Fonctions XSLT
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .249
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .252
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .253
Chapitre 15 : Contenu de page
Fonctions du panneau Actifs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .257
Fonctions relatives aux comportements
Fonctions relatives au Presse-papiers
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .266
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .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
v
Chapitre 16 : Documents dynamiques
Fonctions de composants de serveur . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .297
Fonctions relatives aux sources de données
Fonctions de l'Extension Data Manager
Fonctions Live data
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .298
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .299
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .301
Fonctions relatives aux comportements de serveur
Fonctions de modèle de serveur
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .305
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .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
Fonctions de modifications générales
Fonction relative à l'impression
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .387
Fonctions relatives à Quick Tag Editor
Fonctions relatives au mode Code
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .369
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .373
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .388
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .390
Fonctions de l'éditeur de balises et de la bibliothèque de balises
. . . . . . . . . . . . . . . . . . . . . . . . . .404
Chapitre 19 : Activateurs
Fonctions d'activateur . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .409
Index
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .443
vi
1
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 Dreamweaver 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 2
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/dreamweaver/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 3
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 4
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 dreamweaver. complet dans les définitions de fonctions et dans l'index. Toutefois, dans de
nombreux exemples, le préfixe 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
5
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 6
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 7
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 null. Les caractères suivants de la chaîne représentent les attributs :
•
R signifie lecture seule.
•
D signifie dossier.
•
H signifie masqué.
•
S indique un fichier ou dossier système.
Exemple
Le code suivant obtient les attributs du fichier mydata.txt et affiche un message d'avertissement si le fichier est en lecture
seule :
var fileURL = "file:///c|/temp/mydata.txt";
var str = DWfile.getAttributes(fileURL);
if (str && (str.indexOf("R") != -1)){
alert(fileURL + " 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 8
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
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.
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 9
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 10
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 11
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 confirm() pour afficher à l'utilisateur une boîte de dialogue de type Oui/Non :
function deleteFile(){
var delAnyway = false;
var selIndex = document.theForm.menu.selectedIndex;
var selFile = document.theForm.menu.options[selIndex].value;
if (DWfile.getAttributes(selFile).indexOf('R') != -1){
delAnyway = confirm('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
W
Accessible en écriture (annule R)
H
Masqué
V
Visible (annule H)
Les valeurs acceptables pour la chaîne strAttrs sont : R, W, H, V, RH, RV, WH ou WV.
ADOBE DREAMWEAVER 9.0 12
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 (W). N'utilisez pas H et V conjointement, car ils s'excluent aussi l'un
l'autre. Si vous les associez, H perd tout son sens et le fichier est défini comme étant visible (V).
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 "aaa" au fichier et affiche un deuxième message d'avertissement si
cette opération réussit. Après l'exécution de ce script, le fichier mydata.txt contient uniquement le texte xxxaaa.
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);
}
13
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é data varie selon la fonction ; les valeurs possibles sont spécifiées dans les listes
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.
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 14
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 :
<!-- MENU-LOCATION=NONE -->
<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 15
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 true ou si saveURL est en dehors du
dossier Configuration/Temp, l'utilisateur peut remplacer saveURL dans la boîte de dialogue d'enregistrement.
• L'argument facultatif titleBarLabel est le libellé qui doit figurer dans la barre de titre de la boîte de dialogue d'enregistrement.
Valeurs renvoyées
Un objet représentant la réponse du serveur. La propriété 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é statusCode de l'objet
contient le code d'état envoyé par le serveur. Toutefois, si une erreur de disque se produit lors de l'enregistrement du fichier
sur le lecteur local, la propriété statusCode contient un entier représentant l'un des codes d'erreur suivants en cas d'échec
de l'opération :
• 1 : Erreur inconnue
• 2 : Fichier introuvable
• 3 : Chemin non valide
• 4 : La limite du nombre de fichiers ouverts est atteinte
• 5 : Accès refusé
• 6 : Identificateur de fichier non valide
• 7 : Impossible de supprimer le répertoire de travail en cours
• 8 : Plus d'entrées de dossier
• 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 16
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 saveURL spécifie un emplacement en dehors du dossier Configuration/Temp, une valeur de prompt égale à
false n'est pas prise en compte pour des raisons de sécurité.
• L'argument facultatif saveURL est l'emplacement sur le disque dur de l'utilisateur où le fichier doit être enregistré,
exprimé sous la forme d'une URL de type file://. Si l'argument prompt a pour valeur true ou si saveURL est en dehors du
dossier Configuration/Temp, l'utilisateur peut remplacer saveURL dans la boîte de dialogue d'enregistrement.
• L'argument facultatif titleBarLabel est le libellé qui doit figurer dans la barre de titre de la boîte de dialogue d'enregistrement.
Valeurs renvoyées
Un objet représentant la réponse du serveur. La propriété 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é 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 17
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 Configuration du serveur d'application, à partir duquel vous souhaitez extraire les scripts de serveur. Pour extraire les scripts,
Dreamweaver utilise le protocole de transfert approprié (par exemple FTP, WebDAV ou Remote File System). Dreamweaver copie ces fichiers dans le sous-dossier _mmServerScripts dans le dossier racine du site en cours.
Si une erreur se produit, Dreamweaver la consigne dans la propriété statusCode de l'objet renvoyé.
MMHttp.getTextCallback()
Disponibilité
Dreamweaver UltraDev 4, amélioré dans Dreamweaver MX.
Description
Extrait le contenu du document situé à l'URL spécifiée et le transmet à la fonction spécifiée.
Arguments
callbackFunc, URL, {serverScriptsFolder}
• L'argument callbackFunc est la fonction JavaScript à appeler lorsque la requête HTTP est terminée.
• L'argument URL est une URL absolue sur un serveur Web ; si http:// n'est pas indiqué dans l'URL, Dreamweaver considère
qu'il s'agit du protocole HTTP.
• L'argument serverScriptsFolder est une chaîne facultative qui nomme un dossier spécifique, lié au dossier Configuration du serveur d'application, à partir duquel vous souhaitez extraire les scripts de serveur. Pour extraire les scripts,
Dreamweaver utilise le protocole de transfert approprié (par exemple, FTP, WebDAV ou Remote File System). Dreamweaver extrait ces fichiers et les transmet à la fonction identifiée par callbackFunc.
Si une erreur survient, Dreamweaver MX la consigne dans la propriété 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-formurlencoded" ou s'il n'est pas spécifié, dataToPost doit être codé en formulaire conformément à la section 8.2.1 de la
spécification RFC 1866 (disponible à l'adresse www.faqs.org/rfcs/rfc1866.html).
• L'argument facultatif contentType est le type de contenu des données à envoyer. S'il n'est pas spécifié, il prend par défaut
la valeur "application/x-www-form-urlencoded".
• L'argument serverScriptsFolder est une chaîne facultative qui nomme un dossier spécifique, lié au dossier Configuration du serveur d'application, vers lequel vous souhaitez envoyer les données. Pour envoyer les données, Dreamweaver
utilise le protocole de transfert approprié (par exemple, FTP, WebDAV ou Remote File System).
Si une erreur se produit, Dreamweaver la consigne dans la propriété statusCode de l'objet renvoyé.
ADOBE DREAMWEAVER 9.0 18
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-formurlencoded" ou s'il n'est pas spécifié, data doit être codé en formulaire conformément à la section 8.2.1 de la spécification RFC 1866 (disponible à l'adresse www.faqs.org/rfcs/rfc1866.html).
• L'argument facultatif contentType correspond au type de contenu des données à envoyer. S'il n'est pas spécifié, il prend
par défaut la valeur "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 callbackFunc.
Si une erreur se produit, Dreamweaver la consigne dans la propriété statusCode de l'objet renvoyé.
19
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_source" value="file:///C|sites/dreamcentral/images/sourceFiles/¬
foghorn.png" />
<infoitem key="Auteur" value="Heidi B." />
<infoitem key="Status" value="Version finale, approuvée par Jay L." />
</info>
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 MMNotes.close() une fois le travail sur les Design Notes terminé, afin que Dreamweaver écrive dans le fichier.
ADOBE DREAMWEAVER 9.0 20
Guide des API
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é.
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 21
Guide des API
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
var
var
var
for
noteHandle = MMNotes.open(dw.getDocumentDOM().URL);
theKeys = MMNotes.getKeys(noteHandle);
noteString = "";
theValue = "";
(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);
MMNotes.getSiteRootForFile()
Description
Cette fonction détermine la racine du site pour le fichier Design Notes spécifié.
Arguments
fileURL
• L'argument fileURL, exprimé sous la forme d'une URL de type file://, est le chemin d'un fichier local.
Valeurs renvoyées
Une chaîne contenant le chemin du dossier racine local pour le site, exprimé sous la forme d'une URL de type file://, ou une
chaîne vide si Dreamweaver n'est pas installé ou si le fichier Design Notes se trouve en dehors de tout site défini par Dreamweaver. Cette fonction recherche tous les sites définis dans Dreamweaver.
MMNotes.getVersionName()
Description
Cette fonction renvoie le nom de version de la bibliothèque partagée MMNotes indiquant l'application qui l'a implémentée.
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 22
Guide des API
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 "Dreamweaver". L'appel
de la fonction MMNotes.getVersionName() à partir de Fireworks renvoie également la valeur "Dreamweaver" étant donné
que Fireworks utilise la même version de la bibliothèque (celle qui a été créée par l'équipe technique de Dreamweaver).
MMNotes.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.
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 "MacintoshHD: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 filePath n'est associé à aucun site.
Valeurs renvoyées
L'identificateur du fichier Design Notes ou zéro (0) si le fichier n'a pas été ouvert ni créé.
Exemple
Consultez « MMNotes.set() », page 23.
ADOBE DREAMWEAVER 9.0 23
Guide des API
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.
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 24
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 25
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 26
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 infoPrefs, la fonction renvoie également
les préférences de Design Notes pour le site. Le struct InfoPrefs possède deux variables : bUseDesignNotes et bUploadDesignNotes, toutes deux de type BOOL.
ADOBE DREAMWEAVER 9.0 27
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
Cette fonction renvoie le numéro de version de la bibliothèque partagée MMNotes, ce qui vous permet de savoir si certaines
fonctions sont disponibles.
Arguments
char* versionNumBuf, 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 28
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 localFileURL n'est associé
à aucun site.
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 false. Vous pouvez spécifier l'argument bReadOnly disponible à partir de la version 2 du fichier
MMNotes.dll.
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.
ADOBE DREAMWEAVER 9.0 29
Guide des API
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 30
Guide des API
31
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 Dreamweaver 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 32
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ésultat du script transmis à FWLaunch.execJsInFireworks() si l'opération se termine avec succès,
la valeur null si Fireworks est toujours en train d'exécuter le code JavaScript, ou un code d'erreur non nul indiquant que
l'une des erreurs suivantes s'est produite :
• Utilisation non valide, ce qui indique qu'une erreur JavaScript s'est produite pendant que Fireworks exécutait le script.
• Erreur d'E/S de fichier, ce qui indique que Fireworks ne peut pas créer de fichier réponse car le disque est saturé.
• Erreur de notification de Dreamweaver ; l'utilisateur n'exécute pas une version valide de Dreamweaver (version 3 ou
ultérieure).
• Erreur lors du démarrage de Fireworks, ce qui indique que la fonction n'ouvre pas une version valide de Fireworks
(version 3 ou ultérieure).
• L'utilisateur a annulé l'opération.
ADOBE DREAMWEAVER 9.0 33
Guide des API
Exemple
Le code suivant transmet la chaîne "prompt('Veuillez entrer
FWLaunch.execJsInFireworks(), puis il vérifie le résultat :
votre nom :')" à la fonction
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;
}
}
}
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 34
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 35
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);
ADOBE DREAMWEAVER 9.0 36
Guide des API
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>
37
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 param (enfant de la
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).
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 file permettent d'indiquer à Dreamweaver où se trouve le fichier source de l'élément par rapport au dossier
Objects. Utilisez ensuite l'attribut command pour indiquer à Dreamweaver d'utiliser la fonction dom.insertFlashElement()
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 category
ou menubutton appropriée, selon l'endroit où vous souhaitez voir apparaître le bouton de l'élément Flash) :
<button id="FlashElement_Nav"
name="Navigation"
file="FlashElements\nav.swc"
command="dw.getDocumentDOM().insertFlashElement('nav.swc')" />
Remarque : L'image sur la barre Insertion pour l'élément Flash est déterminée au sein du fichier SWC. En outre, la balise
button pour un élément Flash doit avoir un attribut file défini.
ADOBE DREAMWEAVER 9.0 38
Guide des API
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 "dwType". Sa valeur doit être une chaîne
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.
ADOBE DREAMWEAVER 9.0 39
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.
"-defaultsize",
"640", "480"
-exactFit
Aucun
Etend le contenu de l'image de sortie pour qu'il
s'adapte exactement à la taille de sortie indiquée.
"-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 40
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 SWFFile.createFile().
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.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 "dwType", suivie par sa valeur. La fonction renvoie une valeur null si le fichier est introuvable
ou s'il ne s'agit pas d'un fichier Objet Flash.
Exemple
L'appel du code var params
tableau des paramètres :
"file:///MyMac/test.swt"
"dwType"
"myType"
"text"
"Hello World"
= SWFFile.readFile("file:///MyMac/test.swf")
renvoie les valeurs suivantes dans le
// fichier de modèle utilisé pour créer ce fichier .swf
// premier paramètre
// valeur du premier paramètre
// deuxième paramètre
// valeur du deuxième paramètre
41
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 42
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 MMDB.getColumnAndTypeList() :
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;
}
}
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.
ADOBE DREAMWEAVER 9.0 43
Guide des API
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.
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
à une base de données en exécution.
string
Chaîne de connexion ADO d'exécution ou URL JDBC
ADOBE DREAMWEAVER 9.0 44
Guide des API
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 page
pendant Live Data et Aperçu dans le navigateur
variables
Tableau de noms de variables de pages et leurs valeurs correspondantes, utilisé pendant Live Data et Aperçu dans le navigateur
catalog
Utilisé pour restreindre les métadonnées qui apparaissent (pour plus d'informations,
consultez la section « MMDB.getProcedures() », page 57)
schema
Utilisé pour restreindre les métadonnées qui apparaissent (pour plus d'informations,
consultez la section « MMDB.getProcedures() », page 57)
filename
Nom de fichier de boîte de dialogue qui était utilisé pour créer la connexion
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 45
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 TdsDriver. Vous devez transmettre le nom du pilote à cette fonction pour définir complètement le
nom de connexion que vous souhaitez obtenir.
Arguments
connString, {driverName}
•
connString est la chaîne de connexion qui extrait le nom de la connexion.
• L'argument facultatif driverName définit l'argument connString de manière plus précise.
Valeurs renvoyées
Chaîne de nom de connexion correspondant à la chaîne de connexion.
Exemple
Le code suivant renvoie la chaîne "EmpDB" :
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 46
Guide des API
Exemple
Le code var connectionString
ADO ou JDBC.
= MMDB.getConnectionString ("EmpDB")
renvoie différentes chaînes pour une connexion
• 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_TEMPLATE = "jdbc:db2:[database name]";
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.
Description
Extrait les pilotes JDBC et les modèles d'URL respectifs.
Arguments
Aucun.
ADOBE DREAMWEAVER 9.0 47
Guide des API
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()
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 48
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 MMDB.getRemoteDsnList(). Si le
développeur fournit une chaîne de paramètre, cette fonction la transmet aux scripts de connectivité HTTP.
Arguments
{urlParams}
• L'argument facultatif urlParams est une chaîne contenant une liste des expressions name=value, séparées par des esperluettes (&). Les valeurs ne doivent pas être entourées de guillemets. Certains caractères, tels que l'espace dans la valeur
« 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 49
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 50
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
ou
connRec
ou
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 : findConnection(), inspectConnection() et applyConnection(). En général, vous créez un
fichier JavaScript qui implémente ces fonctions, puis vous intégrez ce fichier au fichier HTML. (Pour plus d'informations
sur la création d'une connexion, consultez la section « API de connectivité à une base de données », page 65).
•
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.
ADOBE DREAMWEAVER 9.0 51
Guide des API
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.
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 52
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 53
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 MMDB.getConnecCette dernière vous permet d'obtenir par programmation une liste de tous les noms de connexion.
tionList().
• 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 (paramNameArray). Vous pouvez utiliser la fonction MMDB.getSPParamsAsString() pour obtenir les
paramètres de la procédure stockée. Si vous fournissez des noms de paramètres, les valeurs spécifiées dans
paramValuesArray doivent être dans l'ordre dans lequel les noms ont été spécifiés dans paramNameArray.
ADOBE DREAMWEAVER 9.0 54
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
de chaînes suivant :
columnArray[0]
columnArray[1]
columnArray[2]
columnArray[3]
columnArray[4]
columnArray[5]
=
=
=
=
=
=
= MMDB.getColumnAndTypeList("EmpDB","Sélectionner * dans Employés") renvoie le tableau
"EmpName"
"varchar"
"EmpFirstName"
"varchar"
"Age"
"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éclaration SQL n'est pas valide ou si la connexion n'a pas pu s'établir.
Exemple
Le code var columnArray
chaînes suivant :
= MMDB.getColumnList("EmpDB","Sélectionner * dans Employés")
columnArray[0] = "EmpName"
columnArray[1] = "EmpFirstName"
columnArray[2] = "Age"
renvoie le tableau de
ADOBE DREAMWEAVER 9.0 55
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 Dreamweaver 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 56
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
var tableName
var primaryKeys
= componentRec.parent.parent.parent.name;
= componentRec.name;
= MMDB.getPrimaryKeys(connName,tableName);
ADOBE DREAMWEAVER 9.0 57
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
a
schema
Nom du schéma associé à l'objet.
Cette propriété identifie l'utilisateur associé à la procédure stockée dans la base de
données SQL et à laquelle accède la fonction getProcedures(). La base de données à
laquelle accède cette fonction dépend du type de connexion.
catalog
•
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 connexion (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.
Nom du catalogue associé à l'objet (qualificatif de propriétaire).
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.
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.
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 58
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 MMDB.getSPParamsAsString() pour obtenir les paramètres de la procédure stockée.
Valeurs renvoyées
Tableau de chaînes représentant la liste des colonnes. Cette fonction renvoie une erreur lorsque l'instruction SQL ou la
chaîne de connexion est incorrecte.
Exemple
Le code suivant 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, getNewEmployeesMakingAtLeast :
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"
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 paramNameArray, spécifiez les valeurs de paramètre dans l'ordre dans lequel leurs
noms apparaissent dans paramNameArray. Si vous n'avez pas indiqué paramNameArray, spécifiez les valeurs dans l'ordre
attendu par la procédure stockée.
ADOBE DREAMWEAVER 9.0 59
Guide des API
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, getNewEmployeesMakingAtLeast :
var paramNameArray = new Array("startDate", "salary")
var paramValueArray = new Array("2/1/2000", "50000")
var columnArray = MMDB.getSPColumnListNamedParams("EmpDB", ¬
"getNewEmployeesMakingAtLeast", paramNameArray, paramValueArray)
Les valeurs suivantes renvoient :
columnArray[0] = "EmpID", columnArray[1] = "LastName", ¬
columnArray[2] ="startDate", columnArray[3] = "salary"
MMDB.getSPParameters()
Disponibilité
Dreamweaver MX.
Description
Cette fonction renvoie un tableau d'objets de paramètre pour une procédure nommée.
Arguments
connName, procName
•
connName est un nom de connexion spécifié dans le Gestionnaire de connexions. Il identifie la chaîne de connexion que
Dreamweaver doit utiliser pour connecter la base de données à une source de données active.
• L'argument procName est le nom de la procédure.
Valeurs renvoyées
Tableau d'objets de paramètre, chacun d'entre eux spécifiant l'ensemble de propriétés suivant :
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 60
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 61
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 catalog, schema et view.
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 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 62
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 MMDB.getSPParamsAsString() pour obtenir les paramètres de la procédure stockée.
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)
ADOBE DREAMWEAVER 9.0 63
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 64
Guide des API
65
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>
<script SRC="../myConnectionImpl.js"></script>
</head>
Stockez ce fichier HTML, qui définit votre boîte de dialogue de connexion, dans le dossier Configuration/Connections/modèle_serveur/plate-forme (où la plate-forme est Windows ou Macintosh).
Par exemple, la boîte de dialogue de connexion ADO par défaut pour un document ASP JavaScript sur une 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 getServerModelFolderName() qui renvoie le nom du dossier associé au modèle de
serveur. L'exemple suivant indique la fonction pour le type de document ASP JavaScript :
function getServerModelFolderName()
{
return "ASP_JS";
}
Vous pouvez également consulter le fichier MMDocumentTypes.xml, situé dans le dossier Configuration/DocumentTypes,
pour déterminer la correspondance entre les modèles de serveur et les types de documents.
ADOBE DREAMWEAVER 9.0 66
Guide des API
2 Créez un fichier JavaScript qui implémente au moins les éléments suivants :
Elément
Description
Exemples
Un ensemble de variables
Chaque variable définit une propriété de
connexion spécifique
Type de connexion, nom de la source
de données, etc.
Un ensemble de boutons
Tous les boutons apparaissent dans la boîte
de dialogue de connexion.
Tester, Aide, etc. (OK et Annuler sont
automatiquement inclus)
Fonctions de connectivité
Ensemble, ces fonctions définissent l'API de
connectivité
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 : findConnection(), inspectConnection() et applyConnection(). Ecrivez
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 findConnection() prend la source HTML et en extrait les
propriétés. Vous pouvez mettre en oeuvre findConnection() pour utiliser les modèles de recherche dans les fichiers XML
afin d'extraire les informations renvoyées à partir de applyConnection(). Si vous souhaitez voir un exemple de ce type 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 findConnection(). Si le contenu d'un fichier correspond aux critères d'une connexion
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 inspectConnection() et retransmet
le même objet de connexion créé par findConnection(). Ce processus permet à Dreamweaver de renseigner la boîte de
dialogue en utilisant les informations de connexion.
ADOBE DREAMWEAVER 9.0 67
Guide des API
Lorsque l'utilisateur clique sur OK dans une boîte de dialogue de connexion, Dreamweaver déclenche la fonction applyConnection() pour construire la page HTML, placée dans le fichier inclus de connexion résidant dans le dossier Configu-
ration/Connections. La fonction applyConnection() renvoie une chaîne vide qui indique une erreur dans l'un des champs.
La boîte de dialogue ne doit pas être fermée. Le fichier inclus a un type d'extension de fichier par défaut pour le modèle de
serveur en cours.
Lorsque l'utilisateur ajoute à une page un comportement de serveur qui utilise la connexion, tel qu'un jeu d'enregistrements
ou une procédure stockée, Dreamweaver ajoute une instruction à la page qui comprend le fichier inclus de connexion.
findConnection()
Disponibilité
Dreamweaver UltraDev 4.
Description
Dreamweaver appelle cette fonction pour détecter une connexion dans la source HTML spécifiée et analyser les paramètres
de la connexion. Si le contenu de ce fichier source respecte les critères permettant une connexion valide, findConnection()
renvoie un objet de connexion ; dans le cas contraire, cette fonction renvoie une valeur null.
Argument
htmlSource
L'argument htmlSource est la source HTML d'une connexion.
Valeurs renvoyées
Objet de connexion qui fournit les valeurs d'une combinaison particulière de propriétés répertoriées dans le tableau suivant.
Les propriétés pour lesquelles cette fonction renvoie une valeur dépendent du type de document.
Propriété
Description
name
Nom de la connexion
type
Si useHTTP est false, indique quelle DLL doit être utilisée pour la connexion à des
bases de données au moment de l'exécution.
string
Chaîne de connexion d'exécution. Pour ADO, il s'agit d'une chaîne de paramètres de
connexion ; pour JDBC, il s'agit d'une URL de connexion.
dsn
Nom de la source de données utilisé pour les connexions de d'exécution ODBC ou Cold
Fusion
driver
Nom d'un pilote JDBC utilisé pendant l'exécution
username
Nom d'utilisateur employé pour la connexion d'exécution
password
Mot de passe utilisé pour la connexion d'exécution
designtimeString
Chaîne de connexion au moment de la conception (voir string)
designtimeDsn
Nom de la source de données au moment de la conception (voir dsn)
designtimeDriver
Nom d'un pilote JDBC utilisé au moment de la conception
designtimeUsername
Nom de l'utilisateur employé pour la connexion au moment de la conception
designtimePassword
Mot de passe utilisé pour la connexion au moment de la conception
designtimeType
Type de connexion utilisée au moment de la conception
usesDesigntimeInfo
En cas de valeur false, Dreamweaver utilise les propriétés d'exécution au moment de
la 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
ADOBE DREAMWEAVER 9.0 68
Guide des API
Propriété
Description
includePattern
Expression régulière utilisée pour trouver l'instruction d'inclusion de fichier sur la page
pendant Live Data et Aperçu dans le navigateur
variables
Objet ayant une propriété pour chaque variable de page définie sur sa valeur correspondante. Cet objet est utilisé pendant Live Data et Aperçu dans le navigateur.
catalog
Chaîne contenant un identificateur de base de données qui restreint la quantité de
métadonnées qui apparaissent
schema
Chaîne contenant un identificateur de base de données qui restreint la quantité de
métadonnées qui apparaissent
filename
Nom de la boîte de dialogue utilisée pour créer la connexion
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 applyConnection() génère la source HTML pour une connexion. Dreamweaver écrit le HTML dans le fichier
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, applyConnection() affiche un message d'erreur et renvoie une chaîne vide pour indiquer
que la boîte de dialogue doit rester ouverte.
ADOBE DREAMWEAVER 9.0 69
Guide des API
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.
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_ado_conn_string.htm"
// Type="ADO"
// HTTP="true"
// Catalog=""
// Schema=""
var MM_MyConnection1_STRING = "dsn=pubs";
%>
Le fichier du comportement de serveur inclut cette connexion en utilisant l'instruction d'inclusion de fichier relative,
comme le montre l'illustration suivante :
<!--#include file="../Connections/MyConnection1.asp"-->
ColdFusion
Lorsque vous utilisez UltraDev 4 ColdFusion, Dreamweaver s'appuie sur un fichier inclus ColdFusion pour extraire une
liste des sources de données.
Remarque : Avec Dreamweaver ColdFusion standard, Dreamweaver ignore tous les fichiers inclus et utilise les RDS pour
récupérer la liste des sources de données à partir de ColdFusion.
Le fichier inclus UltraDev 4 ColdFusion doit être nommé MyConnection1.cfm, où MyConnection1 est le nom de votre
connexion. L'exemple suivant illustre le fichier inclus pour une connexion ColdFusion à un tableau de produits :
<!-- FileName="Connection_cf_dsn.htm" "dsn=products" -->
<!-- Type="ADO" -->
<!-- Catalog="" -->
<!-- Schema="" -->
<!-- HTTP="false" -->
<CFSET MM_MyConnection1_DSN
= "products">
<CFSET MM_MyConnection1_USERNAME
= "">
<CFSET MM_Product_USERNAME
= "">
<CFSET MM_MyConnection1_PASSWORD
= "">
Le fichier du comportement de serveur inclut cette connexion en utilisant l'instruction cfinclude, comme le montre l'illustration suivante :
<cfinclude template="Connections/MyConnection1.cfm">
ADOBE DREAMWEAVER 9.0 70
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 JSP (JavaServer Page)
JSP
PHP MySql
PHP_MySql
Dreamweaver utilise les paramètres quickSearch et searchPattern pour reconnaître les blocs de connexion et le paramètre
insertText afin de créer des blocs de connexion. Pour plus d'informations sur les balises et les attributs EDML et sur les
modèles de recherche d'expression régulière, voir « Comportements de serveur » dans Extension de Dreamweaver.
Remarque : Si vous changez le format de votre fichier inclus ou si vous définissez un fichier inclus pour un nouveau modèle de
serveur, vous devez associer les paramètres de connexion avec l'interface utilisateur de Dreamweaver, Live Data et Aperçu dans
le navigateur. L'exemple suivant de fichier EDML, associé au modèle de serveur ASP JS par défaut, met en correspondance
toutes les variables de page de connexion avec leurs valeurs dynamiques respectives avant d'envoyer la page au serveur. Pour
plus d'informations sur EDML et les modèles de recherche d'expression régulière, voir « Comportements de serveur » dans
Extension de Dreamweaver.
ADOBE DREAMWEAVER 9.0 71
Guide des API
<participant name="connection_includefile" version="5.0">
<quickSearch>
<![CDATA[// HTTP=]]></quickSearch>
<insertText location="">
<![CDATA[<%
// FileName="@@filename@@"
// Type="@@type@@" @@designtimeString@@
// DesigntimeType="@@designtimeType@@"
// HTTP="@@http@@"
// Catalog="@@catalog@@"
// Schema="@@schema@@"
var MM_@@cname@@_STRING = @@string@@
%>
]]>
</insertText>
<searchPatterns whereToSearch="directive">
<searchPattern paramNames="filename">
<![CDATA[/\/\/\s*FileName="([^"]*)"/]]></searchPattern>
<searchPattern paramNames="type,designtimeString">
<![CDATA[/\/\/\s+Type="(\w*)"([^\r\n]*)/]]></searchPattern>
<searchPattern paramNames="designtimeType" isOptional="true">
<![CDATA[/\/\/\s*DesigntimeType="(\w*)"/]]></searchPattern>
<searchPattern paramNames="http">
<![CDATA[/\/\/\s*HTTP="(\w+)"/]]></searchPattern>
<searchPattern paramNames="catalog">
<![CDATA[/\/\/\s*Catalog="(\w*)"/]]></searchPattern>
<searchPattern paramNames="schema">
<![CDATA[/\/\/\s*Schema="(\w*)"/]]></searchPattern>
<searchPattern paramNames="cname,string">
<![CDATA[/var\s+MM_(\w*)_STRING\s*=\s*([^\r\n]+)/]]></searchPattern>
</searchPatterns>
</participant>
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 72
Guide des API
73
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.
ADOBE DREAMWEAVER 9.0 74
Guide des API
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.
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 75
Guide des API
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()
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 76
Guide des API
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.
77
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 GetProcAddress() pour chaque API. Si une adresse n'existe pas,
Dreamweaver suppose que la bibliothèque ne prend pas en charge l'API. Si l'adresse existe, Dreamweaver utilise la version
de la fonction qui se trouve dans la bibliothèque pour prendre en charge la fonctionnalité. Lorsqu'un utilisateur Dreamweaver définit ou modifie un site, puis choisit l'onglet SCS du serveur Web, les choix correspondant aux DLL chargées
depuis le dossier Program Files/Adobe/Adobe Dreamweaver CS3/Configuration/SourceControl s'affichent (en plus des
éléments standard) dans l'onglet.
Pour créer un menu Site > Commande source auquel vous pouvez ajouter des éléments personnalisés, ajoutez le code
suivant au fichier :
<menu name="Source Control" id="DWMenu_MainSite_Site_Source¬
Control"><menuitem dynamic name="None"file="Menus/MM/¬
File_SCSItems.htm" id="DWMenu_MainSite_Site_NewFeatures_¬
Default" />
</menu>
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 (Connect(), Disconnect(), Get(),
Put(), Checkin(), Checkout(), Undocheckout() et Synchronize()). La DLL est responsable de la gestion de la requête,
notamment de l'affichage des boîtes de dialogue qui rassemblent les informations ou qui permettent à l'utilisateur
d'interagir avec la DLL. La DLL affiche également des informations ou des messages d'erreur.
Le système de commande source peut éventuellement prendre en charge les Design Notes et la fonction
d'archivage/extraction. Pour activer les Design Notes dans les systèmes de commande source, l'utilisateur Dreamweaver
doit choisir l'onglet Design Notes dans la boîte de dialogue Modifier les sites et cocher la case qui permet d'activer cette
fonctionnalité (cette procédure s'applique également aux systèmes FTP et de réseau local). Si le système de commande
source ne prend pas en charge les Design Notes et que l'utilisateur souhaite les utiliser, Dreamweaver transporte les fichiers
Design Note (.mno) pour gérer les Design Notes (de la même façon qu'avec les systèmes FTP et de réseau local).
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 78
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 GetNewFeatures qui renvoie l'élément de menu Historique et le nom de la fonction C
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.
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électionner 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 79
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 Connect().
Valeurs renvoyées
Valeur booléenne : true en cas de succès et false dans le cas contraire.
ADOBE DREAMWEAVER 9.0 80
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 Connect().
•
remotePath est une mémoire tampon dans laquelle est enregistré le chemin distant complet du dossier racine.
•
folderLen est un nombre entier qui indique la longueur de l'argument remotePath. Il s'agit de la valeur renvoyée par la
fonction GetRootFolderLength.
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 Connect().
•
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.
ADOBE DREAMWEAVER 9.0 81
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 Connect().
•
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
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
fichier pour déterminer le type, comme il le fait à présent)
taille
int
En octets
•
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 Connect().
•
remotePathList est une liste des fichiers ou dossiers distants à extraire, exprimée sous la forme de noms et de chemins
d'accès complets.
• 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.
ADOBE DREAMWEAVER 9.0 82
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 Connect().
• L'argument remotePathList est une liste de noms de chemin d'accès aux fichiers ou aux dossiers distants à supprimer.
•
numItems est le nombre d'éléments dans remotePathList.
Valeurs renvoyées
Valeur booléenne : true en cas de succès et false dans le cas contraire.
ADOBE DREAMWEAVER 9.0 83
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 newRemotePath. Ainsi, si les valeurs de oldRemotePath et newRemotePath sont respectivement "$/folder1/file1" et
"$/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
fonction Connect().
•
oldRemotePath est le nom du chemin d'accès au fichier ou dossier distant à renommer
•
newRemotePath est le nom du chemin d'accès au nouveau fichier ou dossier distant.
Valeurs renvoyées
Valeur booléenne : true en cas de succès et false dans le cas contraire.
bool SCS_ItemExists()
Description
Détermine si un fichier ou un dossier existe sur le serveur.
Arguments
void *connectionData, const char *remotePath
• L'argument connectionData est un pointeur vers les données de l'agent transférées à Dreamweaver pendant l'appel de la
fonction Connect().
•
remotePath
est le chemin d'accès d'un fichier ou d'un dossier distant.
Valeurs renvoyées
Valeur booléenne : true en cas de succès et false dans le cas contraire.
ADOBE DREAMWEAVER 9.0 84
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 85
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 GetNumNewFeatures().
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 Connect().
•
checkOutName est le nom de l'utilisateur en cours.
•
emailAddress est l'adresse électronique de l'utilisateur en cours.
ADOBE DREAMWEAVER 9.0 86
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 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.
•
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.
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 Connect().
•
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.
ADOBE DREAMWEAVER 9.0 87
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 Connect().
•
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.
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 Connect().
•
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.
ADOBE DREAMWEAVER 9.0 88
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 Connect().
•
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.
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 GetErrorMessage(). Cette fonction doit être appelée uniquement si une fonction d'API renvoie la valeur false
ou <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 false.
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().
•
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 89
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 90
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 Connect().
•
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 GetNoteCount().
•
noteLength est la longueur maximale d'une Design Note ; cette valeur est renvoyée par la fonction GetMaxNoteLength().
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 Connect().
•
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
•
noteLength est la longueur de la Design Note la plus longue pour le fichier ou le dossier spécifié.
; ce nombre permet à la DLL de
connaître la taille des listes spécifiées. Si 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 91
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 isRemoteNewer .
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().
•
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.
remotePathList
• 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.
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 92
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 Connect().
•
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.
Valeurs renvoyées
Valeur booléenne : true en cas de succès et false dans le cas contraire.
ADOBE DREAMWEAVER 9.0 93
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 Connect().
•
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.
Valeurs renvoyées
Valeur booléenne : true en cas de succès et false dans le cas contraire.
ADOBE DREAMWEAVER 9.0 94
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 Connect().
Valeurs renvoyées
Valeur booléenne : true en cas de succès et false dans le cas contraire.
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 9.0 95
Guide des API
bool SCS_BeforePut()
Description
Dreamweaver appelle cette fonction avant de placer ou d'archiver 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'archivage.
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 Connect().
Valeurs renvoyées
Valeur booléenne : true en cas de succès et false dans le cas contraire.
Exemple
Pour acquérir un groupe de fichiers, Dreamweaver effectue des appels vers la DLL dans l'ordre suivant :
SCS_BeforeGet(connectionData);
SCS_Put(connectionData,localPathList1,remotePathList1,successList1);
SCS_Put(connectionData,localPathList2,remotePathList2,successList2);
SCS_Put(connectionData,localPathList3,remotePathList3,successList3);
SCS_AfterPut(connectionData);
bool SCS_AfterGet()
Description
Dreamweaver appelle cette fonction après avoir acquis ou extrait un ou plusieurs fichiers. Cette fonction permet à la DLL
d'effectuer n'importe quelle opération après l'acquisition ou l'extraction d'un lot, telle que la création d'une boîte de dialogue
de résumé.
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 Connect().
Valeurs renvoyées
Valeur booléenne : true en cas de succès et false dans le cas contraire.
Exemple
Consultez « bool SCS_BeforeGet() », page 94.
ADOBE DREAMWEAVER 9.0 96
Guide des API
bool SCS_AfterPut()
Description
Dreamweaver appelle cette fonction après avoir placé ou archivé un ou plusieurs fichiers. Cette fonction permet à la DLL
d'effectuer n'importe quelle opération après le placement ou l'archivage d'un lot, telle que la création d'une boîte de dialogue
de résumé.
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 Connect().
Valeurs renvoyées
Valeur booléenne : true en cas de succès et false dans le cas contraire.
Exemple
Consultez « bool SCS_BeforePut() », page 95.
97
Chapitre 11 : Application
Les fonctions relatives aux applications effectuent des opérations ayant trait à la façon dont Adobe® Dreamweaver® CS3
interagit avec d'autres applications ou des tâches Dreamweaver indépendantes des documents individuels (définition des
préférences ou fermeture de Dreamweaver, par exemple).
Les fonctions décrites dans ce chapitre sont regroupées dans les sections suivantes :
• « Fonctions relatives aux applications externes », page 97
• « Fonctions globales relatives aux applications », page 105
• « Fonctions de communication avec Bridge », page 109
Fonctions relatives aux applications externes
Ces fonctions permettent d'effectuer des opérations relatives aux applications, telles que Adobe® Flash®, aux navigateurs et
aux éditeurs externes, définis respectivement dans les catégories Aperçu dans le navigateur et Editeurs externes des
Préférences. Elles permettent d'obtenir des informations sur les applications externes et d'ouvrir des fichiers dans ces
applications.
dreamweaver.browseDocument()
Disponibilité
Dreamweaver 2, améliorée dans les versions 3 et 4.
Description
Ouvre l'URL spécifiée dans le navigateur spécifié.
Arguments
fileName, {browser}.
• L'argument fileName correspond au nom du fichier à ouvrir, exprimé sous la forme d'une
URL absolue.
Remarque : Certains navigateurs ne sont pas en mesure de trouver un fichier dont l'URL contient une ancre
(« Configuration/ExtensionHelp/browseHelp.htm#helpyou », par exemple).
• L'argument browser, ajouté à Dreamweaver 3, définit un navigateur. Cet argument peut être le nom d'un navigateur tel
qu'il est défini dans la catégorie Aperçu dans le navigateur des Préférences ou être 'primary' ou 'secondary'. Si
l'argument n'est pas défini, l'URL s'ouvre dans le navigateur principal de l'utilisateur.
Valeurs renvoyées
Aucune.
Exemple
La fonction suivante utilise la fonction dreamweaver.browseDocument() pour ouvrir la page d'accueil Hotwired dans un
navigateur :
function goToHotwired(){
dreamweaver.browseDocument('http://www.hotwired.com/');
}
ADOBE DREAMWEAVER 9.0 98
Guide des API
Dans Dreamweaver 4, vous pouvez faire en sorte que cette opération ouvre le document dans Microsoft Internet Explorer
à l'aide du code suivant :
function goToHotwired(){
var prevBrowsers = dw.getBrowserList();
var theBrowser = "";
for (var i=1; i < prevBrowsers.length; i+2){
if (prevBrowsers[i].indexOf('Iexplore.exe') != -1){
theBrowser = prevBrowsers[i];
break;
}
}
dw.browseDocument('http://www.hotwired.com/',theBrowser);
}
Pour plus d'informations sur la fonction dreamweaver.getBrowserList(), consultez la section
« dreamweaver.getBrowserList() », page 98.
dreamweaver.getBrowserList()
Disponibilité
Dreamweaver 3.
Description
Obtient la liste des navigateurs définis dans le sous-menu Fichier > Aperçu dans le navigateur.
Arguments
Aucun.
Valeurs renvoyées
Tableau contenant autant de paires de chaînes que de navigateurs définis. La première chaîne de la paire représente le nom
du navigateur, et la seconde son emplacement sur l'ordinateur de l'utilisateur, exprimé sous la forme d'une URL de type
file://. Si aucun navigateur n'est défini, la fonction ne renvoie rien.
dreamweaver.getExtensionEditorList()
Disponibilité
Dreamweaver 3
Description
Obtient la liste des éditeurs définis dans la catégorie Editeurs externes des préférences pour le fichier spécifié.
Arguments
fileURL
• L'argument fileURL peut être une URL complète de type file://, un nom de fichier ou une extension de fichier (point
compris).
Valeurs renvoyées
Tableau contenant autant de paires de chaînes que d'éditeurs définis. La première chaîne de la paire représente le nom de
l'éditeur, et la seconde son emplacement sur l'ordinateur de l'utilisateur, exprimé sous la forme d'une URL de type file://. Si
aucun éditeur n'est défini dans les préférences, la fonction renvoie un tableau contenant une chaîne vide.
ADOBE DREAMWEAVER 9.0 99
Guide des API
Exemple
Un appel à la fonction dreamweaver.getExtensionEditorList(".gif") pourrait renvoyer un tableau contenant les chaînes
suivantes :
•
"Fireworks 3"
•
"file:///C|/Program Files/Adobe/Fireworks 3/Fireworks 3.exe"
dreamweaver.getExternalTextEditor()
Disponibilité
Dreamweaver 4.
Description
Obtient le nom de l'éditeur de texte externe actuellement configuré.
Arguments
Aucun.
Valeurs renvoyées
Une chaîne contenant le nom de l'éditeur de texte approprié pour l'interface utilisateur et non le chemin entier.
dreamweaver.getFlashPath()
Disponibilité
Dreamweaver MX.
Description
Obtient le chemin d'accès complet de l'application Flash MX sous la forme d'une URL de fichier.
Arguments
Aucun.
Valeurs renvoyées
Tableau contenant deux éléments. Elément [0] est une chaîne contenant le nom de l'éditeur Flash MX. Elément [1] est une
chaîne contenant le chemin de l'application Flash sur l'ordinateur local, exprimé sous la forme d'une URL de type file://. Si
Flash n'est pas installé, la fonction ne renvoie rien.
Exemple
L'exemple suivant appelle la fonction dw.getFlashPath() pour obtenir le chemin d'accès à l'application Flash et transmettre
ce dernier sous la forme d'une URL de type file:// à la fonction dw.openWithApp() afin d'ouvrir le document avec Flash :
var myDoc = dreamweaver.getDocumentDOM();
if (dreamweaver.validateFlash()) {
var flashArray = dreamweaver.getFlashPath();
dreamweaver.openWithApp(myDoc.myForm.swfFilePath, flashArray[1]);
}
ADOBE DREAMWEAVER 9.0 100
Guide des API
dreamweaver.getPrimaryBrowser()
Disponibilité
Dreamweaver 3.
Description
Obtient le chemin du navigateur principal.
Arguments
Aucun.
Valeurs renvoyées
Une chaîne contenant le chemin d'accès au navigateur principal sur l'ordinateur de l'utilisateur, exprimé sous la forme d'une
URL de type file://, ou rien, si aucun navigateur principal n'est défini.
dreamweaver.getPrimaryExtensionEditor()
Disponibilité
Dreamweaver 3.
Description
Obtient l'éditeur principal associé au fichier spécifié.
Arguments
fileURL
• L'argument fileURL correspond au chemin d'accès au fichier à ouvrir, exprimé sous la forme d'une URL de type file://.
Valeurs renvoyées
Tableau contenant une paire de chaînes. La première chaîne de la paire représente le nom de l'éditeur, et la seconde son
emplacement sur l'ordinateur de l'utilisateur, exprimé sous la forme d'une URL de type file://. Si aucun éditeur principal
n'est défini, la fonction renvoie un tableau contenant une chaîne vide.
dreamweaver.getSecondaryBrowser()
Disponibilité
Dreamweaver 3.
Description
Obtient le chemin du navigateur secondaire.
Arguments
Aucun.
Valeurs renvoyées
Une chaîne contenant le chemin d'accès au navigateur secondaire sur l'ordinateur de l'utilisateur, exprimé sous la forme
d'une URL de type file://, ou rien, si aucun navigateur secondaire n'est défini.
ADOBE DREAMWEAVER 9.0 101
Guide des API
dreamweaver.openHelpURL()
Disponibilité
Dreamweaver MX.
Description
Ouvre le fichier d'aide spécifié dans le visualisateur d'aide du système d'exploitation.
Dreamweaver affiche le contenu de l'aide dans le visualisateur d'aide standard du système d'exploitation plutôt que dans un
navigateur. L'aide est au format HTML, mais elle peut être lue par HTML Help sous Windows ou Help Viewer sur
Macintosh OS X.
L'aide complète est contenue dans les quatre types de fichiers suivants. Pour plus d'informations sur les fichiers d'aide,
consultez la documentation de votre système d'exploitation.
• Manuel d'aide
Un manuel d'aide se compose de fichiers d'aide HTML, d'images et d'index. Sous Windows, le manuel d'aide est un fichier
portant l'extension .chm. Sur Macintosh, le manuel d'aide est un dossier.
Les fichiers du manuel d'aide se trouvent dans le dossier d'aide de Dreamweaver.
• Fichier help.xml
Le fichier help.xml établit des correspondances entre les ID et le nom des manuels d'aide. Par exemple, le code XML cidessous établit une correspondance entre l'ID du manuel d'aide de Dreamweaver et le nom des fichiers contenant cette aide,
sous Windows comme sur Macintosh :
<?xml version =
"1.0"
?>
<help-books>
<book-id id="DW_Using" win-mapping="UsingDreamweaver.chm" mac-mapping="Dreamweaver Help"/>
</help-books>
Chaque entrée book-id comporte les attributs suivants :
• L'attribut id correspond à l'ID de manuel utilisé dans les fichiers help.map et HelpDoc.js.
• L'attribut win-mapping correspond au nom du manuel Windows, "UsingDreamweaver.chm" dans cet exemple.
• L'attribut mac-mapping correspond au nom du manuel Macintosh, soit "Dreamweaver
Help"
dans cet exemple.
• Fichier help.map
Le fichier help.map établit une correspondance entre un ID de contenu de l'aide et un manuel d'aide spécifique. Dreamweaver utilise le fichier help.map pour rechercher un contenu d'aide spécifique lorsqu'il appelle l'aide directement.
• Fichier helpDoc.js
Le fichier helpDoc.js vous permet d'établir une correspondance entre des noms de variables que vous pouvez utiliser à la
place de l'ID du manuel et de la chaîne de page. Le fichier helpDoc.js établit une correspondance entre un ID de contenu
et une page HTML dans un manuel d'aide spécifique. Dreamweaver utilise le fichier helpDoc.js lorsqu'il appelle l'aide à
partir de JavaScript.
Arguments
bookID.
• L'argument obligatoire bookID se présente au format suivant :
ID:page
L'attribut ID correspond à l'ID de manuel bookID de l'entrée figurant dans le fichier help.xml qui indique le fichier
renfermant l'aide à afficher. L'attribut page de l'entrée identifie la page à afficher. Les pages sont référencées dans le fichier
help.map.
Valeurs renvoyées
true en cas de réussite et false si Dreamweaver ne peut pas ouvrir le fichier spécifié dans le visualisateur d'aide.
ADOBE DREAMWEAVER 9.0 102
Guide des API
Exemple
openHelpURL("DW_Using:index.htm");
dreamweaver.openWithApp()
Disponibilité
Dreamweaver 3.
Description
Ouvre le fichier spécifié dans l'application spécifiée.
Arguments
fileURL, appURL
• L'argument fileURL correspond au chemin d'accès au fichier à ouvrir, exprimé sous la forme d'une URL de type file://.
• L'argument appURL correspond au chemin d'accès à l'application dans laquelle ouvrir le fichier, exprimé sous forme d'une
URL de type file://.
Valeurs renvoyées
Aucune.
dreamweaver.openWithBrowseDialog()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue Sélectionner un éditeur externe pour permettre à l'utilisateur de sélectionner l'application dans
laquelle ouvrir le fichier spécifié.
Arguments
fileURL
• L'argument fileURL correspond au chemin d'accès au fichier à ouvrir, exprimé sous la forme d'une URL de type file://.
Valeurs renvoyées
Aucune.
dreamweaver.openWithExternalTextEditor()
Disponibilité
Dreamweaver 3.
Description
Ouvre le document actif dans l'éditeur de texte externe défini dans la section Editeurs externes de la boîte de dialogue Préférences.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 103
Guide des API
dreamweaver.openWithImageEditor()
Disponibilité
Dreamweaver 3.
Description
Ouvre le fichier nommé dans l'éditeur d'image spécifié.
Remarque : Cette fonction lance un mécanisme spécial d'intégration Adobe Fireworks qui renvoie les informations au
document actif lorsque Fireworks est spécifié comme éditeur d'image. Pour éviter les erreurs lorsqu'aucun document n'est actif,
n'appelez jamais cette fonction à partir du panneau Site.
Arguments
fileURL, appURL
• L'argument fileURL correspond au chemin d'accès au fichier à ouvrir, exprimé sous la forme d'une URL de type file://.
• L'argument appURL correspond au chemin d'accès à l'application dans laquelle ouvrir le fichier, exprimé sous forme d'une
URL de type file://.
Valeurs renvoyées
Aucune.
dreamweaver.validateFlash()
Disponibilité
Dreamweaver MX.
Description
Détermine si Flash MX (ou une version ultérieure) est installé sur l'ordinateur local.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si Flash MX (ou une version ultérieure) est installé sur l'ordinateur local ; false dans le cas
contraire.
dom.insertFiles()
Disponibilité
Dreamweaver CS3.
Description
Insère un ou plusieurs fichiers dans le document actuel au point d'insertion en cours ou à la place de la sélection actuelle,
et invite l'utilisateur à définir des paramètres si nécessaire.
Arguments :
strFiles
strFiles est une chaîne qui spécifie les chemins et les noms des fichiers à insérer. Plusieurs noms de fichiers peuvent être
transmis à cette fonction.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 104
Guide des API
dreamweaver.activateApp()
Disponibilité
Dreamweaver CS3.
Description
Fait passer l'application spécifiée au premier plan.
Arguments :
applicationID
applicationID est une chaîne qui indique quelle application activer, par exemple, dreamweaver.
Valeurs renvoyées
Aucune.
dreamweaver.printDocument()
Disponibilité
Dreamweaver CS3.
Description
Exécute l'équivalent de la commande Fichier > Imprimer le code de Dreamweaver sur le fichier requis.
Arguments :
fileName.
fileName est une chaîne qui contient le nom du fichier à imprimer, exprimé sous la forme d'une URL.
Valeurs renvoyées
Aucune.
dreamweaver.revealDocument()
Disponibilité
Dreamweaver CS3.
Description
Rend Dreamweaver actif pour le système d'exploitation et, si le fichier spécifié est ouvert dans Dreamweaver, affiche
Dreamweaver au premier plan.
Arguments :
fileName
fileName est une chaîne qui contient le nom du fichier à afficher, exprimé sous la forme d'une URL.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 105
Guide des API
Fonctions globales relatives aux applications
Ces fonctions agissent sur l'ensemble d'une application. Elles permettent d'effectuer des tâches comme quitter une application ou accéder aux préférences.
dreamweaver.beep()
Disponibilité
Dreamweaver MX.
Description
Crée un bip système.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant appelle la fonction dw.beep() pour attirer l'attention de l'utilisateur sur un message affiché par la fonction
alert() :
beep(){
if(confirm(“Votre commande est-elle terminée ?”)
{
dreamweaver.beep();
alert(“Cliquez sur OK pour envoyer votre commande”);
}
}
dreamweaver.getShowDialogsOnInsert()
Disponibilité
Dreamweaver 3.
Description
Vérifie si l'option Afficher la boîte de dialogue lors de l'insertion d'objets est activée dans la catégorie Général des préférences.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne qui indique si cette option est activée.
ADOBE DREAMWEAVER 9.0 106
Guide des API
dreamweaver.quitApplication()
Disponibilité
Dreamweaver 3.
Description
Quitte Dreamweaver lorsque l'exécution du script appelant cette fonction prend fin.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dreamweaver.showAboutBox()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue A propos de.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dreamweaver.showDynamicDataDialog()
Disponibilité
Dreamweaver UltraDev 1.
Description
Affiche la boîte de dialogue Données dynamiques ou Texte dynamique, puis attend que l'utilisateur ferme la boîte de
dialogue. Si l'utilisateur clique sur OK, la fonction showDynamicDataDialog() renvoie une chaîne à insérer dans le
document de l'utilisateur. Cette chaîne est renvoyée par la fonction API de la source des données, c'est-à-dire generateDynamicDataRef(), et transmise à la fonction API du format de données, formatDynamicDataRef() ; la valeur renvoyée par
formatDynamicDataRef() est la même que celle renvoyée par la fonction showDynamicDataDialog().
Arguments
source, {title}.
• L'argument source est une chaîne contenant le code source qui représente l'objet de données dynamique. Il s'agit de la
même chaîne que celle renvoyée après un appel précédent de la même fonction. Cette fonction utilise le contenu de
l'argument source pour initialiser toutes les commandes de la boîte de dialogue afin qu'elles apparaissent exactement
telles qu'elles étaient au moment où l'utilisateur a cliqué sur OK pour créer cette chaîne.
Dreamweaver transmet cette chaîne à la fonction inspectDynamicDataRef() pour déterminer si la chaîne correspond à l'un
des noeuds de l'arborescence. Si la chaîne correspond à un noeud, celui-ci est sélectionné lorsque la boîte de dialogue
réapparaît. Vous pouvez également transmettre une chaîne vide qui n'initialise pas la boîte de dialogue. Par exemple, aucune
boîte de dialogue n'est initialisée lorsqu'elle est utilisée pour créer un nouvel élément.
• L'argument title, qui est facultatif, est une chaîne qui contient le texte à afficher dans la barre de titre de la boîte de
dialogue. S'il n'est pas défini, Dreamweaver affiche Données dynamiques dans la barre de titre.
ADOBE DREAMWEAVER 9.0 107
Guide des API
Valeurs renvoyées
Chaîne qui représente l'objet de données dynamique, si l'utilisateur clique sur OK.
dreamweaver.showPasteSpecialDialog()
Disponibilité
Dreamweaver 8
Description
Affiche la boîte de dialogue Collage spécial. Si l'utilisateur clique sur OK, la fonction showPasteSpecialDialog() effectue
le collage.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Exemple
dw.showPasteSpecialDialog();
dreamweaver.showPreferencesDialog()
Disponibilité
Dreamweaver 3. Ajout de l'argument strCategory dans Dreamweaver 8.
Description
La fonction ouvre la boîte de dialogue Préférences.
Arguments
{strCategory}.
• L'argument facultatif strCategory doit correspondre à l'une des chaînes suivantes pour ouvrir la catégorie correspondante dans la boîte de dialogue Préférences : "general", "accessibility", "html colors" (pour la catégorie Coloration
du code), "html format" (pour la catégorie Format du code), "code hints", "html rewriting" (pour la catégorie
Correction du code), “copyPaste”, "css styles", "file compare", "external editors" (pour la catégorie Types de
fichiers/Editeurs), "fonts", "highlighting", "invisible elements", "layers", "layout mode", "new document",
"floaters" (pour la catégorie Panneaux), "browsers" (pour la catégorie Aperçu dans le navigateur), "site ftp" (pour
la catégorie Site), "status bar" et "validator". Si Dreamweaver ne reconnaît pas dans l'argument un nom de volet
valide ou qu'aucun argument n'est défini, la boîte de dialogue ouvre le dernier volet actif.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant ouvre la boîte de dialogue Préférences et sélectionne la catégorie Coloration du code :
dw.showPreferencesDialog(“html colors”);
ADOBE DREAMWEAVER 9.0 108
Guide des API
dreamweaver.showTagChooser()
Disponibilité
Dreamweaver MX.
Description
Active ou désactive l'affichage de la boîte de dialogue Sélecteur de balise afin que les utilisateurs insèrent des balises en mode
Code. La fonction affiche la boîte de dialogue Sélecteur de balise au-dessus de toutes les autres fenêtres Dreamweaver. Si la
boîte de dialogue n'est pas visible, la fonction l'ouvre, l'affiche au premier plan et en fait l'élément actif. Si le sélecteur de
balise est visible, la fonction masque la boîte de dialogue.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dw.registerIdleHandler()
Disponibilité
Dreamweaver CS3.
Description
Cette fonction enregistre une fonction JavaScript à appeler de façon périodique au cours du temps de traitement inactif.
Arguments
id, idleFunction, interval
•
la tâche d'inactivité à enregistrer. Pour assurer que cet argument soit
unique, ajoutez à cet ID un préfixe correspondant à un identificateur unique. Par exemple, vous voudrez peut-être qu'un
bip sonore soit émis toutes les 5 secondes, mais pas appeler la tâche "beep", parce qu'il est possible que quelqu'un d'autre
ait créé une tâche portant le même nom. Un nom plus approprié serait par exemple "acme_beep_task", un nom unique
fournissant également un contexte.
•
idleFunction - la fonction JavaScript à appeler au cours du temps de traitement inactif.
•
interval - le nombre de secondes entre les appels de la fonction idleFunction, soumis à la disponibilité du temps
d'inactivité.
id - une chaîne unique permettant d'identifier
Valeurs renvoyées
Valeur booléenne indiquant si la tâche d'inactivité a été enregistrée correctement.
Exemple
L'exemple suivant entraîne le déclenchement par le système d'un bip sonore toutes les 5 secondes :
dw.registerIdleHandler("acme_beep_task", function() { dw.beep();}, 5);
ADOBE DREAMWEAVER 9.0 109
Guide des API
dw.revokeIdleHandler()
Disponibilité
Dreamweaver CS3.
Description
Cette fonction supprime une tâche d'inactivité précédemment générée par la fonction registerIdleHandler. L'objectif est
de fournir un moyen de supprimer une tâche d'inactivité enregistrée précédemment. Si une tâche d'inactivité est censée
rester active jusqu'à ce que l'application soit fermée, il n'est pas nécessaire d'appeler cette fonction. Si c'est le cas, la tâche
d'inactivité est supprimée automatiquement avant la fermeture de l'application.
Arguments
id
•
id - une chaîne unique permettant d'identifier la tâche d'inactivité enregistrée à supprimer. Il s'agit du même ID qui a été
utilisé initialement pour enregistrer la tâche.
Valeurs renvoyées
Valeur booléenne indiquant si la tâche d'inactivité a été supprimée correctement.
Exemple
L'exemple suivant supprimer la tâche d'inactivité nommée "dw_beep_task" de la file d'attente des tâches d'inactivité :
dw.revokeIdleHandler("acme_beep_task");
Fonctions de communication avec Bridge
Les fonctions de communication avec Bridge permettent la communication entre Dreamweaver et l'application Bridge.
Cette communication permet notamment à l'utilisateur de rechercher facilement des fichiers dans Bridge à partir de
Dreamweaver.
BridgeTalk.bringToFront()
Disponibilité
Dreamweaver CS3.
Description
Fait de l'application spécifiée le processus de premier plan en appelant la fonction BridgeTalk::bringToFront().
Arguments
applicationID
applicationID est une chaîne, par exemple, bridge ou dreamweaver, qui indique quelle application activer.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 110
Guide des API
Exemple
Cet exemple illustre la façon dont Dreamweaver implémente la fonction browseInBridge(). Vous créez d'abord une
instance BridgeTalk, puis vous définissez les deux propriétés les plus importantes : target et body. <target> correspond à
l'application cible. Dans le cas présent, il suffit de l'application Bridge. Son identificateur est bridge. <body> est le message
à envoyer. Généralement, <body> est un script que l'application cible peut comprendre et exécuter après l'avoir reçu. La
fonction send() est appelée pour envoyer la propriété <body> à la propriété <target>.
if (!JSBridge.isRunning('bridge'))
{
var bt = new BridgeTalk;
var scriptSavePath = browsePath.replace(/['"\\]/g, "\\$&");
var script = "app.document.thumbnail = new Thumbnail(decodeURI('" + scriptSavePath + "'));";
// Envoyer le script à bridge et lui laisser 10 sec pour démarrer avant de supposer qu'une erreur s'est
produite.
bt.target = "bridge";
bt.body = script;
result = bt.send(10);
}
if (result)
BridgeTalk.bringToFront('bridge');
Bridgetalk.send()
Disponibilité
Dreamweaver CS3.
Description
Etablit la communication avec l'application Bridge.
Arguments :
timeout
Cet attribut facultatif définit l'intervalle de temporisation en secondes.
Valeurs renvoyées
Une valeur booléenne indiquant si la communication avec l'application Bridge a réussi (True = réussi, False = échoué).
Exemple
result = bridgeTalk.send(10);
BridgeTalk.suppressStartupScreen()
Disponibilité
Dreamweaver CS3.
Description
Recherche les options de lancement définies pour -nostartupscreen afin de déterminer si la fenêtre modale doit être
supprimée après le démarrage.
Valeurs renvoyées
Valeur booléenne indiquant si les écrans de démarrage doivent être supprimés.
ADOBE DREAMWEAVER 9.0 111
Guide des API
dw.browseInBridge()
Disponibilité
Dreamweaver CS3.
Description
Vous permet de parcourir des fichiers dans Bridge à partir de Dreamweaver. La fonction dw.browseInBridge() démarre
l'application Bridge. Si Bridge est déjà en cours d'exécution, dw.browseInBridge bascule vers l'application Bridge.
Arguments :
Aucun
Valeurs renvoyées
Valeur booléenne indiquant si le script de navigation a été envoyé à l'application Bridge correctement (true = réussi, false
= échoué).
ADOBE DREAMWEAVER 9.0 112
Guide des API
113
Chapitre 12 : Espace de travail
Les fonctions API de l'espace de travail créent des éléments dans l'espace de travail Adobe® Dreamweaver® CS3 ou effectuent
des actions dessus. Elles permettent d'effectuer diverses tâches dont voici un aperçu : refaire les étapes qui s'affichent dans
le panneau Historique, placer un objet dans la barre Insertion, se déplacer à l'aide des fonctions relatives au clavier,
recharger des menus, manipuler des fenêtres de résultats indépendantes ou intégrées, définir des options, positionner une
barre d'outils et obtenir la sélection ou définir l'élément actif.
Les fonctions décrites dans ce chapitre sont regroupées dans les sections suivantes :
• « Fonctions d'historique », page 113
• « Fonctions d'insertion d'objets », page 120
• « Fonctions relatives au clavier », page 123
• « Fonctions relatives aux menus », page 129
• « Fonctions relatives à la fenêtre de résultats », page 130
• « Fonctions de bascule », page 141
• « Fonctions relatives aux barres d'outils », page 158
• « Fonctions relatives aux fenêtres », page 163
• « Fonctions relatives au fractionnement des codes », page 172
• « Fonctions relatives aux barres d'outils du mode Code », page 178
Fonctions d'historique
Ces fonctions permettent d'annuler, de refaire, d'enregistrer et de lire toutes les étapes qui s'affichent dans le panneau Historique. Par étape, on entend une modification apportée à un document (ou à une sélection dans le document) pouvant être
reproduite. Les méthodes de l'objet dreamweaver.historyPalette permettent de contrôler ou d'agir sur la sélection dans
le panneau Historique et non dans le document actif.
dom.redo()
Disponibilité
Dreamweaver 3.
Description
Répète l'étape qui vient juste d'être annulée dans le document.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dom.canRedo() », page 415.
ADOBE DREAMWEAVER 9.0 114
Guide des API
dom.undo()
Disponibilité
Dreamweaver 3.
Description
Annule l'étape qui vient d'être exécutée dans le document.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez la section « dom.canUndo() », page 417.
dreamweaver.getRedoText()
Disponibilité
Dreamweaver 3.
Description
Obtient le texte associé à l'opération de modification à répéter si l'utilisateur choisit Edition > Répéter ou s'il appuie sur
Ctrl+Y (Windows) ou sur Commande+Y (Macintosh).
Arguments
Aucun.
Valeurs renvoyées
Chaîne contenant le texte associé à l'opération de modification à répéter.
Exemple
Si la dernière action de l'utilisateur a consisté à mettre le texte sélectionné en gras, un appel à la fonction
dreamweaver.getRedoText() renvoie "Repeat Apply Bold".
dreamweaver.getUndoText()
Disponibilité
Dreamweaver 3.
Description
Obtient le texte associé à l'opération de modification à annuler si l'utilisateur choisit Edition > Annuler ou s'il appuie sur
Ctrl+Z (Windows) ou sur Commande+Z (Macintosh).
Arguments
Aucun.
Valeurs renvoyées
Chaîne contenant le texte associé à l'opération de modification à annuler.
Exemple
Si la dernière action de l'utilisateur a consisté à appliquer un style CSS (cascading style sheet) à un texte sélectionné, un
appel à la fonction dreamweaver.getUndoText() renvoie "Undo Apply <span>".
ADOBE DREAMWEAVER 9.0 115
Guide des API
dreamweaver.playRecordedCommand()
Disponibilité
Dreamweaver 3.
Description
Exécute la commande mémorisée dans le document actif.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez la section « dreamweaver.canPlayRecordedCommand() », page 421.
dreamweaver.redo()
Disponibilité
Dreamweaver 3.
Description
Répète l'étape qui vient juste d'être annulée dans la fenêtre de document, la boîte de dialogue, le panneau flottant ou le
panneau Site en cours.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.canRedo() », page 422.
dreamweaver.startRecording()
Disponibilité
Dreamweaver 3.
Description
Démarre la mémorisation des étapes dans le document actif ; la commande précédemment mémorisée est
immédiatement éliminée.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez la section « dreamweaver.isRecording() », page 428 (doit renvoyer la valeur false).
ADOBE DREAMWEAVER 9.0 116
Guide des API
dreamweaver.stopRecording()
Disponibilité
Dreamweaver 3.
Description
Arrête la mémorisation sans intervention de l'utilisateur.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez la section « dreamweaver.isRecording() », page 428 (doit renvoyer la valeur true).
dreamweaver.undo()
Disponibilité
Dreamweaver 3.
Description
Annule l'étape précédente dans la fenêtre de document, la boîte de dialogue, le panneau flottant ou le panneau Site actif.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez la section « dom.canUndo() », page 417.
dreamweaver.historyPalette.clearSteps()
Disponibilité
Dreamweaver 3.
Description
Efface toutes les étapes du panneau Historique et désactive les éléments de menu Annuler et Rétablir.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 117
Guide des API
dreamweaver.historyPalette.copySteps()
Disponibilité
Dreamweaver 3.
Description
Copie les étapes spécifiées de l'historique dans le Presse-papiers. Dreamweaver prévient l'utilisateur de la possibilité de
conséquences inattendues au cas où les étapes spécifiées contiendraient une action impossible à reproduire.
Arguments
arrayOfIndices
• L'argument arrayOfIndices est un tableau d'index de position dans le panneau Historique.
Valeurs renvoyées
Chaîne qui contient le code JavaScript correspondant aux étapes spécifiées de l'historique.
Exemple
L'exemple suivant copie les quatre premières étapes dans le panneau Historique :
dreamweaver.historyPalette.copySteps([0,1,2,3]);
dreamweaver.historyPalette.getSelectedSteps()
Disponibilité
Dreamweaver 3.
Description
Détermine quelle section du panneau Historique est sélectionnée.
Arguments
Aucun.
Valeurs renvoyées
Tableau qui contient les index de position de toutes les étapes sélectionnées. La première position est la position 0 (zéro).
Exemple
Si la deuxième, la troisième et la quatrième étapes sont sélectionnées dans le panneau Historique, comme le montre la figure
ci-après, un appel à la fonction dreamweaver.historyPalette.getSelectedSteps() renvoie [1,2,3] :
ADOBE DREAMWEAVER 9.0 118
Guide des API
dreamweaver.historyPalette.getStepCount()
Disponibilité
Dreamweaver 3.
Description
Obtient le nombre d'étapes figurant dans le panneau Historique.
Arguments
Aucun.
Valeurs renvoyées
Nombre entier qui représente le nombre d'étapes répertoriées actuellement dans le panneau Historique.
dreamweaver.historyPalette.getStepsAsJavaScript()
Disponibilité
Dreamweaver 3.
Description
Obtient l'équivalent JavaScript des étapes sélectionnées.
Arguments
arrayOfIndices
• L'argument arrayOfIndices est un tableau d'index de position dans le panneau Historique.
Valeurs renvoyées
Chaîne qui contient le code JavaScript correspondant aux étapes spécifiées de l'historique.
Exemple
Si les trois étapes indiquées dans l'illustration ci-après sont sélectionnées dans le panneau Historique, un appel à la fonction
dreamweaver.historyPalette.getStepsAsJavaScript(dw.historyPalette.getSelectedSteps()) renvoie "dw.getDocumentDOM().insertText('Lon lon lon, le chat et le violon, par-dessus la lune la vache a fait un
bond.');\ndw.getDocumentDOM().newBlock();\n dw.getDocumentDOM().insertHTML('<img src=\
"../wdw99/50browsers/images/sun.gif\">', true);\n" :
dreamweaver.historyPalette.getUndoState()
Disponibilité
Dreamweaver 3.
Description
Obtient l'état d'annulation en cours.
ADOBE DREAMWEAVER 9.0 119
Guide des API
Arguments
Aucun.
Valeurs renvoyées
La position du marqueur d'annulation dans le panneau Historique.
dreamweaver.historyPalette.replaySteps()
Disponibilité
Dreamweaver 3.
Description
Réexécute les étapes spécifiées de l'historique dans le document actif. Dreamweaver prévient l'utilisateur de la possibilité de
conséquences inattendues dans le cas où les étapes spécifiées contiendraient une action qui ne peut pas être reproduite.
Arguments
arrayOfIndices
• L'argument arrayOfIndices est un tableau d'index de position dans le panneau Historique.
Valeurs renvoyées
Chaîne qui contient le code JavaScript correspondant aux étapes spécifiées de l'historique.
Exemple
Un appel à la fonction dreamweaver.historyPalette.replaySteps([0,2,3]) réexécute la première, la troisième et la
quatrième étapes dans le panneau Historique.
dreamweaver.historyPalette.saveAsCommand()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue Enregistrer comme commande et permet à l'utilisateur d'enregistrer les étapes spécifiées sous
forme de commande. Dreamweaver prévient l'utilisateur de la possibilité de conséquences inattendues dans le cas où les
étapes spécifiées contiendraient une action qui ne peut pas être reproduite.
Arguments
arrayOfIndices
• L'argument arrayOfIndices est un tableau d'index de position dans le panneau Historique.
Valeurs renvoyées
Chaîne qui contient le code JavaScript correspondant aux étapes spécifiées de l'historique.
Exemple
L'exemple suivant enregistre la quatrième, la sixième et la huitième étapes du panneau Historique comme une commande :
dreamweaver.historyPalette.saveAsCommand([3,5,7]);
ADOBE DREAMWEAVER 9.0 120
Guide des API
dreamweaver.historyPalette.setSelectedSteps()
Disponibilité
Dreamweaver 3.
Description
Sélectionne les étapes spécifiées dans le panneau Historique.
Arguments
arrayOfIndices
• La fonction arrayOfIndices est un tableau d'index de position dans le panneau Historique. Si aucun argument n'est
défini, aucune étape n'est sélectionnée.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant sélectionne la première, la deuxième et la troisième étapes dans le panneau Historique :
dreamweaver.historyPalette.setSelectedSteps([0,1,2]);
dreamweaver.historyPalette.setUndoState()
Disponibilité
Dreamweaver 3.
Description
Effectue le nombre d'annulations et de répétitions nécessaires pour arriver à l'état d'annulation spécifié.
Arguments
undoState
• L'argument undoState correspond à l'objet renvoyé par la fonction dreamweaver.historyPalette.getUndoState().
Valeurs renvoyées
Aucune.
Fonctions d'insertion d'objets
Les fonctions d'insertion d'objets permettent d'effectuer des tâches ayant trait aux objets de la barre Insertion ou du menu
Insertion.
dom.insertFlashElement()
Disponibilité
Dreamweaver MX 2004.
Description
Insère l'élément Flash (fichier SWC) spécifié dans le document actif. Cette fonction suppose que l'élément Flash a été ajouté
à la barre Insertion et que le fichier du composant se trouve dans le dossier ou le sous-dossier Configuration/Objects/FlashElements.
ADOBE DREAMWEAVER 9.0 121
Guide des API
Arguments
swcFilename
• La chaîne swcFilename indique le chemin d'accès et le nom du composant Flash par rapport au dossier Configuration/Objects/FlashElements.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant insère le composant Flash de la barre de navigation figurant dans le dossier Components/Objects/FlashElements/Navigation dans le document actif :
dom.insertFlashElement("\Navigation\navBar.swc");
dreamweaver.objectPalette.getMenuDefault()
Disponibilité
Dreamweaver MX 2004.
Description
Extrait la chaîne d'ID de l'élément par défaut pour le menu associé.
Arguments
menuId
• L'argument menuId correspond à la chaîne définissant le menu dans le fichier insertbar.xml.
Valeurs renvoyées
Valeur de la chaîne définissant l'ID de l'élément par défaut.
Exemple
L'exemple suivant attribue l'objet par défaut actif du menu Support à la variable defID :
var defId = dw.objectPalette.getMenuDefault("DW_Media");
dreamweaver.objectPalette.setMenuDefault()
Disponibilité
Dreamweaver MX 2004.
Description
Définit l'objet par défaut d'un menu déroulant. L'icône de l'objet par défaut représente le menu déroulant spécifié dans la
barre Insertion. L'utilisateur peut cliquer sur l'objet par défaut pour l'insérer ou cliquer sur la flèche figurant en regard pour
ouvrir le menu déroulant correspondant afin d'afficher les autres objets de ce menu. Dreamweaver prendra en compte la
nouvelle valeur par défaut la prochaine fois que l'utilisateur ouvrira Dreamweaver ou utilisera la commande Recharger
extensions.
Arguments
menuId, defaultId.
• L'argument menuId correspond à la chaîne définissant le menu dans le fichier insertbar.xml.
• L'argument defaultId correspond à la chaîne définissant le nouvel objet par défaut dans le champ insertbar.xml.
Valeurs renvoyées
Valeur booléenne : true si la configuration de la nouvelle valeur par défaut réussit et false dans le cas contraire.
ADOBE DREAMWEAVER 9.0 122
Guide des API
Exemple
L'exemple suivant définit l'objet Flash en qualité d'objet par défaut pour le menu Support :
dw.objectPalette.setMenuDefault("DW_Media", "DW_Flash");
dreamweaver.reloadObjects()
Disponibilité
Dreamweaver MX 2004.
Description
Recharge tous les objets de la barre Insertion. Cette fonction revient à maintenir la touche Ctrl (Windows) ou Alt
(Macintosh) enfoncée tout en cliquant dans le menu des catégories de la barre Insertion et à sélectionner l'option de menu
Recharger extensions.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le chargement des objets a réussi et false dans le cas contraire.
dom.convertActiveContent()
Disponibilité
Dreamweaver CS3.
Description
Convertit tout le contenu actif du document donné.
Arguments
forceUpdate
•
forceUpdate est une valeur booléenne qui indique si les paramètres de préférence de l'utilisateur doivent être remplacés
(true, = remplacer). Cet argument est facultatif.
Valeurs renvoyées
Une valeur booléenne true si l'ensemble du contenu actif a été converti correctement. Renvoie false si une partie du
contenu actif qui devait être converti ne l'a pas été, par exemple, des balises d'objet se trouvant dans une région verrouillée
d'une instance de modèle.
Exemple
if( !dom.convertActiveContent(true) ) {
alert(dw.loadString("Contenu actif/Non intégralement converti"));
}
dom.convertNextActiveContent()
Disponibilité
Dreamweaver CS3.
Description
Indique qu'un script sera créé pour la prochaine balise d'objet qui sera insérée (pour le reste de l'action de modification en
cours, action qui n'est pas annulable). Cette fonction vous permet d'utiliser une extension de tiers pour générer le script
approprié pour le contenu actif spécifique.
ADOBE DREAMWEAVER 9.0 123
Guide des API
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Exemple
dom.convertNextActiveContent()
dom.insertHTML("<object classid=\"clsid:D27CDB6E-AE6D-11cf-96B8-444553540000\" codebase=\
"http://download.Macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=7,0,19,0\"
width=\"100\" height=\"22\"><param name=\"movie\" value=\"button1.swf\" /><param name=\
"quality\" value=\"high\" /><embed src=\"button1.swf\" quality=\"high\" pluginspage=\
"http://www.Macromedia.com/go/getflashplayer\" type=\"application/
x-shockwave-flash\"width=\"100\" height=\"22\"></embed></object>\");
Fonctions relatives au clavier
Les fonctions relatives au clavier émulent les opérations de déplacement au sein d'un document effectuées à l'aide des
touches de direction RET. ARR, SUPPR., PG. PREC et PG. SUIV. Parallèlement aux fonctions générales, telles que
arrowLeft() (équivalent à la touche de direction GAUCHE) et backspaceKey() (équivalent à la touche RET. ARR), Dreamweaver propose également des méthodes permettant d'accéder soit au mot ou paragraphe suivant ou précédent, soit au
début ou à la fin d'une ligne ou d'un document.
dom.arrowDown()
Disponibilité
Dreamweaver 3.
Description
Déplace le point d'insertion vers le bas du nombre de lignes spécifié.
Arguments
{nTimes}, {bShiftIsDown}
• L'argument nTimes correspond au nombre de fois où le point d'insertion doit se déplacer vers le bas. Si cet argument n'est
pas défini, il prend par défaut la valeur 1.
• L'argument bShiftIsDown est une valeur booléenne qui indique s'il faut étendre la sélection. Si cet argument n'est pas
défini, il prend par défaut la valeur false.
Valeurs renvoyées
Aucune.
dom.arrowLeft()
Disponibilité
Dreamweaver 3.
Description
Déplace le point d'insertion vers la gauche du nombre de colonnes spécifié.
ADOBE DREAMWEAVER 9.0 124
Guide des API
Arguments
{nTimes}, {bShiftIsDown}
• Facultatif, l'argument nTimes correspond au nombre de fois où le point d'insertion doit se déplacer vers la gauche. Si cet
argument n'est pas défini, il prend par défaut la valeur 1.
• L'argument facultatif bShiftIsDown est une valeur booléenne qui indique s'il faut étendre la sélection. Si cet argument
n'est pas défini, il prend par défaut la valeur false.
Valeurs renvoyées
Aucune.
dom.arrowRight()
Disponibilité
Dreamweaver 3.
Description
Déplace le point d'insertion vers la droite du nombre de colonnes spécifié.
Arguments
{nTimes}, {bShiftIsDown}
• Facultatif, l'argument nTimes correspond au nombre de fois où le point d'insertion doit se déplacer vers la droite. Si cet
argument n'est pas défini, il prend par défaut la valeur 1.
• L'argument facultatif bShiftIsDown est une valeur booléenne qui indique s'il faut étendre la sélection. Si cet argument
n'est pas défini, il prend par défaut la valeur false.
Valeurs renvoyées
Aucune.
dom.arrowUp()
Disponibilité
Dreamweaver 3.
Description
Déplace le point d'insertion vers le haut du nombre de lignes spécifié.
Arguments
{nTimes}, {bShiftIsDown}
• Facultatif, l'argument nTimes correspond au nombre de fois où le point d'insertion doit se déplacer vers le haut. Si cet
argument n'est pas défini, il prend par défaut la valeur 1.
• L'argument facultatif bShiftIsDown est une valeur booléenne qui indique s'il faut étendre la sélection. Si cet argument
n'est pas défini, il prend par défaut la valeur false.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 125
Guide des API
dom.backspaceKey()
Disponibilité
Dreamweaver 3.
Description
Cette fonction revient à appuyer sur la touche RET. ARR un nombre de fois donné. Le résultat obtenu diffère selon qu'il y
ait une sélection en cours ou simplement un point d'insertion.
Arguments
{nTimes}.
• Facultatif, l'argument nTimes correspond au nombre de fois qu'une opération de retour arrière doit avoir lieu. Si
l'argument n'est pas défini, il prend par défaut la valeur 1.
Valeurs renvoyées
Aucune.
dom.deleteKey()
Disponibilité
Dreamweaver 3.
Description
Cette fonction revient à appuyer sur la touche SUPPR. un nombre de fois donné. Le résultat obtenu diffère selon qu'il y ait
une sélection en cours ou simplement un point d'insertion.
Arguments
{nTimes}.
• Facultatif, l'argument nTimes correspond au nombre de fois qu'une opération de suppression doit avoir lieu. Si l'argument
n'est pas défini, il prend par défaut la valeur 1.
Valeurs renvoyées
Aucune.
dom.endOfDocument()
Disponibilité
Dreamweaver 3.
Description
Déplace le point d'insertion à la fin du document, dans la fenêtre active (selon le cas, après le dernier contenu visible dans
la fenêtre de document ou après la balise HTML de fermeture dans l'inspecteur de code).
Arguments
{bShiftIsDown}.
• L'argument facultatif bShiftIsDown est une valeur booléenne qui indique s'il faut étendre la sélection. Si l'argument n'est
pas défini, il prend par défaut la valeur false.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 126
Guide des API
dom.endOfLine()
Disponibilité
Dreamweaver 3.
Description
Déplace le point d'insertion à la fin de la ligne.
Arguments
{bShiftIsDown}.
• L'argument facultatif bShiftIsDown est une valeur booléenne qui indique s'il faut étendre la sélection. Si l'argument n'est
pas défini, il prend par défaut la valeur false.
Valeurs renvoyées
Aucune.
dom.nextParagraph()
Disponibilité
Dreamweaver 3.
Description
Déplace le point d'insertion au début du paragraphe suivant ou saute plusieurs paragraphes si l'argument nTimes est
supérieur à 1.
Arguments
{nTimes}, {bShiftIsDown}
• Facultatif, l'argument nTimes correspond au nombre de paragraphes suivants que le point d'insertion doit sauter. Si cet
argument n'est pas défini, il prend par défaut la valeur 1.
• L'argument bShiftIsDown est une valeur booléenne qui indique s'il faut étendre la sélection. Si cet argument n'est pas
défini, il prend par défaut la valeur false.
Valeurs renvoyées
Aucune.
dom.nextWord()
Disponibilité
Dreamweaver 3.
Description
Déplace le point d'insertion au début du mot suivant ou saute plusieurs mots si l'argument nTimes est supérieur à 1.
Arguments
{nTimes}, {bShiftIsDown}
• Facultatif, l'argument nTimes correspond au nombre de mots suivants que le point d'insertion doit sauter. Si cet argument
n'est pas défini, il prend par défaut la valeur 1.
• L'argument facultatif bShiftIsDown est une valeur booléenne qui indique s'il faut étendre la sélection. Si cet argument
n'est pas défini, il prend par défaut la valeur false.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 127
Guide des API
dom.pageDown()
Disponibilité
Dreamweaver 3.
Description
Déplace le point d'insertion d'une page vers le bas (équivalent à la touche PG. SUIV).
Arguments
{nTimes}, {bShiftIsDown}
• Facultatif, l'argument nTimes correspond au nombre de pages suivantes que le point d'insertion doit sauter. Si cet
argument n'est pas défini, il prend par défaut la valeur 1.
• L'argument facultatif bShiftIsDown est une valeur booléenne qui indique s'il faut étendre la sélection. Si cet argument
n'est pas défini, il prend par défaut la valeur false.
Valeurs renvoyées
Aucune.
dom.pageUp()
Disponibilité
Dreamweaver 3.
Description
Déplace le point d'insertion d'une page vers le haut (équivalent à la touche PG. PREC).
Arguments
{nTimes}, {bShiftIsDown}
• Facultatif, l'argument nTimes correspond au nombre de pages précédentes que le point d'insertion doit sauter. Si cet
argument n'est pas défini, il prend par défaut la valeur 1.
• L'argument facultatif bShiftIsDown est une valeur booléenne qui indique s'il faut étendre la sélection. Si cet argument
n'est pas défini, il prend par défaut la valeur false.
Valeurs renvoyées
Aucune.
dom.previousParagraph()
Disponibilité
Dreamweaver 3.
Description
Déplace le point d'insertion au début du paragraphe précédent ou saute plusieurs paragraphes si l'argument nTimes est
supérieur à 1.
Arguments
{nTimes}, {bShiftIsDown}
• Facultatif, l'argument nTimes correspond au nombre de paragraphes précédents que le point d'insertion doit sauter. Si
cet argument n'est pas défini, il prend par défaut la valeur 1.
• L'argument facultatif bShiftIsDown est une valeur booléenne qui indique s'il faut étendre la sélection. Si cet argument
n'est pas défini, il prend par défaut la valeur false.
ADOBE DREAMWEAVER 9.0 128
Guide des API
Valeurs renvoyées
Aucune.
dom.previousWord()
Disponibilité
Dreamweaver 3.
Description
Déplace le point d'insertion au début du mot précédent ou saute plusieurs mots si l'argument nTimes est supérieur à 1.
Arguments
{nTimes}, {bShiftIsDown}
• Facultatif, l'argument nTimes correspond au nombre de mots précédents que le point d'insertion doit sauter. Si cet
argument n'est pas défini, il prend par défaut la valeur 1.
• L'argument facultatif bShiftIsDown est une valeur booléenne qui indique s'il faut étendre la sélection. Si cet argument
n'est pas défini, il prend par défaut la valeur false.
Valeurs renvoyées
Aucune.
dom.startOfDocument()
Disponibilité
Dreamweaver 3.
Description
Déplace le point d'insertion au début du document (selon le cas, avant le premier contenu visible dans la fenêtre de
document ou avant la balise HTML d'ouverture dans l'inspecteur de code).
Arguments
{bShiftIsDown}.
• L'argument facultatif bShiftIsDown est une valeur booléenne qui indique s'il faut étendre la sélection. Si l'argument n'est
pas défini, il prend par défaut la valeur false.
Valeurs renvoyées
Aucune.
dom.startOfLine()
Disponibilité
Dreamweaver 3.
Description
Déplace le point d'insertion au début de la ligne.
Arguments
{bShiftIsDown}.
• L'argument facultatif bShiftIsDown est une valeur booléenne qui indique s'il faut étendre la sélection. Si l'argument n'est
pas défini, il prend par défaut la valeur false.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 129
Guide des API
dreamweaver.mapKeyCodeToChar()
Disponibilité
Dreamweaver 4.
Description
Convertit un code de touche tel qu'il est indiqué dans le champ keyCode de l'objet événement en caractère. Vous devez
vérifier si le code de touche est une touche spéciale, telle que les touches ORIG, PG. SUIV, etc. S'il ne s'agit pas d'une touche
spéciale, cette méthode peut être utilisée pour traduire le code en code de caractère affichable à l'utilisateur.
Arguments
keyCode.
• L'argument keyCode est le code de touche à traduire en caractère.
Valeurs renvoyées
Renvoie le code de caractère si la correspondance à réussi. Renvoie 0 dans le cas contraire.
Fonctions relatives aux menus
Ces fonctions permettent d'optimiser et de recharger les menus dans Dreamweaver. Les fonctions dreamweaver.getMenuNeedsUpdating() et dreamweaver.notifyMenuUpdated() sont spécialement conçues pour empêcher l'exécution de
routines de mise à jour superflues sur les menus dynamiques intégrés à Dreamweaver. Pour plus d'informations, voir
« dreamweaver.getMenuNeedsUpdating() », page 129 et « dreamweaver.notifyMenuUpdated() », page 129.
dreamweaver.getMenuNeedsUpdating()
Disponibilité
Dreamweaver 3.
Description
Vérifie si le menu spécifié doit être mis à jour.
Arguments
menuId
• L'argument menuId est une chaîne contenant la valeur de l'attribut id de l'élément de menu, tel qu'il est défini dans le
fichier menus.xml.
Valeurs renvoyées
Valeur booléenne qui indique si le menu doit être mis à jour. Cette fonction renvoie la valeur false uniquement si la
fonction dreamweaver.notifyMenuUpdated() a été appelée avec cet argument menuId et si la valeur renvoyée par menuListFunction n'a pas changé. Pour plus d'informations, consultez la section « dreamweaver.notifyMenuUpdated() », page 129.
dreamweaver.notifyMenuUpdated()
Disponibilité
Dreamweaver 3.
Description
Prévient Dreamweaver lorsque le menu spécifié doit être mis à jour.
ADOBE DREAMWEAVER 9.0 130
Guide des API
Arguments
menuId, menuListFunction.
• L'argument menuId est une chaîne contenant la valeur de l'attribut id de l'élément de menu, tel qu'il est défini dans le
fichier menus.xml.
• L'argument menuListFunction doit correspondre à l'une des chaînes suivantes : "dw.cssStylePalette.getStyles()",
"dw.getDocumentDOM().getFrameNames()", "dw.getDocumentDOM().getEditableRegionList", "dw.getBrowserList()", "dw.getRecentFileList()", "dw.getTranslatorList()", "dw.getFontList()", "dw.getDocumentList()", "dw.htmlStylePalette.getStyles()" ou "site.getSites()".
Valeurs renvoyées
Aucune.
dreamweaver.reloadMenus()
Disponibilité
Dreamweaver 3.
Description
Recharge la structure de menus à partir du fichier menus.xml du dossier Configuration.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Fonctions relatives à la fenêtre de résultats
Les fonctions de la fenêtre de résultats vous permettent de dialoguer avec les panneaux intégrés du groupe de panneaux
Résultats ou de créer une fenêtre indépendante contenant des colonnes de données formatées.
Utilisation du groupe de panneaux Résultats intégré
Ces fonctions produisent l'affichage dans le groupe de panneaux Résultats. Le groupe de panneaux Résultats présente des
panneaux à onglets sur les recherches, la validation de la source, les rapports au niveau du site, la vérification de compatibilité avec les navigateurs, le débogage de serveur, les connexions FTP et les vérifications de liens.
Utilisation de panneaux enfants spécifiques
Les panneaux enfants suivants sont des fenêtres de résultats intégrées qui existent toujours dans l'interface Dreamweaver et
auxquelles il est possible d'accéder directement.
•
dreamweaver.resultsPalette.siteReports
•
dreamweaver.resultsPalette.validator
•
dreamweaver.resultsPalette.bcc
Ces panneaux étant des fenêtres de résultats, vous pouvez utiliser les méthodes suivantes, définies pour les fenêtres de
résultats indépendantes :
•
•
•
•
getItem()
getItemCount()
getSelectedItem()
setSelectedItem()
Pour plus d'informations sur l'utilisation des méthodes resWin, consultez la section « Création d'une fenêtre de résultats
indépendante », page 135.
ADOBE DREAMWEAVER 9.0 131
Guide des API
Utilisation du panneau enfant actif
Les fonctions API générales suivantes s'appliquent au panneau enfant actif. Certains panneaux enfants peuvent ignorer
certaines de ces fonctions. Si le panneau enfant actif ne prend pas la fonction en charge, l'appel n'a aucun effet.
dreamweaver.showResults()
Disponibilité
Dreamweaver MX 2004.
Description
Ouvre le panneau flottant de résultats spécifié et sélectionne l'élément.
Remarque : Cette fonction est uniquement prise en charge dans les fenêtres Validation, Vérification de compatibilité avec les
navigateurs et les panneaux Rapports du site du groupe de panneaux de résultats.
Arguments
floaterName, floaterIndex
• L'argument
floaterName est une chaîne indiquant le panneau flottant de résultats à ouvrir. Les valeurs autorisées sont
'validation' ou 'reports'.
• L'argument floaterIndex est un nombre ou une chaîne. Utilisez un nombre pour spécifier l'index d'un élément à sélectionner dans le panneau de résultats. Utilisez une chaîne pour spécifier l'URL d'un document. Dans le cas d'une URL, la
fonction sélectionne le premier élément visible de ce document.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant vérifie la présence d'erreurs au début de la sélection en cours dans le document. Si des erreurs sont
détectées, elles sont affichées dans la fenêtre spécifiée (floaterName) du panneau de résultats. Dans le cas contraire, il ouvre
la fenêtre Vérification de compatibilité avec les navigateurs du panneau de résultats et affiche le premier élément visible du
document.
var offset = dw.getDocumentDOM().source.getSelection()[0];
var errors = dw.getDocumentDOM().source.getValidationErrorsForOffset(offset);
if ( errors && errors.length > 0 )
dw.showResults( errors[0].floaterName, errors[0].floaterIndex );
else
dw.showResults('bcc', dw.getDocumentDOM().URL);
dreamweaver.resultsPalette.siteReports.addResultItem()
Disponibilité
Dreamweaver 4.
Description
Ajoute une nouvelle entrée dans le panneau Rapports du site, en fonction des informations figurant dans le fichier traité par
la fonction processfile().
Cette fonction est uniquement disponible dans le rappel processFile() d'un rapport de site. Pour plus d'informations sur
les rapports de site, consultez la rubrique « Rapports » dans Extension de Dreamweaver.
ADOBE DREAMWEAVER 9.0 132
Guide des API
Arguments
strFilePath, strIcon, strDisplay, strDesc, {iLineNo}, {iStartSel}, {iEndSel}
• L'argument strFilePath est le chemin d'accès complet à l'URL du fichier à traiter.
• L'argument strIcon est le chemin d'accès à l'icône à utiliser. Pour afficher une icône intégrée, utilisez une valeur
comprise entre 1 et 10 plutôt que le chemin d'accès complet à l'icône (utilisez la valeur 0 pour n'afficher aucune icône).
L'illustration ci-dessous indique les icônes correspondant aux chiffres allant de 1 à 10 :
• L'argument strDisplay est la chaîne à afficher à l'utilisateur dans la première colonne de la fenêtre de résultats (généralement le nom de fichier).
• L'argument strDesc est la description qui accompagne l'entrée.
• L'argument iLineNo est le nombre de lignes figurant dans le fichier (facultatif).
• L'argument iStartSel indique le début du décalage dans le fichier (facultatif, mais s'il est présent, il faut également
utiliser l'argument iEndSel).
• L'argument iEndSel indique la fin du décalage dans le fichier (obligatoire si l'argument iStartSel est utilisé).
Valeurs renvoyées
Aucune.
dreamweaver.resultsPalette.clear()
Disponibilité
Dreamweaver MX.
Description
Efface le contenu du panneau actif.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.resultsPalette.canClear() », page 429.
dreamweaver.resultsPalette.Copy()
Disponibilité
Dreamweaver MX.
Description
Envoie un message copié à la fenêtre active (souvent utilisé pour la fenêtre de connexion FTP).
Arguments
Aucun.
ADOBE DREAMWEAVER 9.0 133
Guide des API
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.resultsPalette.canCopy() », page 429.
dreamweaver.resultsPalette.cut()
Disponibilité
Dreamweaver MX.
Description
Envoie un message coupé à la fenêtre active (souvent utilisé pour la fenêtre de connexion FTP).
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.resultsPalette.canCut() », page 429.
dreamweaver.resultsPalette.Paste()
Disponibilité
Dreamweaver MX.
Description
Envoie un message collé à la fenêtre active (souvent utilisé pour la fenêtre de connexion FTP).
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.resultsPalette.canPaste() », page 429.
dreamweaver.resultsPalette.openInBrowser
Disponibilité
Dreamweaver MX.
Description
Envoie un rapport (Rapports de site, Vérification du navigateur cible, Validation et Vérificateur de lien) vers le navigateur
par défaut.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 134
Guide des API
Activateur
Consultez « dreamweaver.resultsPalette.canOpenInBrowser() », page 430.
dreamweaver.resultsPalette.openInEditor()
Disponibilité
Dreamweaver MX.
Description
Saute à la ligne sélectionnée pour les rapports spécifiques (Rapports du site, Vérification du navigateur cible, Validation et
Vérificateur de lien) et ouvre le document dans l'éditeur.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.resultsPalette.canOpenInEditor() », page 430.
dreamweaver.resultsPalette.save()
Disponibilité
Dreamweaver MX.
Description
Ouvre la boîte de dialogue Enregistrer pour une fenêtre qui prend en charge la fonction Enregistrer (Rapports du site,
Vérification du navigateur cible, Validation et Vérificateur de lien).
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.resultsPalette.canSave() », page 430.
dreamweaver.resultsPalette.selectAll()
Disponibilité
Dreamweaver MX.
Description
Envoie une commande Sélectionner tout vers la fenêtre active.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 135
Guide des API
Activateur
Consultez « dreamweaver.resultsPalette.canSelectAll() », page 431.
Création d'une fenêtre de résultats indépendante
La fonction dreamweaver.createResultsWindow() crée une fenêtre de résultats.
dreamweaver.createResultsWindow()
Disponibilité
Dreamweaver 4.
Description
Crée une nouvelle fenêtre de résultats et renvoie une référence d'objet JavaScript à la fenêtre.
Arguments
strName, arrColumns
• L'argument strName est la chaîne à utiliser pour le titre de la fenêtre.
• L'argument arrColumns est un tableau de noms de colonnes à utiliser dans le contrôle de liste.
Valeurs renvoyées
Référence d'objet à la fenêtre créée.
resWin.addItem()
Disponibilité
Dreamweaver 4.
Description
Ajoute un nouvel élément à la fenêtre de résultats.
Remarque : Utilisez uniquement les fenêtres de résultats indépendantes créées à l'aide de
« dreamweaver.createResultsWindow() », page 135. La fonction resWin.addItem() ne peut pas être utilisée avec les fenêtres de
résultats intégrées, notamment avec les fenêtres Validation, Vérifier la compatibilité avec les navigateurs ou Rapports du site.
Arguments
resultWindowObj, strIcon, strDesc, itemData, iStartSel, iEndSel, colNdata
• L'argument resultWindowObj correspond à l'objet renvoyé par la fonction createResultsWindow().
• L'argument strIcon est une chaîne indiquant le chemin d'accès à l'icône à utiliser. Pour afficher une icône intégrée,
utilisez une valeur comprise entre 1 et 10 plutôt que le chemin d'accès complet à l'icône. Utilisez la valeur 0 pour
n'afficher aucune icône. L'illustration ci-dessous indique les icônes correspondant aux chiffres allant de 1 à 10 :
• L'argument strDesc correspond à la description détaillée de l'élément. Indiquez "0" s'il n'y a pas de description.
• L'argument itemData est une chaîne qui peut vous servir à stocker des données particulières relatives à l'élément à ajouter
(numéro de ligne du document, par exemple).
• L'argument iStartSel indique le début du décalage de la sélection dans le fichier. Entrez la valeur null s'il n'y a pas de
décalage.
ADOBE DREAMWEAVER 9.0 136
Guide des API
• L'argument iEndSel indique la fin du décalage de la sélection dans le fichier. Entrez la valeur null s'il n'y a pas de
décalage.
• L'argument colNdata est un tableau de chaînes qui contient les données de chaque colonne (par exemple, tableau de
3 chaînes s'il existe 3 colonnes).
Valeurs renvoyées
Valeur booléenne : true si l'ajout de l'élément a réussi et false dans le cas contraire.
Exemple
L'exemple suivant crée une fenêtre de résultats du nom de resWin dont les colonnes s'intitulent Frodo, Sam et Gollum.
L'appel de la fonction resWin.addItem() ajoute une icône de dossier ainsi que les trois chaînes (msg1, msg2 et msg3) dans les
trois colonnes définies pour la fenêtre.
var resWin = dw.createResultsWindow("Test Window", ["Frodo", "Sam", "Gollum"]);
resWin.addItem(resWin, "3", "Description", null, null, null, ["msg1", "msg2", "msg3"]);
resWin.getItem()
Disponibilité
Dreamweaver 4.
Description
Extrait un tableau d'éléments qui incluent le nom de la commande qui a ajouté l'élément et les mêmes chaînes que celles
transmises à la fonction addItem().
Arguments
itemIndex
• L'argument itemIndex correspond à l'index de l'élément dont les données doivent être extraites.
Valeurs renvoyées
Tableau de chaînes. Le premier élément du tableau correspond au nom de la commande qui a ajouté l'élément ; les autres
éléments correspondent aux mêmes chaînes que celles transmises à la fonction addItem().
resWin.getItemCount()
Disponibilité
Dreamweaver 4.
Description
Extrait le nombre d'éléments contenus dans la liste.
Arguments
Aucun.
Valeurs renvoyées
Le nombre d'éléments contenus dans la liste.
resWin.getSelectedItem()
Disponibilité
Dreamweaver 4.
Description
Extrait l'index de l'élément sélectionné.
ADOBE DREAMWEAVER 9.0 137
Guide des API
Arguments
Aucun.
Valeurs renvoyées
L'index de l'élément sélectionné.
resWin.setButtons()
Disponibilité
Dreamweaver 4.
Description
Définit les boutons spécifiés par l'argument arrButtons.
Arguments
cmdDoc, arrButtons
• L'argument cmdDoc est un objet document représentant la commande utilisée pour appeler la fonction. Les commandes
doivent utiliser le mot-clé this.
• L'argument arrButtons est un tableau de chaînes correspondant au texte du bouton et au code JavaScript à exécuter
lorsque l'utilisateur clique sur le bouton en question. Cet argument fonctionne de la même manière que la fonction
commandButtons() pour les commandes. Vous ne pouvez définir que deux boutons dans la fenêtre.
Valeurs renvoyées
Aucune.
resWin.setCallbackCommands()
Disponibilité
Dreamweaver 4.
Description
Indique à la fenêtre de résultats sur quelles commandes la méthode processFile() doit être appelée. Si cette fonction n'est
pas appelée, la commande qui a créé la fenêtre de résultats est appelée.
Arguments
arrCmdNames.
• L'argument arrCmdNames est un tableau de noms de commandes sur lesquelles appeler la fonction processFile().
Valeurs renvoyées
Aucune.
resWin.setColumnWidths()
Disponibilité
Dreamweaver 4.
Description
Définit la largeur de chaque colonne.
Arguments
arrWidth.
• L'argument arrWidth est un tableau de nombres entiers représentant les largeurs à utiliser pour chaque colonne de la
commande.
ADOBE DREAMWEAVER 9.0 138
Guide des API
Valeurs renvoyées
Aucune.
resWin.setFileList()
Disponibilité
Dreamweaver 4.
Description
Indique à la fenêtre de résultats une liste de fichiers, de dossiers ou des deux sur lesquels appeler un ensemble de
commandes à traiter.
Arguments
arrFilePaths, bRecursive.
• L'argument arrFilePaths est un tableau de chemins de fichier ou de dossier à répéter.
• L'argument bRecursive est une valeur booléenne indiquant si la répétition doit être récurrente (true) ou non (false).
Valeurs renvoyées
Aucune.
resWin.setSelectedItem()
Disponibilité
Dreamweaver 4.
Description
Définit l'élément sélectionné sur l'élément spécifié par itemIndex.
Arguments
itemIndex
• L'index de l'élément à sélectionner contenu dans la liste.
Valeurs renvoyées
L'index de l'ancien élément sélectionné
resWin.setTitle()
Disponibilité
Dreamweaver 4.
Description
Définit le titre de la fenêtre.
Arguments
strTitle.
• L'argument strTitle est le nouveau titre du panneau flottant.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 139
Guide des API
resWin.startProcessing()
Disponibilité
Dreamweaver 4.
Description
Lance le traitement du fichier.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
resWin.stopProcessing()
Disponibilité
Dreamweaver 4.
Description
Arrête le traitement du fichier.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Débogage de serveur
Dreamweaver peut solliciter des fichiers à partir de ColdFusion et afficher la réponse dans son navigateur incorporé.
Lorsque le serveur renvoie la réponse, Dreamweaver recherche un paquet de XML ayant une signature connue, dans la
réponse. Si Dreamweaver trouve XML avec cette signature, il traite XML et affiche les informations contenues dans une
commande d'arborescence. Cette arborescence affiche des informations sur les éléments suivants :
• l'ensemble des modèles, balises personnalisées et fichiers inclus utilisés pour créer la page CFM rendue ;
• les exceptions ;
• les requêtes SQL ;
• les requêtes d'objets ;
• les variables ;
• la plage de tracé.
En outre, le panneau Débogage du serveur peut afficher des données de débogage provenant d'autres modèles de serveur.
Pour configurer Dreamweaver afin que le programme débogue les autres modèles de serveur, utilisez la fonction
dreamweaver.resultsPalette.debugWindow.addDebugContextData().
ADOBE DREAMWEAVER 9.0 140
Guide des API
dreamweaver.resultsPalette.debugWindow.addDebugContextData()
Disponibilité
Dreamweaver MX.
Description
Interprète un fichier XML personnalisé renvoyé du serveur spécifié dans la boîte de dialogue Définition du site. Le contenu
du fichier XML affiche les données de l'arborescence dans le panneau Débogage du serveur, pour que vous puissiez utiliser
le panneau Débogage du serveur en vue d'évaluer le contenu généré par le serveur à partir des différents modèles de serveur.
Arguments
treedata.
• L'argument treedata est la chaîne XML renvoyée par le serveur. La chaîne XML doit utiliser la mise en forme suivante :
server debug node
Noeud racine pour les données XML de débogage
debugnode
Correspond à tous les noeuds
context
Nom de l'élément qui apparaît dans la liste de contexte
icon
Icône à utiliser pour le noeud d'arborescence
name
Nom à afficher
value
Valeur à afficher
timestamp
Uniquement applicable au noeud de contexte
Les chaînes suivantes sont facultatives :
jumptoline
Etablit un lien vers un numéro de ligne spécifique
template
Nom de la partie du fichier de modèle de l'URL
path
Chemin du fichier à partir du serveur
line number
Numéro de ligne dans le fichier
start position
Début du décalage de caractères dans la ligne
end position
Fin du décalage de caractères dans la ligne
ADOBE DREAMWEAVER 9.0 141
Guide des API
Par exemple :
<serverdebuginfo>
<context>
<template><![CDATA[/ooo/master.cfm]]></template>
<path><![CDATA[C:\server\wwwroot\ooo\master.cfm]]></path>
<timestamp><![CDATA[0:0:0.0]]></timestamp>
</context>
<debugnode >
<name><![CDATA[CGI]]></name>
<icon><![CDATA[ServerDebugOutput/ColdFusion/CGIVariables.gif]]></icon>
<debugnode >
<name><![CDATA[Pubs.name.sourceURL]]></name>
<icon><![CDATA[ServerDebugOutput/ColdFusion/Variable.gif]]></icon>
<value><![CDATA[jdbc:Macromedia:sqlserver:
//name.Macromedia.com:1111;databaseName=Pubs]]></value>
</debugnode>
</debugnode>
<debugnode >
<name><![CDATA[Element Snippet is undefined in class
coldfusion.compiler.TagInfoNotFoundException]]></name>
<icon><![CDATA[ServerDebugOutput/ColdFusion/Exception.gif]]></icon>
<jumptoline linenumber="3" startposition="2" endposition="20">
<template><![CDATA[/ooo/master.cfm]]></template>
<path><![CDATA[C:\Neo\wwwroot\ooo\master.cfm]]></path>
</jumptoline>
</debugnode>
</serverdebuginfo>
Valeurs renvoyées
Aucune.
Fonctions de bascule
Ces fonctions permettent d'obtenir et de définir un certain nombre d'options qui peuvent être activées ou désactivées.
dom.getEditNoFramesContent()
Disponibilité
Dreamweaver 3.
Description
Cette fonction obtient l'état en cours de l'option Modifier > Jeu de cadres > Modifier le contenu sans cadres.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le contenu de NOFRAMES est l'affichage actif et false dans le cas contraire.
dom.getHideAllVisualAids()
Disponibilité
Dreamweaver 4.
Description
Cette fonction détermine si les assistances visuelles sont définies comme étant masquées.
ADOBE DREAMWEAVER 9.0 142
Guide des API
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true pour définir les assistances visuelles comme étant masquées et false dans le cas contraire.
dom.getPreventLayerOverlaps()
Disponibilité
Dreamweaver 3.
Description
Cette fonction obtient l'état en cours de l'option Empêcher le chevauchement des calques.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true pour activer l'option Empêcher le chevauchement des calques et false dans le cas contraire.
dom.getShowAutoIndent()
Disponibilité
Dreamweaver 4.
Description
Cette fonction détermine si l'option de retrait automatique est activée dans la fenêtre de document en mode Code.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le retrait automatique est activé et false dans le cas contraire.
dom.getShowFrameBorders()
Disponibilité
Dreamweaver 3.
Description
Cette fonction obtient l'état en cours de l'option Affichage > Bordures de cadre.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si les bordures de cadre sont visibles et false dans le cas contraire.
ADOBE DREAMWEAVER 9.0 143
Guide des API
dom.getShowGrid()
Disponibilité
Dreamweaver 3.
Description
Cette fonction obtient l'état en cours de l'option Affichage > Grille > Afficher.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si la grille est visible et false dans le cas contraire.
dom.getShowHeadView()
Disponibilité
Dreamweaver 3.
Description
Cette fonction obtient l'état en cours de l'option Affichage > Contenu de l'en-tête.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le contenu de l'en-tête est visible et false dans le cas contraire.
dom.getShowInvalidHTML()
Disponibilité
Dreamweaver 4.
Description
Cette fonction détermine si le code HTML incorrect est actuellement en surbrillance dans la fenêtre de document en mode
Code.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le code HTML incorrect est en surbrillance et false dans le cas contraire.
dom.getShowImageMaps()
Disponibilité
Dreamweaver 3.
Description
Cette fonction obtient l'état en cours de l'option Affichage > Cartes graphiques.
Arguments
Aucun.
ADOBE DREAMWEAVER 9.0 144
Guide des API
Valeurs renvoyées
Valeur booléenne : true si les cartes graphiques sont visibles et false dans le cas contraire.
dom.getShowInvisibleElements()
Disponibilité
Dreamweaver 3.
Description
Cette fonction obtient l'état en cours de l'option Affichage > Eléments invisibles.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si les marqueurs d'éléments invisibles sont visibles et false dans le cas contraire.
dom.getShowLayerBorders()
Disponibilité
Dreamweaver 3.
Description
Cette fonction obtient l'état en cours de l'option Affichage > Bordures de calque.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si les bordures de calque sont visibles et false dans le cas contraire.
dom.getShowLineNumbers()
Disponibilité
Dreamweaver 4.
Description
Cette fonction détermine si les numéros de ligne sont affichés en mode Code.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si les numéros de ligne sont affichés et false dans le cas contraire.
dom.getShowRulers()
Disponibilité
Dreamweaver 3.
Description
Cette fonction obtient l'état en cours de l'option Affichage > Règles > Afficher.
ADOBE DREAMWEAVER 9.0 145
Guide des API
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si les règles sont visibles et false dans le cas contraire.
dom.getShowSyntaxColoring()
Disponibilité
Dreamweaver 4.
Description
Cette fonction détermine si l'option de coloration de la syntaxe est activée dans la fenêtre de document en mode Code.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si la coloration de la syntaxe est activée et false dans le cas contraire.
dom.getShowTableBorders()
Disponibilité
Dreamweaver 3.
Description
Cette fonction obtient l'état en cours de l'option Affichage > Bordures de tableau.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si les bordures de tableau sont visibles et false dans le cas contraire.
dom.getShowToolbar()
Disponibilité
Dreamweaver 4.
Description
Cette fonction détermine si la barre d'outils est visible.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si la barre d'outils est affichée et false dans le cas contraire.
ADOBE DREAMWEAVER 9.0 146
Guide des API
dom.getShowTracingImage()
Disponibilité
Dreamweaver 3.
Description
Cette fonction obtient l'état en cours de l'option Affichage > Tracé de l'image > Afficher.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si l'option est activée et false dans le cas contraire.
dom.getShowWordWrap()
Disponibilité
Dreamweaver 4.
Description
Cette fonction détermine si l'option de retour automatique à la ligne est activée dans la fenêtre de document en mode Code.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le retour automatique à la ligne est activé et false dans le cas contraire.
dom.getSnapToGrid()
Disponibilité
Dreamweaver 3.
Description
Cette fonction obtient l'état en cours de l'option Affichage > Grille > Aligner sur.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si l'option Aligner sur la grille est activée et false dans le cas contraire.
dom.setEditNoFramesContent()
Disponibilité
Dreamweaver 3.
Description
Cette fonction active ou désactive l'option Modifier > Jeu de cadres > Modifier le contenu sans cadres.
ADOBE DREAMWEAVER 9.0 147
Guide des API
Arguments
bEditNoFrames.
• L'argument bEditNoFrames est une valeur booléenne : true active l'option Modifier le contenu sans cadres, tandis que
false la désactive.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dom.canEditNoFramesContent() », page 413.
dom.getHideAllVisualAids()
Disponibilité
Dreamweaver 4.
Description
Cette fonction désactive l'affichage de l'ensemble des bordures, cartes graphiques et éléments invisibles, quel que soit leur
paramètre individuel dans le menu Affichage.
Arguments
bSet.
• L'argument bSet est une valeur booléenne : true masque les assistances visuelles tandis que false les affiche.
Valeurs renvoyées
Aucune.
dom.getPreventLayerOverlaps()
Disponibilité
Dreamweaver 3.
Description
Cette fonction active ou désactive l'option Empêcher le chevauchement des calques.
Arguments
bPreventLayerOverlaps.
• L'argument bPreventLayerOverlaps est une valeur booléenne : true active l'option Empêcher le chevauchement des
calques, tandis que false la désactive.
Valeurs renvoyées
Aucune.
dom.getShowFrameBorders()
Disponibilité
Dreamweaver 3.
Description
Cette fonction active ou désactive l'option Affichage > Bordures de cadre.
ADOBE DREAMWEAVER 9.0 148
Guide des API
Arguments
bShowFrameBorders.
• L'argument bShowFrameBorders est une valeur booléenne : true active l'option Bordures de cadre, tandis que false la
désactive.
Valeurs renvoyées
Aucune.
dom.getShowGrid()
Disponibilité
Dreamweaver 3.
Description
Cette fonction active ou désactive l'option Affichage > Grille > Afficher.
Arguments
bShowGrid.
• L'argument bShowGrid est une valeur booléenne : true active l'option Affichage > Grille > Afficher, tandis que false la
désactive.
Valeurs renvoyées
Aucune.
dom.getShowHeadView()
Disponibilité
Dreamweaver 3.
Description
Cette fonction active ou désactive l'option Affichage > Contenu de l'en-tête.
Arguments
bShowHead.
• L'argument bShowHead est une valeur booléenne : true active l'option Contenu de l'en-tête, tandis que false la désactive.
Valeurs renvoyées
Aucune.
dom.getShowInvalidHTML()
Disponibilité
Dreamweaver 4.
Description
Cette fonction active ou désactive la mise en surbrillance du code HTML incorrect dans la fenêtre de document en mode
Code.
Cette fonction détermine si le code HTML incorrect est actuellement en surbrillance.
Arguments
bShow.
• L'argument bShow est une valeur booléenne : true si la mise en surbrillance du code HTML incorrect est activée et false
dans le cas contraire.
ADOBE DREAMWEAVER 9.0 149
Guide des API
Valeurs renvoyées
Aucune.
dom.getShowImageMaps()
Disponibilité
Dreamweaver 3.
Description
Cette fonction active ou désactive l'option Affichage > Cartes graphiques.
Arguments
bShowImageMaps.
• L'argument bShowImageMaps est une valeur booléenne : true active l'option Cartes graphiques, tandis que false la
désactive.
Valeurs renvoyées
Aucune.
dom.getShowInvisibleElements()
Disponibilité
Dreamweaver 3.
Description
Cette fonction active ou désactive l'option Affichage > Eléments invisibles.
Arguments
bViewInvisibleElements.
• L'argument bViewInvisibleElements est une valeur booléenne : true active l'option Eléments invisibles, tandis que
false la désactive.
Valeurs renvoyées
Aucune.
dom.getShowLayerBorders()
Disponibilité
Dreamweaver 3.
Description
Cette fonction active ou désactive l'option Affichage > Bordures de calque.
Arguments
bShowLayerBorders.
• L'argument bShowLayerBorders est une valeur booléenne : true active l'option Bordures de calque, tandis que false la
désactive.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 150
Guide des API
dom.setShowLineNumbers()
Disponibilité
Dreamweaver 4.
Description
Cette fonction affiche ou masque les numéros de ligne dans la fenêtre de document en mode Code.
Arguments
bShow.
• L'argument bShow est une valeur booléenne : true pour afficher les numéros de ligne et false dans le cas contraire.
Valeurs renvoyées
Aucune.
dom.setShowRulers()
Disponibilité
Dreamweaver 3.
Description
Cette fonction active ou désactive l'option Affichage >Règles > Afficher.
Arguments
bShowRulers.
• L'argument bShowRulers est une valeur booléenne : true active l'option Afficher, tandis que false la désactive.
Valeurs renvoyées
Aucune.
dom.setShowSyntaxColoring()
Disponibilité
Dreamweaver 4.
Description
Cette fonction active ou désactive la coloration de la syntaxe dans la fenêtre de document en mode Code.
Arguments
bShow.
• L'argument bShow est une valeur booléenne : true pour afficher la coloration de la syntaxe et false dans le cas contraire.
Valeurs renvoyées
Aucune.
dom.setShowTableBorders()
Disponibilité
Dreamweaver 3.
Description
Cette fonction active ou désactive l'option Affichage > Bordures de tableau.
ADOBE DREAMWEAVER 9.0 151
Guide des API
Arguments
bShowTableBorders.
• L'argument bShowTableBorders est une valeur booléenne : true active l'option Bordures de tableau, tandis que false la
désactive.
Valeurs renvoyées
Aucune.
dom.setShowToolbar()
Disponibilité
Dreamweaver 4.
Description
Cette fonction affiche ou masque la barre d'outils.
Arguments
bShow.
• L'argument bShow est une valeur booléenne : true pour afficher la barre d'outils et false pour la masquer.
Valeurs renvoyées
Aucune.
dom.setShowTracingImage()
Disponibilité
Dreamweaver 3.
Description
Cette fonction active ou désactive l'option Affichage > Tracé de l'image > Afficher.
Arguments
bShowTracingImage.
• L'argument bShowTracingImage est une valeur booléenne : true active l'option Afficher, tandis que false la désactive.
Valeurs renvoyées
Aucune.
dom.setShowWordWrap()
Disponibilité
Dreamweaver 4.
Description
Cette fonction active ou désactive l'option Retour à la ligne dans la fenêtre de document en mode Code.
Arguments
bShow.
• L'argument bShow est une valeur booléenne : true pour effectuer un retour à la ligne et false dans le cas contraire.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 152
Guide des API
dom.setSnapToGrid()
Disponibilité
Dreamweaver 3.
Description
Cette fonction active ou désactive l'option Affichage > Grille > Aligner sur.
Arguments
bSnapToGrid.
• L'argument bSnapToGrid est une valeur booléenne : true active l'option Aligner sur, tandis que false la désactive.
Valeurs renvoyées
Aucune.
dreamweaver.getHideAllFloaters()
Disponibilité
Dreamweaver 3.
Description
Cette fonction obtient l'état en cours de l'option Masquer les panneaux.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si l'option Masquer les panneaux est activée et false si l'option Afficher les panneaux est activée.
dreamweaver.getShowStatusBar()
Disponibilité
Dreamweaver 3.
Description
Cette fonction obtient l'état en cours de l'option Affichage > Barre d'état.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si la barre d'état est visible et false dans le cas contraire.
dreamweaver.htmlInspector.getShowAutoIndent()
Disponibilité
Dreamweaver 4.
Description
Cette fonction détermine si l'option de retrait automatique est activée dans l'inspecteur de code.
Arguments
Aucun.
ADOBE DREAMWEAVER 9.0 153
Guide des API
Valeurs renvoyées
Valeur booléenne : true si le retrait automatique est activé et false dans le cas contraire.
dreamweaver.htmlInspector.getShowInvalidHTML()
Disponibilité
Dreamweaver 4.
Description
Cette fonction détermine si le code HTML incorrect est actuellement en surbrillance dans l'inspecteur de code.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le code HTML incorrect est en surbrillance et false dans le cas contraire.
dreamweaver.htmlInspector.getShowLineNumbers()
Disponibilité
Dreamweaver 4.
Description
Cette fonction détermine si les numéros de ligne sont affichés dans l'inspecteur de code.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si les numéros de ligne sont affichés et false dans le cas contraire.
dreamweaver.htmlInspector.getShowSyntaxColoring()
Disponibilité
Dreamweaver 4.
Description
Cette fonction détermine si l'option de coloration de la syntaxe est activée dans l'inspecteur de code.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si la coloration de la syntaxe est activée et false dans le cas contraire.
dreamweaver.htmlInspector.getShowWordWrap()
Disponibilité
Dreamweaver 4.
Description
Cette fonction détermine si l'option de retour à la ligne est activée dans l'inspecteur de code.
ADOBE DREAMWEAVER 9.0 154
Guide des API
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le retour automatique à la ligne est activé et false dans le cas contraire.
dreamweaver.htmlInspector.setShowAutoIndent()
Disponibilité
Dreamweaver 4.
Description
Cette fonction active ou désactive l'option de retrait automatique dans l'inspecteur de code.
Arguments
bShow.
• L'argument bShow est une valeur booléenne : true active l'option de retrait automatique, tandis que false la désactive.
Valeurs renvoyées
Aucune.
dreamweaver.htmlInspector.setShowInvalidHTML()
Disponibilité
Dreamweaver 4.
Description
Cette fonction active ou désactive la mise en surbrillance du code HTML incorrect dans l'inspecteur de code.
Arguments
bShow.
• L'argument bShow est une valeur booléenne : true pour rendre la mise en surbrillance du code HTML incorrect visible
et false dans le cas contraire.
Valeurs renvoyées
Aucune.
dreamweaver.htmlInspector.setShowLineNumbers()
Disponibilité
Dreamweaver 4.
Description
Cette fonction affiche ou masque les numéros de ligne dans l'inspecteur de code en mode Code.
Arguments
bShow.
• L'argument bShow est une valeur booléenne : true pour afficher les numéros de ligne et false pour les masquer.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 155
Guide des API
dreamweaver.htmlInspector.setShowSyntaxColoring()
Disponibilité
Dreamweaver 4.
Description
Cette fonction active ou désactive la coloration de la syntaxe dans l'inspecteur de code en mode Code.
Arguments
bShow.
• L'argument bShow est une valeur booléenne : true pour rendre la coloration de la syntaxe visible et false dans le cas
contraire.
Valeurs renvoyées
Aucune.
dreamweaver.htmlInspector.setShowWordWrap()
Disponibilité
Dreamweaver 4.
Description
Cette fonction active ou désactive l'option Retour à la ligne dans l'inspecteur de code.
Arguments
bShow.
• L'argument bShow est une valeur booléenne : true active l'option Retour à la ligne, tandis que false la désactive.
Valeurs renvoyées
Aucune.
dreamweaver.setHideAllFloaters()
Disponibilité
Dreamweaver 3.
Description
Cette fonction active l'option Masquer les panneaux ou Afficher les panneaux.
Arguments
bShowFloatingPalettes.
• L'argument bShowFloatingPalettes est une valeur booléenne : true active l'option Masquer les panneaux, tandis que
false active l'option Afficher les panneaux.
Valeurs renvoyées
Aucune.
dreamweaver.setShowStatusBar()
Disponibilité
Dreamweaver 3.
Description
Cette fonction active ou désactive l'option Affichage > Barre d'état.
ADOBE DREAMWEAVER 9.0 156
Guide des API
Arguments
bShowStatusBar.
• L'argument bShowStatusBar est une valeur booléenne : true active l'option Barre d'état, tandis que false la désactive.
Valeurs renvoyées
Aucune.
site.getShowDependents()
Disponibilité
Dreamweaver 3.
Description
Cette fonction obtient l'état en cours de l'option Afficher les fichiers dépendants.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si les fichiers dépendants sont visibles dans la carte du site et false dans le cas contraire.
site.getShowHiddenFiles()
Disponibilité
Dreamweaver 3.
Description
Cette fonction obtient l'état en cours de l'option Afficher les fichiers identifiés comme masqués.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si les fichiers masqués sont visibles dans la carte du site et false dans le cas contraire.
site.getShowPageTitles()
Disponibilité
Dreamweaver 3.
Description
Cette fonction obtient l'état en cours de l'option Afficher les titres des pages.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si les titres de page sont visibles dans la carte du site et false dans le cas contraire.
ADOBE DREAMWEAVER 9.0 157
Guide des API
site.getShowToolTips()
Disponibilité
Dreamweaver 3.
Description
Cette fonction obtient l'état en cours de l'option Info-bulles.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true lorsque les info-bulles sont visibles dans le panneau Site et false dans le cas contraire.
site.setShowDependents()
Disponibilité
Dreamweaver 3.
Description
Cette fonction active ou désactive l'option Afficher les fichiers dépendants dans la carte du site.
Arguments
bShowDependentFiles.
• L'argument bShowDependentFiles est une valeur booléenne : true active l'option Afficher les fichiers dépendants, tandis
que false la désactive.
Valeurs renvoyées
Aucune.
site.setShowHiddenFiles()
Disponibilité
Dreamweaver 3.
Description
Cette fonction active ou désactive l'option Afficher les fichiers identifiés comme masqués dans la carte du site.
Arguments
bShowHiddenFiles.
• L'argument bShowHiddenFiles est une valeur booléenne : true active l'option Afficher les fichiers identifiés comme
masqués, tandis que false la désactive.
Valeurs renvoyées
Aucune.
site.setShowPageTitles()
Disponibilité
Dreamweaver 3.
Description
Cette fonction active ou désactive l'option Afficher les titres des pages dans la carte du site.
ADOBE DREAMWEAVER 9.0 158
Guide des API
Arguments
bShowPageTitles.
• L'argument bShowPageTitles est une valeur booléenne : true active l'option Afficher les titres des pages, tandis que
false la désactive.
Valeurs renvoyées
Aucune.
Activateur
Consultez « site.canShowPageTitles() », page 440.
site.setShowToolTips()
Disponibilité
Dreamweaver 3.
Description
Cette fonction active ou désactive l'option Info-bulles.
Arguments
bShowToolTips.
• L'argument bShowToolTips est une valeur booléenne : true active l'option Info-bulles, tandis que false la désactive.
Valeurs renvoyées
Aucune.
Fonctions relatives aux barres d'outils
Les fonctions JavaScript suivantes vous permettent d'obtenir et de définir l'affichage des barres d'outils et de leurs étiquettes,
de vous procurer les étiquettes des éléments de barre d'outils dans la fenêtre en cours, de positionner les barres d'outils et
d'obtenir leur ID. Pour plus d'informations sur la création ou la modification des barres d'outils, consultez la rubrique
« Barres d'outils » dans l'aide Extension de Dreamweaver.
dom.forceToolbarUpdate()
Disponibilité
Dreamweaver MX 2004.
Description
Oblige les gestionnaires de mise à jour à s'exécuter sur tous les éléments de la barre d'outils spécifiée.
Arguments
toolbarID.
• L'argument toolbarID correspond à l'ID de la barre d'outils dont Dreamweaver doit mettre à jour les éléments.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 159
Guide des API
dom.getShowToolbarIconLabels()
Disponibilité
Dreamweaver MX.
Description
Cette fonction détermine si les étiquettes des boutons sont visibles dans la fenêtre de document active. Dreamweaver affiche
toujours les étiquettes des commandes autres que les boutons si ces étiquettes sont définies.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si les étiquettes des boutons sont visibles dans la fenêtre de document active et false dans le cas
contraire.
Exemple
L'exemple suivant permet d'afficher les étiquettes des boutons :
var dom = dw.getDocumentDom();
if (dom.getShowToolbarIconLabels() == false)
{
dom.setShowToolbarIconLabels(true);
}
dom.getToolbarIdArray()
Disponibilité
Dreamweaver MX.
Description
Cette fonction renvoie un tableau contenant les ID de toutes les barres d'outils de l'application. Utilisez la fonction
dom.getToolbarIdArray() pour désactiver toutes les barres d'outils et pouvoir ainsi les repositionner en ne rendant visibles
que certaines d'entre elles.
Arguments
Aucun.
Valeurs renvoyées
Tableau de tous les ID de barre d'outils.
Exemple
L'exemple suivant stocke le tableau des ID de barre d'outils dans la variable tb_ids :
var tb_ids = new Array();
tb_ids = dom.getToolbarIdArray();
dom.getToolbarItemValue()
Disponibilité
Dreamweaver MX 2004.
Description
Obtient la valeur de l'élément de barre d'outils spécifié.
ADOBE DREAMWEAVER 9.0 160
Guide des API
Arguments
toolbarID, itemID.
• L'argument toolbarID est une chaîne indiquant l'ID de la barre d'outils contenant l'élément pour lequel vous souhaitez
obtenir une valeur.
• L'argument itemID est une chaîne qui indique l'ID de l'élément pour lequel vous souhaitez obtenir une valeur.
Valeurs renvoyées
Une chaîne représentant la valeur de l'élément de barre d'outils.
Exemple
L'exemple de fonction receiveArguments() suivant figure dans une commande de barre d'outils qui régit le comportement
d'un champ de texte Size ; il obtient la valeur du champ Size sous la forme d'un argument, puis lit la valeur du champ Units
afin de générer une valeur valide pour la fonction de propriété CSS font-size :
receiveArguments(newSize){
var dom = dw.getDocumentDOM();
if (newSize != ""){
dom.applyFontMarkupAsStyle('font-size', newSize +
dom.getToolbarItemValue("DW_Toolbar_Text","DW_Text_Units"));
}
else{
dom.removeFontMarkupAsStyle('font-size');
}
}
dom.getToolbarLabel()
Disponibilité
Dreamweaver MX.
Description
Cette fonction obtient l'étiquette de la barre d'outils spécifiée. Utilisez la fonction dom.getToolbarLabel() pour les menus
qui affichent ou masquent des barres d'outils.
Arguments
toolbar_id
• L'argument toolbar_id est l'ID de la barre d'outils, qui correspond à la valeur de l'attribut ID de la balise toolbar définie
dans le fichier toolbars.xml.
Valeurs renvoyées
La chaîne de nom label qui est affectée à la balise toolbar comme attribut.
Exemple
L'exemple suivant stocke l'étiquette de myEditbar dans la variable label :
var label = dom.getToolbarLabel("myEditbar");
dom.getToolbarVisibility()
Disponibilité
Dreamweaver MX.
Description
Cette fonction renvoie une valeur booléenne qui indique si la barre d'outils spécifiée dans l'argument toolbar_id est visible.
ADOBE DREAMWEAVER 9.0 161
Guide des API
Arguments
toolbar_id
• L'argument toolbar_id est la chaîne d'ID affectée à la barre d'outils.
Valeurs renvoyées
Valeur booléenne : true si la barre d'outils est visible et false si la barre d'outils n'est pas visible ou n'existe pas.
Exemple
L'exemple suivant vérifie si la barre d'outils myEditbar est visible dans la fenêtre de document, puis stocke cette valeur dans
la variable retval :
var retval = dom.getToolbarVisibility("myEditbar");
return retval;
dom.setToolbarItemAttribute()
Disponibilité
Dreamweaver MX 2004.
Description
Modifie une valeur parmi les trois attributs image ou l'attribut tooltip d'un élément de la barre d'outils.
Arguments
toolbarID, toolbarItemId, attrName, attrValue
• L'argument
toolbarID est une chaîne qui indique l'ID de la barre d'outils.
• L'argument toolbarItemId est une chaîne qui indique l'ID de l'élément de la barre d'outils.
• L'argument attrName est une chaîne qui indique le nom de l'attribut à définir. Les valeurs autorisées sont 'image',
'overImage', 'disabledImage' et 'tooltip'.
• L'argument attrValue est une chaîne qui indique la valeur à définir.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant appelle dom.setToolbarItemAttribute() trois fois pour définir les attributs image, imageOver et
tooltip de l'élément MyButton sur la barre d'outils portant l'ID DW_Toolbar_Main :
var dom = dw.getDocumentDOM();
dom.setToolbarItemAttribute('DW_Toolbar_Main', 'MyButton', 'image',
'Toolbars/imgs/newimage.gif');
dom.setToolbarItemAttribute('DW_Toolbar_Main', 'MyButton', 'imageOver',
'Toolbars/imgs/newimageOver.gif');
dom.setToolbarItemAttribute('DW_Toolbar_Main', 'MyButton', 'tooltip', 'One fine button');
dom.setShowToolbarIconLabels()
Disponibilité
Dreamweaver MX.
Description
Cette fonction indique à Dreamweaver d'afficher les étiquettes des boutons comportant des étiquettes. Dreamweaver
affiche toujours les étiquettes des commandes autres que les boutons, si ces étiquettes sont définies.
ADOBE DREAMWEAVER 9.0 162
Guide des API
Arguments
bShow.
• L'argument bShow est une valeur booléenne : true pour afficher les étiquettes des boutons et false dans le cas contraire.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant indique à Dreamweaver d'afficher les étiquettes des boutons sur les barres d'outils :
dom.setShowToolbarIconLabels(true);
dom.setToolbarPosition()
Disponibilité
Dreamweaver MX.
Description
Cette fonction déplace la barre d'outils spécifiée à la position indiquée.
Remarque : Il est impossible de déterminer la position actuelle d'une barre d'outils.
Arguments
toolbar_id, position, relative_to
• L'argument toolbar_id est l'ID de la barre d'outils, qui correspond à la valeur de l'attribut ID de la balise toolbar définie
dans le fichier toolbars.xml.
• L'argument position indique l'endroit où Dreamweaver place la barre d'outils par rapport aux autres barres d'outils. Les
valeurs possibles de l'argument position sont décrites dans la liste suivante :
•
top correspond à la position par défaut. La barre d'outils apparaît en haut de la fenêtre de document.
•
below affiche la barre d'outils au début de la ligne qui se trouve juste en dessous de la barre d'outils spécifiée dans
l'argument relative_to. Dreamweaver indique une erreur si la barre d'outils ne trouve pas la barre d'outils spécifiée dans
l'argument relative_to.
•
floating affiche la barre d'outils au-dessus du document, en mode flottant. Dreamweaver place automatiquement la
barre d'outils de sorte qu'elle soit décalée par rapport aux autres barres d'outils flottantes. Sur Macintosh, floating est
traité de la même façon que top.
•
relative_to="toolbar_id" est requis si position indique below. Dans les autres cas, cet argument est ignoré. Indique
l'ID de la barre d'outils en dessous de laquelle cette barre d'outils doit être placée.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant place myEditbar en dessous de la barre d'outils myPicturebar :
dom.setToolbarPosition("myEditbar", "below", "myPicturebar");
dom.setToolbarVisibility()
Disponibilité
Dreamweaver MX.
Description
Cette fonction affiche ou masque la barre d'outils spécifiée.
ADOBE DREAMWEAVER 9.0 163
Guide des API
Arguments
toolbar_id, bShow
• L'argument toolbar_id est l'ID de la barre d'outils, qui correspond à la valeur de l'attribut ID de la balise toolbar définie
dans le fichier toolbars.xml.
• L'argument bShow est une valeur booléenne qui indique si la barre d'outils doit être affichée ou masquée. Si bShow a pour
valeur true, la fonction dom.setToolbarVisibility() rend la barre d'outils visible. Si bShow a pour valeur false, la
fonction dom.setToolbarVisibility() rend la barre d'outils invisible.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant vérifie si la barre d'outils myEditbar est visible dans la fenêtre de document. Si ce n'est pas le cas, il
l'affiche :
var dom = dw.getDocumentDOM();
if(dom != null && dom.getToolbarVisibility("myEditbar") == false)
{
dom.setToolbarVisibility("myEditbar", true);
{
Fonctions relatives aux fenêtres
Ces fonctions permettent d'agir sur la fenêtre de document et sur les panneaux flottants. Elles permettent d'afficher et de
masquer les panneaux flottants, de déterminer la partie active de la fenêtre de document et de définir le document actif.
Pour les opérations relatives au panneau Site, consultez la section « Fonctions relatives aux sites », page 184.
Remarque : Certaines fonctions de cette section fonctionnent uniquement sous Windows. Leur description indique si tel est le
cas.
dom.getFocus()
Disponibilité
Dreamweaver 3.
Description
Cette fonction détermine quelle partie du document est actuellement active.
Arguments
Aucun.
Valeurs renvoyées
L'une des chaînes suivantes :
• la chaîne "head" si la zone HEAD est active ;
• la chaîne "body" si la zone BODY ou NOFRAMES est active ;
• la chaîne "frameset" si un jeu de cadres ou l'un des cadres qui le composent est sélectionné ;
• la chaîne "none" si la zone active ne figure pas dans le document (si elle se trouve dans l'inspecteur Propriétés ou dans
un autre panneau flottant, par exemple).
ADOBE DREAMWEAVER 9.0 164
Guide des API
dom.getView()
Disponibilité
Dreamweaver 4.
Description
Cette fonction détermine quel mode est visible.
Arguments
Aucun.
Valeurs renvoyées
"design", "code" ou "split", selon le mode d'affichage visible.
dom.getWindowTitle()
Disponibilité
Dreamweaver 3.
Description
Cette fonction obtient le titre de la fenêtre contenant le document.
Arguments
Aucun.
Valeurs renvoyées
Chaîne contenant le texte qui apparaît entre les balises TITLE du document, ou rien si le document ne figure pas dans une
fenêtre ouverte.
dom.setView()
Disponibilité
Dreamweaver 4.
Description
Cette fonction affiche ou masque le mode Création ou Code pour produire un affichage contenant uniquement le mode
Création ou Code ou les deux.
Arguments
viewString.
• L'argument viewString correspond au mode à afficher ; il doit avoir l'une des valeurs suivantes : "design", "code" ou
"split".
Valeurs renvoyées
Aucune.
dreamweaver.bringAttentionToFloater()
Disponibilité
Dreamweaver MX.
Description
Place au premier plan le panneau ou l'inspecteur spécifié et attire l'attention sur cet élément en le faisant clignoter (fonctionnalité légèrement différente de dw.toggleFloater()).
ADOBE DREAMWEAVER 9.0 165
Guide des API
Arguments
floaterName.
• L'argument floaterName correspond au nom de la fenêtre, du panneau ou de l'inspecteur.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant ouvre le panneau Actifs et le fait clignoter :
dw.bringAttentionToFloater("library");
dreamweaver.cascade()
Disponibilité
Dreamweaver MX (Windows uniquement), Dreamweaver 8 (prise en charge supplémentaire pour Macintosh).
Description
Affiche en cascade les fenêtres de document en commençant dans l'angle supérieur gauche et en décalant légèrement
chaque fenêtre par rapport à la précédente.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant affiche les documents ouverts en cascade :
dw.cascade()
dreamweaver.getActiveWindow()
Disponibilité
Dreamweaver 3.
Description
Cette fonction obtient le document figurant dans la fenêtre active.
Arguments
Aucun.
Valeurs renvoyées
Objet document correspondant au document qui figure dans la fenêtre active ou, si le document figure dans un cadre, objet
document correspondant au jeu de cadres.
dreamweaver.getDocumentList()
Disponibilité
Dreamweaver 3.
Description
Cette fonction renvoie la liste de tous les documents ouverts.
ADOBE DREAMWEAVER 9.0 166
Guide des API
Arguments
Aucun.
Valeurs renvoyées
Tableau d'objets document, chacun correspondant à une fenêtre de document ouverte. Si une fenêtre de document contient
un jeu de cadres, l'objet document désigne le jeu de cadres et non le contenu des cadres.
dreamweaver.getFloaterVisibility()
Disponibilité
Dreamweaver 3.
Description
Cette fonction vérifie si le panneau ou l'inspecteur spécifié est visible.
Arguments
floaterName.
• L'argument floaterName est le nom du panneau flottant. Si floaterName ne correspond à aucun nom de panneau
intégré, Dreamweaver recherche dans le dossier Configuration/Floaters un fichier appelé floaterName.htm dans lequel
floaterName correspond au nom d'un panneau flottant.
Les valeurs de floaterName pour les panneaux Dreamweaver intégrés sont les chaînes se trouvant à droite des noms de
panneaux dans la liste suivante :
Actifs = "assets"
Comportements = "behaviors"
Liaisons = "data bindings"
Inspecteur de code = "html"
Composants = "server components"
Styles CSS = "css styles"
Cadres = "frames"
Historique = "history"
Barre Insertion = "objects"
Calques = "layers"
Bibliothèque = "library"
Vérificateur de lien (Résultats) = "linkchecker"
Propriétés = "properties"
Référence = "reference"
Rapports (Résultats) = "reports"
Recherche (Résultats) = "search"
Inspecteur de sélections = "selection inspector"
Comportements de serveur = "server behaviors"
Site = "site"
Fichiers du site = "site files"
Carte du site = "site map"
ADOBE DREAMWEAVER 9.0 167
Guide des API
Fragments de code = "snippets"
Vérification de la compatibilité avec les navigateurs = "bcc"
Validation (Résultats) = "validation"
Valeurs renvoyées
Valeur booléenne : true si le panneau flottant est visible et se trouve au premier plan, false si ce n'est pas le cas ou que
Dreamweaver ne trouve pas de panneau flottant nommé floaterName.
dreamweaver.getFocus()
Disponibilité
Dreamweaver 4.
Description
Cette fonction détermine la partie de l'application actuellement active.
Arguments
bAllowFloaters.
• L'argument bAllowFloaters est une valeur booléenne : true si la fonction doit renvoyer le nom du panneau flottant (si
un panneau flottant est actif) et false dans le cas contraire.
Valeurs renvoyées
L'une des chaînes suivantes :
• la chaîne "document" si la fenêtre de document est active ;
• la chaîne "site" si le panneau Site est actif ;
• la chaîne "textView" si le mode Texte est actif ;
• la chaîne "html" si l'inspecteur de code est actif ;
• la chaîne floaterName, si bAllowFloaters a pour valeur true et si un panneau flottant est actif, floaterName correspondant à "objects", "properties", "launcher", "library", "css
"timelines", "layers", "frames", "templates" ou "history" ;
styles", "html styles", "behaviors",
• la chaîne "none" (Macintosh) si aucune fenêtre de document ni le panneau Site ne sont ouverts.
dreamweaver.getPrimaryView()
Disponibilité
Dreamweaver 4.
Description
Cette fonction détermine le mode d'affichage défini comme mode principal (au premier plan).
Arguments
Aucun.
Valeurs renvoyées
Les chaînes "design" ou "code", selon le mode visible ou le volet situé au premier plan dans un affichage à deux volets.
ADOBE DREAMWEAVER 9.0 168
Guide des API
dreamweaver.getSnapDistance()
Disponibilité
Dreamweaver 4.
Description
Cette fonction renvoie la distance d'alignement en pixels.
Arguments
Aucun.
Valeurs renvoyées
Nombre entier représentant la distance d'alignement en pixels. La distance par défaut est 10 pixels ; 0 indique que la
fonction d'alignement est désactivée.
dreamweaver.minimizeRestoreAll()
Disponibilité
Dreamweaver 4.
Description
Cette fonction réduit en icône ou restaure toutes les fenêtres dans Dreamweaver.
Arguments
bMinimize
• L'argument bMinimize est une valeur booléenne : true pour réduire les fenêtres en icônes et false pour les restaurer.
Valeurs renvoyées
Aucune.
dreamweaver.getActiveWindow()
Disponibilité
Dreamweaver 3.
Description
Cette fonction active la fenêtre contenant le document spécifié.
Arguments
documentObject, {bActivateFrame}
• L'argument documentObject correspond à l'objet situé à la racine de l'arborescence DOM d'un document (c'est-à-dire la
valeur renvoyée par la fonction dreamweaver.getDocumentDOM()).
• Facultatif, l'argument bActivateFrame n'est applicable que lorsque documentObject se trouve à l'intérieur d'un jeu de
cadres. L'argument bActivateFrame est une valeur booléenne : true active le cadre contenant le document ainsi que la
fenêtre contenant le jeu de cadres et false les désactive.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 169
Guide des API
dreamweaver.setFloaterVisibility()
Disponibilité
Dreamweaver 3.
Description
Cette fonction indique s'il faut rendre visible un panneau flottant ou un inspecteur spécifique.
Arguments
floaterName, bIsVisible
• L'argument floaterName est le nom du panneau flottant. Si floaterName ne correspond à aucun nom de panneau
intégré, Dreamweaver recherche dans le dossier Configuration/Floaters un fichier appelé floaterName.htm dans lequel
floaterName correspond au nom d'un panneau flottant. Si Dreamweaver ne trouve aucun panneau flottant portant le
nom floaterName, cette fonction n'a aucun effet.
Les valeurs de floaterName pour les panneaux Dreamweaver intégrés sont les chaînes se trouvant à droite des noms de
panneaux dans la liste suivante :
Actifs = "assets"
Comportements = "behaviors"
Liaisons = "data sources"
Inspecteur de code = "html"
Composants = "server components"
Styles CSS = "css styles"
Cadres = "frames"
Historique = "history"
Styles HTML = "html styles"
Barre Insertion = "objects"
Calques = "layers"
Bibliothèque = "library"
Vérificateur de lien (Résultats) = "linkchecker"
Propriétés = "properties"
Référence = "reference"
Rapports (Résultats) = "reports"
Recherche (Résultats) = "search"
Comportements de serveur = "server behaviors"
Site = "site"
Fichiers du site = "site files"
Carte du site = "site map"
Fragments de code = "snippets"
Inspecteur de balises = "tag inspector"
Vérification de la compatibilité avec les navigateurs = "bcc"
Modèles = "templates"
Validation (Résultats) = "validation"
L'argument bIsVisible est une valeur booléenne indiquant si le panneau flottant doit être visible.
ADOBE DREAMWEAVER 9.0 170
Guide des API
Valeurs renvoyées
Aucune.
dreamweaver.setPrimaryView()
Disponibilité
Dreamweaver 4.
Description
Cette fonction affiche le mode spécifié en haut de la fenêtre de document.
Arguments
viewString.
• L'argument viewString correspond au mode à afficher en haut de la fenêtre de document ; il peut avoir l'une des valeurs
suivantes : "design" ou "code".
Valeurs renvoyées
Aucune.
dreamweaver.setSnapDistance()
Disponibilité
Dreamweaver 4.
Description
Cette fonction définit la distance d'alignement en pixels.
Arguments
snapDistance.
• L'argument snapDistance est un nombre entier représentant la distance d'alignement en pixels. La valeur par défaut est
10 pixels. Saisissez 0 pour désactiver la fonction d'alignement.
Valeurs renvoyées
Aucune.
dreamweaver.showProperties()
Disponibilité
Dreamweaver 3.
Description
Cette fonction rend l'inspecteur Propriétés visible et l'active.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 171
Guide des API
dreamweaver.tileHorizontally()
Disponibilité
Dreamweaver MX (Windows uniquement), Dreamweaver 8 (prise en charge supplémentaire pour Macintosh).
Description
Organise les fenêtres de document en mosaïque horizontale en les plaçant les unes à côté des autres sans qu'elles ne se
chevauchent. Ce processus revient au partage vertical de l'espace de travail.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant affiche les documents ouverts en mosaïque horizontale :
dw.tileHorizontally()
dreamweaver.tileVertically()
Disponibilité
Dreamweaver MX (Windows uniquement), Dreamweaver 8 (prise en charge supplémentaire pour Macintosh).
Description
Organise les fenêtres de documents en mosaïque verticale en les plaçant les unes derrière les autres sans qu'elles ne se
chevauchent. Ce processus revient au partage horizontal de l'espace de travail.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant affiche les documents ouverts en mosaïque verticale :
dw.tileVertically()
dreamweaver.toggleFloater()
Disponibilité
Dreamweaver 3.
Description
Cette fonction affiche, masque ou place au premier plan le panneau ou l'inspecteur spécifié.
Remarque : Cette fonction n'a de sens que dans le fichier menus.xml. Pour afficher, placer au premier plan ou masquer un
panneau flottant, utilisez la fonction dw.setFloaterVisibility().
ADOBE DREAMWEAVER 9.0 172
Guide des API
Arguments
floaterName.
• L'argument floaterName correspond au nom de la fenêtre. Si le nom de la fenêtre flottante est reference, l'état de
visibilité du panneau Référence peut être mis à jour par l'utilisateur dans le mode Code. Tous les autres panneaux effectuent un suivi continu de la sélection, mais le panneau Référence n'analyse la sélection dans le mode Code que lorsque
l'utilisateur lance un suivi.
Valeurs renvoyées
Aucune.
dreamweaver.updateReference()
Disponibilité
Dreamweaver 4.
Description
Cette fonction met à jour le panneau flottant Référence. Si le panneau flottant Référence n'est pas visible, dw.updateReference() l'affiche et le met à jour.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Fonctions relatives au fractionnement des codes
Ces fonctions vous permettent de fractionner et d'étendre visuellement des codes. Vous pouvez fractionner ou étendre des
sélections arbitraires de codes, ou des fragments situés entre les balises d'ouverture et de fermeture. Bien que les fonctions
de fractionnement de code existent dans le dom comme dans htmlInspector, les plages réduites sont identiques dans le
mode Code et dans Cold Inspector.
dom.collapseFullTag()
Disponibilité
Dreamweaver 8.
Description
Cette fonction détermine si l'élément sélectionné se trouve dans une seule paire de balises d'ouverture et de fermeture ou
s'il contient une seule paire de balises d'ouverture et de fermeture en mode Code. Le cas échéant, la fonction fractionne le
fragment de code qui commence immédiatement avant la balise d'ouverture et se termine après la balise de fermeture ; dans
le cas contraire, elle ne fait rien.
Arguments
allowCodeFragmentAdjustment
• L'argument obligatoire allowCodeFragmentAdjustment est une valeur booléenne. Si défini sur true, cet argument n'a
aucun effet actuellement ou bien le même effet que la valeur false. Si défini sur false, Dreamweaver fractionne le code
qui commence immédiatement avant la balise d'ouverture et se termine immédiatement après la balise de fermeture, sans
le modifier
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 173
Guide des API
Exemple
L'exemple suivant fractionne le fragment de code qui commence juste avant la balise d'ouverture et se termine juste après
la balise de fermeture dans la sélection en cours du mode Code :
var currentDOM = dw.getDocumentDOM();
currentDOM.collapseFullTag(false);
dom.collapseFullTagInverse()
Disponibilité
Dreamweaver 8.
Description
Cette fonction détermine si l'élément sélectionné se trouve dans une seule paire de balises d'ouverture et de fermeture ou
s'il contient une seule paire de balises d'ouverture et de fermeture en mode Code. Le cas échéant, elle fractionne le code qui
précède la balise d'ouverture et le code qui suit la balise de fermeture ; dans le cas contraire, elle ne fait rien.
Arguments
allowAdjustmentOfCodeFragments
• L'argument obligatoire allowAdjustmentOfCodeFragments est une valeur booléenne. Si défini sur true, Dreamweaver
ajuste les limites du code situé avant la balise de d'ouverture et du code situé après la balise de fermeture pour effectuer
un fractionnement intelligent qui conserve la mise en retrait et l'espacement en cours. Si défini sur false, Dreamweaver
fractionne les fragments de code qui se trouvent avant la balise d'ouverture et après la balise de fermeture, exactement
comme indiqué par la sélection.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant ajuste les limites du code avant la balise d'ouverture et après la balise de fermeture pour effectuer un
fractionnement intelligent qui conserve la mise en retrait et l'espacement :
var currentDOM = dw.getDocumentDOM();
currentDOM.collapseFullTagInverse(true);
dom.collapseSelectedCodeFragment()
Disponibilité
Dreamweaver 8.
Description
Fractionne le code sélectionné en mode Code. Si la sélection est déjà réduite, cette fonction ne fait rien.
Arguments
allowCodeFragmentAdjustment
•
allowCodeFragmentAdjustment est une valeur booléenne obligatoire. Si défini sur true, Dreamweaver modifie les limites
de la sélection en cours pour effectuer un fractionnement intelligent et conserver la mise en retrait et l'espacement en
cours. Si défini sur false, Dreamweaver fractionne le fragment de code actuellement sélectionné, exactement comme
indiqué par la sélection.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 174
Guide des API
Exemple
L'exemple suivant fractionne le fragment de code sélectionné en mode Code sans le modifier.
var currentDOM = dw.getDocumentDOM();
currentDOM.collapseSelectedCodeFragment(false);
dom.collapseSelectedCodeFragmentInverse()
Disponibilité
Dreamweaver 8.
Description
Fractionne toutes les portions de code avant et après le code sélectionné en mode Code.
Arguments
allowAdjustmentOfCodeFragments
• L'argument obligatoire allowAdjustmentOfCodeFragments est une valeur booléenne. Si défini sur true, Dreamweaver
ajuste les limites du code situé avant et après la sélection en cours pour effectuer un fractionnement intelligent qui
conserve la mise en retrait et l'espacement en cours. Si défini sur false, Dreamweaver fractionne le fragment de code
exactement comme indiqué par la sélection.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant modifie puis fractionne toutes les portions de code situées avant et après le code sélectionné en mode
Code :
var currentDOM = dw.getDocumentDOM();
currentDOM.collapseSelectedCodeFragmentInverse(true);
dom.expandAllCodeFragments()
Disponibilité
Dreamweaver 8.
Description
Etend tous les fragments de code réduits en mode Code, y compris les fragments de code réduits imbriqués.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant étend toutes les portions de code réduit en mode Code.
var currentDOM = dw.getDocumentDOM();
currentDOM.expandAllCodeFragments();
ADOBE DREAMWEAVER 9.0 175
Guide des API
dom.expandSelectedCodeFragments()
Disponibilité
Dreamweaver 8.
Description
Etend tous les fragments de code réduits dans la sélection en cours en mode Code. Si la sélection est déjà étendue, cette
fonction ne fait rien.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant étend toutes les portions de code réduit dans la sélection en cours en mode Code.
var currentDOM = dw.getDocumentDOM();
currentDOM.expandSelectedCodeFragments();
dreamweaver.htmlInspector.collapseFullTag()
Disponibilité
Dreamweaver 8.
Description
Cette fonction détermine si l'élément sélectionné se trouve dans une seule paire de balises d'ouverture et de fermeture ou
s'il contient une seule paire de balises d'ouverture et de fermeture dans l'inspecteur de code. Le cas échéant, la fonction
fractionne le fragment de code qui commence immédiatement avant la balise d'ouverture et se termine après la balise de
fermeture ; dans le cas contraire, elle ne fait rien.
Arguments
allowACodeFragmentAdjustment
• L'argument obligatoire allowCodeFragmentAdjustment est une valeur booléenne. Si défini sur true, cet argument n'a
aucun effet actuellement ou bien le même effet que la valeur false. Si défini sur false, Dreamweaver fractionne le code
qui commence immédiatement avant la balise d'ouverture et se termine immédiatement après la balise de fermeture, sans
le modifier
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant fractionne le fragment de code qui commence juste avant la balise d'ouverture et se termine juste après
la balise de fermeture dans la sélection en cours de l'inspecteur de code :
dreamweaver.htmlInspector.collapseFullTag(false);
ADOBE DREAMWEAVER 9.0 176
Guide des API
dreamweaver.htmlInspector.collapseFullTagInverse()
Disponibilité
Dreamweaver 8.
Description
Cette fonction détermine si l'élément sélectionné se trouve dans une seule paire de balises d'ouverture et de fermeture ou
s'il contient une seule paire de balises d'ouverture et de fermeture dans l'inspecteur de code. Le cas échéant, elle fractionne
le code situé avant la balise d'ouverture et le code situé après la balise de fermeture ; dans le cas contraire, elle ne fait rien.
Arguments
allowAdjustmentOfCodeFragments
• L'argument obligatoire allowAdjustmentOfCodeFragments est une valeur booléenne. Si défini sur true, Dreamweaver
ajuste les limites du code situé avant la balise de d'ouverture et du code situé après la balise de fermeture pour effectuer
un fractionnement intelligent qui conserve la mise en retrait et l'espacement existants. Si défini sur false, Dreamweaver
fractionne le code situé avant la balise d'ouverture et le code situé après la balise de fermeture, sans le modifier.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant effectue un fractionnement intelligent sur les sections de code qui apparaissent avant la balise d'ouverture
et après la balise de fermeture de la sélection en cours :
dreamweaver.htmlInspector.collapseFullTagInverse(true);
dreamweaver.htmlInspector.collapseSelectedCodeFragment()
Disponibilité
Dreamweaver 8.
Description
Fractionne le code sélectionné dans l'inspecteur de code. Si la sélection est déjà réduite, cette fonction ne fait rien.
Arguments
allowCodeFragmentAdjustment
•
allowCodeFragmentAdjustment est une valeur booléenne obligatoire. Si défini sur true, Dreamweaver modifie la
sélection en cours pour effectuer un fractionnement intelligent et conserver la mise en retrait et l'espacement existants. Si
défini sur false, Dreamweaver fractionne le fragment de code actuellement sélectionné, exactement comme indiqué par
la sélection.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant modifie puis fractionne le code sélectionné dans l'inspecteur de code.
dreamweaver.htmlInspector.collapseSelectedCodeFragment(true);
ADOBE DREAMWEAVER 9.0 177
Guide des API
dreamweaver.htmlInspector.collapseSelectedCodeFragmentInverse()
Disponibilité
Dreamweaver 8.
Description
Cette fonction fractionne toutes les portions de code avant et après le code sélectionné dans l'inspecteur de code. Si la
sélection est déjà réduite, cette fonction ne fait rien.
Arguments
allowAdjustmentOfCodeFragments
• L'argument obligatoire allowAdjustmentOfCodeFragments est une valeur booléenne. Si défini sur true, Dreamweaver
ajuste les limites des sections de code situé avant et après la sélection en cours pour effectuer un fractionnement intelligent
qui conserve la mise en retrait et l'espacement en cours. Si défini sur false, Dreamweaver fractionne les sections de code
exactement comme indiqué par la sélection.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant fractionne toutes les portions de code avant et après le code sélectionné dans l'inspecteur de code,
exactement comme indiqué par la sélection.
dreamweaver.htmlInspector.collapseSelectedCodeFragmentInverse(false);
dreamweaver.htmlInspector.expandAllCodeFragments()
Disponibilité
Dreamweaver 8.
Description
Etend tous les fragments de code réduits dans l'inspecteur de code, y compris les fragments de code réduits imbriqués.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant étend toutes les portions de code réduit dans l'inspecteur de code.
dreamweaver.htmlInspector.expandAllCodeFragments();
dreamweaver.htmlInspector.expandSelectedCodeFragments()
Disponibilité
Dreamweaver 8.
Description
Etend tous les fragments de code réduits dans la sélection en cours de l'inspecteur de code. Si la sélection est déjà étendue,
cette fonction ne fait rien.
Arguments
Aucun.
ADOBE DREAMWEAVER 9.0 178
Guide des API
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant étend toutes les portions de code réduit dans la sélection en cours de l'inspecteur de code.
dreamweaver.htmlInspector.expandSelectedCodeFragments();
Fonctions relatives aux barres d'outils du mode Code
Ces fonctions permettent d'insérer du texte, de supprimer des commentaires, d'afficher ou de masquer les caractères
spéciaux utilisés pour les espaces blancs en mode Code et d'obtenir le chemin d'accès du document actif.
Remarque : Deux barres d'outils Codage différentes sont proposées : une pour le mode Code et l'autre pour l'inspecteur de code.
Les deux sont personnalisées dans le ficher Configuration/Toolbars/toolbars.xml.
dom.getOpenPathName()
Disponibilité
Dreamweaver 8.
Description
Cette fonction obtient le chemin de fichier absolu du document ouvert.
Arguments
Aucun.
Valeurs renvoyées
Chaîne qui correspond au chemin de fichier absolu du document ouvert.
Exemple
L'exemple suivant assigne la chaîne contenant le chemin d'accès du document actuellement ouvert à la variable fileName :
var fileName = dom.getOpenPathName();
dom.getShowHiddenCharacters()
Disponibilité
Dreamweaver 8.
Description
Cette fonction détermine si les caractères spéciaux utilisés pour les espaces blancs sont affichés dans la fenêtre de document
en mode Code.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si les caractères masqués sont affichés ; false dans le cas contraire.
ADOBE DREAMWEAVER 9.0 179
Guide des API
Exemple
L'exemple suivant désactive l'affichage des caractères spéciaux utilisés pour les espaces blancs lorsque l'affichage de ces
caractères est activé :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.getShowHiddenCharacters()){
currentDOM.setShowHiddenCharacters(false);
}
dom.setShowHiddenCharacters()
Disponibilité
Dreamweaver 8.
Description
Cette fonction affiche ou masque les caractères spéciaux utilisés pour les espaces blancs dans l'inspecteur de code en mode
Code.
Consultez « dom.getShowHiddenCharacters() », page 178 pour obtenir un exemple.
Arguments
afficher
• L'argument obligatoire show est une valeur booléenne qui indique s'il faut afficher les caractères masqués.
Valeurs renvoyées
Aucune.
dom.source.applyComment()
Disponibilité
Dreamweaver 8.
Description
Insère le texte spécifié dans l'argument beforeText avant la sélection en cours et le texte spécifié dans l'argument afterText
après la sélection en cours. La fonction étend ensuite la sélection en cours de manière à inclure le texte ajouté. Cependant,
s'il n'y a pas de sélection, la fonction ne sélectionne aucun élément. Si la valeur du texte spécifié dans l'argument afterText
est null, la fonction insère le texte spécifié dans l'argument beforeText au début de chaque ligne dans la sélection en cours.
Arguments
beforeText, afterText
• L'argument beforeText est obligatoire. Il indique le texte à insérer au début de la sélection, ou, si la valeur de l'argument
afterText est null, il indique le texte à insérer au début de chaque ligne dans la sélection.
• Facultatif, l'argument afterText indique le texte à insérer à la fin de la sélection.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant transforme la sélection en cours en un commentaire HTML :
dw.getDocumentDOM().source.applyComment('<!--', '-->')
ADOBE DREAMWEAVER 9.0 180
Guide des API
dom.source.refreshVariableCodeHints()
Disponibilité
Dreamweaver CS3.
Description
Analyse à nouveau la page à la recherche de variables et d'associations de classe correspondantes. Cette fonction recrée le
moteur d'état des couleurs et la liste de variables.
Arguments
bSyncDoc
• Il s'agit d'une valeur booléenne. La valeur par défaut est false. Si la valeur est définie sur true, le mode Création est
synchronisé avec le mode Code.
Valeurs renvoyées
Aucune.
Exemple
dom.source.refreshVariableCodeHints();
dom.source.removeComment()
Disponibilité
Dreamweaver 8.
Description
Cette fonction supprime des commentaires. Si vous n'indiquez aucun argument, elle supprime tous les types de commentaires de la sélection en cours, à l'exception des inclusions côté serveur et des commentaires spécifiques Dreamweaver. En
cas de commentaires imbriqués, elle supprime uniquement le commentaire externe. S'il n'y a pas de sélection en cours, elle
supprime uniquement le premier commentaire de la ligne sur laquelle se trouve le curseur. Si vous indiquez des arguments,
la fonction supprime uniquement les commentaires correspondant aux valeurs spécifiées dans les arguments beforeText
et afterText, même si les commentaires correspondants sont imbriqués dans d'autres types de commentaires.
Arguments
beforeText, afterText
• L'argument beforeText est facultatif. Il indique le texte permettant d'identifier le début du commentaire à supprimer
dans la sélection, ou, si la valeur de l'argument afterText est null, il indique le type de commentaire de ligne à supprimer
de la sélection en cours.
• Facultatif, l'argument afterText indique le texte permettant d'identifier la fin du commentaire à supprimer dans la
sélection.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant supprime un commentaire HTML :
dw.getDocumentDOM().source.removeComment('<!--', '-->')
ADOBE DREAMWEAVER 9.0 181
Guide des API
dreamweaver.htmlInspector.getShowHiddenCharacters()
Disponibilité
Dreamweaver 8.
Description
Cette fonction détermine si les caractères spéciaux utilisés pour les espaces blancs sont affichés dans l'inspecteur de code
en mode Code.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si les caractères masqués sont affichés ; false dans le cas contraire.
Exemple
L'exemple suivant désactive l'affichage des caractères spéciaux utilisés pour les espaces blancs dans l'inspecteur de code
lorsque l'affichage de ces caractères est activé :
if (dreamweaver.htmlinspector.getShowHiddenCharacters()){
dreamweaver.htmlinspector.setShowHiddenCharacters(false);
}
dreamweaver.htmlInspector.setShowHiddenCharacters()
Disponibilité
Dreamweaver 8.
Description
Cette fonction affiche ou masque les caractères spéciaux utilisés pour les espaces blancs dans l'inspecteur de code en mode
Code.
Arguments
afficher
• L'argument obligatoire show est une valeur booléenne qui indique s'il faut afficher les caractères masqués utilisés pour
les espaces blancs.
Valeurs renvoyées
Valeur booléenne : true si les caractères masqués sont affichés ; false dans le cas contraire.
Exemple
Consultez « dreamweaver.htmlInspector.getShowHiddenCharacters() », page 181.
ADOBE DREAMWEAVER 9.0 182
Guide des API
183
Chapitre 13 : Site
Les fonctions relatives aux sites de Adobe® Dreamweaver® CS3 effectuent des tâches ayant trait à la gestion d'un site Web. Il
peut s'agir de personnaliser un rapport, de définir un nouveau site, d'archiver ou d'extraire des fichiers, de valider un site,
etc.
Les fonctions décrites dans ce chapitre sont regroupées dans les sections suivantes :
• « Fonctions relatives aux rapports », page 183
• « Fonctions relatives aux sites », page 184
Fonctions relatives aux rapports
Ces fonctions permettent d'accéder aux fonctionnalités de création de rapports et notamment de lancer, de contrôler et de
personnaliser le processus de création de rapports. Pour plus d'informations, consultez la rubrique « Rapports » dans l'aide
Extension de Dreamweaver.
dreamweaver.isReporting()
Disponibilité
Dreamweaver 4.
Description
Vérifie si un processus de création de rapport est en cours.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si un processus est en cours et false dans le cas contraire.
dreamweaver.showReportsDialog()
Disponibilité
Dreamweaver 4.
Description
Ouvre la boîte de dialogue Rapports.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 184
Guide des API
Fonctions relatives aux sites
Ces fonctions permettent d'effectuer des opérations sur les fichiers de site ou sur la carte du site. Elles permettent d'effectuer
les tâches suivantes :
• créer des liens entre fichiers ;
• obtenir, placer, archiver et extraire des fichiers ;
• sélectionner et désélectionner des fichiers ;
• créer et supprimer des fichiers ;
• obtenir des informations sur les sites définis par l'utilisateur ;
• importer et exporter les informations du site.
dom.getSiteURLPrefixFromDoc()
Disponibilité
Dreamweaver 8.
Description
Cette fonction obtient le préfixe de l'URL du site qui est extrait de l'adresse HTTP définie dans la section Infos locales de la
boîte de dialogue Définition du site.
Arguments
Aucun.
Valeurs renvoyées
Chaîne indiquant le préfixe de l'URL du site.
Exemple
L'exemple suivant obtient le préfixe de l'URL du site pour le document actif :
var currentDOM = dw.getDocumentDOM();
var sitePrefix = dom.getSiteURLPrefixFromDoc();
dom.localPathToSiteRelative()
Disponibilité
Dreamweaver 8.
Description
Cette fonction convertit un chemin d'accès de fichier local en une référence d'URI relative au site.
Arguments
localFilePath
• L'argument obligatoire localFilePath est une chaîne contenant le chemin d'accès à un fichier local sur votre ordinateur
local.
Valeurs renvoyées
Chaîne indiquant l'URI relative du site.
Exemple
L'exemple suivant renvoie "/myWebApp/myFile.cfm", en fonction de vos mappages de site et de l'adresse HTTP spécifiée
dans la section Infos locales de la boîte de dialogue Définition du site.
var siteRelativeURI = site.localPathToSiteRelative("C:\Inetpub\wwwroot\siteA\myFile.cfm")
ADOBE DREAMWEAVER 9.0 185
Guide des API
dom.siteRelativeToLocalPath()
Disponibilité
Dreamweaver 8.
Description
Cette fonction convertit une référence d'URI relative au site en un chemin d'accès de fichier local.
Arguments
siteRelativeURI
• L'argument obligatoire siteRelativeURI est une chaîne contenant l'URI relative du site.
Valeurs renvoyées
Chaîne indiquant le chemin d'accès à un fichier local sur votre ordinateur local.
Exemple
L'exemple suivant
var filePath = siteRelativeToLocalPath("/myWebApp/myFile.xml");
renvoie "C:\Inetpub\wwwroot\siteA\myFile.xml", en fonction de vos mappages de site et de l'adresse HTTP spécifiée
dans la section Infos locales de la boîte de dialogue Définition du site.
dreamweaver.compareFiles()
Disponibilité
Dreamweaver 8.
Description
Cette fonction lance l'outil de comparaison de fichiers installé par l'utilisateur dans la section Diff de la boîte de dialogue
Préférences.
Arguments
file1, file2
• L'argument obligatoire file1 est une chaîne contenant le chemin d'accès complet au premier fichier à comparer.
• L'argument obligatoire file2 est une chaîne contenant le chemin d'accès complet au second fichier à comparer.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant compare deux fichiers, red.htm et blue.htm :
dw.compareFiles(hc:\data\red.htm", "e:\data\blue.htm");
dreamweaver.loadSitesFromPrefs()
Disponibilité
Dreamweaver 4.
Description
Charge les informations du site pour tous les sites de la base de registres du système (Windows) ou du fichier de préférences
Dreamweaver (Macintosh) dans Dreamweaver. Si un site est connecté à un serveur distant lorsque cette fonction est
appelée, il est automatiquement déconnecté.
ADOBE DREAMWEAVER 9.0 186
Guide des API
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dreamweaver.saveSitesToPrefs()
Disponibilité
Dreamweaver 4.
Description
Enregistre toutes les informations pour chaque site que l'utilisateur a défini dans la base de registres du système (Windows)
ou le fichier de préférences Dreamweaver (Macintosh).
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dreamweaver.siteSyncDialog.compare()
Disponibilité
Dreamweaver 8.
Description
Cette fonction exécute l'application de comparaison de fichiers spécifiée dans la Catégorie de comparaison de fichiers de la
boîte de dialogue Préférences pour comparer les fichiers sélectionnés sur les sites distants ou locaux.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.siteSyncDialog.canCompare() », page 431.
dreamweaver.siteSyncDialog.markDelete()
Disponibilité
Dreamweaver 8.
Description
Cette fonction bascule l'action des éléments sélectionnés sur Supprimer dans la boîte de dialogue Synchronisation du site.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 187
Guide des API
Activateur
Consultez « dreamweaver.siteSyncDialog.canMarkDelete() », page 431.
dreamweaver.siteSyncDialog.markGet()
Disponibilité
Dreamweaver 8.
Description
Cette fonction bascule l'action des éléments sélectionnés sur Acquérir dans la boîte de dialogue Synchronisation du site.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.siteSyncDialog.canMarkGet() », page 431.
dreamweaver.siteSyncDialog.markIgnore()
Disponibilité
Dreamweaver 8.
Description
Cette fonction bascule l'action des éléments sélectionnés sur Ignorer dans la boîte de dialogue Synchronisation du site.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.siteSyncDialog.canMarkIgnore() », page 432.
dreamweaver.siteSyncDialog.markPut()
Disponibilité
Dreamweaver 8.
Description
Cette fonction bascule l'action des éléments sélectionnés sur Placer dans la boîte de dialogue Synchronisation du site.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.siteSyncDialog.canMarkPut() », page 432.
ADOBE DREAMWEAVER 9.0 188
Guide des API
dreamweaver.siteSyncDialog.markSynced()
Disponibilité
Dreamweaver 8.
Description
Cette fonction bascule l'action des éléments sélectionnés sur Synchroniser dans la boîte de dialogue Synchronisation du site.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.siteSyncDialog.canMarkSynced() », page 432.
dreamweaver.siteSyncDialog.toggleShowAllFiles()
Disponibilité
Dreamweaver 8.
Description
Cette fonction permet d'afficher les fichiers que Dreamweaver considère comme identiques sur les sites distants et locaux
dans la boîte de dialogue d'aperçu Synchroniser le site. Si la fonction est appelée alors que la case à cocher Afficher tous les
fichiers est activée, elle la désactive ; inversement, si la case à cocher Afficher tous les fichiers est désactivée, elle l'active.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
site.addLinkToExistingFile()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue Sélectionner fichier HTML pour permettre à l'utilisateur de sélectionner un fichier, puis crée un
lien entre ce dernier et le document sélectionné.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « site.canAddLink() », page 433.
ADOBE DREAMWEAVER 9.0 189
Guide des API
site.addLinkToNewFile()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue Lier au nouveau fichier pour permettre à l'utilisateur d'indiquer les détails du nouveau fichier,
puis crée un lien entre ce dernier et le document sélectionné.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « site.canAddLink() », page 433.
site.changeLinkSitewide()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue Modifier le lien au niveau du site.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
site.changeLink()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue Sélectionner fichier HTML pour permettre à l'utilisateur de sélectionner le nouveau fichier à
associer au lien.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « site.canChangeLink() », page 434.
ADOBE DREAMWEAVER 9.0 190
Guide des API
site.checkIn()
Disponibilité
Dreamweaver 3.
Description
Archive les fichiers sélectionnés et traite les fichiers dépendants de l'une des façons suivantes :
• Si l'utilisateur a activé l'option Invite lors de Placer/Archiver dans les préférences, catégorie FTP du site, la boîte de
dialogue Fichiers dépendants s'affiche.
• Si l'utilisateur a activé l'option Ne plus afficher ce message dans la boîte de dialogue Fichiers dépendants, puis qu'il a
cliqué sur Oui, les fichiers dépendants sont téléchargés et aucune boîte de dialogue ne s'affiche.
• Si l'utilisateur a activé l'option Ne plus afficher ce message dans la boîte de dialogue Fichiers dépendants, puis qu'il a
cliqué sur Non, les fichiers dépendants ne sont pas transmis et aucune boîte de dialogue ne s'affiche.
Arguments
siteOrURL.
• L'argument siteOrURL doit être soit le mot-clé "site", indiquant que la fonction doit agir sur l'élément sélectionné dans
le panneau Site, soit l'URL d'un fichier.
Valeurs renvoyées
Aucune.
Activateur
Consultez « site.canCheckIn() », page 434.
site.checkLinks()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue Vérificateur de lien et vérifie les liens dans les fichiers spécifiés.
Arguments
scopeOfCheck.
• L'argument scopeOfCheck définit l'étendue de la vérification des liens. Il doit avoir pour valeur "document", "selection"
ou "site".
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 191
Guide des API
site.checkOut()
Disponibilité
Dreamweaver 3.
Description
Extrait les fichiers sélectionnés et traite les fichiers dépendants de l'une des façons suivantes :
• Si l'utilisateur a activé l'option Invite lors de Acquérir/Extraire dans les préférences, catégorie FTP du site, la boîte de
dialogue Fichiers dépendants s'affiche.
• Si l'utilisateur a activé l'option Ne plus afficher ce message dans la boîte de dialogue Fichiers dépendants, puis qu'il a
cliqué sur Oui, les fichiers dépendants sont téléchargés et aucune boîte de dialogue ne s'affiche.
• Si l'utilisateur a activé l'option Ne plus afficher ce message dans la boîte de dialogue Fichiers dépendants, puis qu'il a
cliqué sur Non, les fichiers dépendants ne sont pas téléchargés et aucune boîte de dialogue ne s'affiche.
Arguments
siteOrURL.
• L'argument siteOrURL doit être soit le mot-clé "site", indiquant que la fonction doit agir sur l'élément sélectionné dans
le panneau Site, soit l'URL d'un fichier.
Valeurs renvoyées
Aucune.
Activateur
Consultez « site.canCheckOut() », page 434.
site.checkTargetBrowsers()
Disponibilité
Dreamweaver 3.
Description
Vérifie le navigateur cible des documents sélectionnés.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
site.cloak()
Disponibilité
Dreamweaver MX.
Description
Voile la sélection en cours dans le panneau Site ou le dossier spécifié.
Arguments
siteOrURL.
L'argument siteOrURL doit contenir l'une des deux valeurs suivantes :
• le mot-clé "site", qui indique si cloak() doit envelopper la sélection dans le panneau Site ;
• l'URL d'un dossier particulier, qui indique si cloak() doit envelopper le dossier spécifié et tout son contenu.
ADOBE DREAMWEAVER 9.0 192
Guide des API
Valeurs renvoyées
Aucune.
Activateur
Consultez « site.canCloak() », page 435.
site.compareFiles()
Disponibilité
Dreamweaver 8.
Description
Cette fonction lance l'application d'intégration d'outil Diff pour comparer deux fichiers.
Arguments
url
L'argument obligatoire url doit contenir l'une des deux valeurs suivantes :
• le mot-clé "site", qui indique si compare() doit agir sur la sélection dans le panneau Site ;
• l'URL d'un fichier local à comparer avec sa version distante.
Valeurs renvoyées
Valeur booléenne : true si la comparaison réussit et false dans le cas contraire.
Activateur
Consultez « site.canCompareFiles() », page 435.
Exemple
L'exemple suivant compare les fichiers sélectionnés dans le panneau Site avec leurs versions distantes :
site.compareFiles("site");
site.defineSites()
Disponibilité
Dreamweaver 3.
Description
La fonction ouvre la boîte de dialogue Modifier les sites.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
site.deleteSelection()
Disponibilité
Dreamweaver 3.
Description
Supprime les fichiers sélectionnés.
ADOBE DREAMWEAVER 9.0 193
Guide des API
Arguments
Aucun.
Valeurs renvoyées
Aucune.
site.deployFilesToTestingServerBin()
Disponibilité
Dreamweaver MX.
Description
Place le ou les fichiers spécifiés dans le dossier bin du serveur d'évaluation. Si aucun paramètre relatif au déploiement des
fichiers de prise en charge n'est défini pour le site en cours, cette fonction lance la boîte de dialogue Déployer les fichiers de
prise en charge sur le serveur d'évaluation.
Arguments
filesToDeploy.
• L'argument filesToDeploy correspond à un tableau de noms de fichiers que Dreamweaver déploiera.
Valeurs renvoyées
Valeur booléenne : true si le déploiement des fichiers réussit et false dans le cas contraire.
Exemple
Cet exemple déploie les fichiers image1.jpg et script1.js dans le dossier bin du serveur d'évaluation :
site.deployFilesToTestingServerBin("image1.jpg", "script1.js");
site.displaySyncInfoForFile()
Disponibilité
Dreamweaver CS3.
Description
Présente une boîte de dialogue contenant les heures d'évaluation, locales et distantes, du fichier correspondant au paramètre
transmis. Ces informations sont stockées dans le fichier de synchronisation dwsync.xml.
La boîte de dialogue affiche quatre heures différentes :
• L'heure locale ordinateur distant, qui indique pour le fichier local, l'horodatage de la dernière commande placer ou
acquérir sur le serveur distant.
• L'heure distante, qui indique pour le fichier situé sur le serveur distant, l'horodatage de la dernière commande acquérir
ou placer sur le serveur distant.
• L'heure locale ordinateur de test, qui indique pour le fichier local, l'horodatage de la dernière commande placer ou
acquérir sur le serveur d'évaluation.
• L'heure de test, qui indique pour le fichier situé sur le serveur d'évaluation, l'horodatage de la dernière commande
acquérir ou placer sur le serveur d'évaluation.
Si le fichier dwsync.xml ne contient pas d'informations pour le fichier, un message s'affiche et indique qu'aucune information n'est disponible. Si l'heure est définie dans le fichier xml, elle s'affiche au format date/heure correspondant aux
paramètres régionaux (par exemple, 24/6/05 14:43). Si l'heure n'est pas définie dans l'entrée correspondant au fichier, un
tiret (-) est affiché.
Cette fonction agit sur le fichier sélectionné dans l'affichage local des fichiers, si 'site' est transmis, ou sur le fichier correspondant à l'URL locale, si une URL est transmise.
ADOBE DREAMWEAVER 9.0 194
Guide des API
Arguments
path, 'site'
•
path est l'URL pointant vers un fichier local.
• 'site' indique que la fonction utilise le fichier sélectionné dans le panneau Site.
Valeurs renvoyées
Aucune.
Activateur
Consultez « site.canDisplaySyncInfoForFile() », page 436.
site.editColumns()
Description
Cette fonction affiche la boîte de dialogue Modifier les sites, qui contient la section Colonnes en mode Fichier.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
site.exportSite()
Disponibilité
Dreamweaver MX.
Description
Exporte un site Dreamweaver dans un fichier XML, qui peut être importé dans une autre instance de Dreamweaver pour
permettre la duplication du site.
Toutes les informations contenues dans la boîte de dialogue Définition du site sont enregistrées dans un fichier XML qui
comprend la liste des dossiers voilés et des informations sur le type de document par défaut. La seule exception est que
l'utilisateur peut omettre le nom et le mot de passe de connexion lorsque l'accès FTP est défini.
Arguments
siteName.
• L'argument siteName identifie le site à exporter. Si siteName est une chaîne vide, Dreamweaver exporte le site en cours.
Valeurs renvoyées
Valeur booléenne : true si le site nommé existe et si le fichier XML est correctement exporté, et false dans le cas contraire.
Exemple
L'exemple suivant présente un fichier XML créé par Dreamweaver lors de l'exportation d'un site :
<?xml version="1.0" ?>
<site>
<localinfo
sitename="DW00"
localroot="C:\Documents and Settings\jlondon\Desktop\DWServer\"
imagefolder="C:\Documents and Settings\jlondon\Desktop\DWServer\Images\"
spacerfilepath=""
refreshlocal="TRUE"
cache="FALSE"
httpaddress="http://" curserver="webserver" />
<remoteinfo
ADOBE DREAMWEAVER 9.0 195
Guide des API
accesstype="ftp"
host="dreamweaver"
remoteroot="kojak/"
user="dream"
checkoutname="Jay"
emailaddress="jay@Adobe.com"
usefirewall="FALSE"
usepasv="TRUE"
enablecheckin="TRUE"
checkoutwhenopen="TRUE" />
<designnotes
usedesignnotes="TRUE"
sharedesignnotes="TRUE" />
<sitemap
homepage="C:\Documents and Settings\jlondon\Desktop\DWServer\Untitled-2.htm"
pagesperrow="200" columnwidth="125" showdependentfiles="TRUE"
showpagetitles="FALSE" showhiddenfiles="TRUE" />
<fileviewcolumns sharecolumns="TRUE">
<column name="Dossier local"
align="left" show="TRUE" share="FALSE" builtin="TRUE"
localwidth="180" remotewidth="180" />
<column name="Notes"
align="center" show="TRUE" share="FALSE" builtin="TRUE"
localwidth="36" remotewidth="36" />
<column name="Size"
align="center" show="TRUE" share="FALSE" builtin="TRUE"
localwidth="-2" remotewidth="-2" />
<column name="Type"
align="left" show="TRUE" share="FALSE" builtin="TRUE"
localwidth="60" remotewidth="60" />
<column name="Modifié"
align="left" show="TRUE" share="FALSE" builtin="TRUE"
localwidth="102" remotewidth="102" />
<column name="Vérifié par"
align="left" show="TRUE" share="FALSE" builtin="TRUE"
localwidth="50" remotewidth="50" />
<column name="Etat" note="état"
align="left" show="TRUE" share="FALSE" builtin="FALSE"
localwidth="50" remotewidth="50" />
</fileviewcolumns>
<appserverinfo
servermodel="ColdFusion"
urlprefix="http://dreamweaver/kojak/"
serverscripting="CFML"
serverpageext=""
connectionsmigrated="TRUE"
useUD4andUD5pages="TRUE"
defaultdoctype=""
accesstype="ftp"
host="dreamweaver"
remoteroot="kojak/"
user="dream"
usefirewall="FALSE"
usepasv="TRUE" />
<cloaking enabled="TRUE" patterns="TRUE">
<cloakedfolder folder="databases/" />
<cloakedpattern pattern=".png" />
<cloakedpattern pattern=".jpg" />
<cloakedpattern pattern=".jpeg" />
</cloaking>
</site>
ADOBE DREAMWEAVER 9.0 196
Guide des API
site.findLinkSource()
Disponibilité
Dreamweaver 3.
Description
Ouvre le fichier contenant le lien ou le fichier dépendant sélectionné et met en surbrillance le texte du lien ou la référence
au fichier dépendant. Cette fonction agit seulement sur les fichiers de l'affichage Carte du site.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « site.canFindLinkSource() », page 436.
site.get()
Disponibilité
Dreamweaver 3.
Description
Obtient les fichiers spécifiés et traite les fichiers dépendants comme suit :
• Si l'utilisateur a activé l'option Invite lors de Acquérir/Extraire dans les préférences, catégorie FTP du site, la boîte de
dialogue Fichiers dépendants s'affiche.
• Si l'utilisateur a activé l'option Ne plus afficher ce message dans la boîte de dialogue Fichiers dépendants, puis qu'il a
cliqué sur Oui, les fichiers dépendants sont téléchargés et aucune boîte de dialogue ne s'affiche.
• Si l'utilisateur a activé l'option Ne plus afficher ce message dans la boîte de dialogue Fichiers dépendants, puis qu'il a
cliqué sur Non, les fichiers dépendants ne sont pas téléchargés et aucune boîte de dialogue ne s'affiche.
Arguments
siteOrURL.
• L'argument siteOrURL doit être soit le mot-clé "site", indiquant que la fonction doit agir sur l'élément sélectionné dans
le panneau Site, soit l'URL d'un fichier.
Valeurs renvoyées
Aucune.
Activateur
Consultez « site.canGet() », page 436.
site.getAppServerAccessType()
Disponibilité
Dreamweaver MX.
Description
Renvoie la méthode d'accès utilisée pour tous les fichiers sur le serveur d'application du site en cours. Le site en cours est le
site associé au document actuellement activé. Si aucun document n'est activé, le site ouvert dans Dreamweaver est utilisé.
Remarque : ColdFusion Component Explorer utilise cette fonction ; voir « site.getAppServerPathToFiles() », page 197 et
« site.getLocalPathToFiles() », page 200.
ADOBE DREAMWEAVER 9.0 197
Guide des API
Arguments
Aucun.
Valeurs renvoyées
L'une des chaînes suivantes :
•
"none"
•
"local/network"
•
"ftp"
•
"source_control"
site.getAppServerPathToFiles()
Disponibilité
Dreamweaver MX.
Description
Détermine le chemin d'accès aux fichiers distants sur le serveur d'application défini pour le site en cours. Le site en cours
est le site associé au document actuellement activé. Si aucun document n'est activé, le site ouvert dans Dreamweaver est
utilisé.
Remarque : ColdFusion Component Explorer utilise cette fonction ; voir « site.getAppServerAccessType() », page 196 et
« site.getLocalPathToFiles() », page 200.
Arguments
Aucun.
Valeurs renvoyées
Si le type d'accès au serveur d'application est local/network, cette fonction renvoie un chemin ; dans le cas contraire, cette
fonction renvoie une chaîne vide.
site.getAppURLPrefixForSite()
Disponibilité
Dreamweaver MX.
Description
Renvoie la valeur du préfixe de l'URL qui est extraite de l'adresse HTTP définie dans la section Infos locales de la boîte de
dialogue de définition du site. Il s'agit du chemin figurant après http://nom_hôte:numéro_port/.
Arguments
{ siteName }
L'argument siteName (facultatif) est le nom du site dont vous souhaitez obtenir le préfixe d'URL. Si vous n'indiquez pas de
lien, la fonction obtient le préfixe d'URL du site en cours.
Valeurs renvoyées
Une chaîne contenant le préfixe d'URL du site sélectionné.
Exemple
var sitePrefix = site.getAppURLPrefixForSite();
ADOBE DREAMWEAVER 9.0 198
Guide des API
site.getCheckOutUser()
Disponibilité
Dreamweaver 3.
Description
Obtient les noms d'utilisateur et d'extraction associés au site en cours.
Arguments
Aucun.
Valeurs renvoyées
Chaîne contenant un nom d'utilisateur et un nom d'extraction, s'ils sont définis, ou une chaîne vide si les fonctions
d'archivage et d'extraction sont désactivées.
Exemple
Un appel à la fonction site.getCheckOutUser() pourrait renvoyer ceci : "denise (deniseLaptop)". Si aucun nom
d'extraction n'est spécifié, seul le nom d'utilisateur est renvoyé ("denise", par exemple).
site.getCheckOutUserForFile()
Disponibilité
Dreamweaver 3.
Description
Obtient le nom d'utilisateur et le nom d'extraction de l'utilisateur qui a extrait le fichier spécifié.
Arguments
fileName
• L'argument fileName correspond au chemin d'accès au fichier interrogé, exprimé sous la forme d'une URL de type file://.
Valeurs renvoyées
Chaîne contenant le nom d'utilisateur et le nom d'extraction de l'utilisateur qui a extrait le fichier spécifié, ou chaîne vide
si le fichier n'a pas été extrait.
Exemple
Un appel à la fonction site.getCheckOutUserForFile("file://C:/sites/avocado8/index.html") pourrait renvoyer
ceci : "denise (deniseLaptop)". Si aucun nom d'extraction n'est spécifié, seul le nom d'utilisateur est renvoyé ("denise",
par exemple).
site.getCloakingEnabled()
Disponibilité
Dreamweaver MX.
Description
Détermine si le voilage est activé pour le site en cours.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le voilage est activé pour le site en cours et false dans le cas contraire.
ADOBE DREAMWEAVER 9.0 199
Guide des API
site.getConnectionState()
Disponibilité
Dreamweaver 3.
Description
Obtient l'état de connexion en cours.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne indiquant si le site distant est connecté.
Activateur
Consultez « site.canConnect() », page 435.
site.getCurrentSite()
Disponibilité
Dreamweaver 3.
Description
Obtient le site en cours.
Arguments
Aucun.
Valeurs renvoyées
Chaîne qui contient le nom du site en cours.
Exemple
Si plusieurs sites sont définis, un appel à la fonction site.getCurrentSite() renvoie celui qui est actuellement affiché dans
la liste des sites en cours du panneau Site.
site.getFocus()
Disponibilité
Dreamweaver 3.
Description
Détermine quel volet du panneau Site est activé.
Arguments
Aucun.
Valeurs renvoyées
L'une des chaînes suivantes :
•
"local"
•
"remote"
•
"site map"
ADOBE DREAMWEAVER 9.0 200
Guide des API
site.getLinkVisibility()
Disponibilité
Dreamweaver 3.
Description
Vérifie si tous les liens sélectionnés dans la carte du site sont visibles (c'est-à-dire s'ils ne sont pas identifiés comme
masqués).
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si tous les liens sélectionnés sont visibles et false dans le cas contraire.
site.getLocalPathToFiles()
Disponibilité
Dreamweaver MX.
Description
Détermine le chemin d'accès aux fichiers locaux définis pour le site en cours. Le site en cours est le site associé au document
actuellement activé. Si aucun document n'est activé, le site ouvert dans Dreamweaver est utilisé.
Remarque : ColdFusion Component Explorer utilise cette fonction ; voir « site.getAppServerAccessType() », page 196 et
« site.getAppServerPathToFiles() », page 197.
Arguments
Aucun.
Valeurs renvoyées
Chemin d'accès aux fichiers qui résident sur l'ordinateur local pour le site en cours.
site.getSelection()
Disponibilité
Dreamweaver 3.
Description
Détermine quels sont les fichiers actuellement sélectionnés dans le panneau Site.
Arguments
Aucun.
Valeurs renvoyées
Tableau de chaînes représentant les chemins d'accès aux fichiers et dossiers sélectionnés, exprimé sous la forme d'une URL
de type file://, ou d'un tableau vide si aucun fichier ni dossier n'est sélectionné.
ADOBE DREAMWEAVER 9.0 201
Guide des API
site.getSiteForURL()
Disponibilité
Dreamweaver MX.
Description
Obtient le nom du site, s'il en a un, associé à un fichier donné.
Arguments
fileURL
• L'argument fileURL est l'URL complète (y compris la chaîne «
file:// ») d'un fichier nommé.
Valeurs renvoyées
Chaîne qui contient le nom du site, s'il en a un, dans lequel réside le fichier spécifié. La chaîne est vide lorsque le fichier
spécifié n'existe dans aucun site défini.
site.getSites()
Disponibilité
Dreamweaver 3.
Description
Obtient la liste des sites définis.
Arguments
Aucun.
Valeurs renvoyées
Tableau de chaînes représentant les noms des sites définis, ou tableau vide si aucun site n'est défini.
site.getSiteURLPrefix()
Disponibilité
Dreamweaver 8.
Description
Obtient le préfixe de l'URL qui est extrait de l'adresse HTTP définie dans la section Infos locales.
Arguments
Aucun.
Valeurs renvoyées
Chaîne contenant le préfixe de l'URL du site.
Exemple
sitePrefix = getSiteURLPrefix();
ADOBE DREAMWEAVER 9.0 202
Guide des API
site.importSite()
Disponibilité
Dreamweaver MX.
Description
Crée un site Dreamweaver à partir d'un fichier XML. Au cours de l'importation, si le dossier spécifié par l'attribut localroot
de l'élément <localinfo> n'existe pas sur l'ordinateur local, Dreamweaver invite l'utilisateur à choisir un dossier racine local
différent. Dreamweaver se comporte de la même manière lorsqu'il tente de localiser le dossier d'image par défaut spécifié
par l'attribut imagefolder de l'élément <localinfo>.
Arguments
fileURL
• L'argument fileURL est une chaîne qui contient l'URL du fichier XML. Dreamweaver utilise ce fichier XML pour créer
un nouveau site. Si fileURL est une chaîne vide, Dreamweaver invite l'utilisateur à choisir un fichier XML à importer.
Valeurs renvoyées
Valeur booléenne : true si le fichier XML nommé existe et si la création du site réussit et false dans le cas contraire.
site.invertSelection()
Disponibilité
Dreamweaver 3.
Description
Inverse la sélection dans la carte du site.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
site.isCloaked()
Disponibilité
Dreamweaver MX.
Description
Détermine si la sélection en cours dans le panneau Site ou le dossier spécifié est voilé.
Arguments
siteOrURL.
• L'argument siteOrURL doit contenir l'une des deux valeurs suivantes :
• le mot-clé "site", qui indique que la fonction isCloaked() doit tester la sélection dans le panneau Site ;
• l'URL de fichier d'un dossier particulier, qui indique si isCloaked() doit tester le dossier spécifié.
Valeurs renvoyées
Valeur booléenne : true si l'objet spécifié est voilé et false dans le cas contraire.
ADOBE DREAMWEAVER 9.0 203
Guide des API
site.locateInSite()
Disponibilité
Dreamweaver 3.
Description
Recherche le ou les fichiers indiqués dans le volet spécifié du panneau Site et sélectionne les fichiers.
Arguments
localOrRemote, siteOrURL.
• L'argument localOrRemote doit avoir la valeur "local" ou "remote".
• L'argument siteOrURL doit être soit le mot-clé "site", indiquant que la fonction doit agir sur l'élément sélectionné dans
le panneau Site, soit l'URL d'un fichier.
Valeurs renvoyées
Aucune.
Activateur
Consultez « site.canLocateInSite() », page 437.
site.makeEditable()
Disponibilité
Dreamweaver 3.
Description
Désactive le drapeau de lecture seule sur les fichiers sélectionnés.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « site.canMakeEditable() », page 437.
site.makeNewDreamweaverFile()
Disponibilité
Dreamweaver 3.
Description
Crée un nouveau fichier Dreamweaver dans le panneau Site (dans le même dossier que le premier fichier ou dossier sélectionné).
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « site.canMakeNewFileOrFolder() », page 437.
ADOBE DREAMWEAVER 9.0 204
Guide des API
site.makeNewFolder()
Disponibilité
Dreamweaver 3.
Description
Crée un nouveau dossier dans le panneau Site (dans le même dossier que le premier fichier ou dossier sélectionné).
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « site.canMakeNewFileOrFolder() », page 437.
site.newHomePage()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue Nouvelle page d'accueil pour permettre à l'utilisateur de créer une nouvelle page d'accueil.
Remarque : Cette fonction agit seulement sur les fichiers de l'affichage Carte du site.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
site.newSite()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue Définition du site pour définir un nouveau site.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 205
Guide des API
site.open()
Disponibilité
Dreamweaver 3.
Description
Ouvre les fichiers actuellement sélectionnés dans le panneau Site. Si des dossiers sont sélectionnés, ils sont développés dans
l'affichage Fichiers du site.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « site.canOpen() », page 438.
site.put()
Disponibilité
Dreamweaver 3.
Description
Place les fichiers spécifiés et traite les fichiers dépendants comme suit :
• Si l'utilisateur a activé l'option Invite lors de Placer/Archiver dans les préférences, catégorie FTP du site, la boîte de
dialogue Fichiers dépendants s'affiche.
• Si l'utilisateur a activé l'option Ne plus afficher ce message dans la boîte de dialogue Fichiers dépendants, puis qu'il a
cliqué sur Oui, les fichiers dépendants sont téléchargés et aucune boîte de dialogue ne s'affiche.
• Si l'utilisateur a activé l'option Ne plus afficher ce message dans la boîte de dialogue Fichiers dépendants, puis qu'il a
cliqué sur Non, les fichiers dépendants ne sont pas transmis et aucune boîte de dialogue ne s'affiche.
Arguments
siteOrURL.
• L'argument siteOrURL doit être soit le mot-clé "site", indiquant que la fonction doit agir sur l'élément sélectionné dans
le panneau Site, soit l'URL d'un fichier.
Valeurs renvoyées
Aucune.
Activateur
Consultez « site.canPut() », page 438.
site.recreateCache()
Disponibilité
Dreamweaver 3.
Description
Recrée le cache du site en cours.
Arguments
Aucun.
ADOBE DREAMWEAVER 9.0 206
Guide des API
Valeurs renvoyées
Aucune.
Activateur
Consultez « site.canRecreateCache() », page 438.
site.refresh()
Disponibilité
Dreamweaver 3.
Description
Actualise la liste des fichiers sur le côté spécifié du panneau Site.
Arguments
whichSide.
• L'argument whichSide doit avoir pour valeur "local" ou "remote". Si la carte du site est active et que whichSide a pour
valeur "local", la carte du site est actualisée.
Valeurs renvoyées
Aucune.
Activateur
Consultez « site.canRefresh() », page 439.
site.remoteIsValid()
Disponibilité
Dreamweaver 3.
Description
Détermine si le site distant est valide.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne qui indique si un site distant a été défini et, dans le cas où le type de serveur est Local/Réseau, si le lecteur
est monté.
site.removeLink()
Disponibilité
Dreamweaver 3.
Description
Supprime le lien sélectionné du document situé au-dessus de lui dans la carte du site.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 207
Guide des API
Activateur
Consultez « site.canRemoveLink() », page 439.
site.renameSelection()
Disponibilité
Dreamweaver 3.
Description
Transforme le nom du fichier sélectionné en champ de texte et permet à l'utilisateur de renommer le fichier. Si plusieurs
fichiers sont sélectionnés, cette fonction agit sur le dernier.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
site.runValidation()
Disponibilité
Dreamweaver MX.
Description
Exécute le validateur sur la totalité du site ou uniquement sur les éléments mis en surbrillance.
Arguments
sélection
• L'argument selection est le paramètre qui spécifie que le validateur doit vérifier les éléments mis en surbrillance
uniquement ; dans le cas contraire, le validateur vérifie l'ensemble du site en cours.
Valeurs renvoyées
Aucune.
site.saveAsImage()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue Enregistrer sous pour permettre à l'utilisateur d'enregistrer la carte du site sous forme d'image.
Arguments
fileType.
• L'argument fileType correspond au type d'image à enregistrer. Pour Windows, les valeurs autorisées sont "bmp" et
"png", et pour Macintosh "pict" et "jpeg". Si cet argument n'est pas défini ou que sa valeur n'est pas valide sur la plate-
forme en cours, il prend par défaut la valeur "bmp" pour Windows et "pict" pour Macintosh.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 208
Guide des API
site.selectAll()
Disponibilité
Dreamweaver 3.
Description
Sélectionne tous les fichiers de l'affichage actif (à savoir soit la carte du site, soit les fichiers de site).
Arguments
Aucun.
Valeurs renvoyées
Aucune.
site.selectHomePage()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue d'ouverture de fichier pour permettre à l'utilisateur de sélectionner une nouvelle page d'accueil.
Remarque : Cette fonction agit seulement sur les fichiers de l'affichage Carte du site.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
site.selectNewer()
Disponibilité
Dreamweaver 3.
Description
Sélectionne tous les fichiers les plus récents sur le côté spécifié du panneau Site.
Arguments
whichSide.
• L'argument whichSide doit avoir pour valeur "local" ou "remote".
Valeurs renvoyées
Aucune.
Activateur
Consultez « site.canSelectNewer() », page 440.
ADOBE DREAMWEAVER 9.0 209
Guide des API
site.serverActivity()
Disponibilité
Dreamweaver 8.
Description
Cette fonction détermine si Dreamweaver est en train d'interagir avec un serveur. Dreamweaver ne peut effectuer qu'une
seule activité de serveur à la fois, cette fonction vous permet donc de déterminer s'il faut désactiver la fonctionnalité
exigeant une interaction du serveur.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne indiquant si Dreamweaver est en train d'interagir avec un serveur.
Exemple
L'exemple suivant, extrait du fichier menus.xml, affiche un élément de menu s'il n'y a pas d'activité du serveur (et si un site
est actuellement spécifié dans Dreamweaver) :
<menuitem name="Remove Connection Scripts" enabled="!site.serverActivity() &&
site.getCurrentSite() != ''" command="alert(MMDB.removeConnectionScripts())"
id="SiteOptionsSiteMenu_RemoveConnectionScripts" />
site.setAsHomePage()
Disponibilité
Dreamweaver 3.
Description
Désigne le fichier sélectionné dans l'affichage Fichiers du site comme étant la page d'accueil du site.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
site.setCloakingEnabled()
Disponibilité
Dreamweaver MX.
Description
Détermine s'il est nécessaire d'activer le voilage pour le site en cours.
Arguments
enable
• L'argument enable est une valeur booléenne qui indique s'il est nécessaire d'activer le voilage. Une valeur true active le
voilage pour le site en cours ; une valeur false désactive le voilage pour le site en cours.
Valeurs renvoyées
Aucun.
ADOBE DREAMWEAVER 9.0 210
Guide des API
site.setConnectionState()
Disponibilité
Dreamweaver 3.
Description
Définit l'état de connexion du site en cours.
Arguments
bConnected.
• L'argument bConnected est une valeur booléenne qui indique s'il existe une connexion (true) ou non (false) au site en
cours.
Valeurs renvoyées
Aucune.
site.setCurrentSite()
Disponibilité
Dreamweaver 3.
Description
Ouvre le site spécifié dans le volet local du panneau Site.
Arguments
whichSite.
• L'argument whichSite est le nom d'un site défini (tel qu'il apparaît dans la liste des sites en cours, dans le panneau Site
ou dans la boîte de dialogue Modifier les sites).
Valeurs renvoyées
Aucune.
Exemple
Si trois sites sont définis (avocado8, dreamcentral et testsite, par exemple), un appel à la fonction site.setCurrentSite("dreamcentral") fait de dreamcentral le site en cours.
site.setFocus()
Disponibilité
Dreamweaver 3.
Description
Active le volet spécifié du panneau Site. Si le volet spécifié n'est pas affiché, la fonction l'affiche et l'active.
Arguments
whichPane.
• L'argument whichPane doit correspondre à l'une des chaînes suivantes : "local", "remote" ou "site
Valeurs renvoyées
Aucune.
map".
ADOBE DREAMWEAVER 9.0 211
Guide des API
site.setLayout()
Disponibilité
Dreamweaver 3.
Description
Ouvre le volet Mise en forme de la carte du site dans la boîte de dialogue Définition du site.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « site.canSetLayout() », page 439.
site.setLinkVisibility()
Disponibilité
Dreamweaver 3.
Description
Affiche ou masque le lien en cours.
Arguments
bShow.
• L'argument bShow est une valeur booléenne qui indique si le lien en cours ne doit plus être identifié comme masqué.
Valeurs renvoyées
Aucune.
site.setSelection()
Disponibilité
Dreamweaver 3.
Description
Sélectionne les fichiers ou les dossiers visibles dans le volet actif du panneau Site.
Arguments
arrayOfURLs.
• L'argument arrayOfURLs est un tableau de chaînes correspondant aux chemins d'accès aux fichiers et aux dossiers du site
sélectionné, exprimés sous la forme d'une URL de type file://.
Remarque : Pour les chemins de dossier, ne tapez pas la barre oblique (/) à la fin du chemin.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 212
Guide des API
site.siteRelativeToLocalPath()
Disponibilité
Dreamweaver 8.
Description
Convertit une référence d'URI relative de site en un chemin d'accès de fichier local.
Arguments
siteRelativeURI
• L'argument obligatoire siteRelativeURI est une chaîne contenant l'URI relative du site.
Valeurs renvoyées
Chaîne indiquant le chemin d'accès à un fichier local sur votre ordinateur local.
Exemple
L'exemple suivant
var filePath = site.siteRelativeToLocalPath("/myWebApp/myFile.xlml");
renvoie "C:\Inetpub\wwwroot\siteA\myFile.xml", en fonction de vos mappages de site et de l'adresse HTTP spécifiée dans
la section Infos locales de la boîte de dialogue Définition du site.
site.synchronize()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue Synchroniser les fichiers.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « site.canSynchronize() », page 440.
site.uncloak()
Disponibilité
Dreamweaver MX.
Description
Dévoile la sélection dans le panneau Site ou le dossier spécifié.
Arguments
siteOrURL.
• L'argument siteOrURL doit contenir l'une des valeurs suivantes :
• le mot-clé "site", qui indique que la fonction unCloak() doit agir sur la sélection dans le panneau Site ;
• l'URL d'un dossier particulier, qui indique que la fonction unCloak() doit agir sur le dossier spécifié et tout son
contenu.
ADOBE DREAMWEAVER 9.0 213
Guide des API
Valeurs renvoyées
Aucune.
Activateur
Consultez « site.canUncloak() », page 440.
site.uncloakAll()
Disponibilité
Dreamweaver MX.
Description
Dévoile tous les dossiers dans le site sélectionné et désactive la case à cocher Voiler les fichiers se terminant avec : dans les
Paramètres de voilage.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « site.canUncloak() », page 440.
site.undoCheckOut()
Disponibilité
Dreamweaver 3.
Description
Retire des sites locaux et distants les fichiers verrouillés associés aux fichiers sélectionnés et remplace leur copie locale par
la copie distante.
Arguments
siteOrURL.
• L'argument siteOrURL doit être soit le mot-clé "site", indiquant que la fonction doit agir sur l'élément sélectionné dans
le panneau Site, soit l'URL d'un fichier.
Valeurs renvoyées
Aucune.
Activateur
Consultez « site.canUndoCheckOut() », page 441.
site.viewAsRoot()
Disponibilité
Dreamweaver 3.
Description
Place provisoirement le fichier sélectionné en première position sur la carte du site.
Arguments
Aucun.
ADOBE DREAMWEAVER 9.0 214
Guide des API
Valeurs renvoyées
Aucune.
Activateur
Consultez « site.canViewAsRoot() », page 441.
215
Chapitre 14 : Document
Les fonctions Document de Adobe® Dreamweaver® CS3 permettent d'effectuer des opérations dans le document modifié
par l'utilisateur. Ces fonctions permettent notamment de convertir les tableaux en calques, d'exécuter une commande du
dossier Configuration/Commands, de rechercher l'URL d'un fichier, de vérifier l'orthographe ou de définir les propriétés
d'une page, de convertir une URL relative en URL absolue, d'obtenir le noeud parent sélectionné, d'effectuer l'encodage
URL d'une chaîne ou d'exécuter un traducteur sur le document.
Les fonctions décrites dans ce chapitre sont regroupées dans les sections suivantes :
• « Fonctions relatives aux conversions », page 215
• « Fonctions relatives aux commandes », page 216
• « Fonctions relatives aux manipulations de fichiers », page 217
• « Fonctions relatives à l'ensemble d'un document », page 231
• « Fonctions relatives aux chemins », page 240
• « Fonctions relatives à la sélection », page 243
• « Fonctions de manipulation de chaînes », page 249
• « Fonctions relatives à la traduction », page 252
• « Fonctions XSLT », page 253
Fonctions relatives aux conversions
Ces fonctions permettent de convertir des tableaux en calques, des calques en tableaux et des feuilles de style en cascade
(CSS) en balises HTML. Chacune de ces fonctions se comporte exactement comme une commande de conversion du menu
Fichier ou Modifier.
dom.convertLayersToTable()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue Convertir les calques en tableau.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dom.canConvertLayersToTable() », page 411.
ADOBE DREAMWEAVER 9.0 216
Guide des API
dom.convertTablesToLayers()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue Convertir les tableaux en calques.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dom.canConvertTablesToLayers() », page 411.
Fonctions relatives aux commandes
Ces fonctions permettent de tirer parti des fichiers figurant dans le dossier Configuration/Commands. Elles permettent de
gérer le menu Commandes et d'appeler des commandes à partir d'autres types de fichiers d'extension.
dreamweaver.editCommandList()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue Modifier la liste de commandes.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dreamweaver.popupCommand() (déconseillé)
Disponibilité
Dreamweaver 2, déconseillée depuis Dreamweaver 3 : utiliser à la place « dreamweaver.runCommand() », page 217.
Description
Cette fonction exécute la commande spécifiée. Pour l'utilisateur, cela revient à choisir la commande dans un menu ; si une
boîte de dialogue est associée à la commande, elle s'affiche. Cette fonction permet d'appeler une commande à partir d'un
autre fichier d'extension. L'utilisateur ne peut effectuer aucune autre modification tant qu'il n'a pas fermé la boîte de
dialogue.
Remarque : Cette fonction peut être appelée à partir de la fonction objectTag(), d'un script de fichier de commande ou du
fichier d'inspecteur Propriétés.
ADOBE DREAMWEAVER 9.0 217
Guide des API
Arguments
commandFile
• L'argument commandFile correspond au nom d'un fichier de commandes du dossier Configuration/Commands
("Format
Table.htm", par exemple).
Valeurs renvoyées
Aucune.
dreamweaver.runCommand()
Disponibilité
Dreamweaver 3.
Description
Exécute la commande spécifiée ; cette fonction équivaut à choisir la commande dans un menu. Si une boîte de dialogue est
associée à la commande, elle apparaît et le script de la commande bloque les autres modifications jusqu'à ce que l'utilisateur
ferme la boîte de dialogue. Cette fonction permet d'appeler une commande à partir d'un autre fichier d'extension.
Remarque : Cette fonction peut être appelée à partir de la fonction objectTag(), d'un script de fichier de commande ou du
fichier d'inspecteur Propriétés.
Arguments
commandFile, {commandArg1}, {commandArg2},...{commandArgN}
• L'argument commandFile est un nom de fichier dans le dossier Configuration/Commands.
• Les autres arguments (commandArg1,
commandArg2, etc.) sont facultatifs. Ils sont transmis à la fonction receiveArgu-
ments() dans l'argument commandFile.
Valeurs renvoyées
Aucune.
Exemple
Vous pouvez créer un inspecteur Propriétés personnalisé pour les tableaux. Il permettra à l'utilisateur d'accéder à la
commande Formater le tableau à l'aide d'un bouton de l'inspecteur. Pour ce faire, appelez la fonction suivante à partir du
gestionnaire d'événements onClick de ce bouton :
function callFormatTable(){
dreamweaver.runCommand('Format Table.htm');
}
Fonctions relatives aux manipulations de fichiers
Ces fonctions permettent de créer, d'ouvrir et d'enregistrer des documents (y compris XML et XHTML), de convertir des
documents HTML existants en XHTML et d'exporter des styles CSS vers des fichiers externes. Elles permettent également
de rechercher des fichiers ou des dossiers, de créer des fichiers à partir de modèles, de fermer des documents et d'obtenir
la liste des fichiers récemment ouverts.
ADOBE DREAMWEAVER 9.0 218
Guide des API
dom.cleanupXHTML()
Disponibilité
Dreamweaver MX.
Description
Cette fonction est similaire à la fonction convertToXHTML(), à ceci près que celle-ci nettoie un document XHTML existant.
Cette fonction peut être exécutée sur une sélection à l'intérieur du document. Vous pouvez utiliser la fonction cleanupXHTML() pour nettoyer la syntaxe dans l'ensemble d'un document XHTML ou dans la sélection en cours à l'intérieur du
document.
Arguments
bWholeDoc
• L'argument bWholeDoc contient une valeur booléenne. Si la valeur est true, la fonction cleanupXHTML() nettoie
l'ensemble du document ; dans le cas contraire, elle nettoie uniquement la sélection.
Valeurs renvoyées
Un tableau de six nombres entiers qui quantifient le nombre d'éléments suivants :
• erreurs XHTML réparées par Dreamweaver
• les éléments map ne disposant pas d'un attribut id et ne pouvant pas être résolus ;
• les éléments script ne disposant pas d'un attribut type et ne pouvant pas être résolus ;
• les éléments style ne disposant pas d'un attribut type et ne pouvant pas être résolus ;
• les éléments img ne disposant pas d'un attribut alt et ne pouvant pas être résolus ;
• les éléments area ne disposant pas d'un attribut alt et ne pouvant pas être résolus.
dom.convertToXHTML()
Disponibilité
Dreamweaver MX.
Description
Analyse le code HTML dans une arborescence DOM, insère les éléments manquants qui sont obligatoires pour XHTML,
nettoie l'arborescence puis écrit celle-ci au format XHTML. Les directives, déclarations, éléments et attributs manquants
que la fonction convertToXHTML() ajoute à l'arborescence DOM si nécessaire, incluent les éléments suivants :
• Une directive XML
• Une déclaration doctype
• L'attribut xmlns dans l'élément html
• Une section head
• Un élément title
• Une section body
Pendant la conversion, la fonction dom.convertToXHTML() convertit les balises et les attributs HTML purs en minuscules,
écrit des balises et des attributs HTML à l'aide d'une syntaxe XHTML correcte et ajoute des attributs HTML manquants où
cela est possible. Cette fonction traite les balises et les attributs tiers en fonction des paramètres de la boîte de dialogue Préférences.
Si le document est un modèle, la fonction dom.convertToXHTML() alerte l'utilisateur mais n'effectue pas la conversion.
Arguments
Aucun.
ADOBE DREAMWEAVER 9.0 219
Guide des API
Valeurs renvoyées
Un tableau de six nombres entiers qui quantifient les éléments suivants :
• erreurs XHTML réparées par Dreamweaver
• les éléments map ne disposant pas d'un attribut id et ne pouvant pas être résolus ;
• les éléments script ne disposant pas d'un attribut type et ne pouvant pas être résolus ;
• les éléments style ne disposant pas d'un attribut type et ne pouvant pas être résolus ;
• les éléments img ne disposant pas d'un attribut alt et ne pouvant pas être résolus ;
• les éléments area ne disposant pas d'un attribut alt et ne pouvant pas être résolus.
Exemple
Dans le cadre d'une utilisation normale, une extension appelle d'abord la fonction dreamweaver.openDocument() ou dreamweaver.getDocumentDOM() pour obtenir une référence au document. L'extension appelle ensuite la fonction dom.getIsXHTMLDocument() pour déterminer si le document est déjà au format XHTML. Si ce n'est pas le cas, l'extension appelle la
fonction dom.convertToXHTML() pour convertir le document au format XHTML. Ensuite, l'extension appelle la fonction
dreamweaver.saveDocument() pour enregistrer le fichier converti sous un nouveau nom.
dom.getIsXHTMLDocument()
Disponibilité
Dreamweaver MX.
Description
Vérifie un document (en particulier la déclaration <!DOCTYPE>) pour savoir si celui-ci est au format XHTML.
Arguments
Aucun.
Valeurs renvoyées
true si le document est au format XHTML ; false dans le cas contraire
dreamweaver.browseForFileURL()
Disponibilité
Dreamweaver 1, améliorée dans les versions 2, 3 et 4.
Description
Ouvre le type de boîte de dialogue spécifié ayant le libellé spécifié dans la barre de titre.
Arguments
openSelectOrSave, {titleBarLabel}, {bShowPreviewPane}, {bSupressSiteRootWarnings}, {arrayOfExtensions}
• L'argument openSelectOrSave indique le type de boîte de dialogue : "open", "select" ou "save".
• L'argument titleBarLabel, ajouté à Dreamweaver 2, est le libellé qui doit figurer dans la barre de titre de la boîte de
dialogue. Si cet argument n'est pas défini, Dreamweaver utilise par défaut le libellé fourni par le système d'exploitation.
• L'argument bShowPreviewPane, ajouté à Dreamweaver 2, est une valeur booléenne indiquant si le volet d'aperçu de
l'image doit être affiché dans la boîte de dialogue. Si l'argument a pour valeur true, la boîte de dialogue filtre les fichiers
d'image ; s'il n'est pas défini, il prend par défaut la valeur false.
• L'argument bSupressSiteRootWarnings, ajouté à Dreamweaver 3, est une valeur booléenne indiquant s'il faut supprimer
les avertissements signalant que le fichier sélectionné se trouve hors du dossier racine du site. Si cet argument n'est pas
défini, il prend par défaut la valeur false.
ADOBE DREAMWEAVER 9.0 220
Guide des API
• L'argument arrayOfExtensions, ajouté à Dreamweaver 4, est un tableau de chaînes qui spécifie le contenu par défaut du
menu déroulant Type au bas de la boîte de dialogue. La syntaxe correcte est menuEntryText|.xxx[;.yyy;.zzz]|CCCC|
où menuEntryText est le nom du type de fichier qui s'affiche. Les extensions peuvent être spécifiées sous la forme
.xxx[;.yyy;.zzz] ou CCCC où .xxx définit l'extension du type de fichier (.yyy et .zzz peuvent également spécifier des
extensions de fichier multiples) et CCCC est la constante du type de fichier à quatre caractères utilisée sur Macintosh.
Valeurs renvoyées
Une chaîne contenant le nom du fichier, exprimé sous la forme d'une URL de type file://.
dreamweaver.browseForFolderURL()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue Choisir un dossier ayant le libellé spécifié dans la barre de titre.
Arguments
{titleBarLabel}, {directoryToStartIn}
• L'argument titleBarLabel est le libellé qui doit s'afficher dans la barre de titre de la boîte de dialogue. S'il n'est pas
spécifié, l'argument titleBarLabel prend par défaut la valeur Choose folder (Choisir un dossier).
• L'argument directoryToStartIn est le chemin indiquant où le dossier doit s'ouvrir, exprimé sous la forme d'une URL
de type file://.
Valeurs renvoyées
Une chaîne contenant le nom du dossier, exprimé sous la forme d'une URL de type file://.
Exemple
Le code suivant renvoie l'URL d'un dossier :
return dreamweaver.browseForFolderURL('Choisir un dossier', ¬
dreamweaver.getSiteRoot());
dreamweaver.closeDocument()
Disponibilité
Dreamweaver 2.
Description
Ferme le document spécifié.
Arguments
documentObject.
• L'argument documentObject correspond à l'objet situé à la racine de l'arborescence DOM d'un document (c'est-à-dire la
valeur renvoyée par la fonction dreamweaver.getDocumentDOM()). Si l'argument documentObject fait référence au
document actif, il se peut que la fenêtre du document ne se ferme pas tant que l'exécution du script qui appelle cette
fonction n'est pas terminée.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 221
Guide des API
dreamweaver.createDocument()
Disponibilité
Dreamweaver 2, améliorée dans la version 4.
Description
En fonction de l'argument utilisé, cette fonction ouvre un nouveau document soit dans la même fenêtre, soit dans une
nouvelle fenêtre. Le nouveau document devient le document actif.
Remarque : Cette fonction peut être appelée uniquement à partir du fichier menus.xml, d'un fichier de commande ou depuis
le fichier de l'inspecteur Propriétés. Si une action ou un objet tente d'appeler cette fonction, Dreamweaver affiche un
message d'erreur.
Arguments
{bOpenInSameWindow}, {type}
• L'argument bOpenInSameWindow est une valeur booléenne indiquant si le nouveau document doit s'ouvrir dans la fenêtre
en cours. Si l'argument bOpenInSameWindow a pour valeur false, qu'il n'est pas précisé ou que la fonction est appelée sur
Macintosh, le nouveau document s'ouvre dans une nouvelle fenêtre.
• L'argument type indique le type de document à créer, conformément à ce qui a été déclaré dans le fichier Configuration/DocumentTypes/MMDocumentTypes.xml de Dreamweaver dans l'attribut id de la balise documenttype.
L'argument type peut par exemple avoir la valeur "HTML", "ASP-JS", "ASP-VB", "ColdFusion", "CFC", "JSP",
"ASP.NET_VB", ou toute valeur similaire. Pour obtenir la liste complète des types disponibles, consultez le fichier
MMDocumentTypes.xml. Si vous ne définissez pas l'argument type, il adopte la valeur "HTML".
Remarque : Vous pouvez étendre le fichier MMDocumentTypes en ajoutant de nouveaux types de documents. Pour plus
d'informations sur l'extension des types de documents, voir Extension de Dreamweaver.
Valeurs renvoyées
Objet document correspondant au nouveau document créé. Il s'agit de la valeur renvoyée par la fonction dreamweaver.getDocumentDOM().
dreamweaver.createXHTMLDocument()
Disponibilité
Dreamweaver MX.
Description
En fonction de l'argument utilisé, cette fonction ouvre un nouveau document XHTML soit dans la même fenêtre, soit dans
une nouvelle fenêtre. Le nouveau document devient le document actif. Cette fonction est similaire à la fonction dreamweaver.createDocument().
Lorsque Dreamweaver crée un nouveau document XHTML, il lit un fichier nommé default.xhtml, qui se trouve dans le
dossier Configuration/Templates, et, en utilisant le contenu de ce fichier, il crée un fichier de sortie contenant les déclarations suivantes :
<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Document sans titre</title>
<meta http-equiv="Content-Type" content="text/html; charset=" />
</head>
<body bgcolor="#FFFFFF" text="#000000">
</body>
</html>
ADOBE DREAMWEAVER 9.0 222
Guide des API
La déclaration DTD par défaut est XHTML 1.0 Transitional et non pas Strict. Si l'utilisateur ajoute un jeu de cadres au
document, Dreamweaver remplace la DTD par XHTML 1.0 Frameset. Content-Type est text/html, et charset est intentionnellement omis du fichier default.xhtml mais est rempli avant que l'utilisateur visualise le nouveau document. La
directive ?xml n'est pas obligatoire si le document utilise le codage de caractères UTF-8 ou UTF-16 ; si elle est présente, elle
peut être restituée par d'autres navigateurs de version antérieure. Cependant, étant donné que cette directive doit se trouver
dans un document XHTML, Dreamweaver l'utilise par défaut (à la fois pour les documents nouveaux et convertis). Les
utilisateurs peuvent supprimer manuellement la directive. La directive ?xml inclut l'attribut de codage qui correspond à
charset dans l'attribut Content-Type.
Arguments
{bOpenInSameWindow}
• L'argument bOpenInSameWindow est une valeur booléenne indiquant si le nouveau document doit s'ouvrir dans la fenêtre
en cours. Si cet argument a pour valeur false, qu'il n'est pas précisé ou que la fonction est appelée sur Macintosh, le
nouveau document s'ouvre dans une nouvelle fenêtre.
Valeurs renvoyées
L'objet document correspondant au document nouvellement créé (même valeur que celle renvoyée par la fonction dreamweaver.getDocumentDOM()).
dreamweaver.createXMLDocument()
Disponibilité
Dreamweaver MX.
Description
Crée et ouvre un nouveau fichier XML contenant uniquement la directive XML.
Arguments
Aucun.
Valeurs renvoyées
Le DOM du nouveau fichier XML.
Exemple
L'exemple suivant crée un nouveau document, contenant uniquement la directive XML :
var theDOM = dreamweaver.createXMLDocument("document");
dreamweaver.exportCSS() (déconseillé)
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue Exporter les styles dans un fichier CSS.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.canExportCSS() (déconseillé) », page 420.
ADOBE DREAMWEAVER 9.0 223
Guide des API
dreamweaver.exportEditableRegionsAsXML() (déconseillé)
Disponibilité
Dreamweaver 3, déconseillée depuis MX.
Description
Cette fonction ouvre la boîte de dialogue Exporter les régions modifiables sous XML.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dreamweaver.exportTemplateDataAsXML()
Disponibilité
Dreamweaver MX.
Description
Exporte le document actif dans le fichier indiqué, et ce au format XML. Cette fonction agit sur le document actif, qui doit
être un modèle. Si vous ne spécifiez pas un argument de nom de fichier, Dreamweaver MX ouvre une boîte de dialogue pour
demander la chaîne du fichier d'exportation.
Arguments
{filePath}
• L'argument filePath (facultatif) est une chaîne spécifiant le nom du fichier vers lequel Dreamweaver exporte le modèle.
Exprimez l'argument filePath sous forme d'une URL de type "file:///c|/temp/mydata.txt".
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.canExportTemplateDataAsXML() », page 420.
Exemple
if(dreamweaver.canExportTemplateDataAsXML())
{
dreamweaver.exportTemplateDataAsXML("file:///c|/dw_temps/mytemplate.txt")
}
dreamweaver.getDocumentDOM()
Disponibilité
Dreamweaver 2.
Description
Permet d'accéder à l'arborescence des objets du document spécifié. Une fois celle-ci renvoyée à l'appelant, ce dernier peut
la modifier pour changer le contenu du document.
ADOBE DREAMWEAVER 9.0 224
Guide des API
Arguments
{sourceDoc}
• L'argument sourceDoc doit être "document", "parent", "parent.frames[number]", "parent.frames['frameName']", ou
une URL. L'argument sourceDoc prend par défaut la valeur "document" si vous ne fournissez pas de valeur. Ces valeurs
sont expliquées ci-dessous :
• La valeur document désigne le document actif contenant la sélection en cours.
• La valeur parent désigne le jeu de cadres parent (si le document sélectionné se trouve dans un cadre).
• Les valeurs parent.frames[number] et parent.frames['frameName'] désignent un document figurant dans un
cadre spécifique du jeu de cadres contenant le document actif.
• Si l'argument est une URL relative, celle-ci est relative au fichier de l'extension.
Remarque : Si l'argument a pour valeur "document", l'appelant doit être la fonction applyBehavior(), deleteBehavior(),
objectTag() ou toute fonction d'un fichier de commande ou d'inspecteur Propriétés pouvant modifier le document.
Valeurs renvoyées
L'objet document JavaScript à la racine de l'arborescence.
Exemples
L'exemple suivant utilise la fonction dreamweaver.getDocumentDOM() pour accéder au document actif :
var theDOM = dreamweaver.getDocumentDOM("document");
Dans l'exemple suivant, le document DOM actif identifie une sélection et la colle à la fin d'un autre document :
var currentDOM = dreamweaver.getDocumentDOM('document');
currentDOM.setSelection(100,200);
currentDOM.clipCopy();
var otherDOM = dreamweaver.openDocument(dreamweaver.¬
getSiteRoot() + "html/foo.htm");
otherDOM.endOfDocument();
otherDOM.clipPaste();
Remarque : L'argument openDocument() est utilisé car les méthodes de l'objet DOM agissent en principe uniquement sur les
documents ouverts. L'exécution d'une fonction sur un document qui n'est pas ouvert entraîne une erreur de Dreamweaver.
Lorsqu'une méthode de l'objet DOM ne peut être appliquée qu'au document actif ou à des documents fermés, cette caractéristique
est indiquée dans sa description.
dreamweaver.getNewDocumentDOM()
Disponibilité
Dreamweaver MX ; argument documentType ajouté dans Dreamweaver 8.
Description
Permet d'accéder à l'arborescence modifiable d'un nouveau document vide. Cette fonction est similaire à la fonction getDocumentDOM(), à ceci près qu'elle pointe vers un nouveau document plutôt que vers un document existant et qu'elle n'ouvre
pas le document.
Arguments
{documentType}
• L'argument documentType est une chaîne. Sa valeur doit être un type de document spécifié dans le fichier DocumentTypes.xml.
Valeurs renvoyées
Pointeur vers un nouveau document vide.
ADOBE DREAMWEAVER 9.0 225
Guide des API
Exemple
Le code suivant renvoie le DOM d'un nouveau document vide :
var theDOM = dreamweaver.getNewDocumentDOM();
dreamweaver.getRecentFileList()
Disponibilité
Dreamweaver 3.
Description
Obtient la liste de tous les fichiers récemment ouverts et répertoriés au bas du menu Fichier.
Arguments
Aucun.
Valeurs renvoyées
Un tableau de chaînes représentant les chemins des derniers fichiers ouverts, exprimés sous la forme d'une URL de type
file://. Si aucun fichier n'a été ouvert récemment, la fonction ne renvoie aucune valeur.
dreamweaver.importXMLIntoTemplate()
Disponibilité
Dreamweaver 3.
Description
Importe un fichier de texte XML dans le modèle de document actif. Cette fonction agit sur le document actif, qui doit être
un modèle. Si vous ne spécifiez pas un argument de nom de fichier, Dreamweaver ouvre une boîte de dialogue pour
demander la chaîne du fichier d'importation.
Arguments
{filePath}
• L'argument filePath (facultatif) est une chaîne spécifiant le nom du fichier vers lequel Dreamweaver importe le modèle.
Exprimez l'argument filePath sous forme d'une URL de type "file:///c|/temp/mydata.txt".
Valeurs renvoyées
Aucune.
dreamweaver.newDocument()
Disponibilité
Dreamweaver MX.
Description
Ouvre un document dans le site en cours et affiche la boîte de dialogue Nouveau document.
Arguments
{bopenWithCurSiteAndShowDialog}
• L'argument bopenWithCurSiteAndShowDialog (facultatif) peut avoir la valeur true ou false. Si vous souhaitez ouvrir un
document dans le site en cours et afficher la boîte de dialogue Nouveau document, spécifiez true ; sinon, spécifiez false.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 226
Guide des API
dreamweaver.newFromTemplate()
Disponibilité
Dreamweaver 3.
Description
Crée un nouveau document à partir du modèle spécifié. Si vous ne spécifiez aucun argument, la boîte de dialogue Sélectionner le modèle s'affiche.
Arguments
{templateURL}, bMaintain
• L'argument templateURL est le chemin d'un modèle disponible sur le site en cours, exprimé sous la forme d'une URL de
type file://.
• L'argument bMaintain est une valeur booléenne, pouvant être true ou false, indiquant si le lien vers le modèle d'origine
doit être conservé ou pas.
Valeurs renvoyées
Aucune.
dreamweaver.openDocument()
Disponibilité
Dreamweaver 2.
Description
Ouvre un document à modifier dans une nouvelle fenêtre Dreamweaver et en fait le document actif. Pour l'utilisateur, cela revient
à choisir Fichier > Ouvrir et à sélectionner un fichier. Si le fichier spécifié est déjà ouvert, la fenêtre correspondante s'affiche au
premier plan. La fenêtre contenant le fichier spécifié devient la fenêtre active et le fichier sélectionné devient le document actif.
Dans Dreamweaver 2, si la fonction d'archivage/extraction est activée, le fichier est extrait avant d'être ouvert. Dans
Dreamweaver 3 et ses versions ultérieures, vous devez utiliser la fonction « dreamweaver.openDocumentFromSite() »,
page 227 pour obtenir ce comportement.
Remarque : Cette fonction provoque une erreur si elle est appelée à partir d'un fichier d'objet ou d'action de comportement.
Arguments
fileName
• L'argument fileName est le nom du fichier à ouvrir, exprimé sous forme d'une URL absolue. S'il s'agit d'une URL relative,
elle est relative au fichier contenant le script ayant appelé cette fonction.
Valeurs renvoyées
L'objet document correspondant au fichier spécifié, soit la même valeur renvoyée par la fonction dreamweaver.getDocumentDOM().
ADOBE DREAMWEAVER 9.0 227
Guide des API
dreamweaver.openDocumentFromSite()
Disponibilité
Dreamweaver 3.
Description
Ouvre un document à modifier dans une nouvelle fenêtre Dreamweaver et en fait le document actif. Pour l'utilisateur, cela
revient à double-cliquer sur un fichier dans le panneau Site. Si le fichier spécifié est déjà ouvert, la fenêtre correspondante
s'affiche au premier plan. La fenêtre contenant le fichier spécifié devient la fenêtre active et le fichier sélectionné devient le
document actif.
Remarque : Cette fonction ne peut pas être appelée à partir d'un fichier d'objet ou d'action de comportement sous peine de
générer des erreurs.
Arguments
fileName
• L'argument fileName est le fichier à ouvrir, exprimé sous forme d'une URL absolue. S'il s'agit d'une URL relative, elle est
relative au fichier contenant le script ayant appelé cette fonction.
Valeurs renvoyées
L'objet document correspondant au fichier spécifié, soit la même valeur renvoyée par la fonction dreamweaver.getDocumentDOM().
dreamweaver.openInFrame()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue Ouvrir dans un cadre. Lorsque l'utilisateur sélectionne un document, celui-ci s'ouvre dans le
cadre actif.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.canOpenInFrame() », page 421.
ADOBE DREAMWEAVER 9.0 228
Guide des API
dreamweaver.releaseDocument()
Disponibilité
Dreamweaver 2.
Description
Libère explicitement de la mémoire un document précédemment référencé.
Les documents référencés par les fonctions dreamweaver.getObjectTags(), dreamweaver.getObjectRefs(), dreamweaver.getDocumentPath() et dreamweaver.getDocumentDOM() sont automatiquement libérés au terme de l'exécution du
script contenant l'appel. Si le script ouvre un nombre important de documents, vous devez utiliser cette fonction pour en
libérer certains explicitement avant la fin de l'exécution du script, ceci afin d'éviter de saturer la mémoire.
Remarque : Cette fonction ne s'applique qu'aux documents référencés par une URL, qui ne sont pas ouverts dans un cadre ou
dans une fenêtre de document et qui ne correspondent pas à des fichiers d'extension (les fichiers d'extensions externes sont
chargés en mémoire au démarrage et n'en sont libérés que lorsque vous quittez Dreamweaver).
Arguments
documentObject.
• L'argument documentObject correspond à l'objet situé à la racine de l'arborescence DOM d'un document, c'est-à-dire la
valeur renvoyée par la fonction dreamweaver.getDocumentDOM().
Valeurs renvoyées
Aucune.
dreamweaver.revertDocument()
Disponibilité
Dreamweaver 3.
Description
Rétablit la version précédemment enregistrée du fichier spécifié.
Arguments
documentObject.
• L'argument documentObject correspond à l'objet situé à la racine de l'arborescence DOM d'un document, c'est-à-dire la
valeur renvoyée par la fonction dreamweaver.getDocumentDOM().
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.canRevertDocument() », page 422.
dreamweaver.saveAll()
Disponibilité
Dreamweaver 3.
Description
Enregistre tous les documents ouverts et ouvre la boîte de dialogue Enregistrer sous pour tous ceux qui n'ont pas encore été
enregistrés.
Arguments
Aucun.
ADOBE DREAMWEAVER 9.0 229
Guide des API
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.canSaveAll() », page 423.
dreamweaver.saveDocument()
Disponibilité
Dreamweaver 2.
Description
Enregistre le fichier spécifié sur un ordinateur local.
Remarque : Dans Dreamweaver 2, si le fichier est accessible en lecture seule, Dreamweaver tente de l'extraire. Si le document
reste en lecture seule après cette tentative ou qu'il ne peut pas être créé, un message d'erreur s'affiche.
Arguments
documentObject, {fileURL}
• L'argument documentObject correspond à l'objet situé à la racine de l'arborescence DOM d'un document, c'est-à-dire la
valeur renvoyée par la fonction dreamweaver.getDocumentDOM().
• L'argument fileURL (facultatif) est une URL représentant un emplacement sur un ordinateur local. S'il s'agit d'une URL
relative, elle est relative au fichier de l'extension. Dans Dreamweaver 2, cet argument est obligatoire. Dans
Dreamweaver 4, si l'argument fileURL n'est pas défini et que le fichier a été enregistré précédemment, ce dernier est
enregistré au même endroit ; sinon, une boîte de dialogue d'enregistrement s'affiche.
Valeurs renvoyées
Valeur booléenne indiquant le succès (true) ou l'échec (false) de l'opération.
Activateur
Consultez « dreamweaver.canSaveDocument() », page 423.
dreamweaver.saveDocumentAs()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue Enregistrer sous.
Arguments
documentObject.
• L'argument documentObject correspond à l'objet situé à la racine de l'arborescence DOM d'un document, c'est-à-dire la
valeur renvoyée par la fonction dreamweaver.getDocumentDOM().
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 230
Guide des API
dreamweaver.saveDocumentAsTemplate()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue Enregistrer comme modèle.
Arguments
documentObject, {fileName}
• L'argument documentObject correspond à l'objet situé à la racine de l'arborescence DOM d'un document, c'est-à-dire la
valeur renvoyée par la fonction dreamweaver.getDocumentDOM().
• L'argument fileName (facultatif) est le nom du fichier à ouvrir, exprimé sous forme d'une URL absolue.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.canSaveDocumentAsTemplate() », page 423.
dreamweaver.saveFrameset()
Disponibilité
Dreamweaver 3.
Description
Enregistre le jeu de cadres spécifié ou, si ce dernier n'a pas encore été enregistré, ouvre la boîte de dialogue Enregistrer sous.
Arguments
documentObject.
• L'argument documentObject correspond à l'objet situé à la racine de l'arborescence DOM d'un document, c'est-à-dire la
valeur renvoyée par la fonction dreamweaver.getDocumentDOM().
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.canSaveFrameset() », page 423.
dreamweaver.saveFramesetAs()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue Enregistrer sous correspondant au fichier de jeu de cadres comprenant le DOM spécifié.
Arguments
documentObject.
• L'argument documentObject correspond à l'objet situé à la racine de l'arborescence DOM d'un document, c'est-à-dire la
valeur renvoyée par la fonction dreamweaver.getDocumentDOM().
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 231
Guide des API
Activateur
Consultez « dreamweaver.canSaveFramesetAs() », page 424.
Fonctions relatives à l'ensemble d'un document
Ces fonctions agissent sur l'ensemble d'un document. Elles permettent d'effectuer des vérifications orthographiques, de
vérifier les navigateurs cibles, de définir les propriétés des pages et de déterminer les références d'objet correctes des
éléments du document.
dom.checkSpelling()
Disponibilité
Dreamweaver 3.
Description
Vérifie l'orthographe sur l'ensemble du document (en ouvrant la boîte de dialogue Vérifier l'orthographe, si nécessaire) et
prévient l'utilisateur lorsque la vérification est terminée.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dom.checkTargetBrowsers()
Disponibilité
Dreamweaver 3.
Description
Vérifie le navigateur cible du document. Pour vérifier le navigateur cible d'un dossier ou d'un groupe de fichiers, consultez
la « site.checkTargetBrowsers() », page 191.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 232
Guide des API
dom.getParseMode()
Disponibilité
Dreamweaver MX 2004
Description
Permet d'obtenir le mode d'analyse du document. Ceci permet de contrôler la validation du document et de vérifier qu'il
s'affiche au format HTML dans la fenêtre de document principale.
Arguments
Aucun.
Valeurs renvoyées
Une chaîne indiquant le mode d'analyse : "html", "xml", "css" ou "text".
dom.hideInfoMessagePopup()
Disponibilité
Dreamweaver MX 2004.
Description
Masque le message qui peut s'afficher sous forme d'info-bulle dans la fenêtre de document.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Voir aussi
« dom.showInfoMessagePopup() », page 234.
dom.runValidation()
Disponibilité
Dreamweaver MX, arguments facultatifs ajoutés à Dreamweaver MX 2004.
Description
Exécute le validateur sur un seul document spécifié (similaire à la fonction « site.runValidation() », page 207). Le validateur
vérifie que le langage du document est conforme à celui qui a été spécifié dans le doctype du document (comme, par
exemple, HTML 4.0 ou HTML 3.2) et à celui qui a été spécifié par le modèle de serveur (comme, par exemple, ColdFusion
ou ASP). Si aucun doctype n'a été défini pour le document, le validateur utilise le paramètre de langage spécifié dans la
section Validateur de la boîte de dialogue Préférences.
ADOBE DREAMWEAVER 9.0 233
Guide des API
Arguments
{controlString}, {bOpenResultsWindow}, {bShowInfoMessage}
• L'argument controlString (facultatif) peut avoir l'une des quatre valeurs suivantes : Chaîne vide, "xml", "autoexplicit" ou "auto-implicit".
• Si la valeur de l'argument est une chaîne vide, le validateur effectue une validation par défaut. Si sa valeur est
"xml", il valide le document en tant que XML.
• Si sa valeur est "auto-explicit" ou "auto-implicit", Dreamweaver effectue une validation automatique (ou
validation en ligne). Plutôt que d'être affichées dans la fenêtre de résultats de la validation (voir
« dom.source.getValidationErrorsForOffset() », page 396 et « dom.getAutoValidationCount() », page 391), les
erreurs sont soulignées dans le mode Code.
• Si la valeur de l'argument controlString est "auto-explicit", l'utilisateur est invité à enregistrer un document
non enregistré avant la validation.
• Si la valeur de l'argument controlString est "auto-implicit", la validation échoue sans prévenir l'utilisateur que
le document en cours n'a pas été enregistré.
Remarque : La validation automatique (définie par la valeur "auto-explicit" ou "auto-implicit" de l'argument controlString) n'est disponible que pour la vérification du navigateur cible.
• L'argument bOpenResultsWindow (facultatif) doit avoir une valeur booléenne : pour ouvrir la fenêtre de résultats de la
validation, sa valeur doit être true ; sinon, sa valeur est false. La valeur par défaut est true.
• L'argument bShowInfoMessage n'est utilisé que si la valeur de l'argument controlString est "auto-explicit" ou "autoimplicit". L'argument bShowInfoMessage doit avoir une valeur booléenne : si sa valeur est true, un message d'informa-
tions s'affiche sous l'élément de barre d'outils DW_ValidatorErrors, indiquant le nombre d'erreurs détectées ; si sa valeur
est false, rien ne s'affiche. La valeur par défaut est false.
Valeurs renvoyées
Objet fenêtre des résultats de la validation.
Exemple
Dans l'exemple suivant, une validation régulière est effectuée lorsque l'utilisateur sélectionne Fichier > Vérifier la page >
Valider le marqueur (ou Valider le document actuel dans le panneau Validation) :
dw.getDocumentDOM().runValidation('');
Dans l'exemple suivant, l'utilisateur est invité à enregistrer le document non enregistré, puis une validation automatique est
effectuée. La fenêtre de résultats de la validation ne s'affiche pas et le nombre d'erreurs dans le document s'affiche sur la
barre d'outils du document pour DW_ValidatorErrors :
dw.getDocumentDOM().runValidation('auto-explicit', false, true);
Dans l'exemple suivant, l'utilisateur n'est pas invité à enregistrer le document. Si le document n'a pas été enregistré, la
validation ne peut pas démarrer. Si le document a été enregistré, Dreamweaver effectue une validation automatique. La
fenêtre de résultats de la validation ne s'affiche pas et le nombre d'erreurs dans le document n'apparaît pas sur la barre
d'outils du document :
dw.getDocumentDOM().runValidation('auto-implicit', false);
ADOBE DREAMWEAVER 9.0 234
Guide des API
dom.showInfoMessagePopup()
Disponibilité
Dreamweaver MX 2004.
Description
Affiche un message sous forme d'info-bulle dans la fenêtre de document ou sous un élément de barre d'outils.
Arguments
location, message, timeout
• L'argument
location peut être une chaîne indiquant un élément de barre d'outils, une chaîne vide ou l'un des mots-clés
suivants : "top", "topright", "right", "bottomright", "bottom", "bottomleft", "left" ou "topleft". L'info-bulle
s'affiche près du bord ou de l'angle spécifié et est centrée. Si la valeur de l'argument est une chaîne vide, l'info-bulle est
centrée dans le document. Pour spécifier un élément de barre d'outils, indiquez "toolbar:toolbarID:itemID". L'ID de
barre d'outils et l'ID d'élément de barre d'outils doivent correspondre aux ID du fichier toolbars.xml.
• L'argument message est une chaîne contenant le message.
• L'argument
timeout est un nombre indiquant le temps d'affichage du message en millisecondes. Si sa valeur est 0 (valeur
par défaut), le message reste affiché pendant une durée illimitée. Le message disparaît automatiquement lorsque l'utilisateur clique dessus, passe à un autre document ou lorsque la durée d'affichage spécifiée arrive à expiration.
Valeurs renvoyées
Aucune.
Exemple
Dans l'exemple ci-dessous, deux messages s'affichent sous forme d'info-bulles. La première ligne de code affiche le message
"Ce message est au centre" au centre du document. Le second appel de la fonction showInfoMessagePopup() affiche le
message "N'oubliez pas le titre de la fenêtre" pour la zone de texte Titre (ID : DW_SetTitle) sur la barre d'outils
dont l'ID est DW_Toolbar_Main.
dw.getDocumentDOM.showInfoMessagePopup('', 'Ce message est au centre', 5000);
dw.getDocumentDOM.showInfoMessagePopup('toolbar:DW_Toolbar_Main:DW_SetTitle', 'N'oubliez pas
le titre de la fenêtre', 5000);
Voir aussi
« dom.hideInfoMessagePopup() », page 232.
dom.showPagePropertiesDialog()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue Propriétés de la page.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 235
Guide des API
dreamweaver.doURLDecoding()
Disponibilité
Dreamweaver MX.
Description
Utilise le mécanisme de décodage d'URL interne de Dreamweaver pour décoder des caractères spéciaux et des symboles
dans les chaînes d'URL. Par exemple, cette fonction interprète %20 comme un caractère d'espacement et le nom &quot
comme des guillemets ".
Arguments
inStr
• L'argument inStr est la chaîne à décoder.
Valeurs renvoyées
Chaîne contenant l'URL décodée.
Exemple
L'exemple suivant appelle la fonction dw.doURLDecoding() afin de décoder les caractères spéciaux indiqués dans son
argument et enregistre la chaîne obtenue dans outStr :
outStr = dreamweaver.doURLDecoding(“http://maps.yahoo.com/py/ddResults.py?Pyt= ¬
Tmap&tarname=&tardesc=&newname=&newdesc=&newHash=&newTHash=&newSts=&newTSts=&tlt=&tln= ¬
&slt=&sln=&newFL=Use+Address+Below&newaddr=2000+Shamrock+Rd&newcsz=Metroo+Park%2C+CA& ¬
newcountry=us&newTFL=Use+Address+Below&newtaddr=500+El+Camino&newtcsz=Santa+Clara%2C+CA&
newtcountry=us&Submit=Get+Directions”)
¬
dreamweaver.getElementRef()
Disponibilité
Dreamweaver 2.
Description
Obtient la référence d'objet Netscape Navigator ou Internet Explorer pour un objet balise spécifique de l'arborescence
DOM.
Arguments
NSorIE, tagObject
• L'argument NSorIE doit être "NS
4.0" ou "IE 4.0". En effet, le DOM et les règles relatives aux références imbriquées
diffèrent dans Netscape Navigator 4.0 et Internet Explorer 4.0. Cet argument permet d'indiquer à quel navigateur doit
correspondre la référence renvoyée.
• L'argument tagObject est un objet de balise dans l'arborescence DOM.
ADOBE DREAMWEAVER 9.0 236
Guide des API
Valeurs renvoyées
Chaîne représentant une référence JavaScript valide à l'objet, telle que document.layers['myLayer']. La chaîne est soumise
aux conditions suivantes :
• Dreamweaver renvoie des références Internet Explorer correctes pour les balises suivantes : A, AREA, APPLET, EMBED, DIV,
SPAN, INPUT, SELECT, OPTION, TEXTAREA, OBJECT et IMG.
• Dreamweaver renvoie des références Netscape Navigator correctes pour les balises suivantes : A, AREA, APPLET, EMBED,
LAYER, ILAYER, SELECT, OPTION, TEXTAREA, OBJECT et IMG et pour les balises DIV et SPAN à positionnement absolu. Pour les
balises DIV et SPAN dont le positionnement n'est pas absolu, Dreamweaver renvoie "cannot
reference <tag>".
• Dreamweaver ne renvoie pas de références pour les objets sans nom. Si un objet ne contient pas d'attribut NAME ou ID,
Dreamweaver renvoie "unnamed <tag>". Si le navigateur ne prend pas en charge une référence par nom, Dreamweaver
fait référence à l'objet à l'aide de son index (par exemple document.myform.applets[3]).
• Dreamweaver renvoie les références des objets nommés figurant dans des formulaires ou des calques sans nom (par
exemple document.forms[2].myCheckbox).
dreamweaver.getObjectRefs() (deprecated)
Disponibilité
Dreamweaver 1, déconseillée depuis Dreamweaver 3.
Description
Cette fonction recherche, dans les documents indiqués, les instances des balises spécifiées ou, si aucune balise n'est
spécifiée, recherche toutes les balises du document et fournit des références aux balises en fonction du navigateur. Cette
fonction revient à appeler la fonction getElementsByTagName(), puis la fonction dreamweaver.getElementRef() pour
chaque balise de la nodelist.
Arguments
NSorIE, sourceDoc, {tag1}, {tag2},...{tagN}
• L'argument NSorIE doit être "NS
4.0" ou "IE 4.0". En effet, le DOM et les règles relatives aux références imbriquées
diffèrent dans Netscape Navigator 4.0 et Internet Explorer 4.0. Cet argument permet d'indiquer à quel navigateur doit
correspondre la référence renvoyée.
• L'argument sourceDoc doit être "document", "parent", "parent.frames[number]", "parent.frames['frameName']", ou
une URL. document désigne le document actif contenant la sélection en cours. parent désigne le jeu de cadres parent (si
le document sélectionné se trouve dans un cadre) ; parent.frames[number] et parent.frames['frameName'] désignent
un document figurant dans un cadre spécifique du jeu de cadres contenant le document actif. Si l'argument est une URL
relative, celle-ci est relative au fichier de l'extension.
• Le troisième argument et les arguments suivants, s'ils sont définis, correspondent aux noms de balises (par exemple
"IMG", "FORM" ou "HR").
ADOBE DREAMWEAVER 9.0 237
Guide des API
Valeurs renvoyées
Tableau de chaînes, chacun d'entre eux représentant une référence JavaScript valide à une instance nommée du type de
balise demandé dans le document spécifié (par exemple "document.monCalque.document.monImage") pour le navigateur
spécifié.
• Dreamweaver renvoie des références Internet Explorer correctes pour les balises suivantes : A, AREA, APPLET, EMBED, DIV,
SPAN, INPUT, SELECT, OPTION, TEXTAREA, OBJECT et IMG.
• Dreamweaver renvoie des références Netscape Navigator correctes pour les balises suivantes : A, AREA, APPLET, EMBED,
LAYER, ILAYER, SELECT, OPTION, TEXTAREA, OBJECT et IMG et pour les balises DIV et SPAN à positionnement absolu. Pour les
balises DIV et SPAN dont le positionnement n'est pas absolu, Dreamweaver renvoie "cannot
reference <tag>".
• Dreamweaver ne renvoie pas de références pour les objets sans nom. Si un objet ne contient pas d'attribut NAME ou ID,
Dreamweaver renvoie "unnamed <tag>". Si le navigateur ne prend pas en charge une référence par nom, Dreamweaver
fait référence à l'objet à l'aide de son index (par exemple document.myform.applets[3]).
• Dreamweaver ne renvoie pas de références pour les objets nommés figurant dans des formulaires ou des calques sans
nom (par exemple document.forms[2].myCheckbox).
Lorsque la même liste d'arguments est transmise à la fonction getObjectTags(), les deux fonctions renvoient des tableaux
de même longueur et de contenus identiques.
dreamweaver.getObjectTags() (déconseillé)
Disponibilité
Dreamweaver 1, déconseillée depuis Dreamweaver 3.
Description
Cette fonction recherche, dans le document indiqué, les instances des balises spécifiées ou, si aucune balise n'est spécifiée,
toutes les balises du document. Cette fonction revient à appeler la fonction getElementsByTagName(), puis la fonction
outerHTML() pour chaque balise de la nodelist.
Arguments
sourceDoc, {tag1}, {tag2},...{tagN}
• L'argument sourceDoc doit être "document", "parent", "parent.frames[number]", "parent.frames['frameName']", ou
une URL. document désigne le document actif contenant la sélection en cours. parent désigne le jeu de cadres parent (si
le document sélectionné se trouve dans un cadre) ; parent.frames[number] et parent.frames['frameName'] désignent
un document figurant dans un cadre spécifique du jeu de cadres contenant le document actif. Si l'argument est une URL
relative, celle-ci est relative au fichier de l'extension.
• Le second argument et les arguments suivants, s'il en existe, correspondent aux noms de balises (par exemple "IMG",
"FORM", "HR").
Valeurs renvoyées
Tableau de chaînes, chacun d'entre eux correspondant au code source d'une instance du type de balise demandé dans le
document spécifié.
• Si l'un des arguments de tag est LAYER, la fonction renvoie toutes les balises LAYER et ILAYER et toutes les balises DIV et
SPAN à positionnement absolu.
• Si l'un des arguments de tag est INPUT, la fonction renvoie tous les éléments du formulaire. Pour obtenir un type
d'élément particulier du formulaire, définissez INPUT/TYPE, TYPE correspondant à button, text, radio, checkbox,
password, textarea, select, hidden, reset ou submit.
Lorsque la même liste d'arguments est transmise à la fonction getObjectRefs(), les deux fonctions renvoient des tableaux
de même longueur.
ADOBE DREAMWEAVER 9.0 238
Guide des API
Exemple
Selon le contenu du document actif, dreamweaver.getObjectTags("document",
contenant les éléments suivants :
•
"<IMG SRC="/images/dot.gif" WIDTH="10" HEIGHT="10" NAME="bullet">"
•
•
"<IMG SRC="header.gif" WIDTH="400" HEIGHT="32" NAME="header">"
"IMG") pourrait renvoyer un tableau
"<IMG SRC="971208_nj.jpg" WIDTH="119" HEIGHT="119" NAME="headshot">"
dreamweaver.getPreferenceInt()
Disponibilité
Dreamweaver MX.
Description
Vous permet d'extraire une préférence de nombre entier pour une extension donnée.
Arguments
section, key, default_value
• L'argument section est une chaîne qui spécifie la section des préférences contenant l'entrée.
• L'argument key est une chaîne qui spécifie l'entrée de la valeur à extraire.
• L'argument default_value est la valeur par défaut renvoyée par Dreamweaver si l'entrée est introuvable. Il doit s'agir
d'un entier non signé compris entre 0 et 65 535 ou d'un entier signé compris entre -32 768 et 32 767.
Valeurs renvoyées
Valeur entière de l'entrée spécifiée dans la section ou valeur par défaut si la fonction ne trouve pas l'entrée. Envoie 0 si la
valeur de l'entrée spécifiée n'est pas un entier.
Exemple
L'exemple suivant renvoie la valeur du paramètre Distance d'accrochage de la section Mon extension des Préférences. Si la
section Mon extension n'existe pas ou si le paramètre Distance d'accrochage n'est pas défini, la fonction renvoie la valeur
par défaut spécifiée (0).
var snapDist; //valeur par défaut si entrée introuvable
snapDist = dreamweaver.getPreferenceInt("My Extension", "Snap Distance", 0);
dreamweaver.getPreferenceString()
Disponibilité
Dreamweaver MX.
Remarque : Pour accéder aux préférences des sites, vous devez posséder la version 7.0.1. Vérifiez dw.appVersion pour connaître
la version correcte avant d'accéder aux informations relatives au site.
Description
Permet d'extraire une préférence de chaîne que vous avez stockée pour une extension.
Arguments
section, key, default_value
• L'argument section est une chaîne qui spécifie la section des préférences contenant l'entrée.
• L'argument key est une chaîne qui spécifie la valeur à extraire.
• L'argument default_value est la chaîne par défaut renvoyée par Dreamweaver si l'entrée est introuvable.
Valeurs renvoyées
Chaîne de la préférence demandée ou valeur par défaut si la chaîne est introuvable.
ADOBE DREAMWEAVER 9.0 239
Guide des API
Exemple
L'exemple suivant renvoie la valeur du paramètre Editeur de texte de la section Mon extension des Préférences. Si la section
Mon extension n'existe pas ou si le paramètre Editeur de texte n'est pas défini, la fonction renvoie la valeur par défaut
spécifiée par la variable txtEditor.
var txtEditor = getExternalTextEditor(); // pour définir la valeur de l'éditeur de texte par défaut
txtEditor = dreamweaver.getPreferenceString("My Extension", "Text Editor", txtEditor);
dreamweaver.setPreferenceInt()
Disponibilité
Dreamweaver MX.
Description
Vous permet de définir une préférence de nombre entier pour une extension donnée. Ce paramètre est enregistré avec les
préférences de Dreamweaver lorsque Dreamweaver n'est pas actif.
Arguments
section, key, new_value
• L'argument section est une chaîne qui spécifie la catégorie de préférences définissant l'option. Si la catégorie n'existe pas,
Dreamweaver la crée.
• L'argument key est une chaîne qui spécifie l'option de catégorie définie par la fonction. Si l'option n'existe pas, Dreamweaver la crée.
• L'argument new_value est un entier qui spécifie la valeur de l'option de catégorie.
Valeurs renvoyées
Valeur true en cas de succès et false dans le cas contraire.
Exemple
L'exemple suivant définit l'entrée Distance d'accrochage en fonction de la valeur de la variable snapDist de la catégorie Mon
extension dans les Préférences :
var snapDist = getSnapDistance();
if(snapDist > 0)
{
dreamweaver.setPreferenceInt("My Extension", "Snap Distance", snapDist);
}
dreamweaver.setPreferenceString()
Disponibilité
Dreamweaver MX.
Remarque : Pour accéder aux préférences des sites, vous devez posséder la version 7.0.1. Vérifiez dw.appVersion pour connaître
la version correcte avant d'accéder aux informations relatives au site.
Description
Permet d'écrire une préférence de chaîne pour une extension. Ce paramètre est enregistré avec les préférences de Dreamweaver lorsque Dreamweaver n'est pas actif.
ADOBE DREAMWEAVER 9.0 240
Guide des API
Arguments
section, key, new_value
• L'argument section est une chaîne qui spécifie la catégorie de Préférences définissant l'option. Si la catégorie n'existe pas,
Dreamweaver la crée.
• L'argument key est une chaîne qui spécifie l'option de catégorie définie par les fonctions. Si l'option de catégorie n'existe
pas, Dreamweaver la crée.
• L'argument new_value est une chaîne qui spécifie la valeur de l'option de catégorie.
Valeurs renvoyées
Valeur true en cas de succès et false dans le cas contraire.
Exemple
var txtEditor = getExternalTextEditor();
dreamweaver.setPreferenceString("My Extension", "Text Editor", txtEditor);
dreamweaver.showTargetBrowsersDialog()
Disponibilité
Dreamweaver MX 2004.
Description
Ouvre la boîte de dialogue Navigateurs cibles. Cette boîte de dialogue permet à l'utilisateur de spécifier les versions des
navigateurs utilisées par la fonction Vérification du navigateur cible pour contrôler les problèmes de compatibilité du
navigateur sur la page actuelle.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Fonctions relatives aux chemins
Ces fonctions permettent d'obtenir et de manipuler les chemins d'accès aux différents fichiers et dossiers enregistrés sur le
disque dur d'un utilisateur. Elles permettent, entre autres, de déterminer le chemin d'accès à la racine du site dans lequel
réside le document actif et de convertir des chemins relatifs en URL absolues.
dreamweaver.getConfigurationPath()
Disponibilité
Dreamweaver 2.
Description
Obtient le chemin d'accès au dossier Configuration de Dreamweaver, exprimé sous la forme d'une URL de type file://.
Pour savoir comment Dreamweaver accède aux dossiers Configuration sur une plate-forme multiutilisateur, voir
Extensions C dans l'aide Extension de Dreamweaver.
Arguments
Aucun.
Valeurs renvoyées
Chemin d'accès aux configurations de l'application.
ADOBE DREAMWEAVER 9.0 241
Guide des API
Exemple
La fonction ci-dessous est utile pour faire référence à d'autres fichiers d'extension stockés dans le sous-dossier Configuration du dossier de l'application Dreamweaver :
var sortCmd = dreamweaver.getConfigurationPath() + ¬
"/Commands/Sort Table.htm"
var sortDOM = dreamweaver.getDocumentDOM(sortCmd);
dreamweaver.getDocumentPath()
Disponibilité
Dreamweaver 1.2.
Description
Obtient le chemin d'accès du document défini, exprimé sous la forme d'une URL de type file://. Cette fonction revient à
appeler la fonction dreamweaver.getDocumentDOM() et à lire la propriété URL de la valeur renvoyée.
Arguments
sourceDoc
• La valeur de l'argument sourceDoc doit être "document", "parent", "parent.frames[number]" ou
"parent.frames['frameName']". document désigne le document actif contenant la sélection en cours. parent désigne le
jeu de cadres parent (si le document sélectionné se trouve dans un cadre) ; "parent.frames[number]" et
"parent.frames['frameName']" désignent un document figurant dans un cadre spécifique du jeu de cadres contenant
le document actif.
Valeurs renvoyées
Soit une chaîne contenant l'URL du document défini si le fichier a été enregistré, soit une chaîne vide si le fichier n'a pas été
enregistré.
dreamweaver.getSiteRoot()
Disponibilité
Dreamweaver 1.2.
Description
Obtient le dossier racine local (tel que défini dans la boîte de dialogue Définition du site) du site associé au document sélectionné, exprimé sous la forme d'une URL de type file://.
Arguments
Aucun.
Valeurs renvoyées
Soit une chaîne contenant l'URL du dossier racine local du site où le fichier a été enregistré, soit une chaîne vide si le fichier
n'est associé à aucun site.
ADOBE DREAMWEAVER 9.0 242
Guide des API
dreamweaver.getTempFolderPath()
Disponibilité
Dreamweaver MX.
Description
Permet d'obtenir le chemin d'accès complet à un dossier temporaire dans lequel vous pouvez enregistrer les fichiers temporaires ou transitoires. Cette fonction recherche un dossier Temp dans le dossier Configuration de Dreamweaver. Si le
système est multiutilisateur, la recherche se fait dans le dossier Configuration de l'utilisateur. Si aucun dossier Temp n'a été
trouvé, la fonction en crée un. Les fichiers partagés qui ne sont pas transitoires doivent être enregistrés dans le dossier
Configuration/Shared.
Arguments
Aucun.
Valeurs renvoyées
Chemin d'accès au dossier, exprimé sous la forme d'une URL de type file://.
Exemple
La ligne de code ci-dessous renvoie le chemin d'accès complet au fichier spécifié. Contrairement aux autres fonctions
Dreamweaver (telles que dreamweaver.getSiteRoot()), la fonction dw.getTempFolderPath() ne renvoie pas de barre
oblique (/) à la fin du chemin :
var myTempfile = dw.getTempFolderPath() + "/myTempFile.txt";
dreamweaver.relativeToAbsoluteURL()
Disponibilité
Dreamweaver 2.
Description
Si on lui fournit une URL relative et un point de référence donnés (chemin d'accès au document actif ou racine du site),
cette fonction convertit l'URL relative en URL absolue (file://).
Arguments
docPath, siteRoot, relURL
• L'argument docPath correspond au chemin d'accès à un document sur l'ordinateur de l'utilisateur (le document actif, par
exemple), exprimé sous la forme d'une URL de type file://, ou à une chaîne vide si relURL est une URL relative à la racine.
• L'argument siteRoot est le chemin d'accès à la racine du site, exprimé sous la forme d'une URL de type file://, ou une
chaîne vide si relURL est une URL relative à un document.
• L'argument relURL est l'URL à convertir.
Valeurs renvoyées
URL absolue. La valeur renvoyée est générée conformément aux principes suivants :
• Si relURL est une URL absolue, aucune conversion n'a lieu et la valeur renvoyée est identique à
relURL.
• Si relURL est une URL relative à un document, la valeur renvoyée est une combinaison de docPath + relURL.
• Si relURL est une URL relative à la racine, la valeur renvoyée est une combinaison de siteRoot + relURL.
ADOBE DREAMWEAVER 9.0 243
Guide des API
Fonctions relatives à la sélection
Ces fonctions permettent d'obtenir et de définir la sélection dans les documents ouverts. Pour savoir comment obtenir et
définir la sélection dans le panneau Site, voir « Fonctions relatives aux sites », page 184.
dom.getSelectedNode()
Disponibilité
Dreamweaver 3.
Description
Obtient le noeud sélectionné. Revient à appeler la fonction dom.getSelection() et à transmettre la valeur renvoyée à la
fonction dom.offsetsToNode().
Arguments
Aucun.
Valeurs renvoyées
Objet balise, texte ou commentaire contenant la série de caractères spécifiée.
dom.getSelection()
Disponibilité
Dreamweaver 3.
Description
Obtient la sélection, exprimée en décalages de caractères, dans le code source du document.
Arguments
{bAllowMultiple}
• L'argument bAllowMultiple (facultatif) est une valeur booléenne qui indique si la fonction doit renvoyer plusieurs
décalages lorsque plusieurs calques, cellules de tableau ou zones réactives de carte graphique sont sélectionnés.
Si cet argument n'est pas défini, il prend par défaut la valeur false.
Valeurs renvoyées
Pour les sélections simples, un tableau contenant deux nombres entiers. Le premier entier correspond au décalage de caractères à l'ouverture de la sélection. Le second correspond au décalage de caractères à la fermeture de la sélection. Si les deux
valeurs sont identiques, la sélection en cours correspond à un point d'insertion.
Pour les sélections complexes (lorsque la sélection se compose de plusieurs cellules de tableau, calques ou zones réactives
de carte graphique), tableau contenant 2n nombres entiers, où n représente le nombre d'éléments sélectionnés. Le premier
entier de chaque paire correspond au décalage de caractères de l'ouverture de la sélection (balise d'ouverture TD, DIV, SPAN,
LAYER, ILAYER ou MAP comprise) ; le second entier correspond au décalage de caractères à la fermeture de la sélection (balise
de fermeture TD, DIV, SPAN, LAYER, ILAYER ou MAP). Si plusieurs rangées d'un tableau sont sélectionnées, le décalage de chaque
cellule de chaque rangée est renvoyé. La sélection n'inclut jamais les balises TR.
ADOBE DREAMWEAVER 9.0 244
Guide des API
dom.nodeToOffsets()
Disponibilité
Dreamweaver 3.
Description
Obtient la position d'un noeud donné dans l'arborescence DOM, exprimée en décalages de caractères dans le code source
du document. Fonction valide pour n'importe quel document sur un lecteur local.
Arguments
node
• L'argument node doit être une balise, un commentaire ou un texte correspondant à un noeud de l'arborescence renvoyée
par la fonction dreamweaver.getDocumentDOM().
Valeurs renvoyées
Tableau qui contient deux nombres entiers. Le premier entier correspond au décalage du début de la balise, du texte ou du
commentaire. Le second correspond au décalage de la fin du noeud, par rapport au début du document HTML.
Exemple
L'exemple de code suivant sélectionne le premier objet image du document actif :
var theDOM = dw.getDocumentDOM();
var theImg = theDOM.images[0];
var offsets = theDom.nodeToOffsets(theImg);
theDom.setSelection(offsets[0], offsets[1]);
dom.offsetsToNode()
Disponibilité
Dreamweaver 3.
Description
Obtient l'objet de l'arborescence DOM qui contient la série entière de caractères située entre l'ouverture et la fermeture
définies. Fonction valide pour n'importe quel document sur un lecteur local.
Arguments
offsetBegin, offsetEnd
• L'argument offsetBegin indique le décalage depuis le début du document jusqu'au début d'une série de caractères
correspondant à un objet dans l'arborescence DOM.
• L'argument offsetEnd indique le décalage depuis le début du document jusqu'à la fin d'une série de caractères correspondant à un objet dans l'arborescence DOM.
Valeurs renvoyées
Objet balise, texte ou commentaire contenant la série de caractères spécifiée.
Exemple
Le code suivant affiche une alerte si la sélection est une image.
var offsets = dom.getSelection();
var theSelection = dreamweaver.offsetsToNode(offsets[0], ¬
offsets[1]);
if (theSelection.nodeType == Node.ELEMENT_NODE && ¬
theSelection.tagName == 'IMG'){
alert('La sélection en cours est une image.');
}
ADOBE DREAMWEAVER 9.0 245
Guide des API
dom.selectAll()
Disponibilité
Dreamweaver 3.
Description
Effectue une opération Sélectionner tout.
Remarque : Dans la plupart des cas, cette fonction sélectionne le contenu entier du document actif. Dans certains cas toutefois
(lorsque le point d'insertion se trouve dans un tableau, par exemple), elle ne sélectionne qu'une partie du document actif. Pour
définir le document entier comme sélection, utilisez la fonction dom.setSelection().
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dom.getSelectedNode()
Disponibilité
Dreamweaver 3.
Description
Définit le noeud sélectionné. Revient à appeler la fonction dom.nodeToOffsets() et à transmettre la valeur renvoyée à la
fonction dom.setSelection().
Arguments
node, {bSelectInside}, {bJumpToNode}
• L'argument node est un noeud de texte, de commentaire ou d'élément du document.
• L'argument bSelectInside (facultatif) est une valeur booléenne qui indique s'il faut sélectionner la propriété innerHTML
du noeud. Cet argument n'est pertinent que si node est un noeud d'élément et qu'il prend par défaut la valeur false
lorsqu'il n'est pas défini.
• L'argument bJumpToNode (facultatif) est une valeur booléenne qui indique s'il faut, le cas échéant, faire défiler la fenêtre
de document pour rendre la sélection visible. S'il n'est pas défini, cet argument prend par défaut la valeur false.
Valeurs renvoyées
Aucune.
dom.setSelection()
Disponibilité
Dreamweaver 3.
Description
Définit le début et la fin de la sélection dans le document.
Arguments
offsetBegin, offsetEnd
• Ces arguments correspondent respectivement à l'ouverture et à la fermeture de la nouvelle sélection, exprimées en
décalages de caractères dans le code source du document. Si les deux valeurs sont identiques, la nouvelle sélection
correspond à un point d'insertion. Si la nouvelle sélection n'est pas une sélection HTML valide, elle inclut les caractères
de la première sélection HTML valide. Par exemple, si offsetBegin et offsetEnd définissent SRC="myImage.gif"
comme sélection dans <IMG SRC="myImage.gif">, la sélection est étendue pour inclure également la balise IMG.
ADOBE DREAMWEAVER 9.0 246
Guide des API
Valeurs renvoyées
Aucune.
dreamweaver.getSelection() (deprecated)
Disponibilité
Dreamweaver 2 ; déconseillée depuis Dreamweaver 3. consultez la section « dom.getSelection() », page 243.
Description
Obtient la sélection en cours, exprimée en décalages d'octets dans le code source du document.
Arguments
Aucun.
Valeurs renvoyées
Tableau qui contient deux nombres entiers. Le premier entier représente le décalage d'octets du début de la sélection et le
second correspond au décalage d'octets de la fin de la sélection. Si les deux valeurs sont identiques, la sélection en cours
correspond à un point d'insertion.
dreamweaver.nodeExists()
Disponibilité
Dreamweaver 3.
Description
Détermine si la référence au noeud indiqué est toujours valable. Il arrive souvent, lors de la rédaction d'extensions, que vous
fassiez référence à un noeud, puis que vous effectuiez une opération qui le supprime (comme définir la propriété innerHTML
ou outerHTML de son parent). Cette fonction vous permet de confirmer que le noeud n'a pas été supprimé avant de
commencer à faire référence à l'une de ses propriétés ou méthodes. Le noeud référencé ne doit pas nécessairement se
trouver dans le document actif.
Arguments
node
• L'argument node correspond au noeud à vérifier.
Valeurs renvoyées
Valeur booléenne : true si le noeud existe et false dans le cas contraire.
ADOBE DREAMWEAVER 9.0 247
Guide des API
Exemple
L'exemple ci-dessous permet d'obtenir le noeud en cours, de localiser un tableau, puis d'appeler la fonction
dw.nodeExists() afin de vérifier si le noeud original existe encore :
function applyFormatToSelectedTable(){
// pour obtenir la sélection en cours
var selObj = dw.getDocumentDOM().getSelectedNode();
alternateRows(dwscripts.findDOMObject("presetNames").selectedIndex,
findTable());
// pour restaurer la sélection d'origine, si elle existe encore ; dans le cas contraire, sélectionne
simplement
// le tableau.
var selArr;
if (dw.nodeExists(selObj))
selArr = dom.nodeToOffsets(selObj);
else
selArr = dom.nodeToOffsets(findTable());
dom.setSelection(selArr[0],selArr[1]);
}
dreamweaver.nodeToOffsets() (déconseillé)
Disponibilité
Dreamweaver 2, déconseillée depuis Dreamweaver 3 : utiliser à la place «
dom.nodeToOffsets() », page 244.
Description
Obtient la position d'un noeud donné dans l'arborescence DOM, exprimée en décalages d'octets dans le code source du
document.
Arguments
node
• L'argument node doit être une balise, un commentaire ou un texte correspondant à un noeud de l'arborescence renvoyée
par la fonction dreamweaver.getDocumentDOM().
Valeurs renvoyées
Tableau qui contient deux nombres entiers. Le premier entier représente le décalage d'octets de l'ouverture de la balise, du
texte ou du commentaire et le second correspond au décalage d'octets de la fermeture du noeud.
dreamweaver.offsetsToNode() (déconseillé)
Disponibilité
Dreamweaver 2, déconseillée depuis Dreamweaver 3 : utiliser à la place «
dom.offsetsToNode() », page 244.
Description
Obtient l'objet de l'arborescence DOM qui contient la série entière de caractères située entre l'ouverture et la fermeture
définies.
Arguments
offsetBegin, offsetEnd
• Ces arguments correspondent respectivement à l'ouverture et à la fermeture d'une série de caractères, exprimées en
décalages d'octets dans le code source du document.
Valeurs renvoyées
Objet balise, texte ou commentaire contenant la série de caractères spécifiée.
ADOBE DREAMWEAVER 9.0 248
Guide des API
dreamweaver.selectAll()
Disponibilité
Dreamweaver 3.
Description
Effectue une opération Sélectionner tout dans la fenêtre de document active, dans le panneau Site ou, sur Macintosh, dans
le champ de texte actif d'une boîte de dialogue ou d'un panneau flottant.
Remarque : Si l'opération est effectuée dans le document actif, elle sélectionne dans la plupart des cas le contenu entier du
document. Dans certains cas toutefois (lorsque le point d'insertion se trouve dans un tableau, par exemple), elle ne sélectionne
qu'une partie du document. Pour définir le document entier comme sélection, utilisez la fonction dom.setSelection().
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.canSelectAll() », page 424.
dreamweaver.getSelection() (déconseillé)
Disponibilité
Dreamweaver 2, déconseillée depuis Dreamweaver 3 : utiliser à la place «
dom.setSelection() », page 245.
Description
Définit la sélection dans le document actif. Cette fonction ne peut déplacer la sélection qu'à l'intérieur du document actif.
Elle ne peut pas rendre un autre document actif.
Arguments
offsetBegin, offsetEnd
• Ces arguments correspondent respectivement à l'ouverture et à la fermeture de la nouvelle sélection, exprimées en
décalages d'octets dans le code source du document. Si les deux valeurs sont identiques, la nouvelle sélection correspond
à un point d'insertion. Si la nouvelle sélection n'est pas une sélection HTML valide, elle inclut les caractères de la
première sélection HTML valide. Par exemple, si offsetBegin et offsetEnd définissent SRC="myImage.gif" comme
sélection dans <IMG SRC="myImage.gif">, la sélection est étendue pour inclure également la balise IMG.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 249
Guide des API
Fonctions de manipulation de chaînes
Ces fonctions vous permettent d'obtenir des informations sur une chaîne et de convertir une chaîne Latin1 en code national
sur la plate-forme de l'utilisateur et vice-versa.
dreamweaver.doURLEncoding()
Disponibilité
Dreamweaver 1.
Description
Prend une chaîne et renvoie une chaîne convertie en URL en remplaçant tous les espaces et caractères spéciaux par les
entités spécifiées.
Arguments
stringToConvert
• L'argument stringToConvert est une chaîne qui contient l'URL non codée qui est codée par la fonction.
Valeurs renvoyées
Une chaîne convertie en format d'URL.
Exemple
L'exemple suivant indique la valeur
URL pour "My URL-encoded string"
:
var URL = dw.doURLEncoding(theURL.value);
returns "My%20URL-encoded%20string"
dreamweaver.getTokens()
Disponibilité
Dreamweaver 1.
Description
Accepte une chaîne et la divise en expressions.
Arguments
searchString, separatorCharacters
• L'argument searchString est la chaîne à diviser en expressions.
• L'argument separatorCharacters est le ou les caractères indiquant la fin d'une expression. Les séparateurs figurant dans
des chaînes entre guillemets sont ignorés. Tous les espaces éventuellement contenus dans separatorCharacters (les
tabulations, par exemple) sont traités comme des séparateurs, comme si vous les aviez définis explicitement. Deux
espaces consécutifs ou plus sont traités comme un seul séparateur.
Valeurs renvoyées
Tableau d'expressions.
Exemple
L'appel de la fonction dw.getTokens() ci-dessous renvoie les expressions indiquées à la suite :
dreamweaver.getTokens('foo("my arg1", 34)', '(),')
•
foo
•
"my arg 1"
•
34
ADOBE DREAMWEAVER 9.0 250
Guide des API
dreamweaver.latin1ToNative()
Disponibilité
Dreamweaver 2.
Description
Convertit une chaîne Latin 1 en code national sur la machine de l'utilisateur. Cette fonction permet d'afficher l'interface
utilisateur d'un fichier d'extension dans une autre langue.
Remarque : Sous Windows, cette fonction n'a aucun effet car le code Windows repose sur Latin 1.
Arguments
stringToConvert
• L'argument stringToConvert est la chaîne à convertir de Latin 1 en code national sur la machine de l'utilisateur.
Valeurs renvoyées
Chaîne convertie.
dreamweaver.nativeToLatin1()
Disponibilité
Dreamweaver 2.
Description
Convertit une chaîne de code national en code Latin 1.
Remarque : Sous Windows, cette fonction n'a aucun effet car le code Windows repose sur Latin 1.
Arguments
stringToConvert
• L'argument stringToConvert est la chaîne à convertir du code national en code Latin 1.
Valeurs renvoyées
Chaîne convertie.
dreamweaver.scanSourceString()
Disponibilité
Dreamweaver UltraDev 1.
Description
Analyse une chaîne de code HTML et recherche les balises, les attributs, les directives et le texte. Pour chaque balise, attribut,
directive et texte trouvé, la fonction scanSourceString() lance une fonction de rappel fournie par l'appelant. Dreamweaver
prend en charge les fonctions de rappel suivantes :
•
openTagBegin()
•
openTagEnd()
•
closeTagBegin()
•
closeTagEnd()
•
directive()
•
attribute()
•
text()
ADOBE DREAMWEAVER 9.0 251
Guide des API
Dreamweaver appelle les sept fonctions de rappel dans les cas suivants :
1 Dreamweaver appelle openTagBegin() pour chaque balise d'ouverture (par exemple <font>, et non </font>) et chaque
balise vide (par exemple, <img> ou <hr>). La fonction openTagBegin() accepte deux arguments : le nom de la balise (par
exemple, font ou img) et le décalage du document, qui est le nombre d'octets contenus dans le document avant le début de
la balise. La fonction renvoie la valeur true si l'analyse doit continuer et false si elle doit s'arrêter.
2 Une fois openTagBegin() exécutée, Dreamweaver appelle attribute() pour chaque attribut HTML. La fonction
attribute() accepte deux arguments : une chaîne contenant le nom de l'attribut (par exemple, "color" ou "src") et une
chaîne contenant la valeur de l'attribut (par exemple "#000000" ou "foo.gif"). La fonction attribute() renvoie une valeur
booléenne indiquant si l'analyse doit continuer.
3 Une fois que tous les attributs de la balise ont été analysés, Dreamweaver appelle openTagEnd(). La fonction
openTagEnd() accepte un argument : le décalage du document, qui est le nombre d'octets contenus dans le document avant
la fin de la balise d'ouverture. Elle renvoie une valeur booléenne qui indique si l'analyse doit continuer.
4 Dreamweaver appelle closeTagBegin() pour chaque balise de fermeture (par exemple, </font>). Cette fonction accepte
deux arguments : le nom de la balise à fermer (par exemple, "font") et le décalage du document, qui correspond au nombre
d'octets contenus dans le document avant le début de la balise de fermeture. La fonction renvoie une valeur booléenne qui
indique si l'analyse doit continuer.
5 Une fois closeTagBegin() terminée, Dreamweaver appelle la fonction closeTagEnd(). La fonction closeTagEnd()
accepte un argument : le décalage du document, qui correspond au nombre d'octets contenus dans le document avant la fin
de la balise de fermeture. Elle renvoie une valeur booléenne qui indique si l'analyse doit continuer.
6 Dreamweaver appelle la fonction directive() pour chaque commentaire HTML, script ASP, script JSP ou script PHP.
La fonction directive() accepte deux arguments : une chaîne contenant la directive et le décalage du document, qui
correspond au nombre d'octets contenus dans le document avant la fin de la balise de fermeture. La fonction renvoie une
valeur booléenne qui indique si l'analyse doit continuer.
7 Dreamweaver appelle la fonction text() pour chaque portion de texte du document, c'est-à-dire tout ce qui n'est pas
une balise ni une directive. Les portions de texte incluent le texte qui n'est pas visible pour l'utilisateur, par exemple le texte
contenu à l'intérieur d'une balise <title> ou <option>. La fonction text() accepte deux arguments : une chaîne contenant
le texte et le décalage du document, qui correspond au nombre d'octets contenus dans le document avant la fermeture de
la balise de fermeture. La fonction text() renvoie une valeur booléenne qui indique si l'analyse doit continuer.
Arguments
HTMLstr, parserCallbackObj
• L'argument HTMLstr est une chaîne qui contient un code.
• L'argument parserCallbackObj est un objet JavaScript qui a une ou plusieurs des méthodes suivantes : openTagBegin(),
openTagEnd(), closeTagBegin(), closeTagEnd(), directive(), attribute() et text(). Pour de meilleurs résultats,
parserCallbackObj doit être une bibliothèque partagée définie à l'aide de l'interface Extension C. Vous obtiendrez
également de meilleures performances si la fonction parserCallbackObj définit uniquement les fonctions de rappel
dont elle a besoin.
Valeurs renvoyées
Valeur booléenne : true si l'opération réussit et false dans le cas contraire.
Exemple
La séquence d'étapes suivante offre un exemple d'utilisation de la fonction dreamweaver.scanSourceString() :
1 Créez une implémentation pour une ou plusieurs des sept fonctions de rappel.
2 Ecrivez un script qui appelle la fonction dreamweaver.scanSourceString().
3 La fonction dreamweaver.scanSourceString() transmet une chaîne contenant le code HTML et les pointeurs des
fonctions de rappel que vous avez écrits. Par exemple, supposons que la chaîne HTML soit "<font
size=2>bonjour</font>".
ADOBE DREAMWEAVER 9.0 252
Guide des API
4 Dreamweaver analyse la chaîne et détermine si elle contient une balise de police. Dreamweaver appelle ensuite les
fonctions de rappel dans l'ordre suivant :
• Fonction openTagBegin()
• Fonction attribute() (pour l'attribut de taille)
• Fonction openTagEnd()
• Fonction text() (pour la chaîne «
bonjour »)
• Fonctions closeTagBegin() et closeTagEnd()
Fonctions relatives à la traduction
Ces fonctions permettent d'agir directement sur les traducteurs de données ou sur les résultats de la traduction. Elles
permettent d'exécuter ou d'obtenir des informations sur un traducteur, de modifier le contenu d'une région verrouillée et
de stipuler que le code traduit doit être utilisé lors de l'obtention et de la définition de décalages de sélection.
dom.runTranslator()
Disponibilité
Dreamweaver 3.
Description
Cette fonction exécute le traducteur spécifié sur le document. Cette fonction n'est valide que pour le document actif.
Arguments
translatorName
• L'argument translatorName est le nom d'un traducteur tel qu'il apparaît dans les préférences de traduction.
Valeurs renvoyées
Aucune.
dreamweaver.editLockedRegions()
Disponibilité
Dreamweaver 2.
Description
Selon la valeur de l'argument, autorise ou non la modification des régions verrouillées. Par défaut, les régions verrouillées
ne peuvent pas être modifiées. Si vous tentez de modifier une région verrouillée avant de la rendre modifiable avec cette
fonction, Dreamweaver émet un bip et interdit la modification.
Remarque : La modification de régions verrouillées peut avoir des conséquences inattendues sur les éléments de bibliothèque
et les modèles. N'utilisez cette fonction qu'avec les traducteurs de données.
Arguments
bAllowEdits
• L'argument bAllowEdits doit avoir une valeur booléenne : true indique que les modifications sont autorisées ; false
indique le contraire. Dreamweaver restaure automatiquement l'état par défaut (non modifiable) des régions verrouillées
lorsque l'exécution du script qui appelle la fonction prend fin.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 253
Guide des API
dreamweaver.getTranslatorList()
Disponibilité
Dreamweaver 3.
Description
Cette fonction obtient la liste des traducteurs de données installés.
Arguments
Aucun.
Valeurs renvoyées
Tableau de chaînes, chacune représentant le nom d'un traducteur tel qu'il apparaît dans les préférences de traduction.
dreamweaver.useTranslatedSource()
Disponibilité
Dreamweaver 2.
Description
Cette fonction indique les valeurs renvoyées par dom.nodeToOffsets() et dom.getSelection(). Elles sont utilisées par
dom.offsetsToNode() et dom.setSelection() et doivent être décalées dans le code source converti (code HTML contenu
dans l'arborescence DOM après l'exécution du traducteur) et non dans le code source non converti.
Remarque : Cette fonction ne s'applique qu'aux fichiers de l'inspecteur Propriétés.
Arguments
bUseTranslatedSource
• L'argument bUseTranslatedSource doit avoir une valeur booléenne : true si la fonction utilise des décalages dans le code
source traduit ; false si la fonction utilise le code source non traduit.
La valeur par défaut de l'argument est false. Lorsque le script appelant la fonction dw.useTranslatedSource() prend fin,
Dreamweaver utilise automatiquement le code source non converti pour les appels suivants de dw.getSelection(),
dw.setSelection(), dw.nodeToOffsets() et dw.offsetsToNode(), sauf si la fonction dw.useTranslatedSource() est
appelée explicitement avec l'argument false avant la fin de l'exécution du script.
Valeurs renvoyées
Aucune.
Fonctions XSLT
Les fonctions XSLT permettent d'agir sur les fichiers XML. Elles permettent d'obtenir des informations sur les documents
XML, y compris l'arborescence de schémas ou la référence à un document XML, et invitent l'utilisateur à indiquer le
document XML associé au document XSLT actif.
MMXSLT.getXML()
Disponibilité
Dreamweaver CS3.
Description
Obtient une chaîne de source XML pour un fichier XML.
ADOBE DREAMWEAVER 9.0 254
Guide des API
Arguments
xmlSourceURI
• Chaîne représentant un URI vers un fichier XML. Cet URI peut être absolu (http ou https), relatif au site ou relatif au
document.
Valeurs renvoyées
Une chaîne contenant le contenu du fichier XML.
Exemple
var xmlSource = MMXSLT.getXML(this.fileDataSetURL);
MMXSLT.getXMLSchema()
Disponibilité
Dreamweaver 8.
Description
Cette fonction renvoie l'arborescence de schémas du fichier XML spécifié.
Arguments
schemaURI, {bRefresh}
• L'argument obligatoire schemaURI est une chaîne correspondant à une référence à un fichier XML local ou distant.
• L'argument facultatif bRefresh est une valeur booléenne : true actualise le schéma ; false renvoie la copie du schéma à
partir du cache des schémas XML. La valeur par défaut est false.
Valeurs renvoyées
Chaîne contenant l'arborescence de schémas XML.
Exemple
L'exemple suivant obtient l'arborescence de schémas à partir du cache de schémas XML pour le fichier menus.xml :
var theSchema = MMXSLT.getXMLSchema("file:///c:/Program Files/Adobe/¬
Adobe Dreamweaver CS3/Configuration/Menus/menus.xml"");
MMXSLT.getXMLSourceURI()
Disponibilité
Dreamweaver 8.
Description
Cette fonction obtient une référence au document source XML associé au document XSLT actif.
Arguments
xsltfileURI, {bUseTempForRemote}
• L'argument xsltfileURI est une chaîne correspondant à l'URI du fichier local qui pointe vers l'emplacement du fichier
XSL.
• L'argument facultatif bUseTempForRemote est une valeur booléenne : true renvoie une référence au fichier temporaire
XML (par exemple, file:///C:/Documents and Settings/username/Local Settings/Temporary Internet
Files/Content.IE5/GTSLQ9KZ/rss[1].xml) qui est téléchargé lorsque le fichier XML original est distant (par exemple,
http://myHost/rssfeed.xml) ; false renvoie une référence absolue.
Valeurs renvoyées
Une chaîne contenant la référence au document source XML associé au document XSLT actif. Si la référence à la source
XML est une référence distante, la fonction renvoie le chemin d'accès à l'emplacement temporaire du fichier téléchargé.
ADOBE DREAMWEAVER 9.0 255
Guide des API
Exemple
L'exemple suivant obtient la référence au document source XML associé à c:\myxslt\myxsltdocument.xsl :
var theXMLSource = MMXSLT.getXMLSourceURI("file:///c:/myxslt/myxsltdocument.xsl");
MMXSLT.launchXMLSourceDialog()
Disponibilité
Dreamweaver 8.
Description
Cette fonction invite l'utilisateur à indiquer le document source XML associé au document XSLT actif. L'utilisateur peut
choisir une référence soit locale soit distante à un document XML.
Arguments
{xsltfileURI, bUseTempForRemote, bAddSchemaReference}
• L'argument xsltfileURI est facultatif. Il s'agit d'une chaîne correspondant à l'URI du fichier local qui pointe vers
l'emplacement du fichier XSL. Si cet argument n'est pas défini, il prend comme valeur par défaut le document actuellement ouvert.
• L'argument facultatif bUseTempForRemote est une valeur booléenne : true renvoie une référence au fichier temporaire
XML (par exemple, file:///C:/Documents and Settings/username/Local Settings/Temporary Internet
Files/Content.IE5/GTSLQ9KZ/rss[1].xml) qui est téléchargé lorsque le fichier XML original est distant (par exemple,
http://myHost/rssfeed.xml) ; false renvoie une référence absolue.
• L'argument bAddSchemaReference est facultatif. Il ajoute une référence dans le document actif qui pointe vers l'URI de
la source XML spécifiée dans la boîte de dialogue de la source XML. Si cet argument n'est pas défini, il prend comme
valeur par défaut le document actuellement ouvert.
Valeurs renvoyées
Une chaîne contenant la référence au document source XML associé au document XSLT actif. Si la référence à la source
XML est une référence distante, la fonction renvoie le chemin d'accès à l'emplacement temporaire du fichier téléchargé.
Exemple
L'exemple suivant ouvre la boîte de dialogue Document source XML sans indiquer aucune valeur :
MMXSLT.launchXMLSourceDialog()
ADOBE DREAMWEAVER 9.0 256
Guide des API
257
Chapitre 15 : Contenu de page
Les fonctions relatives au contenu de page de Adobe® Dreamweaver® CS3 permettent d'effectuer des opérations qui affectent
le contenu d'une page Web. Ces opérations comprennent la manipulation d'actifs dans le panneau Actifs, l'ajout de comportements, le coupage et le collage d'éléments provenant du Presse-papiers, l'application d'un modèle ou l'insertion d'un
fragment de code, la création d'ensembles de données XML Spry, la modification avancée de widgets Spry et d'autres
widgets et l'insertion de widgets Spry Le présent chapitre décrit également les fonctions de vérification de la compatibilité
entre les navigateurs qui permettent aux utilisateurs de créer des mises en page fonctionnant dans différents navigateurs.
Les fonctions décrites dans ce chapitre sont regroupées dans les sections suivantes :
• « Fonctions du panneau Actifs », page 257
• « Fonctions relatives aux comportements », page 266
• « Fonctions relatives au Presse-papiers », page 274
• « Fonctions relatives aux éléments de bibliothèque et aux modèles », page 278
• « Fonctions du panneau Fragments de code », page 282
• « Fonctions de modification de widgets Spry », page 286
• « Insertion de fonctions relatives aux widgets Spry », page 288
• « Fonctions de vérification de la compatibilité avec les navigateurs », page 290
Fonctions du panneau Actifs
Ces fonctions, programmées dans l'API comme panneau d'actifs, vous permettent de gérer et d'utiliser
les éléments contenus dans le panneau Actifs (modèles, bibliothèques, images, contenu Adobe
Shockwave et Adobe Flash, URL, couleurs et scripts).
dreamweaver.assetPalette.addToFavoritesFrom
Document()
Disponibilité
Dreamweaver 4.
Description
Ajoute l'élément sélectionné dans la fenêtre de document à la liste des favoris. Cette fonction prend uniquement en charge
les images, les fichiers Shockwave, les fichiers Flash, les couleurs de police et les URL.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 258
Guide des API
dreamweaver.assetPalette.addToFavoritesFromSiteAssets()
Disponibilité
Dreamweaver 4.
Description
Ajoute les éléments sélectionnés dans la liste des sites à la liste des favoris et donne à chaque élément un surnom. Cette
fonction ne supprime pas les éléments de la liste des sites.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dreamweaver.assetPalette.addToFavoritesFromSiteWindow()
Disponibilité
Dreamweaver 4.
Description
Ajoute les éléments sélectionnés dans le panneau Site ou dans la carte du site à la liste des favoris. Cette fonction prend
uniquement en charge les images, les animations, les scripts, les fichiers Shockwave, les fichiers Flash et les URL (dans le
cas de la carte du site). Si d'autres dossiers ou fichiers sont sélectionnés, ils sont ignorés.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dreamweaver.assetPalette.copyToSite()
Disponibilité
Dreamweaver 4.
Description
Copie les éléments sélectionnés dans un autre site et les place dans la liste des favoris de ce site. Si ces éléments sont des
fichiers (autres que des couleurs ou des URL), le fichier réel est copié dans ce site.
Arguments
targetSite.
• L'argument targetSite est le nom du site cible renvoyé par l'appel site.getSites().
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 259
Guide des API
dreamweaver.assetPalette.edit()
Disponibilité
Dreamweaver 4.
Description
Modifie les éléments sélectionnés à l'aide de l'éditeur externe principal ou de la commande d'édition personnalisée. Pour
les couleurs, le sélecteur de couleur s'affiche. S'il s'agit d'URL, une boîte de dialogue invite l'utilisateur à entrer une URL et
un surnom. Cette fonction n'est pas disponible pour la liste de couleurs et les URL du site.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.assetPalette.canEdit() », page 418.
dreamweaver.assetPalette.getSelectedCategory()
Disponibilité
Dreamweaver 4.
Description
Renvoie la catégorie sélectionnée.
Arguments
Aucun.
Valeurs renvoyées
La catégorie sélectionnée, qui peut être l'une des catégories suivantes : "templates",
"shockwave", "flash", "scripts", "colors" ou "urls".
"library", "images", "movies",
dreamweaver.assetPalette.getSelectedItems()
Disponibilité
Dreamweaver 4.
Description
Renvoie un tableau des éléments sélectionnés dans le panneau Actifs, soit dans la liste des sites, soit dans celle des favoris.
Arguments
Aucun.
Valeurs renvoyées
Tableau de trois chaînes pour chaque élément sélectionné :
• La chaîne name est le nom, le nom de fichier ou le surnom qui s'affiche dans le panneau Actifs.
• La chaîne value est le chemin entier, l'URL complète ou la valeur chromatique, selon l'élément sélectionné.
• La chaîne type est soit "folder", soit l'une des catégories suivantes : "templates",
"library", "images", "movies",
"shockwave", "flash", "scripts", "colors" ou "urls".
Remarque : Si aucun élément n'est sélectionné dans le panneau Actifs, cette fonction renvoie un tableau contenant une seule
chaîne vide.
ADOBE DREAMWEAVER 9.0 260
Guide des API
Exemple
Si « URL » est la catégorie et que le dossier « MyFolderName » et l'URL « MyFavoriteURL » sont sélectionnés dans la liste
des favoris, la fonction renvoie :
items[0]
items[1]
items[2]
items[3]
items[4]
items[5]
=
=
=
=
=
=
"MyFolderName"
"//path/FolderName"
"folder"
"MyFavoriteURL"
"http://www.MyFavoriteURL.com"
"urls"
dreamweaver.assetPalette.getSelectedView()
Disponibilité
Dreamweaver 4.
Description
Indique quelle liste est affichée dans le panneau Actifs.
Arguments
Aucun.
Valeurs renvoyées
Renvoie une chaîne comportant la valeur "site" ou "favorites".
dreamweaver.assetPalette.insertOrApply()
Disponibilité
Dreamweaver 4.
Description
Insère les éléments sélectionnés ou applique l'élément à la sélection en cours. Il applique des modèles, des couleurs et des
URL à la sélection ; il insère également des URL et d'autres éléments au niveau du point d'insertion. Si aucun document
n'est ouvert, cette fonction n'est pas disponible.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.assetPalette.canInsertOrApply() », page 418.
dreamweaver.assetPalette.locateInSite()
Disponibilité
Dreamweaver 4.
Description
Sélectionne les fichiers associés aux éléments sélectionnés du côté local du panneau Site. Cette fonction n'est pas applicable
aux couleurs ni aux URL. Elle est disponible dans la liste des sites et la liste des favoris. Si un dossier est sélectionné dans la
liste des favoris, il est ignoré.
ADOBE DREAMWEAVER 9.0 261
Guide des API
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dreamweaver.assetPalette.newAsset()
Disponibilité
Dreamweaver 4.
Description
Crée un nouvel élément correspondant à la catégorie en cours dans la liste des favoris. Dans le cas des bibliothèques et des
modèles, l'élément créé est un nouveau fichier de bibliothèque ou de modèle vierge auquel l'utilisateur peut immédiatement
attribuer un nom. Pour les couleurs, le sélecteur de couleur s'affiche. S'il s'agit d'URL, une boîte de dialogue invite l'utilisateur à entrer une URL et un surnom. Cette fonction n'est pas disponible pour les images, les fichiers Shockwave, les
fichiers Flash ou les scripts.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dreamweaver.assetPalette.newFolder()
Disponibilité
Dreamweaver 4.
Description
Crée un nouveau dossier ayant un nom par défaut (sans nom) dans la catégorie en cours et place une zone de texte autour
du nom. Cette fonction est uniquement disponible dans la liste des favoris.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dreamweaver.assetPalette.recreateLibraryFrom Document()
Disponibilité
Dreamweaver 4.
Description
Remplace l'ancienne fonction libraryPalette, recreateLibraryFromDocument(). Il remplace un fichier d'élément de
bibliothèque (Library item ou LBI) pour l'instance sélectionnée d'un élément de bibliothèque dans le document actif.
Revient à cliquer sur Créer à nouveau dans l'inspecteur Propriétés.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 262
Guide des API
dreamweaver.assetPalette.refreshSiteAssets()
Disponibilité
Dreamweaver 4.
Description
Analyse le site, affiche la liste des sites et y ajoute des données.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dreamweaver.assetPalette.removeFromFavorites()
Disponibilité
Dreamweaver 4.
Description
Supprime les éléments sélectionnés de la liste des favoris. Cette fonction ne supprime pas les fichiers du disque, sauf dans
le cas d'une bibliothèque ou d'un modèle où l'utilisateur est invité à confirmer l'opération avant que le fichier ne soit
supprimé. Cette fonction est uniquement disponible dans la liste des favoris ou si la catégorie est Library ou Templates.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dreamweaver.assetPalette.renameNickname()
Disponibilité
Dreamweaver 4.
Description
Affiche une zone de texte autour du nom du dossier ou du surnom du fichier pour pouvoir le modifier. Cette fonction est
uniquement disponible dans la liste des favoris ou pour la catégorie Library ou Template.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dreamweaver.assetPalette.setSelectedCategory()
Disponibilité
Dreamweaver 4.
Description
Affiche une catégorie différente.
ADOBE DREAMWEAVER 9.0 263
Guide des API
Arguments
categoryType.
• L'argument categoryType peut être l'une des catégories suivantes : "templates",
"library", "images", "movies",
"shockwave", "flash", "scripts", "colors" ou "urls".
Valeurs renvoyées
Aucune.
dreamweaver.assetPalette.setSelectedView()
Disponibilité
Dreamweaver 4.
Description
Passe de la liste des sites à la liste des favoris et vice versa.
Arguments
viewType.
• L'argument viewType est une chaîne qui peut être "site" ou "favorites".
Valeurs renvoyées
Aucune.
dreamweaver.libraryPalette.deleteSelectedItem() (supprimée)
Disponibilité
Dreamweaver 3 ; fonction supprimée dans Dreamweaver 4 ; utiliser à la place
« dreamweaver.assetPalette.setSelectedCategory() », page 262 et appeler
« dreamweaver.assetPalette.removeFromFavorites() », page 262.
Description
Cette fonction supprime l'élément de bibliothèque sélectionné du panneau Bibliothèque et supprime le fichier d'élément de
la bibliothèque Dreamweaver (LBI) qui lui est associé du dossier Library à la racine du site actuel. Il peut rester des instances
de l'élément supprimé sur certaines pages du site.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dreamweaver.libraryPalette.getSelectedItem() (supprimée)
Disponibilité
Dreamweaver 3 ; fonction supprimée dans Dreamweaver 4 ; utiliser à la place
« dreamweaver.assetPalette.getSelectedItems() », page 259.
Description
Cette fonction obtient le chemin de l'élément de bibliothèque sélectionné.
Arguments
Aucun.
ADOBE DREAMWEAVER 9.0 264
Guide des API
Valeurs renvoyées
Chaîne qui contient le chemin d'accès à l'élément de bibliothèque, exprimé sous la forme d'une URL de type file://.
dreamweaver.libraryPalette.newFromDocument() (supprimée)
Disponibilité
Dreamweaver 3 ; fonction supprimée dans Dreamweaver 4 ; utiliser à la place
« dreamweaver.assetPalette.setSelectedCategory() », page 262 et appeler « dreamweaver.assetPalette.newAsset() »,
page 261.
Description
Cette fonction crée un nouvel élément de bibliothèque basé sur l'élément sélectionné dans le document actif.
Arguments
bReplaceCurrent.
• L'argument bReplaceCurrent est une valeur booléenne indiquant si la sélection doit être remplacée par une instance du
nouvel élément de bibliothèque créé.
Valeurs renvoyées
Aucune.
dreamweaver.libraryPalette.recreateFromDocument() (supprimée)
Disponibilité
Dreamweaver 3 ; supprimée dans Dreamweaver 4 ; utiliser à la place « dreamweaver.assetPalette.recreateLibraryFrom
Document() », page 261.
Description
Cette fonction crée dans le document actif un fichier LBI correspondant à l'instance sélectionnée d'un élément de bibliothèque. Revient à cliquer sur Créer à nouveau dans l'inspecteur Propriétés.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dreamweaver.libraryPalette.renameSelectedItem() (supprimée)
Availability
Dreamweaver 3 ; supprimée dans Dreamweaver 4 ; utiliser à la place « dreamweaver.assetPalette.setSelectedCategory() »,
page 262 avec la valeur d'argument "library" et appeler « dreamweaver.assetPalette.renameNickname() », page 262.
Description
Cette fonction transforme le nom de l'élément de bibliothèque sélectionné en champ de texte et permet à l'utilisateur de
renommer la sélection.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 265
Guide des API
dreamweaver.referencePalette.getFontSize()
Disponibilité
Dreamweaver 4.
Description
Renvoie la taille de police actuelle de la zone d'affichage du panneau Référence.
Arguments
Aucun.
Valeurs renvoyées
Les tailles de police relatives exprimées par les valeurs small, medium ou large.
dreamweaver.referencePalette.setFontSize()
Disponibilité
Dreamweaver 4.
Description
Modifie la taille de police affichée dans le panneau Référence.
Arguments
fontSize.
• L'argument fontSize correspond à l'une des tailles relatives suivantes : small, medium ou large.
Valeurs renvoyées
Aucune.
dreamweaver.templatePalette.deleteSelectedTemplate() (supprimée)
Disponibilité
Dreamweaver 3 ; fonction supprimée dans Dreamweaver 4 ; utiliser à la place
« dreamweaver.assetPalette.setSelectedCategory() », page 262 avec "templates" comme valeur d'argument et appeler
« dreamweaver.assetPalette.removeFromFavorites() », page 262.
Description
Cette fonction supprime le modèle sélectionné du dossier des modèles.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dreamweaver.templatePalette.getSelectedTemplate() (supprimée)
Disponibilité
Dreamweaver 3 ; fonction supprimée dans Dreamweaver 4 ; utiliser à la place
« dreamweaver.assetPalette.getSelectedItems() », page 259.
Description
Cette fonction obtient le chemin du modèle sélectionné.
ADOBE DREAMWEAVER 9.0 266
Guide des API
Arguments
Aucun.
Valeurs renvoyées
Chaîne qui contient le chemin d'accès du modèle, exprimé sous la forme d'une URL de type file://.
dreamweaver.templatePalette.renameSelectedTemplate() (supprimée)
Disponibilité
Dreamweaver 3 ; fonction supprimée dans Dreamweaver 4 ; utiliser à la place
« dreamweaver.assetPalette.setSelectedCategory() », page 262 avec "templates" comme valeur d'argument et appeler
« dreamweaver.assetPalette.renameNickname() », page 262.
Description
Cette fonction transforme le nom du modèle sélectionné en champ de texte et permet à l'utilisateur de renommer
la sélection.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Fonctions relatives aux comportements
Ces fonctions vous permettent d'associer des comportements à un objet ou de les en dissocier, d'identifier les comportements associés à un objet, d'obtenir des informations sur un objet auquel est associé un comportement, etc. Les méthodes
de l'objet dreamweaver.behaviorInspector contrôlent ou agissent uniquement sur la sélection dans le panneau Comportements et non sur la sélection dans le document actif.
dom.addBehavior()
Disponibilité
Dreamweaver 3.
Description
Associe un nouveau couple événement/action (comportement) à l'élément sélectionné. Cette fonction n'est valide que pour
le document actif.
Arguments
event, action, {eventBasedIndex}.
• L'argument event est le gestionnaire d'événements JavaScript à utiliser pour associer le comportement à l'élément (par
exemple, onClick, onMouseOver ou onLoad).
• L'argument action est l'appel de fonction qui serait renvoyé par applyBehavior() si l'action était ajoutée à l'aide du
panneau Comportements (par exemple, "MM_popupMsg('Hello
World')").
• L'argument facultatif eventBasedIndex est la position à laquelle cette action doit être ajoutée. L'argument eventBasedIndex est un index de référence zéro ; par conséquent, s'il existe déjà deux actions associées à l'événement en question et
que vous spécifiez eventBasedIndex comme étant l'action 1, cette dernière sera insérée et exécutée entre les deux autres.
Si vous ne définissez pas cet argument, l'action est insérée à la suite des actions déjà associées à l'événement spécifié.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 267
Guide des API
dom.getBehavior()
Disponibilité
Dreamweaver 3.
Description
Obtient l'action qui se trouve à la position indiquée dans l'événement spécifié. Cette fonction agit sur la sélection en cours
et n'est valide que pour le document actif.
Arguments
event, {eventBasedIndex}
• L'argument event est le gestionnaire d'événements JavaScript à utiliser pour associer le comportement à l'élément (par
exemple, onClick, onMouseOver ou onLoad).
• L'argument facultatif eventBasedIndex est la position de l'action à obtenir. Par exemple, si deux actions sont associées à
l'événement spécifié, 0 est la première et 1 la seconde. Si cet argument n'est pas défini, la fonction renvoie toutes les
actions associées à l'événement spécifié.
Valeurs renvoyées
Chaîne représentant l'appel de fonction (par exemple
"MM_swapImage('document.Image1','document.Image1','foo.gif','#933292969950')") ou tableau de chaînes, si vous
n'avez pas défini l'argument eventBasedIndex.
dom.reapplyBehaviors()
Disponibilité
Dreamweaver 3.
Description
Vérifie si les fonctions associées aux appels de comportement sur le noeud spécifié sont présentes dans la section HEAD du
document et, dans le cas contraire, les y insère.
Arguments
elementNode.
• L'argument elementNode est un noeud d'élément du document actif. Si cet argument n'est pas défini, Dreamweaver
recherche les appels de comportement orphelins sur tous les noeuds d'élément du document.
Valeurs renvoyées
Aucune.
dom.removeBehavior()
Disponibilité
Dreamweaver 3.
Description
Supprime l'action qui se trouve à la position indiquée dans l'événement spécifié. Cette fonction agit sur la sélection en cours
et n'est valide que pour le document actif.
ADOBE DREAMWEAVER 9.0 268
Guide des API
Arguments
event, {eventBasedIndex}
• L'argument event est le gestionnaire d'événements JavaScript à utiliser pour associer le comportement à l'élément (par
exemple, onClick, onMouseOver ou onLoad). Si cet argument n'est pas défini, toutes les actions sont supprimées de
l'élément.
• L'argument facultatif eventBasedIndex est la position de l'action à supprimer. Par exemple, si deux actions sont associées
à l'événement spécifié, 0 est la première et 1 la seconde. Si cet argument n'est pas défini, toutes les actions associées à
l'événement sélectionné sont supprimées.
Valeurs renvoyées
Aucune.
dreamweaver.getBehaviorElement()
Disponibilité
Dreamweaver 2.
Description
Obtient l'objet DOM correspondant à la balise à laquelle le comportement est appliqué. Cette fonction ne s'applique qu'aux
fichiers d'action de comportement.
Arguments
Aucun.
Valeurs renvoyées
Un objet DOM ou une valeur null. La fonction renvoie la valeur null dans les cas suivants :
• lorsque le script en cours d'exécution n'est pas actif dans le contexte du panneau Comportements ;
• lorsque le panneau Comportements est utilisé pour modifier un comportement dans un scénario ;
• lorsque le script en cours d'exécution est appelé par la fonction dreamweaver.popupAction() ;
• lorsque le panneau Comportements associe un événement à un empaqueteur de lien et que ce dernier n'existe pas ;
• lorsque cette fonction se trouve en dehors d'un fichier d'action.
Exemple
La fonction dreamweaver.getBehaviorElement() peut être utilisée de la même façon que
« dreamweaver.getBehaviorTag() », page 269 pour déterminer si l'action sélectionnée est appropriée pour la balise HTML
sélectionnée, à la différence qu'elle vous permet d'accéder à davantage d'informations concernant la balise et ses attributs.
Comme indiqué dans l'exemple suivant, si vous créez une action qui ne peut être appliquée qu'à un lien hypertexte (A HREF)
ne renvoyant pas à un autre cadre ou une autre fenêtre, utilisez la fonction getBehaviorElement() dans la fonction qui
initialise l'interface utilisateur de la boîte de dialogue des paramètres.
function initializeUI(){
var theTag = dreamweaver.getBehaviorElement();
var CANBEAPPLIED = (theTag.tagName == "A" && ¬
theTag.getAttribute("HREF") != null && ¬
theTag.getAttribute("TARGET") == null);
if (CANBEAPPLIED) {
// afficher l'IU de l'action
} else {
// afficher un message d'aide indiquant à l'utilisateur
// que cette action ne peut être appliquée qu'à
// un lien hypertexte sans cible explicite]
}
}
ADOBE DREAMWEAVER 9.0 269
Guide des API
dreamweaver.getBehaviorEvent() (supprimée)
Disponibilité
Dreamweaver 1.2, supprimée dans Dreamweaver 2, car les actions sont désormais choisies avant les événements.
Description
Dans un fichier d'action de comportement, cette fonction obtient l'événement qui déclenche l'action.
Arguments
Aucun.
Valeurs renvoyées
Chaîne représentant l'événement. Il s'agit de la chaîne transmise à la fonction canAcceptBehavior() sous la forme d'un
argument (event).
dreamweaver.getBehaviorTag()
Disponibilité
Dreamweaver 1.2.
Description
Obtient la source de la balise à laquelle le comportement est appliqué. Cette fonction ne s'applique qu'aux fichiers d'action.
Arguments
Aucun.
Valeurs renvoyées
Chaîne représentant la source de la balise. Il s'agit de la chaîne transmise à la fonction canAcceptBehavior() sous forme
d'argument (HTMLelement). Si cette fonction apparaît en dehors d'un fichier d'action, la valeur renvoyée est une chaîne vide.
Exemple
Si vous créez une action qui ne peut être appliquée qu'à un lien hypertexte (A HREF), vous pouvez utiliser la fonction getBehaviorTag(), comme indiqué dans l'exemple suivant, dans la fonction qui initialise l'interface utilisateur de la boîte de
dialogue des paramètres :
function initializeUI(){
var theTag = dreamweaver.getBehaviorTag().toUpperCase();
var CANBEAPPLIED = (theTag.indexOf('HREF') != -1));
if (CANBEAPPLIED) {
// afficher l'IU de l'action
} else {
// afficher un message d'aide indiquant à l'utilisateur
// que cette action ne peut être appliquée qu'à
// lien hypertexte
}
}
ADOBE DREAMWEAVER 9.0 270
Guide des API
dreamweaver.popupAction()
Disponibilité
Dreamweaver 2.
Description
Lance une boîte de dialogue de paramètres correspondant à l'action de comportement spécifiée. Pour l'utilisateur, cela
revient à sélectionner l'action dans le menu déroulant des actions du panneau Comportements. Cette fonction permet aux
fichiers d'extension autres que des actions d'associer des comportements aux objets dans le document de l'utilisateur. L'utilisateur ne peut effectuer aucune autre modification tant qu'il n'a pas fermé la boîte de dialogue.
Remarque : Cette fonction peut être appelée au sein de la fonction objectTag() ou dans tout script de fichier de commande
ou dans le fichier de l'inspecteur Propriétés.
Arguments
actionName, {funcCall}
• L'argument actionName est une chaîne contenant le nom d'un fichier dans le dossier Configuration/Behaviors/Actions
qui contient une action de comportement JavaScript (par exemple, "Timeline/Play
Timeline.htm").
• L'argument facultatif funcCall est une chaîne contenant un appel de fonction pour l'action définie dans actionName (par
exemple, "MM_playTimeline(...)"). Cet argument, s'il est défini, est fourni par la fonction applyBehavior() du fichier
d'action.
Valeurs renvoyées
Appel de fonction de l'action de comportement. Lorsque l'utilisateur clique sur OK dans la boîte de dialogue des
paramètres, le comportement est ajouté au document actif (les fonctions appropriées sont ajoutées dans la section HEAD du
document, le code HTML peut être ajouté au début de la section BODY et d'autres modifications peuvent être effectuées dans
le document). L'appel de fonction ("MM_playTimeline(...)", par exemple) n'est pas ajouté au document ; il devient la
valeur renvoyée par cette fonction.
dreamweaver.behaviorInspector.getBehaviorAt()
Disponibilité
Dreamweaver 3.
Description
Obtient le couple événement/action (comportement) qui se trouve à la position indiquée dans le panneau Comportements.
Arguments
positionIndex.
• L'argument positionIndex est la position de l'action dans le panneau Comportements. La première action de la liste est
à la position 0.
Valeurs renvoyées
Tableau constitué de deux éléments :
• un gestionnaire d'événements ;
• un appel de fonction ou une instruction JavaScript.
Exemple
positionIndex étant un index de base zéro, si le panneau Comportements affiche la liste, un appel à la fonction dreamweaver.behaviorInspector.getBehaviorAt(2) renvoie un tableau constitué de deux chaînes : "onMouseOver" et
"MM_changeProp('document.moon','document.moon','src','sun.gif','MG')".
ADOBE DREAMWEAVER 9.0 271
Guide des API
dreamweaver.behaviorInspector.getBehaviorCount()
Disponibilité
Dreamweaver 3.
Description
Compte le nombre d'actions associées à l'élément actuellement sélectionné à l'aide de gestionnaires d'événements.
Arguments
Aucun.
Valeurs renvoyées
Nombre entier qui représente le nombre d'actions attachées à l'élément. Ce nombre est équivalent au nombre d'actions
visibles dans le panneau Comportements et comprend les actions de comportement Dreamweaver et le code JavaScript
personnalisé.
Exemple
Un appel à la fonction dreamweaver.behaviorInspector.getBehaviorCount() pour le lien sélectionné <A
HREF="javas-
cript:setCookie()" onClick="MM_popupMsg('Un cookie a été défini.');parent.rightframe.location.href='aftercookie.html'"> renvoie la valeur 2.
dreamweaver.behaviorInspector.getSelectedBehavior()
Disponibilité
Dreamweaver 3.
Description
Obtient la position de l'action sélectionnée dans le panneau Comportements.
Arguments
Aucun.
Valeurs renvoyées
Un nombre entier qui représente la position de l'action sélectionnée dans le panneau Comportements ou –1 si aucune
action n'est sélectionnée.
Exemple
Si la première action du panneau Comportements est sélectionnée, comme le montre la figure ci-après, un appel à la
fonction dreamweaver.behaviorInspector.getSelectedBehavior() renvoie le nombre 0 :
ADOBE DREAMWEAVER 9.0 272
Guide des API
dreamweaver.behaviorInspector.moveBehaviorDown()
Disponibilité
Dreamweaver 3.
Description
Déplace une action de comportement vers le bas, à l'intérieur d'une séquence, en modifiant son ordre d'exécution au sein
d'un événement.
Arguments
positionIndex.
• L'argument positionIndex est la position de l'action dans le panneau Comportements. La première action de la liste est
à la position 0.
Valeurs renvoyées
Aucune.
Exemple
Si le panneau Comportements est configuré comme dans l'illustration ci-après, l'appel de la fonction dreamaura pour effet d'intervertir les positions des actions Précharger les
images et Changer la propriété dans l'événement onMouseDown. Pour toute autre position, la fonction dreamweaver.behaviorInspector.moveBehaviorDown() n'a aucun effet, car un seul comportement est associé aux événements
onClick et onFocus et le comportement figurant à la position 3 se trouve déjà à la fin du groupe onMouseDown.
weaver.behaviorInspector.moveBehaviorDown(2)
dreamweaver.behaviorInspector.moveBehaviorUp()
Disponibilité
Dreamweaver 3.
Description
Déplace un comportement vers le haut, à l'intérieur d'une séquence, en modifiant son ordre d'exécution au sein d'un
événement.
Arguments
positionIndex.
• L'argument positionIndex est la position de l'action dans le panneau Comportements. La première action de la liste est
à la position 0.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 273
Guide des API
Exemple
Si le panneau Comportements est configuré comme dans l'illustration ci-après, l'appel de la fonction dreamweaver.behaviorInspector.moveBehaviorUp(3) aura pour effet d'intervertir les positions des actions Précharger les
images et Changer la propriété dans l'événement onMouseOver. Pour toute autre position, la fonction dreamweaver.behaviorInspector.moveBehaviorUp() n'a aucun effet, car un seul comportement est associé aux événements
onClick et onFocus et le comportement figurant à la position 2 se trouve déjà au début du groupe onMouseDown.
dreamweaver.behaviorInspector.setSelectedBehavior()
Disponibilité
Dreamweaver 3.
Description
Sélectionne l'action qui se trouve à la position indiquée dans le panneau Comportements.
Arguments
positionIndex.
• L'argument positionIndex est la position de l'action dans le panneau Comportements. La première action de la liste est
à la position 0. Pour désélectionner toutes les actions, spécifiez l'index de position (positionIndex) sur –1. Spécifier une
position à laquelle ne correspond aucune action revient à spécifier –1.
Valeurs renvoyées
Aucune.
Exemple
Si le panneau Comportements est défini comme dans la figure suivante, l'appel de la fonction dreamweaver.behaviorInspector.setSelection(2) sélectionne l'action Changer la propriété associée à l'événement onMouseDown :
ADOBE DREAMWEAVER 9.0 274
Guide des API
Fonctions relatives au Presse-papiers
Ces fonctions permettent de copier, de couper et de coller des informations à l'aide du Presse-papiers. Sur un ordinateur
Macintosh, certaines fonctions du Presse-papiers peuvent également être appliquées aux champs de texte des boîtes de
dialogue et des panneaux flottants. Dans ce cas, elles peuvent être implémentées en tant que méthodes de l'objet dreamweaver ou en tant que méthodes de l'objet DOM. La version dreamweaver de la fonction agit sur la sélection dans la fenêtre
active, qu'il s'agisse d'une fenêtre de document, de l'inspecteur de code ou du panneau Site. Sur un ordinateur Macintosh,
la fonction peut également être appliquée au contenu sélectionné d'une zone de texte s'il s'agit du champ en cours. La
version DOM de la fonction agit toujours sur la sélection dans le document spécifié.
dom.clipCopy()
Disponibilité
Dreamweaver 3.
Description
Copie la sélection dans le Presse-papiers avec toutes les balises HTML correspondantes.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dom.clipCopyText()
Disponibilité
Dreamweaver 3.
Description
Copie le texte sélectionné dans le Presse-papiers sans les balises HTML correspondantes.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dom.canClipCopyText() », page 410.
dom.clipCut()
Disponibilité
Dreamweaver 3.
Description
Coupe la sélection et la place dans le Presse-papiers, avec toutes les balises HTML correspondantes.
Arguments
Aucun.
ADOBE DREAMWEAVER 9.0 275
Guide des API
Valeurs renvoyées
Aucune.
dom.clipPaste()
Disponibilité
Dreamweaver 3.
Description
Colle le contenu du Presse-papiers dans le document actif, au niveau du point d'insertion ou par dessus la sélection en
cours. Si le Presse-papiers contient des balises HTML, celles-ci sont interprétées comme telles.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dom.canClipPaste() », page 410.
Exemple
Si le Presse-papiers contient ABC
suivant :
Widgets, un appel à la fonction dw.getDocumentDOM().clipPaste() produira le résultat
dom.clipPasteText() (supprimée)
Disponibilité
Dreamweaver 3. Supprimée dans Dreamweaver 8. Utilisez plutôt la fonction dom.clipPaste("text").
Description
Colle le contenu du Presse-papiers dans le document actif, au niveau du point d'insertion en cours ou par dessus la sélection
en cours. Cette fonction remplace les sauts de ligne éventuels par des balises BR. Si le Presse-papiers contient des balises
HTML, celles-ci ne sont pas interprétées et les séparateurs de balises sont remplacés par < et > respectivement.
Arguments
Aucun.
ADOBE DREAMWEAVER 9.0 276
Guide des API
Valeurs renvoyées
Aucune.
Activateur
Consultez « dom.canClipPasteText() », page 410.
Exemple
Si le Presse-papiers contient ce qui suit : <code>return
true;</code>, un appel à la fonction dw.getDocu-
mentDOM().clipPasteText() produira le résultat suivant :
dreamweaver.clipCopy()
Disponibilité
Dreamweaver 3.
Description
Copie la sélection à partir de la fenêtre de document, la boîte de dialogue, le panneau Site ou le panneau flottant en cours
dans le Presse-papiers.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.canClipCopy() », page 418.
dreamweaver.clipCut()
Disponibilité
Dreamweaver 3.
Description
Supprime la sélection dans la fenêtre de document, la boîte de dialogue, le panneau Site ou le panneau flottant actif pour la
placer dans le Presse-papiers.
ADOBE DREAMWEAVER 9.0 277
Guide des API
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.canClipCut() », page 419.
dreamweaver.clipPaste()
Disponibilité
Dreamweaver 3. Ajout de l'argument strPasteOption dans Dreamweaver 8.
Description
Colle le contenu du Presse-papiers dans la fenêtre de document, la boîte de dialogue, le panneau flottant ou le panneau Site
actif.
Arguments
{strPasteOption}
• L'argument facultatif strPasteOption indique le type de collage à effectuer. Ces valeurs sont : "text", "structured",
"basicFormat" et "fullFormat".
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.canClipPaste() », page 419.
Exemple
L'exemple suivant colle le contenu du Presse-papiers sous forme de texte :
dw.clipPaste("text");
dreamweaver.getClipboardText()
Disponibilité
Dreamweaver 3.
Description
Obtient tout le texte mémorisé dans le Presse-papiers.
Arguments
{bAsText}.
• La valeur booléenne facultative bAsText spécifie si le contenu du Presse-papiers est extrait sous forme de texte. Si bAsText
a la valeur true, le contenu du Presse-papiers est extrait sous forme de texte. Si bAsText a la valeur false, le contenu
conserve sa mise en forme. Par défaut, cet argument renvoie la valeur false.
Valeurs renvoyées
Chaîne représentant le contenu du Presse-papiers (il peut s'agir de balises HTML) ou, si le Presse-papiers est vide, rien ne
se passe.
Exemple
Si la fonction dreamweaver.getClipboardText() renvoie "text
boardText(true) renvoie "text bold text".
<b>bold</b> text", alors dreamweaver.getClip-
ADOBE DREAMWEAVER 9.0 278
Guide des API
Fonctions relatives aux éléments de bibliothèque et aux
modèles
Ces fonctions permettent d'effectuer des opérations associées aux éléments de bibliothèque et aux modèles, telles que la
création, la mise à jour et la rupture de liens entre un document et un élément de la bibliothèque ou un modèle. Les
méthodes de l'objet dreamweaver.libraryPalette contrôlent ou agissent sur la sélection dans les éléments de bibliothèque
du panneau Actifs, et non dans le document actif. De même, les méthodes de l'objet dreamweaver.templatePalette
contrôlent ou agissent sur la sélection dans les objets de modèle du panneau Actifs.
dom.applyTemplate()
Disponibilité
Dreamweaver 3.
Description
Applique un modèle au document actif. Si vous ne spécifiez aucun argument, la boîte de dialogue Sélectionner le modèle
s'affiche. Cette fonction n'est valide que pour le document actif.
Arguments
{templateURL}, bMaintainLink
• L'argument templateURL est le chemin d'un modèle disponible sur le site en cours, exprimé sous la forme d'une URL de
type file://.
• L'argument bMaintainLink est une valeur booléenne qui indique si le lien au modèle d'origine doit être conservé (true)
ou non (false).
Valeurs renvoyées
Aucune.
Activateur
Consultez « dom.canApplyTemplate() », page 409.
dom.detachFromLibrary()
Disponibilité
Dreamweaver 3.
Description
Rompt le lien entre l'instance actuellement sélectionnée d'un élément de bibliothèque et le fichier LBI qui lui est associé en
supprimant les balises de verrouillage autour de la sélection. Revient à cliquer sur Détacher de l'original dans l'inspecteur
Propriétés.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 279
Guide des API
dom.detachFromTemplate()
Disponibilité
Dreamweaver 3.
Description
Détache le document actif du modèle qui lui est associé.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dom.getAttachedTemplate()
Disponibilité
Dreamweaver 3.
Description
Obtient le chemin du modèle associé au document.
Arguments
Aucun.
Valeurs renvoyées
Chaîne qui contient le chemin d'accès du modèle, exprimé sous la forme d'une URL de type file://.
dom.getEditableRegionList()
Disponibilité
Dreamweaver 3.
Description
Obtient la liste des régions modifiables dans le corps du document.
Arguments
Aucun.
Valeurs renvoyées
Tableau de noeuds d'élément.
Exemple
« dom.getSelectedEditableRegion() », page 280.
dom.getIsLibraryDocument()
Disponibilité
Dreamweaver 3.
Description
Détermine si le document est un élément de bibliothèque.
ADOBE DREAMWEAVER 9.0 280
Guide des API
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne qui indique si le document est un fichier LBI.
dom.getIsTemplateDocument()
Disponibilité
Dreamweaver 3.
Description
Détermine si le document est un modèle.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne qui indique si le document est un fichier DWT.
dom.getSelectedEditableRegion()
Disponibilité
Dreamweaver 3.
Description
Si la sélection ou le point d'insertion se trouve à l'intérieur d'une région modifiable, cette fonction obtient la position de
cette dernière parmi toutes celles qui existent dans le corps du document.
Arguments
Aucun.
Valeurs renvoyées
Un index dans le tableau renvoyé par la fonction dom.getEditbableRegionList(). Pour plus d'informations, consultez la
section « dom.getEditableRegionList() », page 279.
Exemple
Le code suivant affiche une boîte de dialogue présentant le contenu de la région modifiable sélectionnée :
var theDOM = dw.getDocumentDOM();
var edRegs = theDOM.getEditableRegionList();
var selReg = theDOM.getSelectedEditableRegion();
alert(edRegs[selReg].innerHTML);
dom.insertLibraryItem()
Disponibilité
Dreamweaver 3.
Description
Insère une instance d'un élément de bibliothèque dans le document.
Arguments
libraryItemURL.
• L'argument libraryItemURL est le chemin d'accès à un fichier LBI, exprimé sous la forme d'une URL de type file://.
ADOBE DREAMWEAVER 9.0 281
Guide des API
Valeurs renvoyées
Aucune.
dom.markSelectionAsEditable()
Disponibilité
Dreamweaver 3.
Description
Affiche la boîte de dialogue Nouvelle région modifiable. Lorsque l'utilisateur clique sur Nouvelle région, Dreamweaver
marque la sélection comme étant modifiable et laisse le texte tel quel.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dom.canMarkSelectionAsEditable() », page 414.
dom.newEditableRegion()
Disponibilité
Dreamweaver 3.
Description
Affiche la boîte de dialogue Nouvelle région modifiable. Lorsque l'utilisateur clique sur Nouvelle région, Dreamweaver
insère le nom de la région dans le document, entre accolades ({ }), à l'emplacement du point d'insertion.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dom.canMakeNewEditableRegion() », page 414.
dom.removeEditableRegion()
Disponibilité
Dreamweaver 3.
Description
Supprime une région modifiable du document. Si cette région possède un contenu, celui-ci est conservé ; seuls les
marqueurs de région modifiable sont supprimés.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 282
Guide des API
Activateur
Consultez « dom.canRemoveEditableRegion() », page 415.
dom.updateCurrentPage()
Disponibilité
Dreamweaver 3.
Description
Met à jour les modèles ou les éléments de bibliothèque du document, ou les deux. Cette fonction n'est valide que pour le
document actif.
Arguments
{typeOfUpdate}.
• L'argument facultatif typeOfUpdate doit être "library", "template" ou "both". S'il n'est pas défini, il prend par défaut
la valeur "both".
Valeurs renvoyées
Aucune.
dreamweaver.updatePages()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue Mettre à jour les pages et sélectionne les options spécifiées.
Arguments
{typeOfUpdate}.
• L'argument facultatif typeOfUpdate, si vous le spécifiez, doit être "library", "template" ou "both". S'il n'est pas défini,
il prend par défaut la valeur "both".
Valeurs renvoyées
Aucune.
Fonctions du panneau Fragments de code
Avec Dreamweaver, les développeurs Web peuvent modifier et enregistrer des blocs de code réutilisables dans le panneau
Fragments de code, puis les extraire si besoin est.
Le panneau Fragments de code stocke chaque fragment de code dans un fichier CSN enregistré dans le dossier Configuration\Snippets. Les fragments de code fournis avec Dreamweaver sont stockés dans les dossiers suivants :
• Accessible
• Commentaires
• Content_tables
• Filelist.txt
• Pieds de page
• Form_elements
• En-têtes
ADOBE DREAMWEAVER 9.0 283
Guide des API
• Javascript
• Méta
• Navigation
• Texte
Les fichiers de fragment de code sont des documents XML. Par conséquent, vous pouvez spécifier le codage dans la
directive XML de la manière suivante :
<?XML version="1.0" encoding="utf-8">
Voici un exemple de fichier de fragment de code :
<snippet name="Detect Flash" description="VBscript to check for Flash ActiveX control" preview="code"
factory="true" type="wrap" >
<insertText location="beforeSelection">
<![CDATA[ ------- code --------- ]]>
</insertText>
<insertText location="afterSelection">
<![CDATA[ ------- code --------- ]]>
</insertText>
</snippet>
Les balises de fragment de code des fichiers CSN ont les attributs suivants :
Attribut
Description
name
Nom du fragment de code
description
Description du fragment de code
preview
Type d'aperçu : "code" pour afficher le fragment de code dans la zone d'aperçu ou
"design" pour afficher le fragment de code rendu en code HTML dans la zone
d'aperçu.
type
"wrap" si le fragment de code sert à envelopper la sélection de l'utilisateur, "block"
si le fragment de code doit être inséré avant la sélection.
Vous pouvez faire appel aux méthodes suivantes pour ajouter les fonctions du panneau Fragments de code à vos extensions.
dreamweaver.snippetPalette.getCurrentSnippetPath()
Disponibilité
Dreamweaver MX 2004.
Description
Renvoie le chemin du fragment actuellement sélectionné dans le panneau Fragments de code.
Arguments
Aucun.
Valeurs renvoyées
Chemin, selon le dossier Snippets, du fragment actuellement sélectionné dans le panneau Fragments de code. Renvoie une
chaîne vide si aucun fragment n'est sélectionné.
dreamweaver.snippetPalette.newFolder()
Disponibilité
Dreamweaver MX.
Description
Crée un nouveau dossier ayant un nom par défaut (sans
titre) et place une zone de texte autour du nom.
ADOBE DREAMWEAVER 9.0 284
Guide des API
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dreamweaver.snippetPalette.newSnippet()
Disponibilité
Dreamweaver MX.
Description
Ouvre la boîte de dialogue Ajouter un fragment de code et l'affiche au premier plan.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dreamweaver.snippetPalette.editSnippet()
Disponibilité
Dreamweaver MX.
Description
Ouvre la boîte de dialogue Modifier le fragment de code et l'affiche au premier plan pour que vous puissiez modifier
l'élément sélectionné.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.snippetpalette.canEditSnippet() », page 433.
dreamweaver.snippetPalette.insert()
Disponibilité
Dreamweaver MX.
Description
Applique le fragment sélectionné dans le panneau Fragment de code à la sélection en cours.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.snippetpalette.canInsert() », page 433.
ADOBE DREAMWEAVER 9.0 285
Guide des API
dreamweaver.snippetPalette.insertSnippet()
Disponibilité
Dreamweaver MX.
Description
Insère le fragment sélectionné dans la sélection en cours.
Arguments
path
• Chaîne spécifiant le chemin du fragment par rapport au dossier Snippets.
Valeurs renvoyées
Valeur booléenne.
Activateur
Consultez « dreamweaver.snippetpalette.canInsert() », page 433.
Exemple
L'appel de la fonction dw.snippetPalette.insertSnippet() insère le fragment de code à l'emplacement spécifié par
l'argument dans le document actif, au point d'insertion :
dw.snippetPalette.insertSnippet('Text\\Different_Link_Color.csn');
dreamweaver.snippetPalette.rename()
Disponibilité
Dreamweaver MX.
Description
Affiche une zone de texte autour du nom du dossier ou du surnom du fichier sélectionné pour permettre de le modifier.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dreamweaver.snippetPalette.remove()
Disponibilité
Dreamweaver MX.
Description
Supprime l'élément ou le dossier sélectionné du panneau Fragment de code et supprime le fichier du disque.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 286
Guide des API
Fonctions de modification de widgets Spry
Dreamweaver CS3 fournit des fonctions de modification avancées pour les widgets Spry et autres widgets dynamiques.
element.getTranslatedAttribute()
Disponibilité
Dreamweaver CS3.
Description
Cette fonction est la même que la fonction getAttribute() du W3C, mais agit sur les attributs traduits. La fonction
element.getTranslatedAttribute() extrait une valeur d'attribut en fonction du nom.
Arguments
name
• L'argument name est une chaîne de type DOMString correspondant au nom de l'attribut à extraire.
Valeurs renvoyées
Renvoie le nom de l'attribut sous forme de chaîne DOMString. Si l'attribut n'a pas de valeur spécifiée ni de valeur par défaut,
cette fonction renvoie une chaîne vide.
element.removeTranslatedAttribute()
Disponibilité
Dreamweaver CS3.
Description
Cette fonction est la même que la fonction removeAttribute() du W3C, mais agit sur les attributs traduits. La fonction
element.removeTranslatedAttribute() supprime un attribut en fonction du nom. Si l'attribut possède une valeur par
défaut, l'attribut qui s'affiche contient la valeur par défaut ainsi que l'URI d'espace de nom, le nom local et le préfixe correspondants, le cas échéant.
Arguments
name
• L'argument name est une chaîne de type DOMString correspondant au nom de l'attribut à supprimer.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 287
Guide des API
element.setTranslatedAttribute()
Disponibilité
Dreamweaver CS3.
Description
Cette fonction est la même que la fonction setAttribute() du W3C, mais agit sur les attributs traduits. La fonction
element.setTranslatedAttribute() ajoute un nouvel attribut avec la valeur spécifiée. Si un attribut ayant le nom spécifié
existe déjà dans l'élément, sa valeur est remplacée par celle qui est spécifiée dans l'argument value.
L'argument value est une chaîne simple ; il n'est pas analysé du fait qu'il est en cours de définition. Par conséquent, toute
syntaxe incluse dans la chaîne est traitée en tant que texte simple et doit être ignorée de façon appropriée par l'implémentation lorsqu'elle sera écrite.
Pour affecter une valeur d'attribut contenant de la syntaxe devant être reconnue en tant que référence d'entité, vous devez
créer un noeud Attr ainsi que des noeuds Text et EntityReference, créer l'arborescence secondaire appropriée et utiliser
setAttributeNode afin de l'affecter en tant que valeur d'un attribut.
Arguments
name, value
• L'argument name est une chaîne de type DOMString correspondant au nom de l'attribut à créer ou à modifier.
• L'argument value est une chaîne de type DOMString correspondant à la valeur à définir pour l'attribut.
Valeurs renvoyées
Aucune.
element.translatedClassName
Disponibilité
Dreamweaver CS3.
Description
Cette fonction est identique à element.ClassName() mais agit sur l'attribut className traduit.
element.translatedStyle
Disponibilité
Dreamweaver CS3.
Description
Cette fonction est identique à element.style() mais agit sur l'attribut de style traduit.
Exemple
var div1 = dom.getElementById("div1");
div1.translatedStyle.display = "none";
ADOBE DREAMWEAVER 9.0 288
Guide des API
Insertion de fonctions relatives aux widgets Spry
Dreamweaver fournit les fonctions suivantes pour faciliter l'insertion de widgets Spry.
dom.addJavaScript()
Disponibilité
Dreamweaver CS3.
Description
Cette fonction indique à Dreamweaver d'insérer un bloc JavaScript soit dans la section head, soit dans la section body. Si le
point d'insertion est à l'intérieur de la section body, le bloc JavaScript sera inséré juste avant la balise </body>. Si le
document contient déjà un bloc JavaScript à cet endroit, Dreamweaver n'insérera pas de nouvelle balise <script>, mais
ajoutera "code" au contenu du <script>.
Arguments
code, insideHead
•
code est une chaîne contenant le code JavaScript à insérer dans la page
•
insideHead est une valeur booléenne indiquant si le bloc JavaScript doit être inséré dans la section head ou dans la
section body. La valeur par défaut est true ; elle spécifie l'insertion du code dans la section head. Si la valeur est false,
le code est insérer dans la section body juste avant </body>. Cet argument est facultatif.
Valeurs renvoyées
Aucune.
Exemple
function objectTag()
{
.
.
.
var dom = dw.getDocumentDOM();
var id = dwscripts.getUniqueId("accordéon");
var code = "new Accordion('" + id + "',250,{duration:200,step:20})";
dom.addJavaScript(code, false);
return retVal;
}
dom.copyAssets()
Disponibilité
Dreamweaver CS3.
Description
Un auteur d'extension peut utiliser cet API pour copier des fichiers dépendants externes dans le site de l'utilisateur et ajouter
les références de fichier nécessaires dans la section head de la page.
ADOBE DREAMWEAVER 9.0 289
Guide des API
Arguments
assetArray
Tableau d'objets JavaScript. Chaque objet JavaScript possède des champs "srcURL", "destURL", "referenceType", "useDefaultFolder" et “useRelativeSrc”.
• "srcURL" est un chemin relatif au dossier de configuration de Dreamweaver et fait référence à l'actif fourni par l'auteur
d'extension. Voir la description de "useRelativeSrc" dans cette section.
• "destURL" est un chemin relatif au dossier des actifs par défaut d'un site Dreamweaver et fait référence à l'emplacement
dans lequel l'actif doit être copié. Par défaut, Dreamweaver crée un dossier Actifs dans un site et l'utilise en tant que
dossier d'actifs par défaut. Les utilisateurs peuvent modifier le dossier d'actifs par défaut lorsqu'ils définissent un site
Dreamweaver. Voir la description de "useDefault" dans cette section.
• "referenceType" est nécessaire pour que l'auteur d'extension insère une référence de fichier dans la section head. Les
valeurs autorisées pour referenceType"
•
"link"
•
"import"
•
"javascript"
•
"vbscript"
•
""
sont les suivantes :
pour insérer une balise LINK pour un fichier CSS externe
pour insérer une balise STYLE avec @import
pour insérer une balise SCRIPT avec type=text/javascript
pour insérer une balise SCRIPT avec type=text/vbscript
pour n'insérer aucune référence dans la section head
• "useDefault" est une valeur booléenne qui détermine la façon dont la valeur définie ”destURL” est interprétée. La valeur
par défaut est true. Si la valeur est true, Dreamweaver traite ”destURL” comme un chemin relatif au dossier d'éléments
Spry du site. Si la valeur est false, ”destURL” est un chemin relatif à la racine du site.
• "useRelativeSrc" est une valeur booléenne qui détermine la façon dont la valeur définie ”destURL” est interprétée. La
valeur par défaut est false. Si la valeur est false, “srcURL” est inséré en tant que chemin absolu lorsque “referenceType”
est spécifié.
Valeurs renvoyées
Aucune.
Exemple
function objectTag()
{
.
.
.
var dom = dw.getDocumentDOM();
var assetList = new Array();
var assetInfo = new AssetInfo("Objects/Ajax/Accordion.css", "Objects/Ajax/Accordion.css",
"Accordion.css", "link");
assetList.push(assetInfo);
assetInfo = new AssetInfo("Objects/Ajax/Accordion.js", "Accordion.js", "javascript");
assetList.push(assetInfo);
assetInfo = new AssetInfo("Objects/Ajax/Images", "Images", "");
assetList.push(assetInfo);
dom.copyAssets(assetList);
return retVal;
}
ADOBE DREAMWEAVER 9.0 290
Guide des API
dom.getDefaultAssetFolder()
Disponibilité
Dreamweaver CS3.
Description
Extrait le dossier d'actifs par défaut du document.
Arguments
Aucun.
Valeurs renvoyées
Chaîne qui contient le nom du dossier d'actifs par défaut.
Exemple
function objectTag()
{
.
.
.
var defaultAssetFolder = dom.getDefaultAssetFolder();
.
.
.
return retVal;
}
Fonctions de vérification de la compatibilité avec les
navigateurs
Les fonctions suivantes facilitent la localisation des combinaisons de code HTML et de feuilles de style CSS qui peuvent
déclencher des bogues de rendu de navigateur (pour plus d'informations, consultez le chapitre « API de vérification des
problèmes de compatibilité entre les navigateurs » du manuel Extension de Dreamweaver), mais elles peuvent également
être utilisées dans d'autres types d'extensions (telles que des commandes).
Remarque : Les valeurs que ces fonctions renvoient représentent les styles en vigueur en mode Création. Lorsque les fonctions
sont utilisées dans des fichiers de problèmes dans le cadre d'une vérification de compatibilité avec les navigateurs, Dreamweaver
filtre automatiquement les styles en fonction de la façon dont les navigateurs cible les traiteraient (par exemple, les styles définis
à l'aide de Star HTML sont pris en compte si le navigateur cible est Internet Explorer version 6 ou ultérieure), mais ce filtrage
n'est pas effectué lorsque vous utilisez les fonctions en dehors du contexte d'une vérification de compatibilité avec les navigateurs.
elem.getComputedStyleProp()
Disponibilité
Dreamweaver CS3.
Description
Obtient la valeur de la propriété CSS spécifiée qui est utilisée pour restituer l'élément spécifié, que la propriété soit ou non
spécifiée dans la cascade. Les longueurs sont rapportées en pixels (bien que, à la différence des navigateurs, l'indication "px"
ne soit pas fournie avec la valeur).
ADOBE DREAMWEAVER 9.0 291
Guide des API
Arguments
propName, pseudoElt
•
propName - le nom d'une propriété CSS (utiliser une casse mixte au lieu de traits d'union ; par exemple, "font-size"
devient "fontSize")
•
pseudoElt - le pseudo-élément CSS, ou une valeur null s'il n'en existe aucun
Valeurs renvoyées
Une chaîne contenant la valeur calculée pour la propriété.
Remarque : Notez que les valeurs numériques sont également renvoyées en tant que chaînes ; pour utiliser ces valeurs dans
des calculs, convertissez-les en nombres à l'aide de parseInt() ou parseFloat().
Exemple
var dom = dw.getDocumentDOM();
var myDiv = dom.getElementsByTagName('myDiv');
var float = myDiv.getComputedStyleProp("float");
if (float == "left")
alert("Cette balise div est glottante à gauche.");
window.getDeclaredStyle()
Disponibilité
Dreamweaver CS3.
Description
Obtient les styles CSS qui sont déclarés pour l'élément spécifié. Diffère de la fonction getComputedStyle() en ce sens que
les styles qui ne sont pas spécifiquement déclarés sont indéfinis, et qu'elle donne les valeurs de longueur réelles telles qu'elles
sont déclarées dans la feuille de style (par exemple, 20%, .8em) au lieu des valeurs calculées en pixels. Si bGetInherited a
pour valeur false (cas par défaut), la fonction getDeclaredStyle() n'extrait également que les styles qui s'appliquent directement à l'élément ; elle n'inclut pas les styles hérités d'un parent.
Arguments
elt, pseudoElt, psuedoClassList, bGetInherited
•
elt - noeud du document dont les informations de style sont souhaitées
•
pseudoElt - le pseudo-élément CSS, ou une valeur null s'il n'en existe aucun
•
pseudoClassList - chaîne facultative composée d'une liste de pseudo-classes séparées par des espaces
•
bGetInherited - valeur booléenne facultative indiquant s'il faut inclure les styles hérités d'ancêtres (false par défaut).
Valeurs renvoyées
Un objet en lecture seule contenant des propriétés de style qui sont accessibles à partir de leur nom.
Exemple
var dom = dw.getDocumentDOM();
var myDiv = dom.getElementById('myDiv');
var props = window.getDeclaredStyle(myDiv);
var marleft = "";
var units = "";
if (typeof(props.marginLeft) != "indéfini"){
marleft = props.marginLeft;
units = marleft.replace(/\d+/,""); // supprimer les chiffres, laisser les unités
alert(units); // doit indiquer %, px, pt, em, etc.
}
else
alert("aucune propriété de marge gauche n'a été définie pour myDiv.");
ADOBE DREAMWEAVER 9.0 292
Guide des API
dom.getMinDisplayWidth()
Disponibilité
Dreamweaver CS3.
Description
Obtient la largeur minimale requise pour qu'un conteneur de niveau bloc puisse afficher l'intégralité de son contenu.
Remarque : La largeur réelle du conteneur peut être plus petite si une valeur inférieure à la valeur que la fonction
dom.minDisplayWidth() renvoie est spécifiée à l'aide de feuilles de style CSS.
Arguments
container
•
container est l'élément contenant pour lequel une largeur minimale est requise.
Valeurs renvoyées
Un entier représentant la largeur d'affichage minimale du conteneur spécifié, en pixels, ou -1 n'est pas un conteneur ou si
sa largeur minimale ne peut pas être déterminée
Exemple
var
var
var
var
var
dom = dw.getDocumentDOM();
myDiv = dom.getElementById('myDiv');
props = window.getComputedStyle(myDiv);
minW = dom.getMinDisplayWidth(myDiv);
setW = props.width;
if (minW > setW)
alert("En fonction du navigateur, votre contenu sera \n" +
"tronqué, ou le conteneur s'étendra au-delà de sa largeur définie.");
dom.getBlockElements()
elem.getBlockElements()
Disponibilité
Dreamweaver CS3.
Description
Analyse le document (ou l'élément) à la recherche de descendants ayant 'block' comme valeur d'affichage intrinsèque ou
spécifiée.
Arguments
Aucun
Valeurs renvoyées
Tableau de noeuds d'élément.
Exemple
[...]
var blocks = DOM.getBlockElements();
var dProps = null, children = null;
for (var i=0; i < blocks.length; i++){
// obtenir les styles déclarés pour vérifier si la largeur
// ou la hauteur ont été spécifiées de façon explicite
dProps = window.getDeclaredStyle(blocks[i]);
// si le bloc possède des enfants, une bordure gauche et un remplissage bas
// mais pas de largeur ni de hauteur
if (blocks[i].hasChildNodes() && |
issueUtils.hasBorder(blocks[i],null,"gauche") &&
(parseFloat(blocks[i].getComputedStyleProp("remplissage bas")) > 0) &&
typeof(dProps.width) == "indéfini" && typeof(dProps.height) == "indéfini"){
children = blocks[i].getBlockElements();
ADOBE DREAMWEAVER 9.0 293
Guide des API
var hasLayout = false;
// effectuer une boucle sur les enfants de niveau bloc pour voir si
// certains ont une largeur ou hauteur définie. une largeur ou hauteur définie sur l'un
// des enfants du bloc extérieur empêchera le bogue de se produire.
for (var j=0; j < children.length; j++){
dProps = window.getDeclaredStyle(children[j]);
if (typeof(dProps.width) != "undefined" || typeof(dProps.height) !=
"indéfini"){
hasLayout = true;
break;
}
}
[...]
}
}
[...]
dom.getInlineElements()
elem.getInlineElements()
Disponibilité
Dreamweaver CS3.
Description
Analyse le document (ou l'élément) à la recherche de descendants ayant 'inline' comme valeur d'affichage intrinsèque ou
spécifiée.
Arguments
Aucun.
Valeurs renvoyées
Tableau de noeuds d'élément.
Exemple
[...]
var DOM = dw.getDocumentDOM();
var inEls = DOM.body.getInlineElements();
var next = null, prev = null, parent = null;
var props = null;
// rechercher des éléments remplacés parmi tous les éléments en ligne.
// si aucun élément remplacé n'est trouvé, ne poursuivez pas.
for (var i=0; i < inEls.length; i++){
if (inEls[i].tagName == 'IMG' ||
inEls[i].tagName == 'INPUT' ||
inEls[i].tagName == 'TEXTAREA' ||
inEls[i].tagName == 'SELECT' ||
inEls[i].tagName == 'OBJECT'){
// faire quelque chose
}
}
[...]
ADOBE DREAMWEAVER 9.0 294
Guide des API
dom.getHeaderElements()
elem.getHeaderElements()
Disponibilité
Dreamweaver CS3.
Description
Analyse le document (ou l'élément) à la recherche de balises d'en-tête (H1 à H6).
Arguments
Aucun.
Valeurs renvoyées
Tableau de noeuds d'élément.
Exemple
var DOM = dw.getDocumentDOM();
var headers = DOM.getHeaderElements();
for (var i=0; i < headers.length; i++){
alert(headers[i].tagName);
}
dom.getListElements()
elem.getListElements()
Disponibilité
Dreamweaver CS3.
Description
Analyse le document (ou l'élément) à la recherche de listes numérotées, non numérotées et de listes de définitions.
Arguments
Aucun.
Valeurs renvoyées
Tableau de noeuds d'élément.
Exemple
[...]
var DOM = dw.getDocumentDOM();
// extraire tous les éléments UL, OL et DL du document.
var lists = DOM.getListElements();
var props = null;
for (var i=0; i < lists.length; i++){
props = window.getDeclaredStyle(lists[i]);
if ((props.cssFloat == "left" || props.cssFloat == "right") && props.overflow == "auto"){
// faire quelque chose
}
}
[...]
ADOBE DREAMWEAVER 9.0 295
Guide des API
elem.isBlockElement()
Disponibilité
Dreamweaver CS3.
Description
Vérifie si l'élément possède la valeur 'block' comme valeur d'affichage intrinsèque ou spécifiée.
Arguments
Aucun.
Valeurs renvoyées
Une valeur booléenne indiquant si l'objet est un élément de niveau bloc.
Exemple
[...]
var
var
var
for
DOM = dw.getDocumentDOM();
blocks = DOM.body.getBlockElements();
next = null;
(var i=0; i < blocks.length; i++){
// next est le noeud situé juste après blocks[i]
next = blocks[i].nextSibling;
// si next n'a pas pour valeur null ET si next est un noeud d'élément ET si next est un élément
de bloc,
// nous avons réussi le test du "deuxième de deux éléments de bloc consécutifs".
if (next && (next.nodeType == 1) && next.isBlockElement()){
// faire quelque chose
}
}
[...]
elem.isInlineElement()
Disponibilité
Dreamweaver CS3.
Description
Vérifie si l'élément possède la valeur 'inline' comme valeur d'affichage intrinsèque ou spécifiée.
Arguments
Aucun.
Valeurs renvoyées
Une valeur booléenne indiquant si l'objet est un élément en ligne.
Exemple
[...]
var DOM = dw.getDocumentDOM();
var floats = issueUtils.getFloats(DOM.body);
var next = null;
for (var i=0; i < floats.length; i++){
next = floats[i].nextSibling;
// si l'élément nextSibling de l'élément flottant est un noeud de texte ou un élément en ligne
if (next && (next.nodeType == Node.TEXT_NODE ||
(next.nodeType == Node.ELEMENT_NODE && next.isInlineElement()))){
// faire quelque chose
}
}
[...]
ADOBE DREAMWEAVER 9.0 296
Guide des API
elem.isHeaderElement()
Disponibilité
Dreamweaver CS3.
Description
Vérifie si l'élément est l'une des balises suivantes : h1, h2, h3, h4, h5, h6.
Arguments
Aucun.
Valeurs renvoyées
Une valeur booléenne indiquant si l'objet est un élément d'en-tête.
Exemple
[...]
var DOM = dw.getDocumentDOM();
var floats = issueUtils.getFloats(DOM.body);
var prev = null;
// le premier élément flottant du document n'est pas concerné, donc commencer
// à 1.
for (var i=1; i < floats.length; i++){
prev = floats[i].previousSibling;
// si l'élément situé avant l'élément flottant est une en-tête
if (prev && prev.isHeaderElement()){
// faire quelque chose
}
}
[...]
elem.isListElement()
Disponibilité
Dreamweaver CS3.
Description
Vérifie si l'élément est l'une des balises suivantes : ul, ol, dl.
Arguments
Aucun.
Valeurs renvoyées
Une valeur booléenne indiquant si l'objet est un élément de liste.
Exemple
[...]
var DOM = dw.getDocumentDOM();
var floats = issueUtils.getFloats(DOM.body);
var prev = null, children = null;
for (var i=0; i < floats.length; i++){
children = floats[i].childNodes;
for (var k=0; k < children.length; k++){
if (children[k].isListElement()){
// faire quelque chose
}
}
}
[...]
297
Chapitre 16 : Documents dynamiques
Les fonctions de document dynamique de Adobe® Dreamweaver® CS3 effectuent des opérations liées aux pages de serveur
Web. Ces opérations peuvent, par exemple, être le renvoi d'une propriété pour le noeud sélectionné dans le panneau
Composants, l'obtention d'une liste des sources de données dans le document utilisateur, l'affichage de contenu dynamique
en mode Création, l'application d'un comportement de serveur à un document ou encore l'obtention des noms de tous les
modèles de serveur actuellement définis.
Les fonctions décrites dans ce chapitre sont regroupées dans les sections suivantes :
• « Fonctions de composants de serveur », page 297
• « Fonctions relatives aux sources de données », page 298
• « Fonctions de l'Extension Data Manager », page 299
• « Fonctions Live data », page 301
• « Fonctions relatives aux comportements de serveur », page 305
• « Fonctions de modèle de serveur », page 307
Fonctions de composants de serveur
Ces fonctions permettent d'accéder au noeud sélectionné dans la commande d'arborescence Composants de serveur qui apparaît dans le panneau Composants. Vous pouvez également les utiliser pour
actualiser l'affichage de l'arborescence de composants.
dreamweaver.serverComponents.getSelectedNode()
Disponibilité
Dreamweaver MX.
Description
Renvoie la propriété ComponentRec sélectionnée dans la commande d'arborescence Composants de serveur.
Arguments
Aucun.
Valeurs renvoyées
La propriété ComponentRec.
dreamweaver.serverComponents.refresh()
Disponibilité
Dreamweaver MX.
Description
Actualise l'affichage de l'arborescence de composants.
Arguments
Aucun.
ADOBE DREAMWEAVER 9.0 298
Guide des API
Valeurs renvoyées
Aucune.
Fonctions relatives aux sources de données
Les fichiers de source de données sont stockés dans le dossier Configuration/DataSources. Tous les modèles de serveur ont
leur propre dossier : ASP.Net/C#, ASP.Net/VisualBasic, ASP/JavaScript, ASP/VBScript, ColdFusion, JSP et PHP/MySQL. Le
sous-dossier de chaque modèle contient des fichiers HTML et EDML associés aux sources de données de ce modèle de
serveur.
Pour plus d'informations sur l'utilisation de sources de données dans Dreamweaver, voir Sources de données dans Extension
de Dreamweaver.
dreamweaver.dbi.getDataSources
Disponibilité
Dreamweaver UltraDev 4.
Description
Appelle la fonction findDynamicSources() pour chaque fichier contenu dans le dossier Configuration/DataSources. Vous
pouvez utiliser cette fonction pour générer une liste de toutes les sources de données du document de l'utilisateur. Cette
fonction est répétée sur tous les fichiers du dossier Configuration/DataSources, appelle la fonction findDynamicSources()
dans chaque fichier, concatène tous les tableaux renvoyés et renvoie le tableau de sources de données concaténé.
Arguments
Aucun.
Valeurs renvoyées
Un tableau contenant une liste concaténée de toutes les sources de données contenues dans le document de l'utilisateur.
Chaque élément du tableau est un objet et chaque objet a les propriétés suivantes :
• La propriété title correspond au libellé qui apparaît à droite de l'icône de chaque noeud parent. La propriété title est
toujours définie.
• La propriété imageFile est le chemin de fichier contenant l'icône (une image GIF) qui représente le noeud parent dans
les boîtes de dialogue Données dynamiques et Texte dynamique ou dans le panneau Liaisons. La propriété imageFile est
toujours définie.
• La propriété allowDelete est facultative. Si cette propriété est définie sur la valeur false, lorsque l'utilisateur clique sur
ce noeud dans le panneau Liaisons, le bouton moins (-) apparaît désactivé. Si elle est définie sur la valeur true, le bouton
moins (-) est activé. Si la propriété n'est pas définie, le bouton moins (-) est activé lorsque l'utilisateur clique sur l'élément
(comme si la propriété était définie sur la valeur true).
• La propriété dataSource est le nom du fichier dans lequel la fonction findDynamicSources() est définie. Par exemple, la
fonction findDynamicSources() dans le fichier Session.htm, situé dans le dossier Configuration/DataSources/ASP_Js,
définit la propriété dataSource sur session.htm. Cette propriété est toujours définie.
• La propriété name est le nom du comportement de serveur associé à la source de données dataSource, s'il existe. La
propriété name est toujours définie, mais il peut s'agir d'une chaîne vide ("") si aucun comportement de serveur n'est
associé à la source de données (tel qu'une variable de session).
ADOBE DREAMWEAVER 9.0 299
Guide des API
dw.dbi.setExpanded()
Disponibilité
Dreamweaver CS3.
Description
Définit le noeud à développer ou à réduire.
Arguments
data-source-node-name, expanded
•
data-source-node-name
•
expanded
est une chaîne indiquant le nom de la source de données à développer ou à réduire.
est une valeur booléenne indiquant si le noeud du jeu de données doit être développé ou réduit.
Valeurs renvoyées
Aucune.
Exemple
dw.dbi.setExpanded(dsName, true);
//développer le noeud de la source de données
Fonctions de l'Extension Data Manager
Le gestionnaire de données d'extension (EDM) se compose des API de cette section. Vous pouvez programmer l'accès et la
manipulation des données contenues dans les fichiers groupe et participant en appelant ces fonctions. L'EDM fonctionne
de la manière suivante :
• L'EDM exécute toutes les entrées/sorties de fichier EDML pour les fichiers Groupe et Participant.
• En exécutant toutes les demandes de données pour le modèle de serveur en cours, l 'EDM agit comme un filtre de modèle
de serveur.
dreamweaver.getExtDataValue()
Disponibilité
Dreamweaver UltraDev 4.
Description
Cette fonction extrait les valeurs de champ d'un fichier EDML pour les noeuds spécifiés.
Arguments
qualifier(s)
• L'argument qualifier(s) est une liste, de longueur variable (selon le niveau d'information demandé) de qualificateurs
de noeuds séparés par des virgules comprenant le nom du groupe ou du participant, le sous-bloc (le cas échéant) et le
nom du champ.
Valeurs renvoyées
Dreamweaver attend une valeur de champ. Si la valeur n'est pas spécifiée, Dreamweaver utilise la valeur par défaut.
Exemple
L'exemple suivant extrait la valeur de l'attribut d'emplacement pour la balise insertText du participant recordset_main
participant :
dw.getExtDataValue("recordset_main", "insertText", "location");
ADOBE DREAMWEAVER 9.0 300
Guide des API
dreamweaver.getExtDataArray()
Disponibilité
Dreamweaver UltraDev 4.
Description
Cette fonction extrait un tableau de valeurs d'un fichier EDML pour les noeuds spécifiés.
Arguments
qualifier(s)
• L'argument qualifier(s) est une liste, de longueur variable, de qualificateurs de noeuds séparés par des virgules,
comprenant le nom du groupe ou du participant, le sous-bloc (le cas échéant) et le nom du champ.
Valeurs renvoyées
Dreamweaver attend un tableau de noms de noeuds enfants.
dreamweaver.getExtParticipants()
Disponibilité
Dreamweaver UltraDev 4.
Description
Cette fonction extrait la liste de participants d'un fichier de groupe EDML ou de fichiers participants.
Arguments
value, qualifier(s)
• L'argument value est une valeur de propriété. Il est ignoré s'il n'est pas renseigné. Par exemple, dreamweaver.getExtParticipants("", "participant");
• L'argument qualifier(s) est une liste, de longueur variable, de qualificateurs de noeuds ayant la propriété requise,
séparés par des virgules.
Valeurs renvoyées
Dreamweaver attend un tableau de noms de participants ayant la propriété requise, si elle est spécifiée, et la propriété correspondante, si elle est spécifiée.
dreamweaver.getExtGroups()
Disponibilité
Dreamweaver UltraDev 4.
Description
Extrait le nom du groupe, qui est l'équivalent du nom du comportement de serveur, d'un fichier groupe EDML.
Arguments
value, qualifier(s)
• L'argument value est une valeur de propriété. Il est ignoré s'il n'est pas renseigné.
• L'argument qualifier(s) est une liste, de longueur variable, de qualificateurs de noeuds ayant la propriété requise,
séparés par des virgules.
Valeurs renvoyées
Dreamweaver attend un tableau de noms de groupes ayant la propriété requise, si elle est spécifiée, et la propriété correspondante, si elle est spécifiée.
ADOBE DREAMWEAVER 9.0 301
Guide des API
dreamweaver.refreshExtData()
Disponibilité
Dreamweaver UltraDev 4.
Description
Recharge tous les fichiers de données d'extension.
Vous pouvez créer une commande utile à partir de cette fonction, qui vous permettra de recharger les modifications apportées
aux fichiers EDML de comportement de serveur sans avoir à redémarrer Dreamweaver.
Arguments
Aucun.
Valeurs renvoyées
Dreamweaver attend des données rechargées.
Fonctions Live data
Vous pouvez utiliser les fonctions Live Data suivantes pour reproduire les fonctionnalités de menu :
• La fonction showLiveDataDialog() s'utilise pour l'élément de menu Affichage > Paramètres Live Data.
• La fonction setLiveDataMode() s'utilise pour les éléments de menu Affichage > Live Data et Affichage > Actualiser les
données dynamiques.
• La fonction getLiveDataMode() détermine si le mode Live Data est actif.
Vous pouvez utiliser les autres fonctions Live Data lorsque vous implémentez la fonction liveDataTranslateMarkup()
pour l'API du traducteur.
dreamweaver.getLiveDataInitTags()
Disponibilité
Dreamweaver UltraDev 1.
Description
Renvoie les balises d'initialisation pour le document actif. Les balises d'initialisation sont les balises HTML que l'utilisateur
fournit dans la boîte de dialogue Paramètres Live Data. Cette fonction est généralement appelée à partir de la fonction
liveDataTranslateMarkup() d'un traducteur, de façon à ce que le traducteur puisse transmettre les balises à la fonction
liveDataTranslate().
Arguments
Aucun.
Valeurs renvoyées
Chaîne qui contient les balises d'initialisation.
dreamweaver.getLiveDataMode()
Disponibilité
Dreamweaver UltraDev 1.
Description
Détermine si la fenêtre Live Data est actuellement visible.
ADOBE DREAMWEAVER 9.0 302
Guide des API
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si la fenêtre Live Data est visible ; false dans le cas contraire.
dreamweaver.getLiveDataParameters ()
Disponibilité
Dreamweaver MX.
Description
Obtient les paramètres d'URL définis comme paramètres Live Data.
Le mode Live Data vous permet d'afficher une page Web au stade de conception (comme si elle avait été traduite par le
serveur d'application et renvoyée). En générant un contenu dynamique affichable en mode Création, vous pouvez visualiser
la mise en forme d'une page avec ses données dynamiques et l'ajuster, le cas échéant.
Avant d'afficher les données dynamiques, vous devez saisir les paramètres Live Data de tout paramètre d'URL auquel le
document fait référence. Cela évite que le serveur Web ne renvoie des erreurs pour des paramètres qui ne sont pas encore
définis au stade de la simulation.
La saisie des paramètres d'URL s'effectue par paire nom/valeur. Ainsi, si les scripts de serveur d'un document font référence
aux variables d'URL ID et Name, vous devez définir ces paramètres d'URL avant d'afficher les données dynamiques.
Vous pouvez saisir les paramètres Live Data depuis les endroits suivants dans Dreamweaver :
• Depuis la boîte de dialogue Paramètres Live Data, accessible à partir du menu Affichage.
• Dans le champ de texte URL qui apparaît dans la partie supérieure du document lorsque vous cliquez sur le bouton
Affichage des données dynamiques, situé dans la barre d'outils.
Pour les paramètres ID et Name mentionnés ci-dessus, vous pouvez saisir les paires suivantes :
ID
Name
22
Samuel
Dans l'URL, ces paramètres apparaissent alors comme indiqué dans l'exemple ci-dessous :
http://someURL?ID=22&Name=Samuel
Cette fonction vous permet d'obtenir les paramètres Live Data par le biais de JavaScript.
Arguments
Aucun.
Valeurs renvoyées
Tableau qui contient les paramètres d'URL du document actif. Le tableau contient un nombre pair de chaînes de
paramètres. Chaque association de deux éléments représente une paire nom/valeur de paramètre d'URL. L'élément pair
correspond au nom du paramètre et l'élément impair à sa valeur. Dans l'exemple ci-dessus, getLiveDataParameters()
renvoie donc le tableau suivant pour les paramètres ID et Name : ['ID,'22','Name','Samuel'].
Exemple
L'exemple suivant renvoie les paramètres spécifiés comme paramètres Live Data et les conserve dans paramsArray :
var paramsArray = dreamweaver.getLiveDataParameters();
ADOBE DREAMWEAVER 9.0 303
Guide des API
dreamweaver.liveDataTranslate()
Disponibilité
Dreamweaver UltraDev 1.
Description
Envoie un document HTML entier à un serveur d'application, demande au serveur d'exécuter les scripts dans le document,
puis renvoie le document HTML résultant. Cette fonction peut également être appelée à partir de la fonction liveDataTranslateMarkup() d'un traducteur ; si vous tentez de l'appeler à un autre moment, cela produit une erreur. La fonction
dreamweaver.liveDataTranslate() effectue les opérations suivantes :
• Elle lit l'image animée (qui s'affiche à côté du bord droit de la fenêtre Live Data).
• Elle analyse les données saisies par l'utilisateur. Si vous cliquez sur l'icône Arrêter, la fonction est immédiatement
terminée.
• Elle accepte un argument contenant une seule chaîne de l'appelant (cette chaîne représente généralement le code source
entier du document de l'utilisateur. Il s'agit de la même chaîne que celle utilisée dans l'opération suivante).
• Elle enregistre la chaîne HTML du document de l'utilisateur dans un fichier temporaire stocké sur le serveur Live Data.
• Elle envoie une requête HTTP au serveur Live Data, en utilisant les paramètres définis dans la boîte de dialogue
Paramètres Live Data.
• Elle reçoit la réponse HTML du serveur Live Data.
• Elle supprime le fichier temporaire du serveur Live Data.
• Elle arrête la lecture du fichier d'animation.
• Elle renvoie la réponse HTML à l'appelant.
Arguments
string
• Une seule chaîne, représentant généralement le code source entier du document actif de l'utilisateur.
Valeurs renvoyées
Objet httpReply. Cet objet est le même que la valeur renvoyée par la fonction MMHttp.getText(). Si l'utilisateur clique sur
l'icône Arrêter, le code httpReply.statusCode de la valeur de retour est égal à 200 (état OK) et sa valeur httpReply.data
est égal à une chaîne vide. Pour plus d'informations sur l'objet httpReply, consultez le « API HTTP », page 13.
dreamweaver.setLiveDataError()
Disponibilité
Dreamweaver UltraDev 1.
Description
Détermine le message d'erreur qui s'affiche si une erreur se produit lors de l'exécution de la fonction liveDataTranslateMarkup() dans un traducteur. Si le document transmis par Dreamweaver à liveDataTranslate() contient des erreurs, le
serveur retransmet un message d'erreur au format HTML. Si le traducteur (code ayant appelé liveDataTranslate())
détermine que le serveur a renvoyé un message d'erreur, il appelle setLiveDataError() pour afficher le message d'erreur
dans Dreamweaver. Ce message s'affiche une fois que la fonction liveDataTranslateMarkup() a été exécutée ; Dreamweaver affiche la description dans une boîte de dialogue d'erreurs. La fonction setLiveDataError() doit uniquement être
appelée à partir de la fonction liveDataTranslateMarkup().
Arguments
source
• L'argument source est une chaîne qui contient le code source, qui est analysé et affiché dans la boîte de dialogue du
message d'erreur.
ADOBE DREAMWEAVER 9.0 304
Guide des API
Valeurs renvoyées
Aucune.
dreamweaver.getLiveDataMode()
Disponibilité
Dreamweaver UltraDev 1.
Description
Active ou désactive l'affichage de la fenêtre Live Data.
Arguments
bIsVisible
• L'argument bIsVisible est une valeur booléenne qui indique si la fenêtre Live Data doit être visible. Si vous transmettez
la valeur true à cette fonction et que Dreamweaver est défini pour afficher la fenêtre Live Data, l'effet est le même que si
l'utilisateur cliquait sur le bouton Actualiser.
Valeurs renvoyées
Aucune.
dreamweaver.getLiveDataParameters ()
Disponibilité
Dreamweaver MX.
Description
Définit les paramètres d'URL référencés dans le document pour une utilisation en mode Live Data.
Le mode Live Data vous permet d'afficher une page Web au stade de conception (comme si elle avait été traduite par le
serveur d'application et renvoyée). En générant un contenu dynamique affichable en mode Création, vous pouvez visualiser
la mise en forme d'une page avec ses données dynamiques et l'ajuster, le cas échéant.
Avant d'afficher les données dynamiques, vous devez saisir les paramètres Live Data de tout paramètre d'URL auquel le
document fait référence. Cela évite que le serveur Web ne renvoie des erreurs pour des paramètres qui ne sont pas encore
définis au stade de la simulation.
La saisie des paramètres d'URL s'effectue par paire nom/valeur. Ainsi, si les scripts de serveur d'un document font référence
aux variables d'URL ID et Name, vous devez définir ces paramètres d'URL avant d'afficher les données dynamiques.
Cette fonction vous permet de définir les valeurs Live Data par le biais de JavaScript.
Arguments
liveDataString
• L'argument liveDataString est une chaîne qui contient les paramètres d'URL à définir, au sein de paires nom/valeur.
Valeurs renvoyées
Aucune.
Exemple
dreamweaver.setLiveDataParameters(“ID=22&Name=Samuel”)
ADOBE DREAMWEAVER 9.0 305
Guide des API
dreamweaver.showLiveDataDialog()
Disponibilité
Dreamweaver UltraDev 1.
Description
Affiche la boîte de dialogue Paramètres Live Data.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Fonctions relatives aux comportements de serveur
Ces fonctions vous permettent de manipuler le panneau Comportements de serveur, accessible sous Fenêtre > Comportements de serveur. Vous pouvez utiliser ces fonctions pour rechercher tous les comportements de serveur sur une page. Vous
pouvez aussi les utiliser pour appliquer un nouveau comportement à un document ou pour modifier un comportement
existant, et ce par le biais d'un programme.
Remarque : Vous pouvez abréger dw.serverBehaviorInspector en dw.sbi.
dreamweaver.getParticipants()
Disponibilité
Dreamweaver UltraDev 4.
Description
La fonction JavaScript dreamweaver.getParticipants() répertorie les participants présents dans le document utilisateur.
Une fois tous les participants du comportement trouvés, Dreamweaver mémorise ces listes de participants. En général, cette
fonction est utilisée avec la fonction findServerBehaviors() (pour plus d'informations, voir Comportements de serveur
dans Extension de Dreamweaver) pour repérer les instances d'un comportement dans le document utilisateur.
Arguments
edmlFilename
• L'argument edmlFilename est le nom du fichier groupe ou participant qui contient les noms des participants à localiser
dans le document utilisateur. Cette chaîne est le nom de fichier, sans le suffixe d'extension .edml.
Valeurs renvoyées
Cette fonction renvoie un tableau contenant toutes les instances du participant spécifié (ou, dans le cas d'un fichier groupe,
une instance d'un participant dans le groupe) apparaissant dans le document utilisateur. Le tableau contient des objets
JavaScript, avec un élément pour chaque instance de participant trouvée dans le document utilisateur. Le tableau est trié
selon l'ordre dans lequel les participants apparaissent dans le document. Chaque objet JavaScript présente les propriétés
suivantes :
• La propriété participantNode est un pointeur relié au noeud participant dans le document utilisateur.
• La propriété participantName est le nom du fichier EDML du participant (sans le suffixe« .edml »).
• La propriété parameters est un objet JavaScript qui stocke toutes les paires paramètre/valeur.
• La propriété matchRangeMin définit le décalage de caractères à partir du noeud participant du document jusqu'au début
du contenu du participant.
• La propriété matchRangeMax est un nombre entier du participant définissant le décalage depuis le début du noeud participant jusqu'au dernier caractère du contenu du participant.
ADOBE DREAMWEAVER 9.0 306
Guide des API
dreamweaver.serverBehaviorInspector.getServer
Behaviors()
Disponibilité
Dreamweaver UltraDev 1.
Description
Affiche une liste de tous les comportements sur une page. Si Dreamweaver détermine que la liste interne des comportements de serveur n'est peut-être pas à jour, il appelle la fonction findServerBehaviors() pour chaque comportement
installé. Chaque fonction renvoie un tableau. Dreamweaver fusionne tous les tableaux en un seul tableau et le trie dans
l'ordre où chaque objet selectedNode de comportement apparaît dans le document. Dreamweaver stocke le tableau
fusionné localement. La fonction getServerBehaviors() renvoie un pointeur au tableau fusionné.
Arguments
Aucun.
Valeurs renvoyées
Tableau d'objets JavaScript. L'appel findServerBehaviors() renvoie les objets dans le tableau. Ils sont triés dans leur ordre
d'apparition dans le panneau Comportements de serveur.
dreamweaver.popupServerBehavior()
Disponibilité
Dreamweaver UltraDev 1.
Description
Applique un nouveau comportement de serveur au document ou modifie un comportement existant. Si l'utilisateur doit
définir les paramètres du comportement, une boîte de dialogue s'affiche.
Arguments
{behaviorName ou behaviorObject}
• L'argument facultatif behaviorName est une chaîne qui représente le nom du comportement, la balise de titre d'un fichier
ou un nom de fichier.
• L'argument facultatif behaviorObject est un objet comportement.
Si vous ne définissez pas cet argument, Dreamweaver exécute le comportement de serveur sélectionné. Si l'argument est le
nom d'un comportement de serveur, Dreamweaver ajoute ce comportement à la page. Si l'argument est l'un des objets du
tableau renvoyé par la fonction getServerBehaviors(), une boîte de dialogue s'affiche pour permettre à l'utilisateur de
modifier les paramètres du comportement.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 307
Guide des API
Fonctions de modèle de serveur
Dans Dreamweaver, tous les documents ont un type de document associé. Pour les types de documents dynamiques,
Dreamweaver associe également un modèle de serveur (tel que ASP-JS, ColdFusion ou PHP-MySQL).
Les modèles de serveur sont utilisés pour regrouper une fonctionnalité spécifique à une technologie de serveur. Différents
comportements de serveur, sources de données, etc., apparaissent en fonction du modèle de serveur associé au document.
Utilisez les fonctions de modèle de serveur pour déterminer l'ensemble des modèles de serveur actuellement définis, le
nom, la langue et la version du modèle de serveur en cours, et si le modèle de serveur en cours prend en charge un ensemble
nommé de caractères (tel que UTF-8).
Remarque : Dreamweaver lit toutes les informations contenues dans le fichier HTML du modèle de serveur et stocke ces informations lors du premier chargement du modèle de serveur. Lorsqu'une extension appelle des fonctions telles que dom.serverModel.getServerName(), dom.serverModel.getServerLanguage() et dom.serverModel.getServerVersion(), ces
fonctions renvoient les valeurs stockées.
dom.serverModel.getAppURLPrefix()
Disponibilité
Dreamweaver MX.
Description
Renvoie l'URL du dossier racine du site sur le serveur d'évaluation. Cette URL est la même que celle qui a été spécifiée pour
le serveur d'évaluation dans l'onglet Avancé de la boîte de dialogue Définition du site.
Lorsque Dreamweaver communique avec votre serveur d'évaluation, il utilise HTTP (de la même manière qu'un
navigateur). Il utilise alors cette URL pour accéder au dossier racine de votre site.
Arguments
Aucun.
Valeurs renvoyées
Chaîne qui maintient l'URL au serveur d'application utilisé pour les données dynamiques et le débogage.
Exemple
Si l'utilisateur crée un site et précise que le serveur d'évaluation est sur l'ordinateur local et que le dossier racine est intitulé
« employeeapp », un appel à la fonction dom.serverModel.getAppURLPrefix() renvoie la chaîne suivante :
http://localhost/employeeapp/
dom.serverModel.getDelimiters()
Disponibilité
Dreamweaver MX.
Description
Permet au code JavaScript d'obtenir le délimiteur de script pour chaque modèle de serveur, afin de pouvoir séparer la
gestion du modèle de serveur et celle du code utilisateur.
Arguments
Aucun.
ADOBE DREAMWEAVER 9.0 308
Guide des API
Valeurs renvoyées
Tableau d'objets dans lequel tous les objets contiennent les trois propriétés suivantes :
• La propriété startPattern est une expression régulière qui correspond au délimiteur d'ouverture de script.
• La propriété endPattern est une expression régulière qui correspond au délimiteur de fermeture de script.
• Le modèle participateInMerge est une valeur booléenne qui indique si le contenu entre les délimiteurs utilisés doit
(true) ou non (false) prendre part à la fusion de blocs.
dom.serverModel.getDisplayName()
Disponibilité
Dreamweaver MX.
Description
Obtient le nom du modèle de serveur qui apparaît dans l'interface utilisateur (UI).
Arguments
Aucun.
Valeurs renvoyées
Chaîne dont la valeur est le nom du modèle de serveur.
dom.serverModel.getFolderName()
Disponibilité
Dreamweaver MX.
Description
Obtient le nom du dossier utilisé pour ce modèle de serveur dans le dossier Configuration (tel que le sous-dossier ServerModels).
Arguments
Aucun.
Valeurs renvoyées
Chaîne dont la valeur est le nom du dossier.
dom.serverModel.getServerExtension() (déconseillée)
Disponibilité
Dreamweaver UltraDev 4 ; déconseillée dans Dreamweaver MX
Description
Renvoie l'extension par défaut des fichiers exploitant le modèle de serveur en cours (l'extension du fichier par défaut est la
première dans la liste). Si aucun document utilisateur n'est sélectionné, l'objet serverModel est défini sur le modèle de
serveur du site actuellement sélectionné.
Arguments
Aucun.
Valeurs renvoyées
Chaîne qui représente les extensions de fichier prises en charge.
ADOBE DREAMWEAVER 9.0 309
Guide des API
dom.serverModel.getServerIncludeUrlPatterns()
Disponibilité
Dreamweaver MX.
Description
Renvoie la liste de propriétés, qui vous permet d'accéder aux éléments suivants :
• Modèles URL du traducteur
• Références du fichier
• Type
Arguments
Aucun.
Valeurs renvoyées
Liste d'objets, un pour chaque searchPattern. Chaque objet présente les trois propriétés suivantes :
Propriété
Description
pattern
Expression régulière JavaScript spécifiée dans le champ searchPattern d'un fichier
EDML (une expression régulière est délimitée par deux barres obliques (//)).
fileRef
L'index de base 1 de la sous-correspondance de l'expression régulière qui correspond
à la référence du fichier inclus.
type
La portion de la valeur paramName qui reste après avoir ôté le suffixe _includeUrl.
Ce type est affecté à l'attribut du type de balise <MM:BeginLock>. Pour avoir un
exemple, voir Server Model SSI.htm dans le dossier Configuration/Translators.
Exemple
Le fragment de code suivant d'un fichier participant illustre une balise searchPatterns de traducteur :
<searchPatterns whereToSearch="comment">
<searchPattern paramNames=",ssi_comment_includeUrl">
<![CDATA[/<!--\s*#include\s+(file|virtual)\s*=\s*"([^"]*)"\s*-->/i]]>
</searchPattern>
</searchPatterns>
Le modèle de recherche contient une expression régulière JavaScript qui spécifie deux sous-correspondances (toutes deux
entre parenthèses). La première sous-correspondance est pour la chaîne de texte file ou virtual. La deuxième souscorrespondance est une référence de fichier.
Pour accéder au modèle URL du traducteur, votre code doit ressembler à l'exemple suivant :
var serverModel = dw.getDocumentDOM().serverModel;
var includeArray = new Array();
includeArray = serverModel.getServerIncludeUrlPatterns();
L'appel à la fonction serverModel.getServerIncludeUrlPatterns() renvoie les trois propriétés suivantes :
Propriété
Valeur renvoyée
pattern
/<!--\s*#include\s+(file|virtual)\s*=\s*"([^"]*)"\s*-->/i
fileRef
2
type
ssi_comment
ADOBE DREAMWEAVER 9.0 310
Guide des API
dom.serverModel.getServerInfo()
Disponibilité
Dreamweaver MX.
Description
Renvoie des informations spécifiques au modèle de serveur en cours. Ces informations figurent dans le fichier de définition
HTML correspondant au modèle de serveur, situé dans le dossier Configuration/ServerModels.
Vous pouvez modifier les informations contenues dans le fichier de définition HTML ou placer des valeurs ou fonctions de
variable supplémentaires dans le fichier. Vous pouvez par exemple modifier les propriétés serverName, serverLanguage et
serverVersion. La fonction dom.serverModel.getServerInfo() renvoie les informations ajoutées par l'auteur du modèle
de serveur au fichier de définition.
Remarque : Les autres valeurs définies dans les fichiers de modèles de serveur par défaut sont réservées à un usage interne.
Les propriétés serverName, serverLanguage et serverVersion sont spécifiques, accessibles directement au moyen des
fonctions correspondantes suivantes :
•
dom.serverModel.getServerName()
•
dom.serverModel.getServerLanguage()
•
dom.serverModel.getServerVersion()
Arguments
Aucun.
Valeurs renvoyées
Objet JavaScript qui contient diverses informations spécifiques au modèle de serveur en cours.
dom.serverModel.getServerLanguage() (déconseillé)
Disponibilité
Dreamweaver UltraDev 1 ; déconseillée dans Dreamweaver MX
Description
Détermine le modèle de serveur associé au document et renvoie cette valeur. Le langage serveur d'un site est la valeur
choisie dans le paramètre Langage de script par défaut de l'onglet Infos du serveur d'application de la boîte de dialogue
Définition du site. Pour obtenir la valeur de retour, cette fonction appelle la fonction getServerLanguage() dans l'API de
modèle de serveur.
Remarque : La liste Langage de script par défaut existe uniquement dans Dreamweaver 4 et les versions antérieures. Pour
Dreamweaver MX (ou version supérieure), la boîte de dialogue Définition du site ne répertorie pas les langages de script pris
en charge. Toujours pour Dreamweaver MX (ou version supérieure), la fonction dom.serverModel.getServerLanguage() lit
la propriété serverLanguage de l'objet renvoyé par un appel à la fonction getServerInfo() dans l'API de modèle de serveur.
Arguments
Aucun.
Valeurs renvoyées
Chaîne qui contient les langages de script pris en charge.
ADOBE DREAMWEAVER 9.0 311
Guide des API
dom.serverModel.getServerName()
Disponibilité
Dreamweaver 1 ; amélioré dans la version Dreamweaver MX
Description
Extrait le nom du serveur associé au document et renvoie cette valeur. Le nom de serveur varie selon les technologies de
serveur (comme ASP.NET et JSP) et non selon les langages d'une même technologie de serveur (comme ASP.NET VB et
ASP.NET C#). Parmi les valeurs possibles, on retrouve ASP, ASP.NET, Cold Fusion, JSP et PHP.
Pour extraire le nom de modèle de serveur associé au document, consultez la section
« dom.serverModel.getDisplayName() », page 308 ou « dom.serverModel.getFolderName() », page 308.
Remarque : Pour Dreamweaver MX ou version ultérieure, la fonction dom.serverModel.getServerName() lit la propriété
dans l'API de modèle de serveur.
serverName de l'objet renvoyé par un appel à la fonction getServerInfo()
Arguments
Aucun.
Valeurs renvoyées
Chaîne qui contient le nom du serveur.
dom.serverModel.getServerSupportsCharset()
Disponibilité
Dreamweaver MX.
Description
Détermine si le modèle de serveur associé au document prend en charge le jeu de caractères nommé.
Remarque : Dreamweaver vous permet d'appeler cette fonction à partir du calque JavaScript mais aussi lorsque l'utilisateur
modifie l'encodage dans la boîte de dialogue des propriétés. Si le modèle de serveur ne prend pas en charge le nouvel encodage
des caractères, cette fonction renvoie la valeur false et Dreamweaver affiche une boîte de dialogue d'avertissement demandant
à l'utilisateur s'il souhaite faire la conversion. Cela peut se produire par exemple lorsqu'un utilisateur essaie de convertir un
document ColdFusion 4.5 en UTF-8, car ColdFusion ne prend pas en charge l'encodage UTF-8.
Arguments
metaCharSetString
• L'argument metaCharSetString est une valeur de chaîne qui dénomme un jeu de caractères donné. Cette valeur est la
même que celle de l'attribut "charset=" d'une balise meta associée à un document. Les valeurs prises en charge pour un
modèle de serveur donné sont définies dans le fichier de définition HTML pour le modèle de serveur, situé dans le
dossier Configuration/ServerModels.
Valeurs renvoyées
Valeur booléenne : true si le modèle de serveur prend en charge le jeu de caractères nommé ; false dans le cas contraire.
ADOBE DREAMWEAVER 9.0 312
Guide des API
dom.serverModel.getServerVersion()
Disponibilité
Dreamweaver 1 ; amélioré dans la version Dreamweaver MX
Description
Détermine le modèle de serveur associé au document et renvoie cette valeur. Chaque modèle de serveur a une fonction
getVersionArray() (dans l'API de modèle de serveur), qui renvoie un tableau de couples nom-version.
Remarque : Pour Dreamweaver, la fonction dom.serverModel.getServerVersion() lit d'abord la propriété serverVersion
de l'objet renvoyé par un appel à la fonction getServerInfo() dans l'API de modèle de serveur. Si cette propriété n'existe pas,
la fonction dom.serverModel.getServerVersion() la lit à partir de la fonction getVersionArray().
Arguments
name
• L'argument name est une chaîne représentant le nom d'un modèle de serveur.
Valeurs renvoyées
Chaîne qui contient la version du modèle de serveur nommé.
dom.serverModel.testAppServer()
Disponibilité
Dreamweaver MX.
Description
Teste s'il est possible d'établir une connexion au serveur d'application.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne qui indique si la demande de connexion au serveur d'application a été acceptée.
dreamweaver.getServerModels()
Disponibilité
Dreamweaver MX.
Description
Obtient les noms de tous les modèles de serveur actuellement définis. Les noms sont les mêmes que ceux qui apparaissent
dans la zone de texte Modèle de serveur de la boîte de dialogue Définition du site.
Arguments
Aucun.
Valeurs renvoyées
Tableau de chaînes. Tous les éléments de chaîne contiennent le nom d'un modèle de serveur actuellement défini.
313
Chapitre 17 : Conception
Les fonctions de Conception de Adobe® Dreamweaver® CS3 permettent d'effectuer des opérations en rapport avec la
personnalisation de l'apparence d'un document. Ces opérations incluent des fonctions permettant d'appliquer le style de
feuille de style en cascade (CSS) spécifié, de fractionner le cadre sélectionné verticalement ou horizontalement, d'aligner
les calques ou zones réactives sélectionnés, d'exécuter le plug-in sélectionné, de créer une cellule de Mise en forme ou de
manipuler des lignes ou des colonnes d'un tableau.
Les fonctions décrites dans ce chapitre sont regroupées dans les sections suivantes :
• « Fonctions relatives aux mises en forme CSS », page 313
• « Fonctions relatives aux cadres et aux jeux de cadres », page 330
• « Fonctions relatives aux calques et aux cartes graphiques », page 332
• « Fonctions d'environnement de mise en forme », page 334
• « Fonctions relatives au mode de Mise en forme », page 339
• « Fonctions relatives aux zooms », page 347
• « Propriétés et fonctions de repère », page 350
• « Fonctions de modification des tableaux », page 356
Fonctions relatives aux mises en forme CSS
Ces fonctions permettent d'appliquer, de retirer, de créer et de supprimer des styles CSS. Les méthodes de l'objet dreamweaver.cssRuleTracker contrôlent ou agissent sur l'élément sélectionné dans le panneau de suivi des règles CSS de
l'inspecteur de sélections. Les méthodes de l'objet dreamweaver.cssStylePalette contrôlent ou agissent sur la sélection
dans le panneau Styles, et non dans le document actif.
dom.applyLayout()
Disponibilité
Dreamweaver CS3.
Description
Applique une mise en forme CSS au document. Le corps du document doit être vide, et le document doit être une page dans
laquelle vous pouvez appliquer une mise en forme. C'est-à-dire :
• une page basée sur le code HTML, telle que HTML, XHTML, ColdFusion, PHP, etc. (mais pas CSS, XML, JavaScript,
etc.) ;
• une page qui n'est pas un jeu de cadres ni une instance de modèle (bien qu'un modèle soit approprié).
ADOBE DREAMWEAVER 9.0 314
Guide des API
Arguments
layout-index, CSS, cssFileName, preventOverwrite
•
layout-index est un entier d'index de base zéro spécifiant la mise en forme à utiliser. Il s'agit d'un index dans la liste des
mises en forme qui sert à renvoyer les valeurs layoutNames et layoutDescriptions dans les fonctions correspondantes.
•
CSS
indique où placer la mise en forme CSS. Les valeurs possibles sont les suivantes :
• “embed" - incorporer le fichier CSS dans la section head du document.
• “link“ - établir un lien vers cssFileName.
• “create_and_link“ - écrire un fichier CSS dans cssFileName et établir un lien vers lui.
• “import"- importer
cssFileName.
• “create_and_import“ - écrire un fichier CSS dans cssFileName et importer.
•
cssFileName est le
•
preventOverwrite est une valeur booléenne :
nom du fichier CSS vers lequel établir un lien ou à importer et à créer, le cas échéant.
true : lorsqu'un nouveau fichier css est créé, échoue si le fichier existe déjà
false : écraser le fichier s'il existe déjà
Valeurs renvoyées
Valeur booléenne :
true: signifie que la mise en forme a été appliquée correctement
false: signifie que la mise en forme n'a pas été appliquée correctement
Exemple
dw.getLayoutNames();
var theDOM = dw.getDocumentDOM();
alert (theDOM.canApplyLayout());
if (theDOM.canApplyLayout())
theDOM.applyLayout(1, "embed");
else
alert("impossible d'appliquer la mise en forme à ce doc");
dom.canApplyLayout()
Disponibilité
Dreamweaver CS3.
Description
Vérifie si une mise en forme CSS peut être appliquée au document. Cette fonction vérifie que le corps du document est vide,
et qu'il s'agit d'une page dans laquelle vous pouvez appliquer une mise en forme. C'est-à-dire :
• une page basée essentiellement sur le code HTML, telle que HTML, XHTML, ColdFusion, PHP, etc. (mais pas CSS, XML,
JavaScript, etc.) ;
• une page qui n'est pas un jeu de cadres ni une instance de modèle (bien qu'un modèle soit approprié).
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne :
true : indique que la mise en forme peut être appliquée
false: indique que la mise en forme ne peut pas être appliquée.
ADOBE DREAMWEAVER 9.0 315
Guide des API
dw.getFilesForLayout()
Disponibilité
Dreamweaver CS3.
Description
Obtient les chemins des fichiers de configuration pour la mise en forme spécifiée.
Arguments
layoutIndex
•
layoutIndex est un entier d'index de base zéro spécifiant la mise en forme. Il s'agit d'un index dans la liste des mises en
forme qui sert à renvoyer les valeurs layoutNames et layoutDescriptions dans les fonctions correspondantes.
Valeurs renvoyées
Un tableau de chaînes contenant les chemins complets des fichiers HTML et des fichiers d'image d'aperçu (pouvant être
null).
dw.getLayoutNames()
Disponibilité
Dreamweaver CS3.
Description
Obtient les noms des mises en forme CSS disponibles.
Arguments
Aucun.
Valeurs renvoyées
Un tableau de chaînes des noms des mises en forme.
dw.getLayoutDescriptions()
Disponibilité
Dreamweaver CS3.
Description
Obtient les descriptions des mises en forme CSS disponibles.
Arguments
Aucun.
Valeurs renvoyées
Un tableau de chaînes des descriptions des mises en forme.
ADOBE DREAMWEAVER 9.0 316
Guide des API
dom.applyCSSStyle()
Disponibilité
Dreamweaver 4.
Description
Applique le style spécifié à l'élément spécifié. Cette fonction n'est valide que pour le document actif.
Arguments
elementNode, styleName, {classOrID}, {bForceNesting}
• L'argument elementNode désigne un noeud d'élément dans le DOM. Si l'argument elementNode a pour valeur NULL ou
est exprimé sous forme d'une chaîne vide (""), la fonction agit sur la sélection en cours.
• L'argument styleName est le nom d'un style CSS.
• L'argument facultatif classOrID est l'attribut avec lequel le style doit être appliqué ("class" ou "id"). Si l'argument
elementNode a pour valeur NULL ou s'il est exprimé sous forme d'une chaîne vide et qu'aucune balise n'entoure complè-
tement la sélection, le style est appliqué avec des balises SPAN. Si la sélection est un point d'insertion, Dreamweaver utilise
la méthode heuristique pour déterminer à quelle balise le style doit être appliqué.
• L'argument facultatif bForceNesting est une valeur booléenne qui indique si l'imbrication est autorisée ou non. Si le
drapeau bForceNesting est défini, Dreamweaver insère une nouvelle balise SPAN au lieu de tenter de modifier les balises
existantes dans le document. S'il n'est pas défini, cet argument a la valeur false par défaut.
Valeurs renvoyées
Aucune.
Exemple
Le code suivant applique le style red à la sélection, soit en entourant cette dernière de balises SPAN, soit en appliquant un
attribut CLASS aux balises qui entourent la sélection :
var theDOM = dreamweaver.getDocumentDOM('document');
theDOM.applyCSSStyle('','red');
dom.getElementView()
Disponibilité
Dreamweaver 8.
Description
Cette fonction renvoie le mode Elément pour l'élément sélectionné dans le document. Si l'élément sélectionné est normal,
la fonction getElementView() recherche le premier ancêtre de l'élément sélectionné qui est soit full soit hidden.
Arguments
Aucun.
Valeurs renvoyées
Une chaîne indiquant l'état de l'élément sélectionné. Ces valeurs sont :
•
"hidden", indique que l'élément possède des propriétés CSS pouvant entraîner un affichage masqué partiel ou total du
contenu en mode Création. Les propriétés CSS prises en charge sont les suivantes :
• overflow : hidden, scroll ou auto
• display : aucune
•
"full", indique que par défaut l'élément est "hidden", mais que la valeur actuelle est "full" comme définie par la
fonction setElementView("full").
•
"normal", indique que l'élément n'a pour valeur ni "hidden" ni "full".
ADOBE DREAMWEAVER 9.0 317
Guide des API
Exemple
L'exemple suivant modifie l'état de l'élément sélectionné en "full" s'il a pour valeur "hidden" :
var currentDOM = dw.getDocumentDOM();
if (currentDOM && getElementView() == "hidden"){
currentDOM.setElementView("full");
}
dom.getShowDivBackgrounds()
Disponibilité
Dreamweaver 8.
Description
Cette fonction renvoie l'état de l'assistance visuelle Arrière-plans des blocs de mise en forme.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne ; true si l'assistance visuelle Arrière-plans des blocs de mise en forme est activée ; false dans le cas
contraire.
Exemple
L'exemple suivant vérifie si l'assistance visuelle Arrière-plans des blocs de mise en forme est activée et, si ce n'est pas le cas,
l'active :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.getShowDivBackgrounds() == false){
currentDOM.setShowDivBackgrounds(true);
}
dom.getShowDivBoxModel()
Disponibilité
Dreamweaver 8.
Description
Cette fonction renvoie l'état de l'assistance visuelle Modèle de boîte des blocs de mise en forme.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne ; true si l'assistance visuelle Modèle de boîte des blocs de mise en forme est activée ; false dans le cas
contraire.
Exemple
L'exemple suivant vérifie si l'assistance visuelle Modèle de boîte des blocs de mise en forme est activée et, si ce n'est pas le
cas, l'active :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.getShowDivBoxModel() == false){
currentDOM.setShowDivBoxModel(true);
}
ADOBE DREAMWEAVER 9.0 318
Guide des API
dom.getShowDivOutlines()
Disponibilité
Dreamweaver 8.
Description
Cette fonction renvoie l'état de l'assistance visuelle Contours des blocs de mise en forme.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne ; true si l'assistance visuelle Contours des blocs de mise en forme est activée ; false dans le cas contraire.
Exemple
L'exemple suivant vérifie si l'assistance visuelle Contours des blocs de mise en forme est activée et, si ce n'est pas le cas,
l'active :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.getShowDivOutlines() == false){
currentDOM.setShowDivOutlines(true);
}
dom.removeCSSStyle()
Disponibilité
Dreamweaver 3.
Description
Supprime l'attribut CLASS ou ID de l'élément spécifié ou supprime les balises SPAN qui entourent complètement l'élément
spécifié. Cette fonction n'est valide que pour le document actif.
Arguments
elementNode, {classOrID}
• L'argument elementNode désigne un noeud d'élément dans le DOM. Si l'argument elementNode est une chaîne vide (""),
la fonction est appliquée à la sélection en cours.
• L'argument facultatif classOrID est l'attribut qui doit être supprimé ("class" ou
"id"). Si l'argument classOrID n'est
pas spécifié, il prend par défaut la valeur "class". Si aucun attribut CLASS n'est défini pour l'argument elementNode, la
balise SPAN entourant l'argument elementNode est supprimée.
Valeurs renvoyées
Aucune.
dom.resetAllElementViews()
Disponibilité
Dreamweaver 8.
Description
Cette fonction rétablit le mode Elément original de tous les éléments du document en supprimant tous les styles CSS
générés en interne.
ADOBE DREAMWEAVER 9.0 319
Guide des API
Arguments
forceRefresh
• L'argument facultatif forceRefresh est une valeur booléenne qui indique s'il faut actualiser le rendu de la totalité du
document lorsqu'il n'y a pas de style CSS interne à supprimer. La valeur true provoque l'actualisation. La valeur par
défaut est false.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant rétablit le mode Elément de tous les éléments du document sans avoir à actualiser le rendu :
var currentDOM = dw.getDocumentDOM();
currentDOM.resetAllElementViews(false);
dom.setElementView()
Disponibilité
Dreamweaver 8.
Description
Cette fonction définit le mode Elément pour l'élément sélectionné dans le document. Si l'élément sélectionné est "normal",
la fonction setElementView() recherche le premier ancêtre de l'élément sélectionné qui est "full" ou "hidden".
Arguments
mode
• L'argument obligatoire view est une chaîne qui définit l'élément sélectionné comme "full" ou "hidden". Si l'élément
sélectionné est "normal", la fonction setElementView() recherche le premier ancêtre de l'élément sélectionné, qui
correspond soit à "full" soit à "hidden". Pour des informations supplémentaires, consultez la section
« dom.getElementView() », page 316. Les valeurs possibles sont les suivantes :
•
"full" — Supprime le style CSS interne qui place l'élément en mode "full" pour permettre à l'élément de
retrouver son état original.
•
— Si l'élément sélectionné est en mode "hidden", Dreamweaver génère le style CSS permettant
d'afficher tout le contenu puis l'applique comme une feuille de style interne au moment de la conception.
"hidden"
Valeurs renvoyées
Aucune.
Exemple
Consultez « dom.getElementView() », page 316.
dom.setShowDivBackgrounds()
Disponibilité
Dreamweaver 8.
Description
Cette fonction active ou désactive l'assistance visuelle Arrière-plans des blocs de mise en forme.
Arguments
afficher
• L'argument obligatoire show est une valeur booléenne qui indique s'il faut activer l'assistance visuelle Arrière-plans des
blocs de mise en forme. Définir l'argument show sur true active l'assistance visuelle Arrière-plans des blocs de mise en
forme.
ADOBE DREAMWEAVER 9.0 320
Guide des API
Valeurs renvoyées
Aucune.
Exemple
Consultez « dom.getShowDivBackgrounds() », page 317.
dom.setShowDivBoxModel()
Disponibilité
Dreamweaver 8.
Description
Cette fonction active ou désactive l'assistance visuelle Modèle de boîte des blocs de mise en forme.
Arguments
show
• L'argument obligatoire show est une valeur booléenne qui indique s'il faut activer l'assistance visuelle Modèle de boîte des
blocs de mise en forme. Définir l'argument show sur true active l'assistance visuelle Modèle de boîte des blocs de mise
en forme.
Valeurs renvoyées
Aucune.
Exemple
Consultez « dom.getShowDivBoxModel() », page 317.
dom.setShowDivOutlines()
Disponibilité
Dreamweaver 8.
Description
Cette fonction active ou désactive l'assistance visuelle Contours des blocs de mise en forme.
Arguments
show
• L'argument obligatoire show est une valeur booléenne qui indique s'il faut activer l'assistance visuelle Contours des blocs
de mise en forme. Définir l'argument show sur true active l'assistance visuelle Contours des blocs de mise en forme.
Valeurs renvoyées
Aucune.
Exemple
Consultez « dom.getShowDivOutlines() », page 318.
dreamweaver.cssRuleTracker.editSelectedRule()
Disponibilité
Dreamweaver MX 2004.
Description
Permet à l'utilisateur de modifier la règle sélectionnée dans l'outil de suivi des règles. Cette fonction affiche la règle sélectionnée dans la grille des propriétés CSS et, si cela s'avère nécessaire, affiche la grille des propriétés ainsi que la palette qui
la contient.
ADOBE DREAMWEAVER 9.0 321
Guide des API
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.cssRuleTracker.canEditSelectedRule() », page 425.
dreamweaver.cssRuleTracker.newRule()
Disponibilité
Dreamweaver MX 2004.
Description
Ouvre la boîte de dialogue Nouveau style CSS pour permettre à l'utilisateur de créer une nouvelle règle.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dreamweaver.cssStylePalette.applySelectedStyle()
Disponibilité
Dreamweaver MX.
Description
Applique le style sélectionné au document actif ou à la feuille de style associée, en fonction de l'élément sélectionné dans le
panneau Styles CSS.
Arguments
{ pane }
• L'argument facultatif pane est une chaîne spécifiant le volet du panneau Styles auquel cette fonction est appliquée. Les
valeurs possibles sont les suivantes : "stylelist", qui correspond à la liste des styles dans le mode « Tout » ; "cascade",
qui correspond à la liste des règles applicables concernées dans le mode « Courant » ; "summary", qui correspond à la liste
des propriétés de la sélection en cours dans le mode « Courant » et "ruleInspector", qui correspond à la liste ou grille
de propriétés modifiable dans le mode « Courant ». La valeur par défaut est "stylelist".
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.cssStylePalette.canApplySelectedStyle() », page 426.
dreamweaver.cssStylePalette.attachStyleSheet()
Disponibilité
Dreamweaver 4.
Description
Affiche une boîte de dialogue qui permet aux utilisateurs d'attacher une feuille de style au document actif ou à l'une des
feuilles de style qui y sont associées en fonction de l'élément sélectionné dans le panneau Styles CSS.
ADOBE DREAMWEAVER 9.0 322
Guide des API
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dreamweaver.cssStylePalette.deleteSelectedStyle()
Disponibilité
Dreamweaver 3.
Description
Supprime du document le style actuellement sélectionné dans le panneau Styles CSS.
Arguments
{ pane }
• L'argument facultatif pane est une chaîne spécifiant le volet du panneau Styles auquel cette fonction est appliquée. Les
valeurs possibles sont les suivantes : "stylelist", qui correspond à la liste des styles dans le mode « Tout » ; "cascade",
qui correspond à la liste des règles applicables concernées dans le mode « Courant » ; "summary", qui correspond à la liste
des propriétés de la sélection en cours dans le mode « Courant » et "ruleInspector", qui correspond à la liste ou grille
de propriétés modifiable dans le mode « Courant ». La valeur par défaut est "stylelist".
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.cssStylePalette.canDeleteSelectedStyle() », page 426.
dreamweaver.cssStylePalette.duplicateSelectedStyle()
Disponibilité
Dreamweaver 3.
Description
Duplique le style actuellement sélectionné dans le panneau Styles CSS et affiche la boîte de dialogue Dupliquer le style afin
de permettre à l'utilisateur d'attribuer un nom ou un sélecteur au nouveau style.
Arguments
{ pane }
• L'argument facultatif pane est une chaîne spécifiant le volet du panneau Styles auquel cette fonction est appliquée. Les
valeurs possibles sont les suivantes : "stylelist", qui correspond à la liste des styles dans le mode « Tout » ; "cascade",
qui correspond à la liste des règles applicables concernées dans le mode « Courant » ; "summary", qui correspond à la liste
des propriétés de la sélection en cours dans le mode « Courant » et "ruleInspector", qui correspond à la liste ou grille
de propriétés modifiable dans le mode « Courant ». La valeur par défaut est "stylelist".
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.cssStylePalette.canDuplicateSelectedStyle() », page 426.
ADOBE DREAMWEAVER 9.0 323
Guide des API
dreamweaver.cssStylePalette.editSelectedStyle()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue Définition du style correspondant au style sélectionné dans le panneau Styles CSS.
Arguments
{ pane }
• L'argument facultatif pane est une chaîne spécifiant le volet du panneau Styles auquel cette fonction est appliquée. Les
valeurs possibles sont les suivantes : "stylelist", qui correspond à la liste des styles dans le mode « Tout » ; "cascade",
qui correspond à la liste des règles applicables concernées dans le mode « Courant » ; "summary", qui correspond à la liste
des propriétés de la sélection en cours dans le mode « Courant » et "ruleInspector", qui correspond à la liste ou grille
de propriétés modifiable dans le mode « Courant ». La valeur par défaut est "stylelist".
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.cssStylePalette.canEditSelectedStyle() », page 427.
dreamweaver.cssStylePalette.editSelectedStyleInCodeview()
Disponibilité
Dreamweaver 8.
Description
Cette fonction affiche le mode Code et déplace le curseur de la souris jusqu'au code du style actuellement sélectionné dans
le panneau Styles.
Arguments
{ pane }
• L'argument facultatif pane est une chaîne spécifiant le volet du panneau Styles auquel cette fonction est appliquée. Les
valeurs possibles sont les suivantes : "stylelist", qui correspond à la liste des styles dans le mode « Tout » ; "cascade",
qui correspond à la liste des règles applicables concernées dans le mode « Courant » ; "summary", qui correspond à la liste
des propriétés de la sélection en cours dans le mode « Courant » et "ruleInspector", qui correspond à la liste ou grille
de propriétés modifiable dans le mode « Courant ». La valeur par défaut est "stylelist".
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.cssStylePalette.canEditSelectedStyleInCodeview() », page 427.
dreamweaver.cssStylePalette.editStyleSheet()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue Modifier feuille de style.
ADOBE DREAMWEAVER 9.0 324
Guide des API
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.cssStylePalette.canEditStyleSheet() », page 427.
dreamweaver.cssStylePalette.getDisplayStyles()
Disponibilité
Dreamweaver 8.
Description
Cette fonction détermine si les styles CSS sont rendus. La valeur par défaut est true.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si les styles CSS sont rendus ; false dans le cas contraire.
Exemple
var areStylesRendered = dw.cssStylePalette.getDisplayStyles();
dreamweaver.cssStylePalette.getMediaType()
Disponibilité
Dreamweaver MX 2004.
Description
Permet d'obtenir le type de média cible pour le rendu. Le type de média par défaut est "screen".
Arguments
Aucun.
Valeurs renvoyées
Chaîne indiquant le type de média cible.
Exemple
var mediaType = dw.cssStylePalette.getMediaType();
dreamweaver.cssStylePalette.getSelectedStyle()
Disponibilité
Dreamweaver 3 ; fullSelector disponible dans Dreamweaver MX.
Description
Renvoie le nom du style actuellement sélectionné dans le panneau Styles CSS.
ADOBE DREAMWEAVER 9.0 325
Guide des API
Arguments
fullSelector.
• L'argument fullSelector est une valeur booléenne qui indique si le sélecteur complet ou la classe uniquement doivent
être renvoyés. Si rien n'est précisé, seul le nom de classe est renvoyé. Par exemple, p.class1 est un sélecteur qui signifie
que le style est appliqué à n'importe quelle balise p de class1, mais il ne s'applique pas, par exemple, à une balise div de
class1. Sans l'argument fullSelector , la fonction dreamweaver.cssStylePalette.getSelectedStyle() renvoie
uniquement le nom de classe, class1, pour le sélecteur. L'argument fullSelector ordonne à la fonction de renvoyer
p.class1 au lieu de class1.
Valeurs renvoyées
Lorsque l'argument fullSelector a la valeur true, la fonction renvoie soit le sélecteur complet, soit une chaîne vide
lorsque le noeud de la feuille de style est sélectionné.
Lorsque l'argument fullSelector a la valeur false ou est ignoré, une chaîne qui représente le nom de classe du style sélectionné est renvoyée. Si le style sélectionné n'a pas de classe ou si un noeud de feuille de style est sélectionné, une chaîne vide
est renvoyée.
Exemple
Si le style red est sélectionné, un appel à la fonction dw.cssStylePalette.getSelectedStyle() renvoie "red".
dreamweaver.cssStylePalette.getSelectedTarget() (déconseillée)
Disponibilité
Dreamweaver 3, déconseillée dans Dreamweaver MX, car le menu Appliquer à n'existe plus dans le panneau Styles.
Description
Cette fonction permet d'obtenir l'élément sélectionné dans le menu déroulant Appliquer à, en haut du panneau Styles.
Arguments
Aucun.
Valeurs renvoyées
Fonction ancienne ; renvoie toujours une valeur null.
dreamweaver.cssStylePalette.getStyles()
Disponibilité
Dreamweaver 3.
Description
Renvoie la liste de tous les styles de classe que contient le document actif. Sans arguments, il renvoie simplement les noms
de sélecteurs de classes. Si l'argument bGetIDs est true, il renvoie simplement les noms des sélecteurs d'ID. Dans les deux
cas, si l'argument bGetFullSelector est true, il renvoie le noms de sélecteur complet.
Prenons par exemple un fichier HTML avec le code suivant :
<Style>
.test{ background:none };
p.foo{ background:none };
#bar {background:none };
div#hello p.world {background:none};
ADOBE DREAMWEAVER 9.0 326
Guide des API
Les appels dans le tableau suivant renvoient les valeurs dans la colonne Résultat.
Appel de fonction
Résultat
dw.cssStylePalette.getStyles()
foo,test,world
dw.cssStylePalette.getStyles(true)
bar,hello
dw.cssStylePalette.getStyles(false, true)
p.foo,.test,div#hello p.world
dw.cssStylePalette.getStyles(true, true)
#bar,div#hello p.world
Arguments
{bGetIDs, bGetFullSelector}
• L'argument bGetIDs est facultatif. Il s'agit d'une valeur booléenne qui, si défini sur true, oblige la fonction à renvoyer
uniquement les noms des sélecteurs d'ID (la partie située après le "#"). La valeur par défaut est false.
• L'argument bGetFullSelector est facultatif. Il s'agit d'une valeur booléenne qui, si défini sur true, renvoie la chaîne du
sélecteur complète, et non uniquement les noms. La valeur par défaut est false.
Valeurs renvoyées
Tableau de chaînes représentant les noms de tous les styles de classe contenus dans le document.
Exemple
Si la configuration du panneau Styles est calquée sur l'exemple suivant, un appel à la fonction dreamweaver.cssStylePalette.getStyles() renvoie un tableau qui contient ces chaînes : "BreadcrumbEnd", "change", "doctitle", "heading" et
"highlight" :
dreamweaver.cssStylePalette.newStyle()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue Nouveau style.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 327
Guide des API
dreamweaver.cssStylePalette.renameSelectedStyle()
Disponibilité
Dreamweaver 3.
Description
Modifie le nom de classe utilisé dans la règle sélectionnée dans le panneau Styles ainsi que toutes les instances du nom de
classe figurant dans la règle sélectionnée.
Arguments
{ pane }
• L'argument facultatif pane est une chaîne spécifiant le volet du panneau Styles auquel cette fonction est appliquée. Les
valeurs possibles sont les suivantes : "stylelist", qui correspond à la liste des styles dans le mode « Tout » ; "cascade",
qui correspond à la liste des règles applicables concernées dans le mode « Courant » ; "summary", qui correspond à la liste
des propriétés de la sélection en cours dans le mode « Courant » et "ruleInspector", qui correspond à la liste ou grille
de propriétés modifiable dans le mode « Courant ». La valeur par défaut est "stylelist".
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.cssStylePalette.canRenameSelectedStyle() », page 428.
dreamweaver.cssStylePalette.setDisplayStyles()
Disponibilité
Dreamweaver 8.
Description
Cette fonction détermine si les styles CSS doivent être rendus et actualise le rendu de tous les documents ouverts.
Arguments
display
• L'argument display est une valeur booléenne : true pour rendre les styles CSS ; false dans le cas contraire.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant désactive le rendu des styles CSS :
dw.cssStylePalette.setDisplayStyles(false);
dreamweaver.cssStylePalette.setMediaType()
Disponibilité
Dreamweaver MX 2004.
Description
Permet de définir le type de média cible pour le rendu. Actualise le rendu de tous les documents ouverts.
Arguments
mediaType.
• L'argument mediaType indique le nouveau type de média cible.
ADOBE DREAMWEAVER 9.0 328
Guide des API
Valeurs renvoyées
Aucune.
Exemple
dw.cssStylePalette.setMediaType("print");
dreamweaver.getBlockVisBoxModelColors()
Disponibilité
Dreamweaver 8.
Description
Cette fonction permet d'obtenir les couleurs utilisées pour rendre le modèle de boîte d'un bloc sélectionné lorsque l'assistance visuelle Modèle de boîte des blocs de mise en forme est activée.
Arguments
Aucun.
Valeurs renvoyées
Tableau de chaînes contenant deux chaînes :
•
marginColor, qui représente la valeur hexadécimale de
la couleur RVB sous la forme #RRVVBB ; paddingColor, qui
représente la valeur hexadécimale de la couleur RVB sous la forme #RRVVBB
Exemple
L'exemple suivant vérifie la valeur de la couleur des marges et du remplissage; si aucune n'est blanche, elles sont toutes deux
définies sur blanc :
var boxColors = dreamweaver.getBlockVisBoxModelColors();
if ((boxColors[0] != "#FFFFFF") || (boxColors[1] != "#FFFFFF)){
currentDOM.setBlockVisBoxModelColors("#FFFFFF", "#FFFFFF");
}
dreamweaver.getBlockVisOutlineProperties()
Disponibilité
Dreamweaver 8.
Description
Cette fonction renvoie les propriétés de contour pour l'assistance visuelle de représentation des blocs.
Arguments
forWhat
• L'argument obligatoire forWhat est une chaîne. Les valeurs possibles sont les suivantes : "divs", "selectedDiv" ou
"layers" Si l'argument forWhat a pour valeur "divs", la fonction renvoie les propriétés utilisées pour l'assistance visuelle
qui met en surbrillance tous les blocs de mise en forme. Si l'argument forWhat a pour valeur "selectedDiv", la fonction
renvoie les propriétés utilisées pour l'assistance visuelle qui met en surbrillance les blocs de mise en forme sélectionnés.
La valeur layers définit les calques.
Valeurs renvoyées
Tableau de chaînes contenant trois chaînes :
•
color,
•
width, qui indique la largeur en pixels
•
style, dont la valeur est soit "SOLID", "DOTTED", "DASHED" ou "OUTSET"
qui correspond à la valeur hexadécimale de la couleur RVB, sous la forme #RRVVBB
ADOBE DREAMWEAVER 9.0 329
Guide des API
Exemple
L'exemple suivant renvoie les propriétés de contour de "divs" et définit le style de contour sur "SOLID" :
var outlineStyle = dw.getBlockVisOutlineProperties("divs");
if (outlineStyle[2] != "SOLID"){
dw.setBlockVisOutlineProperties("divs", outlineStyle[0], outlineStyle[1], "SOLID");
}
dreamweaver.getDivBackgroundColors()
Disponibilité
Dreamweaver 8.
Description
Cette fonction renvoie les couleurs utilisées par l'assistance visuelle Arrière-plans des blocs de mise en forme.
Arguments
Aucun.
Valeurs renvoyées
Tableau de chaînes contenant les 16 couleurs, chaque couleur étant représentée par la valeur hexadécimale de la couleur
RVB, sous la forme #RRVVBB.
Exemple
L'exemple suivant renvoie les couleurs d'arrière-plans utilisées par l'assistance visuelle Arrière-plans des blocs de mise en
forme :
var backgroundColors = dreamweaver.getDivBackgroundColors();
dreamweaver.setBlockVisOutlineProperties()
Disponibilité
Dreamweaver 8.
Description
Cette fonction définit les propriétés de contour pour l'assistance visuelle de représentation des blocs.
Arguments
forWhat, color, width, {style}
• L'argument obligatoire forWhat est une chaîne indiquant l'utilisation prévue pour la couleur et la largeur spécifiées. Les
valeurs possibles sont les suivantes : "divs", "selectedDiv" ou "layers" Si la valeur est "layers", la couleur et la largeur
spécifiées sont utilisées pour mettre en surbrillance tous les calques lorsque l'assistance visuelle Contours des blocs de
mise en forme est activée. Si la valeur est "divs", les arguments color et width permettent de mettre en surbrillance tous
les divs et autres blocs de mise en forme. Si la valeur est "selectedDiv", les arguments color et width permettent de
mettre en surbrillance tout div ou bloc de mise en forme sélectionné.
• L'argument obligatoire color est une chaîne qui contient la valeur hexadécimale indiquant la couleur RVB sous la forme
#RRVVBB.
• L'argument obligatoire width est un entier qui indique la largeur du contour, en pixels.
• L'argument facultatif style est une chaîne qui indique le style du contour. Les valeurs possibles sont les suivantes :
"SOLID", "DOTTED", "DASHED" et "OUTSET". La valeur "OUTSET" est applicable aux calques uniquement. Cet argument est
ignoré lorsque la valeur de l'argument forWhat est "selectedDiv".
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 330
Guide des API
Exemple
Consultez « dreamweaver.getBlockVisOutlineProperties() », page 328.
dreamweaver.setDivBackgroundColors()
Disponibilité
Dreamweaver 8.
Description
Cette fonction définit les couleurs utilisées par l'assistance visuelle Arrière-plans des blocs de mise en forme.
Arguments
couleurs
• L'argument obligatoire colors est un tableau de chaînes contenant toutes les couleurs, représentées par des valeurs
hexadécimales sous la forme #RRVVBB. Ce tableau doit contenir 16 couleurs.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant vérifie qu'il y ait 16 couleurs maximum spécifiées comme couleurs d'arrière-plan div et, le cas échéant,
définit les couleurs utilisées comme couleurs d'arrière-plan en fonction des nuances de gris :
var currentDOM = dw.getDocumentDOM();
var divColors = currentDOM.getDivBackgroundColors("divs");
var shadesOfGray = new Array["#000000", "#111111", "#222222", "#333333",¬
"#444444", "#555555", "#666666", "#777777", "#888888", "#999999", ¬
"#AAAAAA", "#BBBBBB", "#CCCCCC", "#DDDDDD", "#EEEEEE", "#FFFFFF"]¬
var howManyColors = divColors.length;
if howManyColors <= 16{
for (var i = 0; i < howManyColors; i++)
{
currentDOM.setDivBackgroundColors("divs", shadeOfGray[i]);
}
Fonctions relatives aux cadres et aux jeux de cadres
Ces fonctions permettent d'effectuer les opérations suivantes : obtenir le nom des cadres constituant un jeu de cadres et
diviser un cadre en deux.
dom.getFrameNames()
Disponibilité
Dreamweaver 3.
Description
Renvoie la liste de tous les cadres nommés du jeu de cadres.
Arguments
Aucun.
Valeurs renvoyées
Tableau de chaînes où chaque chaîne correspond au nom d'un cadre dans le jeu de cadres en cours. La fonction ignore tous
les cadres sans nom. Si aucun des cadres du jeu n'est nommé, un tableau vide est renvoyé.
ADOBE DREAMWEAVER 9.0 331
Guide des API
Exemple
Pour un document contenant quatre cadres, dont deux sont nommés, un appel à la fonction dom.getFrameNames() pourrait
renvoyer un tableau contenant les chaînes suivantes :
•
"navframe"
•
"main_content"
dom.isDocumentInFrame()
Disponibilité
Dreamweaver 4.
Description
Indique si le document actif est affiché à l'intérieur d'un jeu de cadres.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le document se trouve dans un jeu de cadres et false dans le cas contraire.
dom.saveAllFrames()
Disponibilité
Dreamweaver 4.
Description
Si un document est un jeu de cadres ou se trouve à l'intérieur d'un jeu de cadres, cette fonction enregistre tous les cadres ou
les jeux de la fenêtre de document. Si le document spécifié ne se trouve pas dans un jeu de cadres, cette fonction enregistre
le document. Cette fonction ouvre la boîte de dialogue Enregistrer sous pour tous les documents qui n'ont pas été
enregistrés précédemment.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dom.splitFrame()
Disponibilité
Dreamweaver 3.
Description
Fractionne le cadre sélectionné verticalement ou horizontalement.
Arguments
splitDirection.
• L'argument splitDirection est une chaîne qui doit indiquer l'une des directions suivantes : "up", "down", "left" ou
"right".
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 332
Guide des API
Activateur
Consultez « dom.canSplitFrame() », page 416.
Fonctions relatives aux calques et aux cartes graphiques
Ces fonctions permettent d'aligner, de redimensionner et de déplacer des calques et des zones réactives de carte d'images.
Il est indiqué, dans la description de chaque fonction, si cette dernière s'applique aux calques ou aux zones réactives.
dom.align()
Disponibilité
Dreamweaver 3.
Description
Aligne à gauche, à droite, en haut ou en bas les calques ou zones réactives sélectionnés.
Arguments
alignDirection.
• L'argument alignDirection est une chaîne qui représente le bord par rapport auquel aligner les calques ou les zones
réactives, à savoir "left", "right", "top" ou "bottom".
Valeurs renvoyées
Aucune.
Activateur
Consultez « dom.canAlign() », page 409.
dom.arrange()
Disponibilité
Dreamweaver 3.
Description
Déplace les zones réactives sélectionnées dans le sens indiqué.
Arguments
toBackOrFront.
• L'argument toBackOrFront correspond au sens du déplacement des zones réactives, à savoir front ou back.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dom.canArrange() », page 409.
ADOBE DREAMWEAVER 9.0 333
Guide des API
dom.makeSizesEqual()
Disponibilité
Dreamweaver 3.
Description
Affecte aux calques ou aux zones réactives sélectionnés la même hauteur ou la même largeur, ou les deux. Le dernier calque
ou la dernière zone réactive sélectionnée sert de guide.
Arguments
bHoriz, bVert.
• L'argument bHoriz est une valeur booléenne qui indique si les calques ou les zones réactives doivent être
redimensionnés horizontalement.
• L'argument bVert est une valeur booléenne qui indique si les calques ou les zones réactives doivent être
redimensionnés verticalement.
Valeurs renvoyées
Aucune.
dom.moveSelectionBy()
Disponibilité
Dreamweaver 3.
Description
Déplace les calques ou les zones réactives sélectionnés horizontalement et verticalement du nombre de pixels spécifiés.
Arguments
x, y
• L'argument x est le nombre de pixels dont la sélection doit être déplacée horizontalement.
• L'argument y est le nombre de pixels dont la sélection doit être déplacée verticalement.
Valeurs renvoyées
Aucune.
dom.resizeSelectionBy()
Disponibilité
Dreamweaver 3.
Description
Redimensionne le calque ou la zone réactive sélectionnée.
Arguments
left, top, bottom, right.
• L'argument left est la nouvelle position de la limite gauche du calque ou de la zone réactive.
• L'argument top est la nouvelle position de la limite supérieure du calque ou de la zone réactive.
• L'argument bottom est la nouvelle position de la limite inférieure du calque ou de la zone réactive.
• L'argument right est la nouvelle position de la limite droite du calque ou de la zone réactive.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 334
Guide des API
Exemple
Si le calque sélectionné possède les propriétés Gauche (left), Sommet (top), Largeur (width) et Hauteur (height) indiquées,
un appel à la fonction dw.getDocumentDOM().resizeSelectionBy(–10,–30,30,10) revient à restaurer Gauche à 40,
Sommet à 20, Largeur à 240 et Hauteur à 240.
dom.setLayerTag()
Disponibilité
Dreamweaver 3.
Description
Spécifie la balise HTML définissant le ou les calques sélectionnés.
Arguments
tagName
• L'argument tagName doit être "layer", "ilayer",
"div" ou "span".
Valeurs renvoyées
Aucune.
Fonctions d'environnement de mise en forme
Ces fonctions permettent d'effectuer des opérations associées aux paramètres d'utilisation d'un document. Elles permettent
de modifier la source, la position et l'opacité du tracé de l'image, d'obtenir et de définir l'origine et les unités de mesure de
la règle, d'activer et de désactiver la grille et d'en modifier les paramètres, de démarrer et d'arrêter l'exécution des plug-ins.
dom.getRulerOrigin()
Disponibilité
Dreamweaver 3.
Description
Renvoie l'origine de la règle.
Arguments
Aucun.
Valeurs renvoyées
Tableau contenant deux nombres entiers. Le premier entier correspond à la coordonnée x de l'origine, le second à la
coordonnée y. Les deux valeurs sont exprimées en pixels.
dom.getRulerUnits()
Disponibilité
Dreamweaver 3.
Description
Renvoie les unités de mesure actuelles de la règle.
ADOBE DREAMWEAVER 9.0 335
Guide des API
Arguments
Aucun.
Valeurs renvoyées
Chaîne qui contient l'une des valeurs suivantes :
•
"in"
•
"cm"
•
"px"
dom.getTracingImageOpacity()
Disponibilité
Dreamweaver 3.
Description
Renvoie le paramètre d'opacité du tracé de l'image dans le document actif.
Arguments
Aucun.
Valeurs renvoyées
Valeur comprise entre 0 et 100, ou rien si l'opacité n'est pas définie.
Activateur
Consultez « dom.hasTracingImage() », page 418.
dom.loadTracingImage()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue Sélectionner source de l'image. Si l'utilisateur sélectionne une image et clique sur OK, la boîte de
dialogue Propriétés de la page s'ouvre et le champ Tracé de l'image contient une valeur.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dom.playAllPlugins()
Disponibilité
Dreamweaver 3.
Description
Exécute tous les plug-ins dans le document.
Arguments
Aucun.
ADOBE DREAMWEAVER 9.0 336
Guide des API
Valeurs renvoyées
Aucune.
dom.playPlugin()
Disponibilité
Dreamweaver 3.
Description
Exécute le plug-in sélectionné.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dom.canPlayPlugin() », page 415.
dom.getRulerOrigin()
Disponibilité
Dreamweaver 3.
Description
Définit l'origine de la règle.
Arguments
xCoordinate, yCoordinate
• L'argument xCoordinate est une valeur, exprimée en pixels, sur l'axe horizontal.
• L'argument yCoordinate est une valeur, exprimée en pixels, sur l'axe vertical.
Valeurs renvoyées
Aucune.
dom.setRulerUnits()
Disponibilité
Dreamweaver 3.
Description
Définit les unités de mesure de la règle.
Arguments
units.
• L'argument units doit être "px", "in" ou "cm".
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 337
Guide des API
dom.setTracingImagePosition()
Disponibilité
Dreamweaver 3.
Description
Déplace le coin supérieur gauche du tracé de l'image vers les coordonnées spécifiées. Si les arguments ne sont pas définis,
la boîte de dialogue Ajuster la position du tracé de l'image s'affiche.
Arguments
x, y
• L'argument x est le nombre de pixels définissant la coordonnée horizontale.
• L'argument y est le nombre de pixels définissant la coordonnée verticale.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dom.hasTracingImage() », page 418.
dom.setTracingImageOpacity()
Disponibilité
Dreamweaver 3.
Description
Définit le pourcentage d'opacité du tracé de l'image.
Arguments
opacityPercentage.
• L'argument opacityPercentage doit être un nombre compris entre 0 et 100.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dom.hasTracingImage() », page 418.
Exemple
L'exemple de code suivant règle l'opacité du tracé de l'image sur 30 %.
dw.getDocumentDOM().setTracingOpacity('30');
dom.snapTracingImageToSelection()
Disponibilité
Dreamweaver 3.
Description
Aligne le coin supérieur gauche du tracé de l'image avec le coin supérieur gauche de la sélection en cours.
Arguments
Aucun.
ADOBE DREAMWEAVER 9.0 338
Guide des API
Valeurs renvoyées
Aucune.
Activateur
Consultez « dom.hasTracingImage() », page 418.
dom.stopAllPlugins()
Disponibilité
Dreamweaver 3.
Description
Arrête l'exécution de tous les plug-ins en cours dans le document.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dom.stopPlugin()
Disponibilité
Dreamweaver 3.
Description
Arrête le plug-in sélectionné.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne qui indique si la sélection est exécutée actuellement avec un plug-in.
Activateur
Consultez « dom.canStopPlugin() », page 417.
dreamweaver.arrangeFloatingPalettes()
Disponibilité
Dreamweaver 3.
Description
Déplace les panneaux flottants visibles vers leur position par défaut.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 339
Guide des API
dreamweaver.showGridSettingsDialog()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue Paramètres de la grille.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Fonctions relatives au mode de Mise en forme
Ces fonctions permettent de modifier les éléments de mise en forme d'un document. Elles s'appliquent aux paramètres de
tableau, colonnes et cellules, y compris leur position, propriétés et aspect.
dom.addSpacerToColumn()
Disponibilité
Dreamweaver 4.
Description
Crée une image d'espacement transparente d'un pixel de hauteur au bas d'une colonne définie du tableau sélectionné. Cette
fonction échoue si la sélection courante n'est pas un tableau.
Arguments
colNum.
• L'argument colNum est la colonne au bas de laquelle l'image d'espacement est créée.
Valeurs renvoyées
Aucune.
dom.createLayoutCell()
Disponibilité
Dreamweaver 4.
Description
Crée une cellule de Mise en forme dans le document actif à la position et aux dimensions spécifiées, soit à l'intérieur d'un
tableau de Mise en forme existant, soit dans une zone située sous le contenu existant sur la page. Si la cellule est créée dans
un tableau de Mise en forme existant, elle ne doit ni chevaucher ni contenir d'autres cellules de Mise en forme ou des
tableaux de Mise en forme imbriqués. Si le rectangle n'est pas à l'intérieur d'un tableau de Mise en forme existant, Dreamweaver tente de créer un tableau de Mise en forme devant contenir la nouvelle cellule. Cette fonction ne place pas le
document en mode de Mise en forme. Elle échoue si la cellule ne peut pas être créée.
ADOBE DREAMWEAVER 9.0 340
Guide des API
Arguments
left, top, width, height.
• L'argument left est la position x de la bordure gauche de la cellule.
• L'argument top est la position y de la bordure supérieure de la cellule.
• L'argument width est la largeur de la cellule en pixels.
• L'argument height est la hauteur de la cellule en pixels.
Valeurs renvoyées
Aucune.
dom.createLayoutTable()
Disponibilité
Dreamweaver 4.
Description
Crée un tableau de Mise en forme dans le document actif à la position et aux dimensions spécifiées, soit à l'intérieur d'un
tableau de mise en forme existant, soit dans une zone située sous le contenu existant sur la page. Si le tableau est créé dans
un tableau de Mise en forme existant, il ne peut pas chevaucher d'autres cellules de Mise en forme ou des tableaux de Mise
en forme imbriqués, mais il peut en contenir. Cette fonction ne place pas le document en mode de Mise en forme. Elle
échoue si le tableau ne peut pas être créé.
Arguments
left, top, width, height.
• L'argument left est la position x de la bordure gauche du tableau.
• L'argument top est la position y de la bordure supérieure du tableau.
• L'argument width est la largeur du tableau en pixels.
• L'argument height est la hauteur du tableau en pixels.
Valeurs renvoyées
Aucune.
dom.doesColumnHaveSpacer()
Disponibilité
Dreamweaver 4.
Description
Détermine si une colonne contient une image d'espacement générée par Dreamweaver. Cette fonction échoue si la sélection
en cours n'est pas un tableau.
Arguments
colNum.
• L'argument colNum est la colonne à vérifier pour une image d'espacement.
Valeurs renvoyées
Renvoie la valeur true si la colonne définie dans le tableau sélectionné contient une image d'espacement générée par
Dreamweaver et false dans le cas contraire.
ADOBE DREAMWEAVER 9.0 341
Guide des API
dom.doesGroupHaveSpacers()
Disponibilité
Dreamweaver 4.
Description
Détermine si le tableau sélectionné contient une ligne d'images d'espacement générées par Dreamweaver. Cette fonction
échoue si la sélection en cours n'est pas un tableau.
Arguments
Aucun.
Valeurs renvoyées
Renvoie la valeur true si le tableau contient une ligne d'images d'espacement et false dans le cas contraire.
dom.getClickedHeaderColumn()
Disponibilité
Dreamweaver 4.
Description
Si l'utilisateur clique sur un bouton de menu dans l'en-tête d'un tableau du mode de Mise en forme, faisant ainsi apparaître
le menu d'en-tête du tableau, cette fonction renvoie l'index de la colonne sur laquelle l'utilisateur a cliqué. Le résultat n'est
pas défini si le menu d'en-tête du tableau n'est pas visible.
Arguments
Aucun.
Valeurs renvoyées
Nombre entier qui représente l'index de la colonne.
dom.getShowLayoutTableTabs()
Disponibilité
Dreamweaver 4.
Description
Détermine si le document actif affiche les tabulations des tableaux de Mise en forme dans le mode correspondant.
Arguments
Aucun.
Valeurs renvoyées
Renvoie la valeur true si le document actif affiche les tabulations des tableaux de Mise en forme dans le mode correspondant et false si tel n'est pas le cas.
dom.getShowLayoutView()
Disponibilité
Dreamweaver 4.
Description
Détermine le mode d'affichage du document actif, Mise en forme ou Standard.
ADOBE DREAMWEAVER 9.0 342
Guide des API
Arguments
Aucun.
Valeurs renvoyées
Renvoie la valeur true si le document actif est en mode de Mise en forme et false s'il est en mode Standard.
dom.isColumnAutostretch()
Disponibilité
Dreamweaver 4.
Description
Détermine si une colonne doit être agrandie ou réduite automatiquement selon la taille du document. Cette fonction
échoue si la sélection en cours n'est pas un tableau.
Arguments
colNum.
• L'argument colNum est la colonne à redimensionner automatiquement ou dont la largeur est fixe.
Valeurs renvoyées
Renvoie la valeur true si la colonne située à l'index donné du tableau sélectionné doit s'agrandir automatiquement et false
dans le cas contraire.
dom.makeCellWidthsConsistent()
Disponibilité
Dreamweaver 4.
Description
Dans le tableau sélectionné, cette fonction définit la largeur de chaque colonne de code HTML pour qu'elle corresponde à
la largeur de rendu de la colonne. Cette fonction échoue si la sélection courante n'est pas un tableau.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dom.removeAllSpacers()
Disponibilité
Dreamweaver 4.
Description
Supprime toutes les images d'espacement générées par Dreamweaver à partir du tableau sélectionné. Cette fonction échoue
si la sélection courante n'est pas un tableau.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 343
Guide des API
dom.removeSpacerFromColumn()
Disponibilité
Dreamweaver 4.
Description
Supprime l'image d'espacement d'une colonne donnée et supprime la ligne d'espacement s'il n'y a plus d'images
d'espacement générées par Dreamweaver. Cette fonction échoue si la sélection courante n'est pas un tableau.
Arguments
colNum.
• L'argument colNum est la colonne dans laquelle l'image d'espacement doit être supprimée.
Valeurs renvoyées
Aucune.
dom.setColumnAutostretch()
Disponibilité
Dreamweaver 4.
Description
Passe d'une colonne automatiquement dimensionnée à une colonne d'une largeur fixe et vice versa. Si bAutostretch est
défini sur true, la colonne située à l'index donné du tableau sélectionné est définie pour s'agrandir automatiquement ; dans
le cas contraire, elle est définie sur une largeur fixe qui est celle du rendu en cours. Cette fonction échoue si la sélection
courante n'est pas un tableau.
Arguments
colNum, bAutostretch.
• L'argument colNum est la colonne à redimensionner automatiquement ou définie sur une largeur fixe.
• L'argument bAutostretch indique si la colonne doit être agrandie automatiquement (true) ou définie sur une largeur
fixe (false).
Valeurs renvoyées
Aucune.
dom.getShowBlockBackgrounds()
Disponibilité
Dreamweaver 8.
Description
Cette fonction renvoie l'état de l'assistance visuelle qui active la coloration de l'arrière-plan de tous les blocs ou divs.
Arguments
allblocks
• L'argument obligatoire allblocks est une valeur booléenne. Définir la valeur sur true pour que l'argument ne soit
appliqué qu'aux balises div. Définir la valeur sur false pour que l'argument soit appliqué à tous les éléments de bloc.
Valeurs renvoyées
Valeur booléenne. Si définie sur true, les arrière-plans sont imposés ; si définie sur false, les arrière-plans ne sont pas
imposés.
ADOBE DREAMWEAVER 9.0 344
Guide des API
Exemple
L'exemple suivant vérifie si la coloration d'arrière-plan de tous les blocs est imposée et, si ce n'est pas le cas, active la
coloration d'arrière-plan de tous les blocs :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.getShowBlockBackgrounds(false) == false){
currentDOM.setShowBlockBackgrounds(false);
}
dom.getShowBlockBorders()
Disponibilité
Dreamweaver 8.
Description
Cette fonction renvoie l'état de l'assistance visuelle qui dessine les bordures de tous les blocs ou divs.
Arguments
allblocks
• L'argument obligatoire allblocks est une valeur booléenne. Définir la valeur sur true pour obtenir uniquement l'état
des balises div. Définir la valeur sur false pour obtenir l'état de tous les éléments de bloc.
Valeurs renvoyées
Valeur booléenne ; si définie sur true, les bordures sont affichées ; si définie sur false, les bordures ne sont pas affichées.
Exemple
L'exemple suivant vérifie si l'assistance visuelle des bordures de blocs est activée et, si ce n'est pas le cas, l'active :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.getShowBlockBorders(false) == false){
currentDOM.setShowBlockBorders(true);
}
dom.getShowBlockIDs()
Disponibilité
Dreamweaver 8.
Description
Cette fonction renvoie l'état de l'assistance visuelle qui affiche les informations relatives à la classe et à l'ID de tous les blocs
ou divs.
Arguments
allblocks
• L'argument obligatoire allblocks est une valeur booléenne. Définir la valeur sur true pour afficher uniquement la classe
et l'ID des balises div. Définir la valeur sur false pour afficher la classe et l'ID de tous les éléments de bloc.
Valeurs renvoyées
Valeur booléenne : Si définie sur true, les ID sont affichés ; si définie sur false, les ID ne sont pas affichés.
Exemple
L'exemple suivant vérifie si les ID de blocs sont affichés et, si ce n'est pas le cas, les affiche :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.getShowBlockIDs(false) == false){
currentDOM.setShowBlockIDs(true);
}
ADOBE DREAMWEAVER 9.0 345
Guide des API
dom.getShowBoxModel()
Disponibilité
Dreamweaver 8.
Description
Cette fonction active ou désactive l'assistance visuelle qui colore le modèle de boîte complet du bloc sélectionné.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant vérifie si le modèle de boîte complet de la boîte sélectionnée est affiché en couleur et, si ce n'est pas le cas,
le colore :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.getShowBoxModel() == false){
currentDOM.setShowBoxModel(true);
}
dom.setShowBlockBackgrounds()
Disponibilité
Dreamweaver 8.
Description
Cette fonction active ou désactive l'assistance visuelle qui commande la coloration de l'arrière-plan de tous les blocs ou divs.
Arguments
allblocks
• L'argument obligatoire allblocks est une valeur booléenne. Définir la valeur sur true pour appliquer la coloration
d'arrière-plan aux balises div uniquement. Définir la valeur sur false pour appliquer la coloration d'arrière-plan à tous
les éléments de bloc.
Valeurs renvoyées
Aucune.
Exemple
Consultez « dom.getShowBlockBackgrounds() », page 343.
dom.setShowBlockBorders()
Disponibilité
Dreamweaver 8.
Description
Cette fonction active ou désactive l'assistance visuelle qui dessine les bordures de tous les blocs ou divs.
Arguments
allblocks
• L'argument obligatoire allblocks est une valeur booléenne. Définir la valeur sur true pour appliquer les bordures aux
balises div uniquement. Définir la valeur sur false pour appliquer les bordures à tous les éléments de bloc.
ADOBE DREAMWEAVER 9.0 346
Guide des API
Valeurs renvoyées
Aucune.
Exemple
Consultez « dom.getShowBlockBorders() », page 344.
dom.setShowBlockIDs()
Disponibilité
Dreamweaver 8.
Description
Cette fonction active ou désactive l'assistance visuelle qui affiche l'ID et la classe de tous les blocs ou divs.
Arguments
allblocks
• L'argument obligatoire allblocks est une valeur booléenne. Définir la valeur sur true pour afficher la classe et l'ID des
balises div uniquement. Définir la valeur sur false pour afficher la classe et l'ID de tous les éléments de bloc.
Valeurs renvoyées
Aucune.
Exemple
Consultez « dom.getShowBlockIDs() », page 344.
dom.setShowBoxModel()
Disponibilité
Dreamweaver 8.
Description
Cette fonction définit l'état de l'assistance visuelle qui colore le modèle de boîte complet du bloc sélectionné.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le modèle de boîte est affiché ; false dans le cas contraire.
Exemple
Consultez « dom.getShowBoxModel() », page 345.
dom.setShowLayoutTableTabs()
Disponibilité
Dreamweaver 4.
Description
Définit le document actif pour qu'il affiche les tabulations des tableaux de Mise en forme chaque fois qu'il est en mode de
Mise en forme. Cette fonction ne place pas le document en mode de Mise en forme.
ADOBE DREAMWEAVER 9.0 347
Guide des API
Arguments
bShow.
• L'argument bShow indique si les tabulations des tableaux de Mise en forme doivent s'afficher lorsque le document actif
est en mode de Mise en forme. Si la valeur de l'argument bShow est true, Dreamweaver affiche les tabulations ; si la valeur
de bShow est false, Dreamweaver ne les affiche pas.
Valeurs renvoyées
Aucune.
dom.getShowLayoutView()
Disponibilité
Dreamweaver 4.
Description
Met le document actif en mode de Mise en forme si bShow a pour valeur true.
Arguments
bShow.
• L'argument bShow est une valeur booléenne qui fait passer le document actif du mode de Mise en forme au mode
Standard, et vice versa. Si la valeur de l'argument bShow est true, le document actif est en mode de Mise en forme ; si la
valeur de bShow est false, le document est en mode Standard.
Valeurs renvoyées
Aucune.
Fonctions relatives aux zooms
Fonctions de zoom avant et arrière en mode Création.
dreamweaver.activeViewScale()
Disponibilité
Dreamweaver 8.
Description
Cette fonction permet d'obtenir ou de définir une propriété de virgule flottante modifiable. Lorsque vous obtenez la valeur,
Dreamweaver renvoie l'échelle de l'affichage actif tel qu'il apparaît dans la zone de liste modifiable Zoom, divisée par 100.
Par exemple, 100% correspond à 1.0 ; 50% à 0.5, etc. Lorsque vous définissez la valeur, Dreamweaver définit la valeur dans
la zone de liste modifiable Zoom. Cette valeur peut être comprise entre 0,06 et 64, ce qui correspond à 6% et 6400%.
Exemple
L'exemple suivant renvoie la valeur de l'échelle de l'affichage actif et effectue un zoom avant s'il cela est possible et si l'échelle
est inférieure ou égale à 100%:
if (canZoom() && dreamweaver.activeViewScale <= 1.0) {
zoomIn();
}
L'exemple suivant définit la valeur de l'échelle de l'affichage actif sur 50% :
dreamweaver.activeViewScale = 0.50;
ADOBE DREAMWEAVER 9.0 348
Guide des API
dreamweaver.fitAll()
Disponibilité
Dreamweaver 8.
Description
Cette fonction effectue un zoom avant ou arrière de manière à ce que la totalité du document s'adapte à la zone actuellement
visible du mode Création.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.canZoom() », page 425.
Exemple
if (canZoom()){
fitAll();
}
dreamweaver.fitSelection()
Disponibilité
Dreamweaver 8.
Description
Cette fonction effectue un zoom avant ou arrière de manière à ce que la sélection en cours s'adapte à la zone actuellement
visible du mode Création.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.canFitSelection() », page 421.
Exemple
if (canFitSeletion()){
fitSelection();
}
dreamweaver.fitWidth()
Disponibilité
Dreamweaver 8.
Description
Cette fonction effectue un zoom avant ou arrière de manière à ce que la largeur totale du document s'adapte à la zone actuellement visible du mode Création.
ADOBE DREAMWEAVER 9.0 349
Guide des API
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.canZoom() », page 425.
Exemple
if (canZoom()){
fitWidth();
}
dreamweaver.zoomIn()
Disponibilité
Dreamweaver 8.
Description
Cette fonction effectue un zoom avant sur la fenêtre de mode Création active. Le niveau de zoom correspond à la valeur
prédéfinie dans le menu Zoom. Si aucune valeur n'est prédéfinie, cette fonction est inactive.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.canZoom() », page 425.
Exemple
if (canZoom()){
zoomIn();
}
dreamweaver.zoomOut()
Disponibilité
Dreamweaver 8.
Description
Cette fonction effectue un zoom arrière sur la fenêtre de mode Création active. Le niveau de zoom correspond à la valeur
prédéfinie dans le menu Zoom. Si aucune valeur n'est prédéfinie, cette fonction est inactive.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.canZoom() », page 425.
ADOBE DREAMWEAVER 9.0 350
Guide des API
Exemple
if (canZoom()){
zoomOut();
}
Propriétés et fonctions de repère
Les propriétés et fonctions de repère permettent d'afficher, de manipuler et de supprimer des repères utilisés par les utilisateurs pour mesurer et mettre en forme des éléments sur leurs pages HTML.
dom.clearGuides()
Disponibilité
Dreamweaver 8.
Description
Cette fonction détermine si tous les repères du document doivent être supprimés.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant supprime tous les repères contenus dans le document si ce dernier en contient au moins un :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.hasGuides() == true) {
currentDOM.clearGuides();
}
dom.createHorizontalGuide()
Disponibilité
Dreamweaver 8.
Description
Cette fonction crée un repère horizontal à l'emplacement spécifié dans le document.
Arguments
location
• L'argument location représente l'emplacement du repère, qui correspond à une chaîne unique contenant à la fois la
valeur et les unités de mesure sans espace entre les deux. Les unités possibles sont "px" pour les pixels et "%" pour les
pourcentages. Par exemple, pour indiquer 10 pixels, location = "10px" ; pour indiquer 50 pourcent, location = "50%".
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant crée un repère horizontal à l'emplacement spécifié dans le document :
var currentDOM = dw.getDocumentDOM();
currentDOM.createHorizontalGuide("10px");
ADOBE DREAMWEAVER 9.0 351
Guide des API
dom.createVerticalGuide()
Disponibilité
Dreamweaver 8.
Description
Cette fonction crée un repère vertical à l'emplacement spécifié dans le document.
Arguments
location
• L'argument location représente l'emplacement du repère, qui correspond à une chaîne unique contenant à la fois la
valeur et les unités de mesure sans espace entre les deux. Les unités possibles sont "px" pour les pixels et "%" pour les
pourcentages. Par exemple, pour indiquer 10 pixels, location = "10px" ; pour indiquer 50 pourcent, location = "50%".
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant crée un repère vertical à l'emplacement spécifié dans le document :
var currentDOM = dw.getDocumentDOM();
currentDOM.createVerticalGuide("10px");
dom.deleteHorizontalGuide()
Disponibilité
Dreamweaver 8.
Description
Cette fonction supprime le repère horizontal à l'emplacement spécifié.
Arguments
location
• L'argument location est une chaîne unique représentant l'emplacement à tester dans le document, contenant à la fois la
valeur et les unités de mesure sans espace entre les deux. Les unités possibles sont "px" pour les pixels et "%" pour les
pourcentages. Par exemple, pour indiquer 10 pixels, location = "10px" ; pour indiquer 50 pourcent, location = "50%".
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant supprime le repère horizontal à l'emplacement spécifié dans le document :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.hasHorizontalGuide("10px") == true) {
currentDOM.deleteHorizonalGuide("10px");
}
dom.deleteVerticalGuide()
Disponibilité
Dreamweaver 8.
Description
Cette fonction supprime le repère vertical à l'emplacement spécifié.
ADOBE DREAMWEAVER 9.0 352
Guide des API
Arguments
location
• L'argument location est une chaîne unique représentant l'emplacement à tester dans le document, contenant à la fois la
valeur et les unités de mesure sans espace entre les deux. Les unités possibles sont "px" pour les pixels et "%" pour les
pourcentages. Par exemple, pour indiquer 10 pixels, location = "10px" ; pour indiquer 50 pourcent, location = "50%".
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant supprime le repère vertical à l'emplacement spécifié dans le document :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.hasVerticalGuide("10px") == true) {
currentDOM.deleteVerticalGuide("10px");
}
dom.guidesColor
Disponibilité
Dreamweaver 8.
Description
Cette propriété de couleur modifiable détermine la couleur des repères contenus dans le document. Vous pouvez définir et
consulter cette propriété.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant affiche les repères en gris :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.guidesColor != "#444444"){
currentDOM.guidesColor = "#444444";
}
dom.guidesDistanceColor
Disponibilité
Dreamweaver 8.
Description
Cette propriété de couleur modifiable détermine la couleur des commentaires distants des repères contenus dans le
document. Vous pouvez définir et consulter cette propriété.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 353
Guide des API
Exemple
L'exemple suivant affiche la couleur des commentaires distants des repères en gris :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.guidesDistanceColor != "#CCCCCC"){
currentDOM.guidesDistanceColor = "#CCCCCC";
}
dom.guidesLocked
Disponibilité
Dreamweaver 8.
Description
Cette propriété booléenne modifiable détermine si les repères doivent être verrouillés dans le document. Vous pouvez
définir et consulter cette propriété.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant verrouille les repères s'ils ne le sont pas :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.guidesLocked == false) {
currentDOM.guidesLocked = true;
}
dom.guidesSnapToElements
Disponibilité
Dreamweaver 8.
Description
Cette propriété booléenne modifiable détermine s'il faut aligner les repères sur les éléments dans le document. Vous pouvez
définir et consulter cette propriété.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant aligne les repères contenus dans le document sur les éléments :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.guidesSnapToElements == false) {
currentDOM.guidesSnapToElements = true;
}
ADOBE DREAMWEAVER 9.0 354
Guide des API
dom.guidesVisible
Disponibilité
Dreamweaver 8.
Description
Cette propriété booléenne modifiable détermine si les repères sont visibles dans le document. Vous pouvez définir et
consulter cette propriété.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant affiche les repères s'ils ne sont pas visibles :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.guidesVisible == false) {
currentDOM.guidesVisible = true;
}
dom.hasGuides()
Disponibilité
Dreamweaver 8.
Description
Cette fonction détermine si le document contient au moins un repère. Vous pouvez définir et consulter cette propriété.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant supprime tous les repères contenus dans le document si ce dernier en contient au moins un :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.hasGuides() == true) {
currentDOM.clearGuides();
}
dom.hasHorizontalGuide()
Disponibilité
Dreamweaver 8.
Description
Cette fonction détermine si le document contient un repère horizontal à l'emplacement spécifié.
ADOBE DREAMWEAVER 9.0 355
Guide des API
Arguments
location
• L'argument location est une chaîne unique représentant l'emplacement à tester dans le document, contenant à la fois la
valeur et les unités de mesure sans espace entre les deux. Les unités possibles sont "px" pour les pixels et "%" pour les
pourcentages. Par exemple, pour indiquer 10 pixels, location = "10px" ; pour indiquer 50 pourcent, location = "50%".
Valeurs renvoyées
Valeur booléenne : true s'il y a un repère horizontal à l'emplacement spécifié ; false dans le cas contraire.
Exemple
L'exemple suivant supprime tous les repères contenus dans le document si ce dernier contient un repère horizontal à
l'emplacement spécifié :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.hasHorizontalGuide("10px") == true) {
currentDOM.clearGuides();
}
dom.hasVerticalGuide()
Disponibilité
Dreamweaver 8.
Description
Cette fonction détermine si le document contient un repère vertical à l'emplacement spécifié.
Arguments
location
• L'argument location est une chaîne unique représentant l'emplacement à tester dans le document, contenant à la fois la
valeur et les unités de mesure sans espace entre les deux. Les unités possibles sont "px" pour les pixels et "%" pour les
pourcentages. Par exemple, pour indiquer 10 pixels, location = "10px" ; pour indiquer 50 pourcent, location = "50%".
Valeurs renvoyées
Valeur booléenne : true s'il y a un repère vertical à l'emplacement spécifié ; false dans le cas contraire.
Exemple
L'exemple suivant supprime tous les repères contenus dans le document si ce dernier contient un repère vertical à l'emplacement spécifié :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.hasVerticalGuide("10px") == true) {
currentDOM.clearGuides();
}
dom.snapToGuides
Disponibilité
Dreamweaver 8.
Description
Cette propriété booléenne modifiable détermine s'il faut aligner les éléments sur les repères dans le document. Vous pouvez
définir et consulter cette propriété.
Arguments
Aucun.
ADOBE DREAMWEAVER 9.0 356
Guide des API
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant aligne les éléments du document sur les repères :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.snapToGuides == false) {
currentDOM.snapToGuides = true;
}
Fonctions de modification des tableaux
Ces fonctions permettent d'insérer et de supprimer des lignes et des colonnes dans des tableaux, de modifier la largeur des
colonnes et la hauteur des lignes, de convertir en pourcentage des mesures exprimées en pixels (et vice versa) et d'effectuer
d'autres opérations standard de modification des tableaux.
dom.convertWidthsToPercent()
Disponibilité
Dreamweaver 3.
Description
Cette fonction convertit en pourcentage tous les attributs WIDTH exprimés en pixels du tableau en cours.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dom.convertWidthsToPixels()
Disponibilité
Dreamweaver 4.
Description
Cette fonction convertit en pourcentage tous les attributs WIDTH exprimés en pixels du tableau en cours.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dom.decreaseColspan()
Disponibilité
Dreamweaver 3.
Description
Cette fonction diminue l'étendue de colonnes de 1.
ADOBE DREAMWEAVER 9.0 357
Guide des API
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dom.canDecreaseColspan() », page 411.
dom.decreaseRowspan()
Disponibilité
Dreamweaver 3.
Description
Cette fonction diminue l'étendue de lignes de 1.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dom.canDecreaseRowspan() », page 411.
dom.deleteTableColumn()
Disponibilité
Dreamweaver 3.
Description
Cette fonction supprime du tableau la ou les colonnes sélectionnées.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dom.canDeleteTableColumn() », page 412.
dom.deleteTableRow()
Disponibilité
Dreamweaver 3.
Description
Cette fonction supprime du tableau la ou les lignes sélectionnées.
Arguments
Aucun.
ADOBE DREAMWEAVER 9.0 358
Guide des API
Valeurs renvoyées
Aucune.
Activateur
Consultez la section « dom.canDeleteTableRow() », page 412.
dom.doDeferredTableUpdate()
Disponibilité
Dreamweaver 3.
Description
Si l'option Modification de tableau plus rapide est activée dans la catégorie Général des préférences, cette fonction oblige la
mise en forme du tableau à adopter les modifications apportées récemment, et ce sans déplacer la sélection à l'extérieur du
tableau. Cette fonction n'a aucun effet si l'option Modification de tableau plus rapide n'est pas activée.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dom.getShowTableWidths()
Disponibilité
Dreamweaver MX 2004.
Description
Indique si les largeurs d'un tableau s'affichent en mode Standard ou Tableaux développés (mode autre que Mise en forme).
Pour plus d'informations sur l'affichage des tabulations de tableau en mode de Mise en forme dans Dreamweaver, consultez
la section « dom.getShowLayoutTableTabs() », page 341.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si Dreamweaver affiche les largeurs du tableau en mode Standard ou Tableaux développés ; false
dans le cas contraire.
dom.getTableExtent()
Disponibilité
Dreamweaver 3.
Description
Cette fonction renvoie le nombre de colonnes et de lignes du tableau sélectionné.
Arguments
Aucun.
Valeurs renvoyées
Tableau contenant deux nombres entiers. Le premier entier correspond au nombre de colonnes, et le second au nombre de
lignes. Si aucun tableau n'est sélectionné, aucune valeur n'est renvoyée.
ADOBE DREAMWEAVER 9.0 359
Guide des API
dom.increaseColspan()
Disponibilité
Dreamweaver 3.
Description
Cette fonction augmente l'étendue de colonnes de 1.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dom.canIncreaseColspan() », page 413.
dom.increaseRowspan()
Disponibilité
Dreamweaver 3.
Description
Cette fonction augmente l'étendue de lignes de 1.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dom.canIncreaseRowspan() », page 413.
dom.insertTableColumns()
Disponibilité
Dreamweaver 3.
Description
Cette fonction insère le nombre de colonnes spécifié dans le tableau en cours.
Arguments
numberOfCols, bBeforeSelection
• L'argument numberOfCols est le nombre de colonnes à insérer.
• L'argument bBeforeSelection est une valeur booléenne : true indique que les colonnes doivent être insérées avant la
colonne contenant la sélection ; false indique le contraire.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dom.canInsertTableColumns() », page 413.
ADOBE DREAMWEAVER 9.0 360
Guide des API
dom.insertTableRows()
Disponibilité
Dreamweaver 3.
Description
Cette fonction insère le nombre de lignes spécifié dans le tableau en cours.
Arguments
numberOfRows, bBeforeSelection
• L'argument numberOfRows est le nombre de lignes à insérer.
• L'argument bBeforeSelection est une valeur booléenne : true indique que les lignes doivent être insérées au-dessus de
la ligne contenant la sélection ; false indique le contraire.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dom.canInsertTableRows() », page 414.
dom.mergeTableCells()
Disponibilité
Dreamweaver 3.
Description
Cette fonction fusionne les cellules de tableau sélectionnées.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dom.canMergeTableCells() », page 415.
dom.removeAllTableHeights()
Disponibilité
Dreamweaver 3.
Description
Cette fonction supprime tous les attributs HEIGHT du tableau sélectionné.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 361
Guide des API
dom.removeAllTableWidths()
Disponibilité
Dreamweaver 3.
Description
Cette fonction supprime tous les attributs WIDTH du tableau sélectionné.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dom.removeColumnWidth()
Disponibilité
Dreamweaver MX 2004.
Description
Cette fonction supprime tous les attributs WIDTH d'une unique colonne sélectionnée.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dom.selectTable()
Disponibilité
Dreamweaver 3.
Description
Sélectionne un tableau entier.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dom.canSelectTable() », page 416.
ADOBE DREAMWEAVER 9.0 362
Guide des API
dom.setShowTableWidths()
Disponibilité
Dreamweaver MX 2004.
Description
Permet d'activer ou de désactiver l'affichage des largeurs d'un tableau en mode Standard ou Tableaux développés (mode
autre que Mise en forme). Cette fonction définit la valeur assignée au document en cours et à tous les documents suivants,
sauf indication contraire. Pour plus d'informations sur la définition de l'affichage des tabulations de tableau en mode de
Mise en forme dans Dreamweaver, consultez la section « dom.setShowLayoutTableTabs() », page 346.
Arguments
bShow.
• L'argument bShow est un booléen qui indique si les largeurs de tableau doivent s'afficher lorsque le document en cours
est en mode Standard ou Tableaux développés (mode autre que Mise en forme). Si la valeur de bShow est true, Dreamweaver affiche les largeurs. Si la valeur de bShow est false, Dreamweaver ne les affiche pas.
Valeurs renvoyées
Aucune.
dom.setTableCellTag()
Disponibilité
Dreamweaver 3.
Description
Cette fonction définit la balise de la cellule sélectionnée.
Arguments
tdOrTh.
• L'argument tdOrTh doit être "td" ou "th".
Valeurs renvoyées
Aucune.
dom.setTableColumns()
Disponibilité
Dreamweaver 3.
Description
Cette fonction définit le nombre de colonnes du tableau sélectionné.
Arguments
numberOfCols.
• L'argument numberOfCols indique le nombre de colonnes à définir dans le tableau.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 363
Guide des API
dom.setTableRows()
Disponibilité
Dreamweaver 3.
Description
Cette fonction définit le nombre de lignes du tableau sélectionné.
Arguments
numberOfCols.
• L'argument numberOfRows indique le nombre de lignes à définir dans le tableau sélectionné.
Valeurs renvoyées
Aucune.
dom.showInsertTableRowsOrColumnsDialog()
Disponibilité
Dreamweaver 3.
Description
Cette fonction ouvre la boîte de dialogue Insérer des lignes ou des colonnes.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez la section « dom.canInsertTableColumns() », page 413 ou « dom.canInsertTableRows() », page 414.
dom.splitTableCell()
Disponibilité
Dreamweaver 3.
Description
Cette fonction fractionne la cellule de tableau en cours en un nombre de lignes ou de colonnes donné. Si vous ne définissez
pas l'un des deux arguments, ou les deux, la boîte de dialogue Fractionner la cellule s'affiche.
Arguments
{colsOrRows}, {numberToSplitInto}
• L'argument facultatif colsOrRows doit être "columns" ou "rows".
• L'argument facultatif numberToSplitInto indique en combien de lignes ou de colonnes la cellule doit être fractionnée.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dom.canSplitTableCell() », page 417.
ADOBE DREAMWEAVER 9.0 364
Guide des API
365
Chapitre 18 : Code
Les fonctions de code vous permettent d'effectuer des opérations sur un document affiché en mode Code. Ces opérations
comprennent l'ajout de nouvelles balises de fonction ou de menu à un menu d'indicateurs de code, la recherche et le remplacement de modèles de chaînes, la suppression de la sélection en cours, l'impression de code complet ou sélectionné, la
modification de balises ou l'application de formatage de syntaxe au code sélectionné.
Les fonctions décrites dans ce chapitre sont regroupées dans les sections suivantes :
• « Fonctions de code », page 365
• « Fonctions relatives à la recherche et au remplacement », page 369
• « Fonctions de modifications générales », page 373
• « Fonction relative à l'impression », page 387
• « Fonctions relatives à Quick Tag Editor », page 388
• « Fonctions relatives au mode Code », page 390
• « Fonctions de l'éditeur de balises et de la bibliothèque de balises », page 404
Fonctions de code
Les indicateurs de code sont des menus contextuels qui s'affichent dans Adobe® Dreamweaver® CS3 lorsque vous tapez
certains caractères en mode Code. Ils vous évitent de saisir tout le texte en proposant une liste de chaînes susceptibles de
compléter la chaîne que vous tapez. Si la chaîne que vous tapez apparaît dans le menu, sélectionnez-la et appuyez sur Entrée
ou Retour pour compléter votre saisie. Si vous tapez <, par exemple, un menu contextuel affiche une liste des noms de
balises. Plutôt que de taper le reste du nom de la balise, vous pouvez la sélectionner dans le menu pour l'inclure à votre texte.
Vous pouvez ajouter des menus Indicateurs de code dans Dreamweaver en les définissant dans le fichier CodeHints.xml.
Pour plus d'informations sur le fichier CodeHints.xml, voir Extension de Dreamweaver.
Vous pouvez également ajouter de nouveaux menus d'indicateurs de code de façon dynamique via JavaScript après
chargement du contenu du fichier CodeHints.xml par Dreamweaver. Par exemple, le code JavaScript ajoute des données à
la liste des variables de session dans le panneau Liaisons. Vous pouvez utiliser le même code pour ajouter un menu Indicateurs de code. Dans ce cas, Dreamweaver affiche un menu de variables de session lorsqu'un utilisateur tape Session en mode
Code.
Le fichier CodeHints.xml et l'API JavaScript contiennent un sous-ensemble utile du moteur Indicateurs de code, mais
certaines fonctionnalités Dreamweaver ne sont pas accessibles. Par exemple, comme il n'existe pas d'accroche JavaScript
pouvant afficher un sélecteur de couleur, Dreamweaver ne peut pas exprimer le menu Valeurs des attributs à l'aide de JavaScript. Vous pouvez uniquement afficher un menu d'éléments de texte permettant d'insérer du texte.
La coloration du code vous permet de définir des styles de couleur de code et de modifier des modèles de coloration de code
ou d'en créer de nouveaux. Vous pouvez spécifier ces styles et modèles en modifiant le fichier Colors.xml et celui de modèle
de coloration. Pour plus d'informations sur ces fichiers, voir Extension de Dreamweaver.
L'API JavaScript pour les indicateurs et la coloration de code comprend les fonctions suivantes :
ADOBE DREAMWEAVER 9.0 366
Guide des API
dreamweaver.codeHints.addMenu()
Disponibilité
Dreamweaver MX.
Description
Définit dynamiquement une nouvelle balise menu dans le fichier CodeHints.xml. Si une balise de menu est définie par le
même modèle et le même type de document, cette fonction ajoute les éléments au menu existant.
Arguments
menuGroupId, pattern, labelArray, {valueArray}, {iconArray}, {doctypes}, {casesensitive}
• L'argument menuGroupId est l'attribut ID de l'une des balises menugroup.
• L'argument pattern est l'attribut de modèle de la nouvelle balise menu.
• L'argument labelArray est un tableau de chaînes. Chaque chaîne constitue le texte d'un élément de menu dans le menu
contextuel.
• L'argument facultatif valueArray est un tableau de chaînes qui doit avoir la même longueur que l'argument labelArray.
Lorsqu'un utilisateur sélectionne un élément dans le menu contextuel, la chaîne de ce tableau est insérée dans son
document. Si la chaîne à insérer est toujours identique à celle de l'étiquette du menu, la valeur de cet argument peut être
null.
• L'argument facultatif iconArray peut être une chaîne ou un tableau de chaînes. S'il s'agit d'une chaîne, elle spécifie l'URL
d'un fichier d'image utilisé par Dreamweaver pour tous les éléments du menu. S'il s'agit d'un tableau de chaînes, il doit
être de la même longueur que l'argument labelArray. Chaque chaîne est une URL (dossier Configuration de Dreamweaver) désignant un fichier d'image que Dreamweaver utilise comme une icône pour l'élément de menu correspondant.
Si cet argument a la valeur null, Dreamweaver affiche le menu sans les icônes.
• L'argument facultatif doctypes indique que le menu est actif pour certains types de documents uniquement. Vous
pouvez spécifier l'argument doctypes en tant que liste d'ID de types de documents séparés par des virgules. Pour obtenir
une liste des types de documents Dreamweaver, consultez le fichier Dreamweaver Configuration/Documenttypes/MMDocumentTypes.xml.
• L'argument facultatif casesensitive indique si le modèle fait la distinction entre les majuscules et les minuscules. Les
valeurs possibles de l'argument casesensitive sont les valeurs booléennes true ou false. Par défaut, la valeur est false
si vous omettez cet argument. Dans le cas où l'argument casesensitive aurait la valeur true, le menu d'indicateurs de
code s'affiche uniquement si le texte entré par l'utilisateur correspond exactement au modèle spécifié par l'attribut de
modèle. Dans le cas où l'argument casesensitive aurait la valeur false, le menu s'affiche, même si le modèle est en
minuscules et que le texte est en majuscules.
Valeurs renvoyées
Aucune.
Exemple
Si l'utilisateur crée un jeu d'enregistrements appelé "myRs", le code suivant crée un menu pour myRS:
dw.codeHints.addMenu(
"CodeHints_object_methods",
"myRS.",
new Array("firstName", "lastName"),
new Array("firstName", "lastName"),
null,
"ASP_VB, ASP_JS");
// le menu est activé si les méthodes d'objet sont activées
// menu déroulant si l'utilisateur entre "myRS."
// éléments du menu déroulant pour myRS
// texte à insérer effectivement dans le document
// aucune icône pour ce menu
// spécifique aux types de doc ASP
ADOBE DREAMWEAVER 9.0 367
Guide des API
dreamweaver.codeHints.addFunction()
Disponibilité
Dreamweaver MX.
Description
Définit dynamiquement une nouvelle balise function. Si une balise function est définie par le même modèle et le même
type de document, cette fonction remplace la balise function existante.
Arguments
menuGroupId, pattern, {doctypes}, {casesensitive}
• L'argument menuGroupId est l'attribut de chaîne d'ID d'une balise menugroup.
• L'argument pattern est une chaîne qui spécifie l'attribut de modèle de la nouvelle balise function.
• L'argument facultatif doctypes définit que cette fonction est active pour certains types de documents uniquement. Vous
pouvez spécifier l'argument doctypes en tant que liste d'ID de types de documents séparés par des virgules. Pour obtenir
une liste des types de documents Dreamweaver, consultez le fichier Dreamweaver Configuration/Documenttypes/MMDocumentTypes.xml.
• L'argument facultatif casesensitive indique si le modèle fait la distinction entre les majuscules et les minuscules. Les
valeurs possibles de l'argument casesensitive sont les valeurs booléennes true ou false. Par défaut, la valeur est false
si vous omettez cet argument. Dans le cas où l'argument casesensitive aurait la valeur true, le menu d'indicateurs de
code s'affiche uniquement si le texte entré par l'utilisateur correspond exactement au modèle spécifié par l'attribut de
modèle. Si l'argument casesensitive est false, le menu s'affiche même si le modèle est en minuscules et le texte en
majuscules.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant de la fonction dw.codeHints.addFunction() ajoute le modèle de nom de fonction out.newLine() au
groupe de menu d'indicateurs de code CodeHints_Object_Methods et l'active uniquement pour les documents de type JSP :
dw.codeHints.addFunction(
"CodeHints_Object_Methods",
"out.newLine()",
"JSP")
dreamweaver.codeHints.resetMenu()
Disponibilité
Dreamweaver MX.
Description
Réinitialise la balise de menu ou de fonction spécifiée à l'état dans lequel elle se trouvait juste après la lecture du fichier
CodeHints.xml par Dreamweaver. En d'autres termes, l'appel de cette fonction annule l'effet des appels précédents des
fonctions addMenu() et addFunction().
Arguments
menuGroupId, pattern, {doctypes}
• L'argument menuGroupId est l'attribut de chaîne d'ID d'une balise menugroup.
• L'argument pattern est une chaîne qui spécifie l'attribut de modèle de la nouvelle balise menu ou function à réinitialiser.
• L'argument facultatif doctypes indique que le menu est actif pour certains types de documents uniquement. Vous
pouvez spécifier l'argument doctypes en tant que liste d'ID de types de documents séparés par des virgules. Pour obtenir
une liste des types de documents Dreamweaver, consultez le fichier Dreamweaver Configuration/Documenttypes/MMDocumentTypes.xml.
ADOBE DREAMWEAVER 9.0 368
Guide des API
Valeurs renvoyées
Aucune.
Exemple
Votre code JavaScript peut créer un menu Indicateurs de code qui contient toutes les variables de session définies par l'utilisateur. Dès que la liste des variables de session est modifiée, ce code met le menu à jour. Avant de charger la nouvelle liste
de variables de session dans le menu, le code doit supprimer l'ancienne liste. L'appel de cette fonction supprime les
anciennes variables de session.
dreamweaver.codeHints.showCodeHints()
Disponibilité
Dreamweaver MX.
Description
Dreamweaver appelle cette fonction lorsque l'utilisateur ouvre l'élément de menu Edition > Afficher les indicateurs de code.
La fonction ouvre le menu Indicateurs de code à l'emplacement de la sélection en mode Code.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Exemple
L'exemple suivant ouvre le menu d'indicateurs de code au niveau du point d'insertion dans le document en mode Code.
dw.codeHints.showCodeHints()
dreamweaver.reloadCodeColoring()
Description
Recharge les fichiers de coloration de code dans le dossier Configuration/Code Coloring de Dreamweaver.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Exemple
dreamweaver.reloadCodeColoring()
ADOBE DREAMWEAVER 9.0 369
Guide des API
Fonctions relatives à la recherche et au remplacement
Comme leur nom l'indique, ces fonctions permettent d'effectuer des recherches et des remplacements. Elles vont de la
simple recherche de l'instance suivante d'une chaîne donnée à des opérations plus complexes de remplacement automatique.
dreamweaver.findNext()
Disponibilité
Dreamweaver 3 ; modifié dans Dreamweaver MX 2004.
Description
Recherche l'instance suivante de la chaîne de recherche précédemment définie par « dreamweaver.setUpFind() », page 371,
par « dreamweaver.setUpComplexFind() », page 370 ou par l'utilisateur (à l'aide de la boîte de dialogue Rechercher), puis
la sélectionne dans le document.
Arguments
{bUseLastSetupSearch}
• L'argument facultatif bUseLastSetupSearch est une valeur booléenne. Si bUseLastSetupSearch a la valeur true (valeur
par défaut si aucun argument n'est fourni), la fonction recherche l'occurrence suivante selon les paramètres définis lors
de l'appel précédent à la fonction dreamweaver.setupComplexFind() ou à la fonction dreamweaver.setupComplexFindReplace(). Si vous définissez bUseLastSetupSearch sur la valeur false, la fonction ignore la recherche précédente et
recherche l'instance suivante du texte sélectionné dans le document.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.canFindNext() », page 420.
dreamweaver.replace()
Disponibilité
Dreamweaver 3.
Description
Vérifie que la sélection actuelle correspond aux critères de recherche spécifiés par « dreamweaver.setUpFindReplace() »,
page 372, par « dreamweaver.setUpComplexFindReplace() », page 370 ou par l'utilisateur dans la boîte de dialogue
Remplacer ; la fonction remplace ensuite la sélection par le texte de substitution spécifié dans la demande de recherche.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 370
Guide des API
dreamweaver.replaceAll()
Disponibilité
Dreamweaver 3.
Description
Remplace chaque section du document actif correspondant aux critères de recherche précédemment définis par la fonction
« dreamweaver.setUpFindReplace() », page 372 ou « dreamweaver.setUpComplexFindReplace() », page 370 ou par l'utilisateur (dans la boîte de dialogue Remplacer) par le contenu de remplacement spécifié.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dreamweaver.setUpComplexFind()
Disponibilité
Dreamweaver 3.
Description
Prépare le terrain pour une recherche avancée de texte ou de balises en chargeant la requête XML spécifiée.
Arguments
xmlQueryString
• L'argument xmlQueryString est une chaîne de code XML commençant par dwquery et se terminant par /dwquery. Pour
obtenir une chaîne formatée correctement, vous pouvez définir la requête à l'aide de la boîte de dialogue Rechercher,
cliquer sur le bouton Enregistrer la requête, ouvrir ce fichier de requête dans un éditeur de texte et copier tout ce qui est
compris entre le début de la balise dwquery et la fin de la balise /dwquery.
Remarque : Dans une requête, certains caractères spéciaux, tels que la barre oblique inverse (\), doivent être ignorés. Par conséquent, pour utiliser une barre oblique inverse dans une requête, vous devez écrire \\.
Valeurs renvoyées
Aucune.
Exemple
Dans l'exemple ci-après, la première ligne de code définit une recherche de balise et précise que la recherche doit porter sur
le document actif ; la deuxième ligne exécute la recherche.
dreamweaver.setUpComplexFind('<dwquery><queryparams matchcase="false" ¬
ignorewhitespace="true" useregexp="false"/><find>¬
<qtag qname="a"><qattribute qname="href" qcompare="=" qvalue="#">¬
</qattribute><qattribute qname="onMouseOut" qcompare="=" qvalue="" qnegate="true">¬
</qattribute></qtag></find></dwquery>');
dw.findNext();
dreamweaver.setUpComplexFindReplace()
Disponibilité
Dreamweaver 3.
Description
Prépare le terrain pour une recherche avancée de texte ou de balises en chargeant la requête XML spécifiée.
ADOBE DREAMWEAVER 9.0 371
Guide des API
Arguments
xmlQueryString
• L'argument xmlQueryString est une chaîne du code XML qui commence par la balise dwquery et se termine par la balise
/dwquery. Pour obtenir une chaîne ayant formatée correctement, vous pouvez définir la requête à l'aide de la boîte
de
dialogue Rechercher, cliquer sur le bouton Enregistrer la requête, ouvrir ce fichier de requête dans un éditeur de texte et
copier tout ce qui est compris entre le début de la balise dwquery et la fin de la balise /dwquery.
Remarque : Dans une requête, certains caractères spéciaux, tels que la barre oblique inverse (\), doivent être ignorés. Par conséquent, pour utiliser une barre oblique inverse dans une requête, vous devez écrire \\.
Valeurs renvoyées
Aucune.
Exemple
Dans l'exemple ci-après, la première ligne de code définit une recherche de balise et précise que la recherche doit porter sur
quatre fichiers ; la deuxième ligne exécute la recherche et le remplacement.
dreamweaver.setUpComplexFindReplace('<dwquery><queryparams ¬
matchcase="false" ignorewhitespace="true" useregexp="false"/>¬
<find><qtag qname="a"><qattribute qname="href" qcompare="=" qvalue="#">¬
</qattribute><qattribute qname="onMouseOut" ¬qcompare="=" qvalue="" qnegate="true">¬
</qattribute></qtag></find><replace action="setAttribute" param1="onMouseOut" ¬
param2="this.style.color='#000000';this.style.¬
fontWeight='normal'"/></dwquery>');
dw.replaceAll();
dreamweaver.setUpFind()
Disponibilité
Dreamweaver 3.
Description
Prépare le terrain pour l'exécution d'une recherche de texte ou de code source HTML en définissant les critères de recherche
de l'opération dreamweaver.findNext() qui va suivre.
Arguments
searchObject
L'argument searchObject est un objet pour lequel les propriétés suivantes peuvent être définies :
• La propriété searchString est le texte à rechercher.
• La propriété searchSource est une valeur booléenne indiquant si la recherche doit également porter sur le code
source HTML.
• La propriété facultative {matchCase} est une valeur booléenne indiquant si la recherche doit respecter les majuscules et
les minuscules. Si cette propriété n'est pas définie, elle prend par défaut la valeur false.
• La propriété facultative {ignoreWhitespace} est une valeur booléenne indiquant si les différences entre les espaces
blancs doivent être ignorées. La propriétés ignoreWhitespace prend sa valeur par défaut, false, si la valeur de la
propriété useRegularExpressions est true, et true si la valeur de la propriété useRegularExpressions est false.
• La propriété {useRegularExpressions} est une valeur booléenne indiquant que la propriété searchString utilise des
expressions régulières. Si cette propriété n'est pas définie, elle prend par défaut la valeur false.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 372
Guide des API
Exemple
L'exemple de code suivant montre comment créer un objet à rechercher (searchObject) de trois façons différentes :
var searchParams;
searchParams.searchString = 'bgcolor="#FFCCFF"';
searchParams.searchSource = true;
dreamweaver.setUpFind(searchParams);
var searchParams = {searchString: 'bgcolor="#FFCCFF"', searchSource: true};
dreamweaver.setUpFind(searchParams);
dreamweaver.setUpFind({searchString: 'bgcolor="#FFCCFF"', searchSource: ¬true});
dreamweaver.setUpFindReplace()
Disponibilité
Dreamweaver 3.
Description
Prépare une recherche de texte ou de code source HTML en définissant les critères de recherche et le cadre d'application de
l'opération dreamweaver.replace() dreamweaver.replaceAll() qui va suivre.
Arguments
searchObject
L'argument searchObject est un objet pour lequel les propriétés suivantes peuvent être définies :
• La propriété searchString est le texte à rechercher.
• La propriété replaceString est le texte à substituer au texte recherché.
• La propriété searchSource est une valeur booléenne indiquant si la recherche doit également porter sur le code
source HTML.
• La propriété facultative {matchCase} est une valeur booléenne indiquant si la recherche doit respecter les majuscules et
les minuscules. Si cette propriété n'est pas définie, elle prend par défaut la valeur false.
• La propriété facultative {ignoreWhitespace} est une valeur booléenne indiquant si les différences entre les espaces
blancs doivent être ignorées. La propriété ignoreWhitespace prend la valeur false si la propriété useRegularExpressions a la valeur true et prend la valeur true si l'expression useRegularExpressions a la valeur false.
• La propriété {useRegularExpressions} est une valeur booléenne indiquant que la propriété searchString utilise des
expressions régulières. Si cette propriété n'est pas définie, elle prend par défaut la valeur false.
Valeurs renvoyées
Aucune.
Exemple
L'exemple de code suivant montre comment créer un objet à rechercher (searchObject) de trois façons différentes :
var searchParams;
searchParams.searchString = 'bgcolor="#FFCCFF"';
searchParams.replaceString = 'bgcolor="#CCFFCC"';
searchParams.searchSource = true;
dreamweaver.setUpFindReplace(searchParams);
var searchParams = {searchString: 'bgcolor="#FFCCFF"', replaceString: 'bgcolor="#CCFFCC"',
searchSource: true};
dreamweaver.setUpFindReplace(searchParams);
dreamweaver.setUpFindReplace({searchString: 'bgcolor="#FFCCFF"',
replaceString: 'bgcolor="#CCFFCC"', searchSource: true});
ADOBE DREAMWEAVER 9.0 373
Guide des API
dreamweaver.showFindDialog()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue Rechercher.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.canShowFindDialog() », page 424.
dreamweaver.showFindReplaceDialog()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue Remplacer.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.canShowFindDialog() », page 424.
Fonctions de modifications générales
Ces fonctions s'utilisent depuis la fenêtre de document. Elles permettent d'insérer du texte, du code HTML et des objets,
d'appliquer, de modifier et de supprimer des marqueurs de police et de caractère, de modifier des balises et des attributs, etc.
dom.applyCharacterMarkup()
Disponibilité
Dreamweaver 3.
Description
Applique à la sélection le type de marqueur de caractère spécifié. Si la sélection est un point d'insertion, la fonction applique
les marqueurs de caractère spécifiés au texte saisi après le point d'insertion.
Arguments
tagName
• L'argument tagName est le nom de la balise associé au marqueur de caractère. Il doit s'agir de l'une des chaînes suivantes :
"b", "cite", "code", "dfn", "em", "i", "kbd", "samp", "s", "strong", "tt", "u" ou "var".
ADOBE DREAMWEAVER 9.0 374
Guide des API
Valeurs renvoyées
Aucune.
dom.applyFontMarkup()
Disponibilité
Dreamweaver 3.
Description
Applique à la sélection en cours la balise FONT, ainsi que l'attribut spécifié et sa valeur.
Arguments
attribute, value
• L'argument attribute doit être "face", "size" ou "color".
• L'argument value est la valeur à affecter à l'attribut, comme "Arial, Helvetica, sans-serif", "5" ou "#FF0000".
Valeurs renvoyées
Aucune.
dom.deleteSelection()
Disponibilité
Dreamweaver 3.
Description
Supprime la sélection du document.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dom.editAttribute()
Disponibilité
Dreamweaver 3.
Description
Affiche l'interface permettant de modifier l'attribut de document spécifié. Dans la plupart des cas, il s'agit d'une boîte de
dialogue. Cette fonction n'est valide que pour le document actif.
Arguments
attribut
•
attribute est une chaîne qui spécifie l'attribut de balise à modifier.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 375
Guide des API
dom.exitBlock()
Disponibilité
Dreamweaver 3.
Description
Quitte le bloc de paragraphe ou d'en-tête en cours et place le point d'insertion à l'extérieur de tous les éléments de bloc.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dom.getCharSet()
Disponibilité
Dreamweaver 4.
Description
Renvoie l'attribut charset dans la balise Meta du document.
Arguments
Aucun.
Valeurs renvoyées
L'identité de codage du document. Par exemple, dans un document Latin1, dans un document Latin1, cette fonction
renvoie iso-8859-1.
dom.getFontMarkup()
Disponibilité
Dreamweaver 3.
Description
Obtient la valeur de l'attribut spécifié de la balise FONT pour la sélection en cours.
Arguments
attribut
• L'argument attribute doit être "face", "size" ou "color".
Valeurs renvoyées
Soit une chaîne contenant la valeur de l'attribut spécifié, soit une chaîne vide si l'attribut n'est pas défini.
dom.getLineFromOffset()
Disponibilité
Dreamweaver MX.
Description
Trouve le numéro de ligne d'un décalage de caractère précis dans le texte (le code HTML ou JavaScript) du fichier.
ADOBE DREAMWEAVER 9.0 376
Guide des API
Arguments
offset
• L'argument offset est un nombre entier qui représente l'emplacement du caractère à partir du début du fichier.
Valeurs renvoyées
Nombre entier qui représente le numéro de la ligne dans le document.
dom.getLinkHref()
Disponibilité
Dreamweaver 3.
Description
Obtient le lien qui entoure la sélection en cours. Revient à effectuer une boucle sur les parents et les grands-parents du
noeud en cours jusqu'à ce qu'un lien soit rencontré, puis à appeler la fonction getAttribute('HREF') sur ce lien.
Arguments
Aucun.
Valeurs renvoyées
Chaîne qui contient le nom du fichier lié, exprimé sous la forme d'une URL de type file://.
dom.getLinkTarget()
Disponibilité
Dreamweaver 3.
Description
Obtient la cible du lien qui entoure la sélection en cours. Revient à effectuer une boucle sur les parents et les grands-parents
du noeud en cours jusqu'à ce qu'un lien soit rencontré, puis à appeler la fonction getAttribute('TARGET') sur ce lien.
Arguments
Aucun.
Valeurs renvoyées
Soit une chaîne contenant la valeur de l'attribut TARGET spécifié pour le lien, soit une chaîne vide si aucune cible n'est définie.
dom.getListTag()
Disponibilité
Dreamweaver 3.
Description
Obtient le style de la liste sélectionnée.
Arguments
Aucun.
Valeurs renvoyées
Soit une chaîne contenant la balise associée à la liste ("ul", "ol" ou "dl"), soit une chaîne vide si aucune balise n'est associée
à la liste. Cette valeur est toujours renvoyée en minuscules.
ADOBE DREAMWEAVER 9.0 377
Guide des API
dom.getTextAlignment()
Disponibilité
Dreamweaver 3.
Description
Obtient l'alignement du bloc contenant la sélection.
Arguments
Aucun.
Valeurs renvoyées
Soit une chaîne contenant la valeur de l'attribut ALIGN de la balise associée au bloc, soit une chaîne vide si l'attribut ALIGN
n'est pas défini. Cette valeur est toujours renvoyée en minuscules.
dom.getTextFormat()
Disponibilité
Dreamweaver 3.
Description
Obtient le format du bloc contenant la sélection.
Arguments
Aucun.
Valeurs renvoyées
Soit une chaîne contenant la balise de bloc associée au texte (comme "p", "h1", "pre", etc.), soit une chaîne vide si aucune
balise de bloc n'est associée à la sélection. Cette valeur est toujours renvoyée en minuscules.
dom.hasCharacterMarkup()
Disponibilité
Dreamweaver 3.
Description
Vérifie si le marqueur de caractère spécifié est déjà associé à la sélection.
Arguments
markupTagName
• L'argument markupTagName est le nom de la balise à vérifier. Il doit s'agir de l'une des chaînes suivantes : "b", "cite",
"code", "dfn", "em", "i", "kbd", "samp", "s", "strong", "tt", "u" ou "var".
Valeurs renvoyées
Valeur booléenne qui indique si le marqueur de caractère spécifié est associé à la sélection entière. Cette fonction renvoie
la valeur false si le marqueur spécifié n'est associé qu'à une partie de la sélection.
ADOBE DREAMWEAVER 9.0 378
Guide des API
dom.indent()
Disponibilité
Dreamweaver 3.
Description
Applique un retrait à la sélection à l'aide des balises BLOCKQUOTE. Si la sélection est un élément de liste, cette fonction lui
applique un retrait en convertissant l'élément sélectionné en liste imbriquée. La liste imbriquée est du même type que la liste
externe et contient un seul élément (la sélection d'origine).
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dom.insertHTML()
Disponibilité
Dreamweaver 3.
Description
Insère un contenu HTML dans le document, au niveau du point d'insertion en cours.
Arguments
contentToInsert, {bReplaceCurrentSelection}
• L'argument contentToInsert est le contenu à insérer.
• L'argument facultatif bReplaceCurrentSelection est une valeur booléenne qui indique si le contenu spécifié doit
remplacer la sélection en cours. Si la valeur de l'argument bReplaceCurrentSelection est true, le contenu remplace la
sélection actuelle. Si sa valeur est false, le contenu est inséré après la sélection actuelle.
Valeurs renvoyées
Aucune.
Exemple
Le code suivant insère la chaîne HTML <b>130</b> dans le document actuel :
var theDOM = dw.getDocumentDOM();
theDOM.insertHTML('<b>130</b>');
Le résultat apparaît dans la fenêtre de document, comme indiqué dans la figure suivante :
dom.insertObject()
Disponibilité
Dreamweaver 3.
Description
Insère l'objet spécifié et invite l'utilisateur à définir des paramètres, le cas échéant.
ADOBE DREAMWEAVER 9.0 379
Guide des API
Arguments
objectName
• L'argument objectName est le nom d'un objet dans le dossier Configuration/Objects.
Valeurs renvoyées
Aucune.
Exemple
Un appel à la fonction dom.insertObject('Button') insère un bouton de formulaire dans le document actif, après la
sélection en cours. Si aucun élément n'est sélectionné, cette fonction insère le bouton au niveau du point d'insertion en
cours.
Remarque : Même si les fichiers d'objets peuvent être conservés dans des dossiers séparés, le nom de chaque fichier doit impérativement être unique. En effet, si le dossier Forms et le dossier MyObjects contiennent chacun un fichier nommé Button.htm,
par exemple, Dreamweaver n'est pas capable de faire la différence entre les deux.
dom.insertText()
Disponibilité
Dreamweaver 3.
Description
Insère un contenu dans le document, au niveau du point d'insertion en cours.
Arguments
contentToInsert, {bReplaceCurrentSelection}
• L'argument contentToInsert est le contenu à insérer.
• L'argument facultatif bReplaceCurrentSelection est une valeur booléenne qui indique si le contenu spécifié doit
remplacer la sélection en cours. Si la valeur de l'argument bReplaceCurrentSelection est true, le contenu remplace la
sélection actuelle. Si sa valeur est false, le contenu est inséré après la sélection actuelle.
Valeurs renvoyées
Aucune.
Exemple
Le code suivant insère le texte : <b>130</b> dans le document actif :
var theDOM = dreamweaver.getDocumentDOM();
theDOM.insertText('<b>130</b>');
Les résultats apparaissent dans la fenêtre de document, comme indiqué dans la figure suivante :
dom.newBlock()
Disponibilité
Dreamweaver 3.
Description
Crée un bloc doté de la même balise et des mêmes attributs que le bloc contenant la sélection en cours ou, si le pointeur se
trouve à l'extérieur de tous les blocs, crée un paragraphe.
ADOBE DREAMWEAVER 9.0 380
Guide des API
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Exemple
Si la sélection en cours se trouve à l'intérieur d'un paragraphe centré, un appel à la fonction dom.newBlock() insère <p
align="center"> après le paragraphe en cours.
dom.notifyFlashObjectChanged()
Disponibilité
Dreamweaver 4.
Description
Indique à Dreamweaver que le fichier Flash en cours a été modifié. Dreamweaver met à jour la fenêtre d'aperçu en la
redimensionnant, le cas échéant, et en veillant à conserver le rapport hauteur/largeur d'origine. Par exemple, le texte Flash
utilise cette fonction pour mettre à jour le texte en mode de Mise en forme à mesure que l'utilisateur en change les propriétés
dans la boîte de dialogue Commande.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dom.outdent()
Disponibilité
Dreamweaver 3.
Description
Applique un retrait négatif à la sélection.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dom.removeCharacterMarkup()
Disponibilité
Dreamweaver 3.
Description
Supprime de la sélection le type de marqueur de caractère spécifié.
Arguments
tagName
• L'argument tagName est le nom de la balise associé au marqueur de caractère. Il doit s'agir de l'une des chaînes suivantes :
"b", "cite", "code", "dfn", "em", "i", "kbd", "samp", "s", "strong", "tt", "u" ou "var".
ADOBE DREAMWEAVER 9.0 381
Guide des API
Valeurs renvoyées
Aucune.
dom.removeFontMarkup()
Disponibilité
Dreamweaver 3.
Description
Supprime d'une balise FONT l'attribut spécifié, ainsi que sa valeur. Si, après suppression de l'attribut, il ne reste que la balise
FONT, la balise FONT est également supprimée.
Arguments
attribut
• L'argument attribute doit être "face", "size" ou "color".
Valeurs renvoyées
Aucune.
dom.removeLink()
Disponibilité
Dreamweaver 3.
Description
Supprime le lien hypertexte de la sélection.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dom.resizeSelection()
Disponibilité
Dreamweaver 3.
Description
Redimensionne l'objet sélectionné et lui applique les nouvelles dimensions spécifiées.
Arguments
newWidth, newHeight
• L'argument newWidth spécifie la nouvelle largeur définie pour l'objet sélectionné par la fonction.
• L'argument newHeight spécifie la nouvelle hauteur définie pour l'objet sélectionné par la fonction.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 382
Guide des API
dom.setAttributeWithErrorChecking()
Disponibilité
Dreamweaver 3.
Description
Définit l'attribut spécifié sur la valeur indiquée pour la sélection en cours et affiche une invite utilisateur si le type de valeur
est incorrect ou si la valeur n'est pas comprise dans la plage spécifiée. Cette fonction n'est valide que pour le document actif.
Arguments
attribute, value
• L'argument attribute spécifie l'attribut à définir pour la sélection actuelle.
• L'argument value spécifie la valeur à définir pour l'attribut.
Valeurs renvoyées
Aucune.
dom.setLinkHref()
Disponibilité
Dreamweaver 3.
Description
Transforme la sélection en lien hypertexte ou modifie la valeur de l'URL pour la balise HREF qui entoure la sélection en
cours.
Arguments
linkHREF
• L'argument linkHREF est une URL (chemin relatif au document ou à la racine, ou URL absolue) contenant le lien. Si
aucun argument n'est défini, la boîte de dialogue Sélectionner fichier HTML s'affiche.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dom.canSetLinkHref() », page 416.
dom.getLinkTarget()
Disponibilité
Dreamweaver 3.
Description
Définit la cible du lien qui entoure la sélection en cours. Revient à effectuer une boucle sur les parents et les grands-parents
du noeud en cours jusqu'à ce qu'un lien soit rencontré, puis à appeler la fonction setAttribute('TARGET') sur ce lien.
Arguments
{linkTarget}
• L'argument linkTarget est une chaîne qui représente le nom d'un cadre ou d'une fenêtre, ou l'une des cibles réservées
("_self", "_parent", "_top" ou "_blank"). Si aucun argument n'est défini, la boîte de dialogue Définir la cible s'affiche.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 383
Guide des API
dom.setListBoxKind()
Disponibilité
Dreamweaver 3.
Description
Modifie le type du menu SELECT sélectionné.
Arguments
kind
• L'argument kind doit être "menu" ou "list
box".
Valeurs renvoyées
Aucune.
dom.showListPropertiesDialog()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue Propriétés de la liste.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dom.canShowListPropertiesDialog() », page 416.
dom.setListTag()
Disponibilité
Dreamweaver 3.
Description
Définit le style de la liste sélectionnée.
Arguments
listTag
• L'argument listTag est la balise associée à la liste. Il doit s'agir de "ol", "ul", "dl" ou d'une chaîne vide.
Valeurs renvoyées
Aucune.
dom.setTextAlignment()
Disponibilité
Dreamweaver 3.
Description
Affecte la valeur spécifiée à l'attribut ALIGN du bloc contenant la sélection.
ADOBE DREAMWEAVER 9.0 384
Guide des API
Arguments
alignValue
• L'argument alignValue doit être "left", "center" ou "right".
Valeurs renvoyées
Aucune.
dom.setTextFieldKind()
Disponibilité
Dreamweaver 3.
Description
Définit le format du champ de texte sélectionné.
Arguments
fieldType
• L'argument fieldType doit être "input", "textarea" ou "password".
Valeurs renvoyées
Aucune.
dom.setTextFormat()
Disponibilité
Dreamweaver 4.
Description
Définit le format de bloc du texte sélectionné.
Arguments
blockFormat
• L'argument blockFormat est une chaîne qui spécifie un des formats suivants : "" (aucun format), "p", "h1", "h2", "h3",
"h4", "h5", "h6" ou "pre".
Valeurs renvoyées
Aucune.
dom.showFontColorDialog()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue du sélecteur de couleur.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 385
Guide des API
dreamweaver.deleteSelection()
Disponibilité
Dreamweaver 3.
Description
Supprime la sélection du document actif, du panneau Site ou, sur Macintosh, il supprime la zone de texte active dans une
boîte de dialogue ou un panneau flottant.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.canDeleteSelection() », page 419.
dreamweaver.editFontList()
Disponibilité
Dreamweaver 3.
Description
Ouvre la boîte de dialogue Modifier la liste des polices.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dreamweaver.getFontList()
Disponibilité
Dreamweaver 3.
Description
Obtient la liste de tous les groupes de polices apparaissant dans l'inspecteur Propriétés de texte et la boîte de dialogue
Définition du style.
Arguments
Aucun.
Valeurs renvoyées
Tableau de chaînes dont chaque chaîne représente un élément de la liste des polices.
ADOBE DREAMWEAVER 9.0 386
Guide des API
Exemple
Si vous avez effectué une installation par défaut de Dreamweaver, un appel à la fonction dreamweaver.getFontList()
renvoie un tableau contenant les éléments suivants :
•
"Arial, Helvetica, sans-serif"
•
"Times New Roman, Times, serif"
•
"Courier New, Courier, mono"
•
"Georgia, Times New Roman, Times, serif"
•
"Verdana, Arial, Helvetica, sans-serif"
dreamweaver.getFontStyles()
Disponibilité
Dreamweaver 4.
Description
Renvoie les styles pris en charge par la police TrueType spécifiée.
Arguments
fontName
• L'argument fontName est une chaîne contenant le nom de la police.
Valeurs renvoyées
Tableau de trois valeurs booléennes qui indique les styles pris en charge par la police. La première valeur indique si la police
prend en charge le style Gras, la deuxième le style Italique et la troisième les styles Gras et Italique.
dreamweaver.getKeyState()
Disponibilité
Dreamweaver 3.
Description
Détermine si la touche de modification spécifiée est enfoncée.
Arguments
key
• L'argument key doit correspondre à l'une des valeurs suivantes : "Cmd", "Ctrl", "Alt" ou "Shift". Sous Windows, "Cmd"
et "Ctrl" désignent la touche Contrôle ; sur Macintosh, "Alt" désigne la touche Option.
Valeurs renvoyées
Valeur booléenne qui indique si la touche est enfoncée.
Exemple
Le code suivant vérifie si les touches Maj et Ctrl (Windows) ou Maj et Commande (Macintosh) sont enfoncées avant
d'effectuer une opération.
if (dw.getKeyState("Shift") && dw.getKeyState("Cmd")){
// exécuter le code
}
ADOBE DREAMWEAVER 9.0 387
Guide des API
dreamweaver.getNaturalSize()
Disponibilité
Dreamweaver 4.
Description
Renvoie la largeur et la hauteur d'un objet graphique.
Arguments
url
• L'argument url pointe vers un objet graphique dont les dimensions sont requises. Dreamweaver doit prendre en charge
cet objet (GIF, JPEG, PNG, Flash ou Shockwave). L'URL fournie comme argument de la fonction getNaturalSize() doit
correspondre à une URL absolue pointant vers un fichier local ; il ne peut pas s'agir d'une URL relative.
Valeurs renvoyées
Tableau contenant deux nombres entiers, le premier définissant la largeur de l'objet et le second sa hauteur.
dreamweaver.getSystemFontList()
Disponibilité
Dreamweaver 4.
Description
Renvoie une liste de polices à utiliser pour le système. Cette fonction peut appeler toutes les polices ou uniquement les
polices TrueType. Ces polices sont requises pour l'objet Texte Flash.
Arguments
fontTypes
• L'argument fontTypes est une chaîne qui contient soit "all", soit "TrueType".
Valeurs renvoyées
Tableau de chaînes qui contient le nom de toutes les polices ; renvoie la valeur null si aucune police n'est trouvée.
Fonction relative à l'impression
Cette fonction permet à l'utilisateur d'imprimer le code depuis le mode Code.
dreamweaver.printCode()
Disponibilité
Dreamweaver MX.
Description
Sous Windows, cette fonction imprime toutes les portions de code ou seulement une sélection de code depuis le mode
Code. Sur Macintosh, elle imprime toutes les portions de code ou seulement une plage de pages de code.
ADOBE DREAMWEAVER 9.0 388
Guide des API
Arguments
showPrintDialog, document
• L'argument showPrintDialog est true ou false. Sous Windows, si cet argument a pour valeur true, la fonction dreamweaver.PrintCode() affiche la boîte de dialogue d'impression pour demander à l'utilisateur s'il souhaite imprimer tout
le texte ou seulement une sélection de texte. Sur Macintosh, la fonction dreamweaver.PrintCode() affiche la boîte de
dialogue d'impression pour demander à l'utilisateur s'il souhaite imprimer tout le texte ou seulement une plage de pages.
Si l'argument a pour valeur false, dreamweaver.PrintCode() utilise la sélection précédente de l'utilisateur. La valeur par
défaut est true.
• L'argument document est le DOM du document à imprimer. Pour plus d'informations sur la façon d'obtenir le DOM d'un
document, consultez la section « dreamweaver.getDocumentDOM() », page 223.
Valeurs renvoyées
Valeur booléenne : true si le code peut s'imprimer ; false dans les autres cas.
Exemple
L'exemple suivant appelle dw.PrintCode() pour lancer la boîte de dialogue d'impression pour le document utilisateur. Si la
fonction renvoie la valeur false, le code affiche un message d'alerte informant l'utilisateur qu'il n'est pas possible d'exécuter
la demande d'impression.
var theDOM = dreamweaver.getDocumentDOM("document");
if(!dreamweaver.PrintCode(true, theDOM))
{
alert(“Impossible d'exécuter votre demande d'impression !”);
}
Fonctions relatives à Quick Tag Editor
Ces fonctions permettent de se déplacer d'une balise à l'autre à l'intérieur et autour de la sélection en cours. Elles permettent
de supprimer n'importe laquelle de ces balises, d'envelopper la sélection à l'intérieur d'une nouvelle balise et d'afficher
Quick Tag Editor pour permettre à l'utilisateur de modifier certains attributs d'une balise.
dom.selectChild()
Disponibilité
Dreamweaver 3.
Description
Sélectionne un enfant de la sélection en cours. Revient à sélectionner la balise située immédiatement à droite dans le
sélecteur de balises, en bas de la fenêtre de document.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 389
Guide des API
dom.selectParent()
Disponibilité
Dreamweaver 3.
Description
Sélectionne le parent de la sélection en cours. Revient à sélectionner la balise située immédiatement à gauche dans le
sélecteur de balises, en bas de la fenêtre de document.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dom.stripTag()
Disponibilité
Dreamweaver 3.
Description
Supprime les balises qui entourent la sélection actuelle, laissant intact leur contenu. Si la sélection contient plusieurs balises
ou n'en contient aucune, Dreamweaver affiche un message d'erreur.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dom.wrapTag()
Disponibilité
Dreamweaver 3.
Description
Place la balise spécifiée autour de la sélection en cours. Si la balise n'est pas complète, Dreamweaver affiche un message
d'erreur.
Arguments
startTag
• L'argument startTag est la source associée à la balise d'ouverture.
Valeurs renvoyées
Aucune.
Exemple
Le code suivant place un lien autour de la sélection en cours.
var theDOM = dw.getDocumentDOM();
var theSel = theDOM.getSelectedNode();
if (theSel.nodeType == Node.TEXT_NODE){
theDOM.wrapTag('<a href="foo.html">');
}
ADOBE DREAMWEAVER 9.0 390
Guide des API
dreamweaver.showQuickTagEditor()
Disponibilité
Dreamweaver 3.
Description
Affiche Quick Tag Editor pour la sélection en cours.
Arguments
{nearWhat}, {mode}
• L'argument facultatif nearWhat doit, s'il est spécifié, être "selection" ou "tag
selector". Si
cet argument n'est pas
défini, il prend par défaut la valeur "selection".
• L'argument facultatif mode doit, s'il est spécifié, être "default", "wrap", "insert" ou "edit". Si l'argument mode a pour
valeur "default" ou qu'il n'est pas défini, Dreamweaver utilise la méthode heuristique afin de déterminer le mode à
utiliser pour la sélection en cours. Si l'argument nearWhat a pour valeur "tag selector", l'argument mode est ignoré.
Valeurs renvoyées
Aucune.
Fonctions relatives au mode Code
Ces fonctions incluent les opérations associées à la modification du code source d'un document (et tous les changements
ayant une incidence sur le mode Création). Les fonctions de cette section vous permettent d'ajouter des commandes de
navigation aux modes Code au sein d'une fenêtre de document affichée dans deux volets ou dans la fenêtre de l'inspecteur
de code.
dom.formatRange()
Disponibilité
Dreamweaver MX.
Description
Applique le formatage de syntaxe automatique de Dreamweaver à une plage définie de caractères en mode Code, et ce
conformément aux paramètres de la boîte de dialogue Préférences > Format de code.
Arguments
startOffset, endOffset
• L'argument startOffset est un nombre entier qui représente le début de la plage définie, et ce sous la forme d'un
décalage par rapport au début du document.
• L'argument endOffset est un nombre entier qui représente la fin de la plage définie, et ce sous la forme d'un décalage par
rapport au début du document.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 391
Guide des API
dom.formatSelection()
Disponibilité
Dreamweaver MX.
Description
Applique le formatage de syntaxe automatique de Dreamweaver au contenu sélectionné (ce qui revient à utiliser l'option
Commandes > Appliquer le format source à la sélection), conformément aux paramètres de la boîte de dialogue Préférences
> Format de code.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dom.getShowNoscript()
Disponibilité
Dreamweaver MX.
Description
Obtient l'état actuel de l'option de contenu noscript (depuis l'option de menu Affichage > Contenu Noscript). Activée par
défaut, la balise noscript identifie un script de page pouvant, au choix, être affiché ou non dans le navigateur.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le contenu de la balise noscript est actuellement affiché ; false dans le cas contraire.
dom.getAutoValidationCount()
Disponibilité
Dreamweaver MX 2004.
Description
Obtient le nombre d'erreurs, d'avertissements et de messages d'information pour la dernière auto-validation (ou validation
en ligne) du document. Actuellement seule une vérification du navigateur cible est effectuée durant l'auto-validation
(consultez la section « dom.runValidation() », page 232).
Remarque : Cette fonction renvoie uniquement les résultats actuellement affichés dans la fenêtre de résultats du document.
Pour vous assurer que les comptes sont à jour, vous pouvez appeler dom.runValidation() avant d'appeler cette fonction.
Arguments
Aucun.
Valeurs renvoyées
Un objet avec les propriétés suivantes :
• la propriété numError, qui est le nombre d'erreurs ;
• la propriété numWarning, qui est le nombre d'avertissements ;
• la propriété numInfo, qui est le nombre de messages d'information.
ADOBE DREAMWEAVER 9.0 392
Guide des API
Exemple
theDom = dw.getDocumentDOM();
theDom.runValidation();
theDom.getAutoValidationCount();
dom.isDesignViewUpdated()
Disponibilité
Dreamweaver 4.
Description
Détermine si le contenu des modes Création et Texte est synchronisé pour les opérations Dreamweaver qui requièrent un
état de document correct.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le mode Création (WYSIWIG) est synchronisé avec le texte du mode Texte et false dans le cas
contraire.
dom.isSelectionValid()
Disponibilité
Dreamweaver 4.
Description
Détermine si une sélection est valide, ce qui signifie qu'elle est synchronisée avec le mode Création, ou s'il faut la déplacer
avant qu'une opération n'ait lieu.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si la sélection en cours contient un segment de code correct ; false si le document n'a pas encore
été synchronisé, étant donné que la sélection n'a pas été mise à jour.
dom.setShowNoscript()
Disponibilité
Dreamweaver MX.
Description
Active ou désactive l'option de contenu noscript (ce qui revient à utiliser l'option Affichage > Contenu Noscript). Activée
par défaut, la balise noscript identifie un script de page pouvant, au choix, être affiché ou non dans le navigateur.
Arguments
{bShowNoscript}
• L'argument facultatif bShowNoscript est une valeur booléenne qui indique si le contenu de la balise noscript doit être
affiché ; true si le contenu de la balise noscript doit être affiché ; false dans le cas contraire.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 393
Guide des API
dom.source.arrowDown()
Disponibilité
Dreamweaver 4.
Description
Déplace le point d'insertion vers le bas du document affiché en mode Code, ligne par ligne. Si le contenu est déjà sélectionné, cette fonction étend la sélection ligne par ligne.
Arguments
{nTimes}, {bShiftIsDown}
• L'argument facultatif nTimes est le nombre de lignes que le point d'insertion doit sauter. Si nTimes n'est pas défini, il prend
par défaut la valeur 1.
• L'argument facultatif bShiftIsDown est une valeur booléenne qui indique si un contenu est sélectionné. Si bShiftIsDown
a la valeur true, le contenu est sélectionné.
Valeurs renvoyées
Aucune.
dom.source.arrowLeft()
Disponibilité
Dreamweaver 4.
Description
Déplace le point d'insertion vers la gauche de la ligne courante dans le mode Code. Si le contenu est déjà sélectionné, cette
fonction étend la sélection vers la gauche.
Arguments
{nTimes}, {bShiftIsDown}
• L'argument facultatif nTimes est le nombre de caractères que le point d'insertion doit sauter. Si nTimes n'est pas défini,
il prend par défaut la valeur 1.
• L'argument facultatif bShiftIsDown est une valeur booléenne qui indique si un contenu est sélectionné. Si bShiftIsDown
a la valeur true, le contenu est sélectionné.
Valeurs renvoyées
Aucune.
dom.source.arrowRight()
Disponibilité
Dreamweaver 4.
Description
Déplace le point d'insertion vers la droite de la ligne courante dans le mode Code. Si le contenu est déjà sélectionné, cette
fonction étend la sélection vers la droite.
Arguments
{nTimes}, {bShiftIsDown}
• L'argument facultatif nTimes est le nombre de caractères que le point d'insertion doit sauter. Si nTimes n'est pas défini,
il prend par défaut la valeur 1.
• L'argument facultatif bShiftIsDown est une valeur booléenne qui indique si un contenu est sélectionné. Si bShiftIsDown
a la valeur true, le contenu est sélectionné ; dans le cas contraire, il ne l'est pas.
ADOBE DREAMWEAVER 9.0 394
Guide des API
Valeurs renvoyées
Aucune.
dom.source.arrowUp()
Disponibilité
Dreamweaver 4.
Description
Déplace le point d'insertion vers le haut du document affiché en mode Code, ligne par ligne. Si le contenu est déjà sélectionné, cette fonction étend la sélection ligne par ligne.
Arguments
{nTimes}, {bShiftIsDown}
• L'argument nTimes est le nombre de lignes que le point d'insertion doit déplacer. Si nTimes n'est pas défini, il prend par
défaut la valeur 1.
• L'argument bShiftIsDown est une valeur booléenne qui indique si un contenu est sélectionné. Si bShiftIsDown a la
valeur true, le contenu est sélectionné.
Valeurs renvoyées
Aucune.
dom.source.balanceBracesTextview()
Disponibilité
Dreamweaver 4.
Description
Cette fonction est une extension du mode Code qui permet d'équilibrer les parenthèses. Vous pouvez appeler la fonction
dom.source.balanceBracesTextView() pour étendre la sélection mise en surbrillance ou le point d'insertion depuis le
début de l'instruction entre parenthèses jusqu'à la fin de l'instruction afin d'équilibrer les caractères suivants : [], {} et ().
Tout nouvel appel étend la sélection à des niveaux supplémentaires de ponctuation imbriquée.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dom.source.endOfDocument()
Disponibilité
Dreamweaver 4.
Description
Place le point d'insertion à la fin du document actif affiché en mode Code. Si le contenu est déjà sélectionné, cette fonction
étend la sélection à la fin du document.
Arguments
bShiftIsDown
• L'argument bShiftIsDown est une valeur booléenne qui indique si un contenu est sélectionné. Si bShiftIsDown a la
valeur true, le contenu est sélectionné.
ADOBE DREAMWEAVER 9.0 395
Guide des API
Valeurs renvoyées
Aucune.
dom.source.endOfLine()
Disponibilité
Dreamweaver 4.
Description
Place le point d'insertion à la fin de la ligne courante. Si le contenu est déjà sélectionné, cette fonction étend la sélection
jusqu'à la fin de la ligne courante.
Arguments
bShiftIsDown
• L'argument bShiftIsDown est une valeur booléenne qui indique si un contenu est sélectionné. Si bShiftIsDown a la
valeur true, le contenu est sélectionné.
Valeurs renvoyées
Aucune.
dom.source.endPage()
Disponibilité
Dreamweaver 4.
Description
Déplace le point d'insertion à la fin de la page en cours ou à la fin de la page suivante (si le point d'insertion est déjà à la fin
d'une page). Si le contenu est déjà sélectionné, cette fonction étend la sélection page par page.
Arguments
{nTimes}, {bShiftIsDown}
• L'argument facultatif nTimes est le nombre de pages que le point d'insertion doit sauter. Si nTimes n'est pas défini, il prend
par défaut la valeur 1.
• L'argument facultatif bShiftIsDown est une valeur booléenne qui indique si un contenu est sélectionné. Si bShiftIsDown
a la valeur true, le contenu est sélectionné.
Valeurs renvoyées
Aucune.
dom.source.getCurrentLines()
Disponibilité
Dreamweaver 4.
Description
Renvoie les numéros de ligne des décalages spécifiés à partir du début du document.
Arguments
Aucun.
Valeurs renvoyées
Numéros de ligne de la sélection en cours.
ADOBE DREAMWEAVER 9.0 396
Guide des API
dom.source.getSelection()
Description
Obtient la sélection du document actif, exprimée en décalages de caractères dans le mode Code du document.
Arguments
Aucun.
Valeurs renvoyées
Paire de nombres entiers représentant les décalages à partir du début du document source. Le premier nombre entier
correspond au début de la sélection et le second à la fin. Si les deux nombres sont égaux, la sélection est un point d'insertion.
Si aucun élément n'est sélectionné dans la source, les deux nombres sont -1.
dom.source.getLineFromOffset()
Disponibilité
Dreamweaver MX.
Description
Place un décalage dans le document source.
Arguments
Aucun.
Valeurs renvoyées
Numéro de la ligne, ou -1 si le décalage est négatif ou se trouve après la fin du fichier.
dom.source.getText()
Disponibilité
Dreamweaver 4.
Description
Renvoie la chaîne de texte de la source comprise entre les décalages définis.
Arguments
startOffset, endOffset
• L'argument startOffset est un nombre entier qui représente le décalage à partir du début du document.
• L'argument endOffset est un nombre entier qui représente la fin du document.
Valeurs renvoyées
Chaîne qui représente le texte du code source compris entre les décalages start et end.
dom.source.getValidationErrorsForOffset()
Disponibilité
Dreamweaver MX 2004.
Description
Renvoie la liste des erreurs de validation au point de décalage spécifié ou recherche l'erreur suivante après le décalage. Si
aucune n'est trouvée dans la fonction, la valeur null est renvoyée.
ADOBE DREAMWEAVER 9.0 397
Guide des API
Arguments
offset, {searchDirection}
• L'argument offset est un nombre qui spécifie le décalage dans le code pour lequel la fonction renvoie des erreurs.
• L'argument facultatif searchDirection est une chaîne qui spécifie "empty", "forward" ou "back". Si spécifié, la fonction
recherche vers la fin ou le début du document, en partant du décalage défini, les caractères comportant des erreurs et les
renvoie. Si cela n'est pas spécifié, la fonction vérifie la présence d'erreur au point de décalage défini.
Valeurs renvoyées
Tableau d'objets ou valeur null. Chaque objet du tableau comporte les propriétés suivantes :
• L'objet message est une chaîne qui contient le message d'erreur.
• L'objet floaterName est une chaîne qui contient le nom de la fenêtre de résultats. Vous pouvez transmettre cette valeur
aux fonctions showResults() ou setFloaterVisibility().
• L'objet floaterIndex est un index d'éléments dans la liste de résultats de palette.
• L'objet start est l'index d'ouverture du code souligné.
• L'objet end est l'index de fermeture du code souligné.
Remarque : Les index de palette renvoyés ne doivent pas être conservés car ils varient fréquemment, par exemple, lors de
l'ouverture ou de la fermeture de documents.
Exemple
L'exemple suivant appelle getValidationErrorsForOffset() pour vérifier qu'il n'y a pas d'erreur au décalage de la
sélection actuelle. Si la fonction renvoie une erreur, le code appelle la fonction alert() pour afficher le message d'erreur à
l'utilisateur.
var offset = dw.getDocumentDOM().source.getSelection()[0];
var errors = dw.getDocumentDOM().source.getValidationErrorsForOffset(offset);
if ( errors && errors.length > 0 )
alert( errors[0].message );
dom.source.indentTextview()
Disponibilité
Dreamweaver 4.
Description
Déplace le texte sélectionné en mode Code d'une marque de tabulation vers la droite.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dom.source.insert()
Disponibilité
Dreamweaver 4.
Description
Insère la chaîne spécifiée dans le code source au niveau du point de décalage défini à partir du début du fichier source. Si le
décalage n'est pas supérieur ou égal à zéro, l'insertion échoue et la fonction renvoie la valeur false.
ADOBE DREAMWEAVER 9.0 398
Guide des API
Arguments
offset, string
• L'argument offset est le décalage à partir du début du fichier où la chaîne doit être insérée.
• L'argument string est la chaîne à insérer.
Valeurs renvoyées
Valeur booléenne : true en cas de succès et false dans le cas contraire.
dom.source.nextWord()
Disponibilité
Dreamweaver 4.
Description
Déplace le point d'insertion au début du mot suivant (ou des mots suivants, si spécifié) en mode Code. Si le contenu est déjà
sélectionné, cette fonction étend la sélection vers la droite.
Arguments
{nTimes}, {bShiftIsDown}
• L'argument facultatif nTimes est le nombre de mots que le point d'insertion doit déplacer. Si nTimes n'est pas défini, il
prend par défaut la valeur 1.
• L'argument facultatif bShiftIsDown est une valeur booléenne qui indique si un contenu est sélectionné. Si bShiftIsDown
a la valeur true, le contenu est sélectionné.
Valeurs renvoyées
Aucune.
dom.source.outdentTextview()
Disponibilité
Dreamweaver 4.
Description
Déplace le texte sélectionné en mode Code d'une marque de tabulation vers la gauche.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dom.source.pageDown()
Disponibilité
Dreamweaver 4.
Description
Déplace le point d'insertion vers le bas du document affiché en mode Code, page par page. Si le contenu est déjà sélectionné,
cette fonction étend la sélection page par page.
ADOBE DREAMWEAVER 9.0 399
Guide des API
Arguments
{nTimes}, {bShiftIsDown}
• L'argument facultatif nTimes est le nombre de pages que le point d'insertion doit sauter. Si nTimes n'est pas défini, il prend
par défaut la valeur 1.
• L'argument facultatif bShiftIsDown est une valeur booléenne qui indique si un contenu est sélectionné. Si bShiftIsDown
a la valeur true, le contenu est sélectionné.
Valeurs renvoyées
Aucune.
dom.source.pageUp()
Disponibilité
Dreamweaver 4.
Description
Déplace le point d'insertion vers le haut du document affiché en mode Code, page par page. Si le contenu est déjà sélectionné, cette fonction étend la sélection page par page.
Arguments
{nTimes}, {bShiftIsDown}
• L'argument facultatif nTimes est le nombre de pages que le point d'insertion doit sauter. Si nTimes n'est pas défini, il prend
par défaut la valeur 1.
• L'argument facultatif bShiftIsDown est une valeur booléenne qui indique si un contenu est sélectionné. Si bShiftIsDown
a la valeur true, le contenu est sélectionné.
Valeurs renvoyées
Aucune.
dom.source.previousWord()
Disponibilité
Dreamweaver 4.
Description
Déplace le point d'insertion au début du mot précédent (ou des mots précédents, si spécifié) en mode Code. Si le contenu
est déjà sélectionné, cette fonction étend la sélection vers la gauche.
Arguments
{nTimes}, {bShiftIsDown}
• L'argument facultatif nTimes est le nombre de mots que le point d'insertion doit déplacer. Si nTimes n'est pas défini, il
prend par défaut la valeur 1.
• L'argument facultatif bShiftIsDown est une valeur booléenne qui indique si un contenu est sélectionné. Si bShiftIsDown
a la valeur true, le contenu est sélectionné.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 400
Guide des API
dom.source.replaceRange()
Disponibilité
Dreamweaver 4.
Description
Remplace la plage de texte source comprise entre startOffset et endOffset par string. Si startOffset est supérieur à
endOffset ou si l'un des décalages n'est pas un nombre entier positif, cette fonction n'a aucun effet et renvoie la valeur
false. Si endOffset est supérieur au nombre de caractères du fichier, cette fonction remplace la plage comprise entre
startOffset et la fin du fichier. Si startOffset et endOffset sont supérieurs au nombre de caractères du fichier, cette
fonction insère le texte à la fin du fichier.
Arguments
startOffset, endOffset, string
• L'argument startOffset est le décalage indiquant le début du bloc à remplacer.
• L'argument endOffset est le décalage indiquant la fin du bloc à remplacer.
• L'argument string est la chaîne à insérer.
Valeurs renvoyées
Valeur booléenne : true en cas de succès et false dans le cas contraire.
dom.source.scrollEndFile()
Disponibilité
Dreamweaver 4.
Description
Fait défiler le mode Code vers le bas du document sans déplacer le point d'insertion.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dom.source.scrollLineDown()
Disponibilité
Dreamweaver 4.
Description
Fait défiler le mode Code vers le bas ligne par ligne sans déplacer le point d'insertion.
Arguments
nTimes
• L'argument nTimes est le nombre de lignes à faire défiler. Si nTimes n'est pas défini, il prend par défaut la valeur 1.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 401
Guide des API
dom.source.scrollLineUp()
Disponibilité
Dreamweaver 4.
Description
Fait défiler le mode Code vers le haut ligne par ligne sans déplacer le point d'insertion.
Arguments
nTimes
• L'argument nTimes est le nombre de lignes à faire défiler. Si nTimes n'est pas défini, il prend par défaut la valeur 1.
Valeurs renvoyées
Aucune.
dom.source.scrollPageDown()
Disponibilité
Dreamweaver 4.
Description
Fait défiler le mode Code vers le bas page par page sans déplacer le point d'insertion.
Arguments
nTimes
• L'argument nTimes est le nombre de pages à faire défiler. Si nTimes n'est pas défini, il prend par défaut la valeur 1.
Valeurs renvoyées
Aucune.
dom.source.scrollPageUp()
Disponibilité
Dreamweaver 4.
Description
Fait défiler le mode Code vers le haut page par page sans déplacer le point d'insertion.
Arguments
nTimes
• L'argument nTimes est le nombre de pages à faire défiler. Si nTimes n'est pas défini, il prend par défaut la valeur 1.
Valeurs renvoyées
Aucune.
dom.source.scrollTopFile()
Disponibilité
Dreamweaver 4.
Description
Fait défiler le mode Code vers le haut du document sans déplacer le point d'insertion.
ADOBE DREAMWEAVER 9.0 402
Guide des API
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dom.source.selectParentTag()
Disponibilité
Dreamweaver 4.
Description
Cette fonction est une extension du mode Code qui permet d'équilibrer les balises. Vous pouvez appeler
dom.source.selectParentTag() pour étendre la sélection ou le point d'insertion courant de la balise d'ouverture à la balise
de fermeture. Les appels suivants étendent la sélection à des balises supplémentaires jusqu'à ce qu'il n'y ait plus de balises
de fermeture.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dom.source.setCurrentLine()
Disponibilité
Dreamweaver 4.
Description
Place le point d'insertion au début de la ligne indiquée. Si l'argument lineNumber n'est pas un nombre entier positif, la
fonction n'a aucun effet et renvoie la valeur false. Le point d'insertion est placé au début de la dernière ligne si lineNumber
est supérieur au nombre de lignes de la source.
Arguments
lineNumber
• L'argument lineNumber est la ligne au début de laquelle le point d'insertion est placé.
Valeurs renvoyées
Valeur booléenne : true en cas de succès et false dans le cas contraire.
dom.source.startOfDocument()
Disponibilité
Dreamweaver 4.
Description
Place le point d'insertion au début du document affiché en mode Code. Si le contenu est déjà sélectionné, cette fonction
étend la sélection au début du document.
ADOBE DREAMWEAVER 9.0 403
Guide des API
Arguments
bShiftIsDown
• L'argument bShiftIsDown est une valeur booléenne qui indique si un contenu est sélectionné. Si bShiftIsDown a la
valeur true, le contenu est sélectionné.
Valeurs renvoyées
Aucune.
dom.source.startOfLine()
Disponibilité
Dreamweaver 4.
Description
Place le point d'insertion au début de la ligne courante. Si le contenu est déjà sélectionné, cette fonction étend la sélection
au début de la ligne courante.
Arguments
bShiftIsDown
• L'argument bShiftIsDown est une valeur booléenne qui indique si un contenu est sélectionné. Si bShiftIsDown a la
valeur true, le contenu est sélectionné.
Valeurs renvoyées
Aucune.
dom.source.topPage()
Disponibilité
Dreamweaver 4.
Description
Déplace le point d'insertion en haut de la page courante ou de la page précédente (si le point d'insertion est déjà en haut
d'une page). Si le contenu est déjà sélectionné, cette fonction étend la sélection page par page.
Arguments
{nTimes}, {bShiftIsDown}
• L'argument facultatif nTimes est le nombre de pages que le point d'insertion doit sauter. Si nTimes n'est pas défini, il prend
par défaut la valeur 1.
• L'argument facultatif bShiftIsDown est une valeur booléenne qui indique si un contenu est sélectionné. Si bShiftIsDown
a la valeur true, le contenu est sélectionné.
Valeurs renvoyées
Aucune.
ADOBE DREAMWEAVER 9.0 404
Guide des API
dom.source.wrapSelection()
Disponibilité
Dreamweaver 4.
Description
Insère le texte de startTag avant la sélection en cours et le texte de endTag après la sélection en cours. La fonction sélectionne ensuite la plage entière entre les balises insérées, en incluant ces balises. Si la sélection en cours est un point
d'insertion, la fonction place le point d'insertion entre startTag et endTag (startTag et endTag ne doivent pas nécessairement être des balises ; il peut s'agir de tout segment de texte de votre choix).
Arguments
startTag, endTag
• L'argument startTag est le texte à insérer au début de la sélection.
• L'argument endTag est le texte à insérer à la fin de la sélection.
Valeurs renvoyées
Aucune.
dom.synchronizeDocument()
Disponibilité
Dreamweaver 4.
Description
Synchronise les modes Code et Création.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Fonctions de l'éditeur de balises et de la bibliothèque de
balises
Vous pouvez utiliser les éditeurs de balises pour insérer de nouvelles balises, pour modifier des balises existantes ou pour
accéder à des informations de référence sur les balises. Le sélecteur de balises permet aux utilisateurs d'organiser leurs
balises afin qu'ils puissent sélectionner les balises les plus fréquemment utilisées. Les bibliothèques de balises fournies avec
Dreamweaver stockent des informations concernant les balises utilisées dans les langages de balisage standard et dans les
langages de script et de balise fréquemment utilisés. Vous pouvez utiliser les fonctions de l'éditeur de balises JavaScript, du
sélecteur de balises, de la bibliothèque de balises lorsque vous devez utiliser les éditeurs de balises et bibliothèques de balises
dans vos extensions.
dom.getTagSelectorTag()
Disponibilité
Dreamweaver MX.
Description
Cette fonction obtient le noeud DOM de la balise sélectionnée dans la barre du sélecteur de balises se trouvant au bas de la
fenêtre de document.
ADOBE DREAMWEAVER 9.0 405
Guide des API
Arguments
Aucun.
Valeurs renvoyées
Noeud DOM de la balise sélectionnée ; null si aucune balise n'est sélectionnée.
dreamweaver.popupInsertTagDialog()
Disponibilité
Dreamweaver MX.
Description
Cette fonction vérifie les fichiers VTM pour s'assurer qu'un éditeur de balises a été utilisé pour la balise. Si c'est le cas,
l'éditeur de cette balise apparaît et accepte la balise de début. Si ce n'est pas le cas, la balise de début est insérée telle quelle
dans le document de l'utilisateur.
Arguments
start_tag_string
Chaîne de balise de début qui comprend un des types suivants de valeurs initiales :
• une balise, comme <input> ;
• une balise avec des attributs, comme <input
• une directive, comme <%=
type='text'> ;
%>.
Valeurs renvoyées
Valeur booléenne : true si un élément est inséré dans le document et false dans le cas contraire.
dreamweaver.popupEditTagDialog()
Disponibilité
Dreamweaver MX.
Description
Si une balise est sélectionnée, cette fonction ouvre l'éditeur de balises correspondant à cette balise pour vous permettre de
modifier la balise.
Arguments
Aucun.
Valeurs renvoyées
Aucune.
Activateur
Consultez « dreamweaver.canPopupEditTagDialog() », page 422.
dreamweaver.showTagChooser()
Disponibilité
Dreamweaver MX.
Description
Cette fonction affiche la boîte de dialogue Sélecteur de balises, la fait apparaître au premier plan et la rend active.
ADOBE DREAMWEAVER 9.0 406
Guide des API
Arguments
Aucun.
Valeurs renvoyées
Aucune.
dreamweaver.showTagLibraryEditor()
Disponibilité
Dreamweaver MX.
Description
Cette fonction ouvre l'éditeur de la bibliothèque de balises.
Arguments
Aucun.
Valeurs renvoyées
Aucun.
dreamweaver.tagLibrary.getTagLibraryDOM()
Disponibilité
Dreamweaver MX.
Description
Associée à l'URL d'un fichier filename.vtm, cette fonction renvoie le DOM de ce fichier afin que son contenu soit modifié.
Cette fonction ne doit être appelée que lorsque l'éditeur de la bibliothèque de balises est actif.
Arguments
fileURL
• L'argument fileURL est l'URL d'un fichier filename.vtm, relatif au dossier Configuration/Tag Libraries, comme indiqué
dans l'exemple suivant :
"HTML/img.vtm"
Valeurs renvoyées
Un pointeur DOM désignant un fichier nouveau ou plus ancien du dossier TagLibraries.
dreamweaver.tagLibrary.getSelectedLibrary()
Disponibilité
Dreamweaver MX.
Description
Si un noeud de bibliothèque est sélectionné dans l'éditeur de la bibliothèque de balises, cette fonction obtient le nom de la
bibliothèque.
Arguments
Aucun.
Valeurs renvoyées
Chaîne correspondant au nom de la bibliothèque sélectionnée dans l'éditeur de la bibliothèque de balises ; renvoie une
chaîne vide si aucune bibliothèque n'est sélectionnée.
ADOBE DREAMWEAVER 9.0 407
Guide des API
dreamweaver.tagLibrary.getSelectedTag()
Disponibilité
Dreamweaver MX.
Description
Si un noeud d'attribut est sélectionné, cette fonction obtient le nom de la balise qui contient l'attribut.
Arguments
Aucun.
Valeurs renvoyées
Chaîne correspondant au nom de la balise sélectionnée dans l'éditeur de la bibliothèque de balises ; renvoie une chaîne vide
si aucune balise n'est sélectionnée.
dreamweaver.tagLibrary.importDTDOrSchema()
Disponibilité
Dreamweaver MX.
Description
Cette fonction importe un fichier DTD/Schéma à partir d'un serveur distant dans la bibliothèque de balises.
Arguments
fileURL, Préfixe
• L'argument fileURL est le chemin du fichier DTD ou schéma, au format URL local.
• L'argument Prefix est la chaîne de préfixe qui doit être ajoutée à toutes les balises de cette bibliothèque.
Valeurs renvoyées
Nom de la bibliothèque de balises importées.
dreamweaver.tagLibrary.getImportedTagList()
Disponibilité
Dreamweaver MX.
Description
Cette fonction génère une liste d'objets TagInfo à partir d'une bibliothèque de balises importées.
Arguments
libname
• L'argument libname est le nom de la bibliothèque de balises importées.
Valeurs renvoyées
Tableau d'objets tagInfo.
Un objet taginfo contient des informations concernant une balise de la bibliothèque de balises. Les propriétés suivantes
sont définies dans un objet tagInfo :
• la propriété tagName, qui est une chaîne ;
• la propriété attributes, qui est un tableau de chaînes. Chaque chaîne correspond au nom d'un attribut défini pour cette
balise.
ADOBE DREAMWEAVER 9.0 408
Guide des API
Exemple :
L'exemple suivant indique que l'utilisation de la fonction dw.tagLibrary.getImportedTagList() peut résulter en un
tableau de balises de la bibliothèque libName :
// "fileURL" et "prefix" ont été saisis par l'utilisateur.
// indiquant à la bibliothèque de balise d'importer le DTD/schema.
var libName = dw.tagLibrary.importDTDOrSchema(fileURL, prefix);
// obtenir le tableau de balises pour cette bibliothèque
// Il s'agit de l'objet TagInfo.
var tagArray = dw.tagLibrary.getImportedTagList(libName);
// maintenant nous obtenons un objet sous forme de tableau contenant les informations de balise.
// Nous pouvons en extraire les infos. Ceci extrait les infos du premier.
// remarque : Cela suppose qu'il y a au moins un élément dans le tableau.
var firstTagName = tagArray[0].name;
var firstTagAttributes = tagArray[0].attributes;
// Remarquez que firstTagAttributes est un tableau d'attributs.
409
Chapitre 19 : Activateurs
Les fonctions d'activateur de Adobe® Dreamweaver® CS3 déterminent si une autre fonction peut effectuer une opération
donnée dans le contexte actuel. Les circonstances générales dans lesquelles chaque fonction renvoie la valeur true sont
décrites dans la spécification de fonction correspondante. Toutefois, ces descriptions ne prétendent pas être exhaustives et
ne couvrent pas nécessairement tous les cas où la fonction renverrait la valeur false.
Fonctions d'activateur
Les fonctions d'activateur dans l'API JavaScript comprennent les fonctions suivantes.
dom.canAlign()
Disponibilité
Dreamweaver 3.
Description
Vérifie si Dreamweaver peut effectuer une opération Aligner à gauche, Aligner à droite, Aligner en
haut ou Aligner en bas.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne indiquant si deux calques ou zones réactives au minimum sont sélectionnés.
dom.canApplyTemplate()
Disponibilité
Dreamweaver 3.
Description
Vérifie si Dreamweaver peut effectuer une opération Appliquer à la page. Cette fonction n'est valide que pour le document
actif.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne indiquant si le document n'est pas un élément de bibliothèque ni un modèle, et si la sélection n'est pas
encadrée de balises NOFRAMES.
dom.canArrange()
Disponibilité
Dreamweaver 3.
Description
Vérifie si Dreamweaver peut effectuer une opération Mettre au premier plan ou Mettre en arrière-plan.
ADOBE DREAMWEAVER 9.0 410
Guide des API
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne indiquant si une zone réactive est sélectionnée.
dom.canClipCopyText()
Disponibilité
Dreamweaver 3.
Description
Vérifie si Dreamweaver peut effectuer une opération Copier comme texte.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si les décalages d'ouverture et de fermeture sont différents ; false dans le cas contraire, pour
indiquer qu'aucune sélection n'a été effectuée.
dom.canClipPaste()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Coller.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le Presse-papiers contient des données pouvant être collées dans Dreamweaver ; false dans le
cas contraire.
dom.canClipPasteText()
Disponibilité
Dreamweaver 3.
Description
Vérifie si Dreamweaver peut effectuer une opération Coller comme texte.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le Presse-papiers contient un élément pouvant être collé dans Dreamweaver comme texte ; false
dans le cas contraire.
ADOBE DREAMWEAVER 9.0 411
Guide des API
dom.canConvertLayersToTable()
Disponibilité
Dreamweaver 3.
Description
Vérifie si Dreamweaver peut effectuer une opération Convertir les calques en tableau.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le contenu complet de la section BODY du document est compris dans des calques ; false dans le
cas contraire.
dom.canConvertTablesToLayers()
Disponibilité
Dreamweaver 3.
Description
Vérifie si Dreamweaver peut effectuer une opération Convertir les tableaux en calques.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si tout le contenu de la section BODY du document figure dans des tableaux et si le document n'est
pas basé sur un modèle ; false dans le cas contraire.
dom.canDecreaseColspan()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Réduire l'étendue de colonnes.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si la cellule active possède un attribut COLSPAN et si la valeur de cet attribut est supérieure ou égale
à 2 ; false dans le cas contraire.
dom.canDecreaseRowspan()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Réduire l'étendue de lignes.
ADOBE DREAMWEAVER 9.0 412
Guide des API
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si la cellule active possède un attribut ROWSPAN et si la valeur de cet attribut est supérieure ou égale
à 2 ; false dans le cas contraire.
dom.canDeleteTableColumn()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Supprimer la colonne.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le point d'insertion se trouve dans une cellule ou si une cellule ou une colonne est sélectionnée ;
false dans le cas contraire.
dom.canDeleteTableRow()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Supprimer la ligne.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le point d'insertion se trouve dans une cellule ou si une cellule ou une ligne est sélectionnée ;
false dans le cas contraire.
site.canEditColumns()
Description
Vérifie si un site existe.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true s'il existe un site et false dans le cas contraire.
ADOBE DREAMWEAVER 9.0 413
Guide des API
dom.canEditNoFramesContent()
Disponibilité
Dreamweaver 3.
Description
Vérifie si Dreamweaver peut effectuer une opération Modifier le contenu sans cadres.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le document actif est un jeu de cadres ou s'il figure dans un jeu de cadres ; false dans le cas
contraire.
dom.canIncreaseColspan()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Augmenter l'étendue de colonnes.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true s'il existe des cellules à droite de la cellule active ; false dans le cas contraire.
dom.canIncreaseRowspan()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Augmenter l'étendue de lignes.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true s'il existe des cellules au-dessous de la cellule active ; false dans le cas contraire.
dom.canInsertTableColumns()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Insérer une colonne.
Arguments
Aucun.
ADOBE DREAMWEAVER 9.0 414
Guide des API
Valeurs renvoyées
Valeur booléenne : true si la sélection se trouve dans un tableau ; false si la sélection constitue un tableau entier ou si elle
ne se trouve pas dans un tableau.
dom.canInsertTableRows()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Insérer une ligne.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si la sélection se trouve dans un tableau ; false si la sélection constitue un tableau entier ou si elle
ne se trouve pas dans un tableau.
dom.canMakeNewEditableRegion()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Nouvelle région modifiable.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le document actif est un fichier de modèle (DWT).
dom.canMarkSelectionAsEditable()
Disponibilité
Dreamweaver 3.
Description
Vérifie si Dreamweaver peut effectuer une opération Marquer la sélection comme modifiable.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true s'il y a une sélection et si le document actif est un fichier DWT ; false dans le cas contraire.
ADOBE DREAMWEAVER 9.0 415
Guide des API
dom.canMergeTableCells()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Fusionner les cellules.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si la sélection est un regroupement adjacent de cellules de tableau ; false dans le cas contraire.
dom.canPlayPlugin()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Lire. Cette fonction n'est valide que pour le document actif.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si la sélection peut être exécutée avec un plug-in.
dom.canRedo()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Rétablir.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true s'il reste des opérations à rétablir ; false dans le cas contraire.
dom.canRemoveEditableRegion()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Rendre la région non modifiable.
Arguments
Aucun.
ADOBE DREAMWEAVER 9.0 416
Guide des API
Valeurs renvoyées
Valeur booléenne : true si le document actif est un modèle ; false dans le cas contraire.
dom.canSelectTable()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Sélectionner le tableau.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si la sélection ou le point d'insertion se trouve dans un tableau ; false dans le cas contraire.
dom.canSetLinkHref()
Disponibilité
Dreamweaver 3.
Description
Vérifie si Dreamweaver peut modifier le lien qui entoure la sélection en cours ou en créer un si nécessaire.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si la sélection est une image, du texte ou si le point d'insertion se trouve dans un lien ; false dans
les autres cas. Une sélection de texte se définit comme une sélection pour laquelle l'inspecteur Propriétés de texte s'ouvrirait.
dom.canShowListPropertiesDialog()
Disponibilité
Dreamweaver 3.
Description
Vérifie si Dreamweaver peut afficher la boîte de dialogue Propriétés de la liste.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si la sélection est encadrée de balises LI ; false dans le cas contraire.
dom.canSplitFrame()
Disponibilité
Dreamweaver 3.
Description
Vérifie si Dreamweaver peut effectuer une opération Fractionner le cadre [à gauche | à droite | vers le haut | vers le bas]
ADOBE DREAMWEAVER 9.0 417
Guide des API
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si la sélection se trouve dans un cadre ; false dans le cas contraire.
dom.canSplitTableCell()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Fractionner la cellule.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le point d'insertion se trouve dans une cellule de tableau ou si la sélection est une cellule de
tableau ; false dans les autres cas.
dom.canStopPlugin()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Arrêter.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si la sélection est exécutée actuellement avec un plug-in ; false dans les autres cas.
dom.canUndo()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Annuler.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true s'il reste des opérations à annuler ; false dans le cas contraire.
ADOBE DREAMWEAVER 9.0 418
Guide des API
dom.hasTracingImage()
Disponibilité
Dreamweaver 3.
Description
Détermine si le document possède un tracé d'image.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le document possède un tracé d'image ; false dans le cas contraire.
dreamweaver.assetPalette.canEdit()
Disponibilité
Dreamweaver 4.
Description
Active les options de menu du panneau Actifs pour permettre leur modification.
Arguments
Aucun.
Valeurs renvoyées
Renvoie une valeur booléenne : true si l'actif peut être modifié ; false dans le cas contraire. Renvoie la valeur false pour
les couleurs et les URL de la liste des sites et false pour une sélection de plusieurs couleurs et URL dans la liste des favoris.
dreamweaver.assetPalette.canInsertOrApply()
Disponibilité
Dreamweaver 4.
Description
Vérifie si les options sélectionnées peuvent être insérées ou appliquées. Renvoie les valeurs true ou false pour que
l'insertion ou l'application des options de menu puissent être activées ou désactivées.
Arguments
Aucun.
Valeurs renvoyées
Renvoie une valeur booléenne : true si les éléments sélectionnés peuvent être insérés ou appliqués ; false si la page active
est un modèle et que la catégorie en cours est Templates. La fonction renvoie également la valeur false si aucun document
n'est ouvert ou si un élément de bibliothèque est sélectionné dans le document et que la catégorie active est Bibliothèque.
dreamweaver.canClipCopy()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Copier.
ADOBE DREAMWEAVER 9.0 419
Guide des API
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si un contenu sélectionné peut être copié dans le Presse-papiers ; false dans le cas contraire.
dreamweaver.canClipCut()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Couper.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si un contenu sélectionné peut être coupé dans le Presse-papiers ; false dans le cas contraire.
dreamweaver.canClipPaste()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Coller.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le contenu du Presse-papiers, le cas échéant, peut être collé dans le document actif, dans la fenêtre
active du panneau Site ou, sur Macintosh, dans un champ de texte d'un panneau flottant ou d'une boîte de dialogue ; false
dans le cas contraire.
dreamweaver.canDeleteSelection()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut supprimer la sélection en cours. Celle-ci peut se trouver, selon le cas, dans la fenêtre de
document, dans le panneau Site ou, sur Macintosh, dans un champ de texte d'un panneau flottant ou d'une boîte de
dialogue.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si les décalages d'ouverture et de fermeture de la sélection sont différents, ce qui indique qu'une
sélection est effectuée ; false s'ils sont identiques et qu'il n'y a donc qu'un point d'insertion.
ADOBE DREAMWEAVER 9.0 420
Guide des API
dreamweaver.canExportCSS() (déconseillé)
Disponibilité
Dreamweaver 3.
Description
Vérifie si Dreamweaver peut effectuer une opération Exporter les styles CSS.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si un document contient des styles de classe définis dans la section HEAD ; false dans le cas
contraire.
dreamweaver.canExportTemplateDataAsXML()
Disponibilité
Dreamweaver MX.
Description
Vérifie si Dreamweaver peut exporter le document actif au format XML.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le document actif peut être exporté et false dans le cas contraire.
Exemple
Dans l'exemple suivant, dw.canExportTemplateDataAsXML() est appelé pour déterminer si Dreamweaver peut exporter le
document actif au format XML. S'il renvoie la valeur true, il appelle dw.ExportTemplateDataAsXML() pour l'exporter :
if(dreamweaver.canExportTemplateDataAsXML())
{
dreamweaver.exportTemplateDataAsXML("file:///c|/dw_temps/mytemplate.txt")
}
dreamweaver.canFindNext()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Rechercher le suivant.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si un modèle de recherche a été défini ; false dans le cas contraire.
ADOBE DREAMWEAVER 9.0 421
Guide des API
dreamweaver.canFitSelection()
Disponibilité
Dreamweaver 8.
Description
Vérifie si un élément est sélectionné dans un mode Création actif, ce qui signifie que fitSelection() peut être appelée.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si un élément est sélectionné dans un mode Création actif ; false dans le cas contraire.
dreamweaver.canOpenInFrame()
Disponibilité
Dreamweaver 3.
Description
Vérifie si Dreamweaver peut effectuer une opération Ouvrir dans un cadre.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si la sélection ou le point d'insertion se trouve dans un cadre ; false dans le cas contraire.
dreamweaver.canPasteSpecial()
Disponibilité
Dreamweaver 8.
Description
Vérifie si Dreamweaver peut effectuer une opération Collage spécial.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le Presse-papiers contient du texte, du code HTML ou du code HTML pour Dreamweaver et que
le mode Code, Création ou Inspecteur de code est actif ; false dans le cas contraire.
dreamweaver.canPlayRecordedCommand()
Disponibilité
Dreamweaver 3.
Description
Vérifie si Dreamweaver peut effectuer une opération Reproduire la commande enregistrée.
Arguments
Aucun.
ADOBE DREAMWEAVER 9.0 422
Guide des API
Valeurs renvoyées
Valeur booléenne : true s'il existe un document actif et une commande enregistrée pouvant être exécutée ; false dans le
cas contraire.
dreamweaver.canPopupEditTagDialog()
Disponibilité
Dreamweaver MX.
Description
Vérifie si la sélection en cours est une balise et si l'élément de menu Modifier la balise est actif.
Arguments
Aucun.
Valeurs renvoyées
Nom de la balise sélectionnée ou la valeur null si aucune balise n'est sélectionnée.
dreamweaver.canRedo()
Disponibilité
Dreamweaver 3.
Description
Vérifie si Dreamweaver peut effectuer une opération Rétablir dans le contexte en cours.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne indiquant s'il existe des opérations pouvant être annulées.
dreamweaver.canRevertDocument()
Disponibilité
Dreamweaver 3.
Description
Vérifie si Dreamweaver peut effectuer une opération Rétablir (revenir au dernier état enregistré).
Arguments
documentObject.
• L'argument documentObject correspond à l'objet situé à la racine de l'arborescence DOM d'un document (c'est-à-dire la
valeur renvoyée par la fonction dreamweaver.getDocumentDOM()).
Valeurs renvoyées
Valeur booléenne indiquant si le document est à l'état non enregistré et s'il en existe une version enregistrée sur un lecteur
local.
ADOBE DREAMWEAVER 9.0 423
Guide des API
dreamweaver.canSaveAll()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Enregistrer tout.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne indiquant si deux documents non enregistrés, ou plus, sont ouverts.
dreamweaver.canSaveDocument()
Disponibilité
Dreamweaver 3.
Description
Vérifie si Dreamweaver peut effectuer une opération Enregistrer sur le document spécifié.
Arguments
documentObject.
• L'argument documentObject est la racine d'un DOM de document (valeur identique à celle renvoyée par dreamweaver.getDocumentDOM()).
Valeurs renvoyées
Valeur booléenne indiquant si le document contient des modifications non enregistrées.
dreamweaver.canSaveDocumentAsTemplate()
Disponibilité
Dreamweaver 3.
Description
Vérifie si Dreamweaver peut effectuer une opération Enregistrer comme modèle sur le document spécifié.
Arguments
documentObject.
• L'argument documentObject est la racine d'un DOM de document (valeur identique à celle renvoyée par dreamweaver.getDocumentDOM()).
Valeurs renvoyées
Valeur booléenne indiquant si le document peut être enregistré comme modèle.
dreamweaver.canSaveFrameset()
Disponibilité
Dreamweaver 3.
Description
Vérifie si Dreamweaver peut effectuer une opération Enregistrer le jeu de cadres sur le document spécifié.
ADOBE DREAMWEAVER 9.0 424
Guide des API
Arguments
documentObject.
• L'argument documentObject est la racine d'un DOM de document (valeur identique à celle renvoyée par dreamweaver.getDocumentDOM()).
Valeurs renvoyées
Valeur booléenne indiquant si le document est un jeu de cadres comportant des modifications non enregistrées.
dreamweaver.canSaveFramesetAs()
Disponibilité
Dreamweaver 3.
Description
Vérifie si Dreamweaver peut effectuer une opération Enregistrer le jeu de cadres sous sur le document spécifié.
Arguments
documentObject.
• L'argument documentObject est la racine d'un DOM de document (valeur identique à celle renvoyée par dreamweaver.getDocumentDOM()).
Valeurs renvoyées
Valeur booléenne qui indique si le document est un jeu de cadres.
dreamweaver.canSelectAll()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Sélectionner tout.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne indiquant s'il est possible d'effectuer une opération Sélectionner tout.
dreamweaver.canShowFindDialog()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Rechercher.
Arguments
Aucun.
Valeurs renvoyées
Une valeur booléenne qui est true si une fenêtre de document ou un panneau Site est ouvert. Cette fonction renvoie la
valeur false lorsque la sélection se trouve dans la section HEAD.
ADOBE DREAMWEAVER 9.0 425
Guide des API
dreamweaver.canUndo()
Disponibilité
Dreamweaver 3.
Description
Vérifie si Dreamweaver peut effectuer une opération Annuler dans le contexte en cours.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne indiquant s'il existe des opérations pouvant être annulées.
dreamweaver.canZoom()
Disponibilité
Dreamweaver 8.
Description
Vérifie si un mode Création est actif, ce qui signifie que les commandes de base de zoom peuvent être appliquées.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si un mode Création est actif ; false dans le cas contraire.
dreamweaver.cssRuleTracker.canEditSelectedRule()
Disponibilité
Dreamweaver MX 2004.
Description
Vérifie si l'éditeur de grille de propriété peut s'appliquer à la règle sélectionnée. La grille de propriété pouvant afficher les
règles dans les fichiers verrouillés, la valeur de renvoi true ne garantit pas que les règles peuvent être modifiées.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si l'éditeur de grille de propriété peut s'appliquer à la règle sélectionnée ; false dans le cas
contraire.
Exemple
Le code suivant vérifie que la fonction de l'activateur a été définie sur la valeur true avant d'autoriser les modifications sur
la règle sélectionnée :
if(dw.cssRuleTracker.canEditSelectedRule()){
dw.cssRuleTracker.editSelectedRule();
}
ADOBE DREAMWEAVER 9.0 426
Guide des API
dreamweaver.cssStylePalette.canApplySelectedStyle()
Disponibilité
Dreamweaver MX.
Description
Vérifie si le style sélectionné peut être appliqué au document actif.
Arguments
{ pane }
• L'argument facultatif pane est une chaîne spécifiant le volet du panneau Styles auquel cette fonction est appliquée. Les
valeurs possibles sont les suivantes : "stylelist", qui correspond à la liste des styles dans le mode « Tout » ; "cascade",
qui correspond à la liste des règles applicables concernées dans le mode « Courant » ; "summary", qui correspond à la liste
des propriétés de la sélection en cours dans le mode « Courant » et "ruleInspector", qui correspond à la liste ou grille
de propriétés modifiable dans le mode « Courant ». La valeur par défaut est "stylelist".
Valeurs renvoyées
Valeur booléenne : true si le style sélectionné comporte un sélecteur de classes ; false dans le cas contraire.
dreamweaver.cssStylePalette.canDeleteSelectedStyle()
Disponibilité
Dreamweaver MX.
Description
Vérifie si le style sélectionné peut être supprimé de la sélection en cours.
Arguments
{ pane }
• L'argument facultatif pane est une chaîne spécifiant le volet du panneau Styles auquel cette fonction est appliquée. Les
valeurs possibles sont les suivantes : "stylelist", qui correspond à la liste des styles dans le mode « Tout » ; "cascade",
qui correspond à la liste des règles applicables concernées dans le mode « Courant » ; "summary", qui correspond à la liste
des propriétés de la sélection en cours dans le mode « Courant » et "ruleInspector", qui correspond à la liste ou grille
de propriétés modifiable dans le mode « Courant ». La valeur par défaut est "stylelist".
Valeurs renvoyées
Valeur booléenne : true si la sélection peut être supprimée ; false dans le cas contraire.
dreamweaver.cssStylePalette.canDuplicateSelectedStyle()
Disponibilité
Dreamweaver MX.
Description
Vérifie si le style sélectionné peut être dupliqué dans le document actif.
Arguments
{ pane }
• L'argument facultatif pane est une chaîne spécifiant le volet du panneau Styles auquel cette fonction est appliquée. Les
valeurs possibles sont les suivantes : "stylelist", qui correspond à la liste des styles dans le mode « Tout » ; "cascade",
qui correspond à la liste des règles applicables concernées dans le mode « Courant » ; "summary", qui correspond à la liste
des propriétés de la sélection en cours dans le mode « Courant » et "ruleInspector", qui correspond à la liste ou grille
de propriétés modifiable dans le mode « Courant ». La valeur par défaut est "stylelist".
ADOBE DREAMWEAVER 9.0 427
Guide des API
Valeurs renvoyées
Valeur booléenne : true si le style sélectionné peut être dupliqué ; false dans le cas contraire.
dreamweaver.cssStylePalette.canEditSelectedStyle()
Disponibilité
Dreamweaver MX.
Description
Vérifie si le style sélectionné peut être modifié dans le document actif.
Arguments
{ pane }
• L'argument facultatif pane est une chaîne spécifiant le volet du panneau Styles auquel cette fonction est appliquée. Les
valeurs possibles sont les suivantes : "stylelist", qui correspond à la liste des styles dans le mode « Tout » ; "cascade",
qui correspond à la liste des règles applicables concernées dans le mode « Courant » ; "summary", qui correspond à la liste
des propriétés de la sélection en cours dans le mode « Courant » et "ruleInspector", qui correspond à la liste ou grille
de propriétés modifiable dans le mode « Courant ». La valeur par défaut est "stylelist".
Valeurs renvoyées
Valeur booléenne : true si le style sélectionné peut être modifié ; false dans le cas contraire.
dreamweaver.cssStylePalette.canEditSelectedStyleInCodeview()
Disponibilité
Dreamweaver MX.
Description
Vérifie si le style sélectionné peut être modifié dans le document actif en mode Code.
Arguments
{ pane }
• L'argument facultatif pane est une chaîne spécifiant le volet du panneau Styles auquel cette fonction est appliquée. Les
valeurs possibles sont les suivantes : "stylelist", qui correspond à la liste des styles dans le mode « Tout » ; "cascade",
qui correspond à la liste des règles applicables concernées dans le mode « Courant » ; "summary", qui correspond à la liste
des propriétés de la sélection en cours dans le mode « Courant » et "ruleInspector", qui correspond à la liste ou grille
de propriétés modifiable dans le mode « Courant ». La valeur par défaut est "stylelist".
Valeurs renvoyées
Valeur booléenne : true si le style sélectionné peut être modifié ; false dans le cas contraire.
dreamweaver.cssStylePalette.canEditStyleSheet()
Disponibilité
Dreamweaver MX.
Description
Vérifie si la sélection en cours contient des éléments de feuille de style modifiables.
Arguments
Aucun.
ADOBE DREAMWEAVER 9.0 428
Guide des API
Valeurs renvoyées
Valeur booléenne : true si la sélection est un noeud de feuille de style ou une définition de style n'est pas masquée et si elle
est distincte de ce document ; false si la sélection est masquée ou si elle se trouve dans ce document.
dreamweaver.cssStylePalette.canRenameSelectedStyle()
Disponibilité
Dreamweaver MX.
Description
Vérifie si le style sélectionné peut être renommé dans le document actif.
Arguments
{ pane }
• L'argument facultatif pane est une chaîne spécifiant le volet du panneau Styles auquel cette fonction est appliquée. Les
valeurs possibles sont les suivantes : "stylelist", qui correspond à la liste des styles dans le mode « Tout » ; "cascade",
qui correspond à la liste des règles applicables concernées dans le mode « Courant » ; "summary", qui correspond à la liste
des propriétés de la sélection en cours dans le mode « Courant » et "ruleInspector", qui correspond à la liste ou grille
de propriétés modifiable dans le mode « Courant ». La valeur par défaut est "stylelist".
Valeurs renvoyées
Valeur booléenne : true si le style sélectionné peut être renommé ; false dans le cas contraire.
dreamweaver.isRecording()
Disponibilité
Dreamweaver 3.
Description
Indique si Dreamweaver est en train de mémoriser une commande.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne indiquant si Dreamweaver est en train d'enregistrer une commande.
dreamweaver.htmlStylePalette.canEditSelection()
Disponibilité
Dreamweaver 3.
Description
Vérifie si Dreamweaver peut modifier, supprimer ou dupliquer la sélection dans le panneau Styles HTML.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si Dreamweaver peut modifier, supprimer ou dupliquer la sélection dans le panneau Styles HTML ;
false si aucun style n'est sélectionné ou si l'un des styles indéterminés est sélectionné.
ADOBE DREAMWEAVER 9.0 429
Guide des API
dreamweaver.resultsPalette.canClear()
Disponibilité
Dreamweaver MX.
Description
Vérifie que vous pouvez effacer le contenu du panneau Résultats actuellement actif.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le contenu peut être effacé ; false dans le cas contraire.
dreamweaver.resultsPalette.canCopy()
Disponibilité
Dreamweaver MX.
Description
Vérifie si la fenêtre de résultats peut afficher un message copié dans son contenu.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le contenu peut être affiché ; false dans le cas contraire.
dreamweaver.resultsPalette.canCut()
Disponibilité
Dreamweaver MX.
Description
Vérifie si la fenêtre de résultats peut afficher un message coupé dans son contenu.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le contenu peut être affiché ; false dans le cas contraire.
dreamweaver.resultsPalette.canPaste()
Disponibilité
Dreamweaver MX.
Description
Vérifie si la fenêtre de résultats peut afficher un message collé dans son contenu.
Arguments
Aucun.
ADOBE DREAMWEAVER 9.0 430
Guide des API
Valeurs renvoyées
Valeur booléenne : true si le contenu peut être affiché ; false dans le cas contraire.
dreamweaver.resultsPalette.canOpenInBrowser()
Disponibilité
Dreamweaver MX.
Description
Vérifie si le rapport en cours peut être affiché dans un navigateur.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le contenu peut être affiché ; false dans le cas contraire.
dreamweaver.resultsPalette.canOpenInEditor()
Disponibilité
Dreamweaver MX.
Description
Vérifie si le rapport en cours peut être affiché dans un éditeur.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le contenu peut être affiché ; false dans le cas contraire.
dreamweaver.resultsPalette.canSave()
Disponibilité
Dreamweaver MX.
Description
Vérifie si la boîte de dialogue d'enregistrement peut être lancée pour le panneau en cours. Actuellement, les panneaux
Rapports du site, Vérification du navigateur cible, Validation et Vérificateur de lien prennent en charge la boîte de dialogue
d'enregistrement.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true, si la boîte de dialogue d'enregistrement apparaît ; false dans le cas contraire.
ADOBE DREAMWEAVER 9.0 431
Guide des API
dreamweaver.resultsPalette.canSelectAll()
Disponibilité
Dreamweaver MX.
Description
Vérifie si un message Sélectionner tout peut être transmis à la fenêtre active.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true, si le message Sélectionner tout peut être transmis ; false dans le cas contraire.
dreamweaver.siteSyncDialog.canCompare()
Disponibilité
Dreamweaver 8.
Description
Cette fonction vérifie si le menu contextuel Comparer peut être affiché dans la boîte de dialogue Synchroniser le site.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le menu contextuel Comparer peut être affiché dans la boîte de dialogue Synchroniser le site ;
false dans le cas contraire.
dreamweaver.siteSyncDialog.canMarkDelete()
Disponibilité
Dreamweaver 8.
Description
Cette fonction vérifie si le menu contextuel Modifier l'action à supprimer peut être affiché dans la boîte de dialogue
Synchroniser le site.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le menu contextuel Modifier l'action à supprimer peut être affiché ; false dans le cas contraire.
dreamweaver.siteSyncDialog.canMarkGet()
Disponibilité
Dreamweaver 8.
Description
Cette fonction vérifie si le menu contextuel Modifier l'action à obtenir peut être affiché dans la boîte de dialogue Synchroniser le site.
ADOBE DREAMWEAVER 9.0 432
Guide des API
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le menu contextuel Modifier l'action à obtenir peut être affiché ; false dans le cas contraire.
dreamweaver.siteSyncDialog.canMarkIgnore()
Disponibilité
Dreamweaver 8.
Description
Cette fonction vérifie si le menu contextuel Modifier l'action à ignorer peut être affiché dans la boîte de dialogue Synchroniser le site.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le menu contextuel Modifier l'action à ignorer peut être affiché ; false dans le cas contraire.
dreamweaver.siteSyncDialog.canMarkPut()
Disponibilité
Dreamweaver 8.
Description
Cette fonction vérifie si le menu contextuel Modifier l'action à placer peut être affiché dans la boîte de dialogue Synchroniser le site.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le menu contextuel Modifier l'action à placer peut être affiché ; false dans le cas contraire.
dreamweaver.siteSyncDialog.canMarkSynced()
Disponibilité
Dreamweaver 8.
Description
Cette fonction vérifie si le menu contextuel Modifier l'action à synchroniser peut être affiché dans la boîte de dialogue
Synchroniser le site.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le menu contextuel Modifier l'action à synchroniser peut être affiché ; false dans le cas contraire.
ADOBE DREAMWEAVER 9.0 433
Guide des API
dreamweaver.snippetpalette.canEditSnippet()
Disponibilité
Dreamweaver MX.
Description
Vérifie si vous pouvez modifier l'élément sélectionné et renvoie la valeur true ou la valeur false pour vous permettre
d'activer ou de désactiver les éléments de menu destinés à l'édition.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si vous pouvez modifier l'élément sélectionné ; false dans le cas contraire.
dreamweaver.snippetpalette.canInsert()
Disponibilité
Dreamweaver MX.
Description
Vérifie si vous pouvez insérer ou appliquer l'élément sélectionné et renvoie la valeur true ou la valeur false pour vous
permettre d'activer ou de désactiver les éléments de menu destinés à l'insertion ou à l'application.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si vous pouvez insérer ou appliquer l'élément sélectionné ; false dans le cas contraire.
site.browseDocument()
Disponibilité
Dreamweaver 4.
Description
Ouvre tous les documents sélectionnés dans une fenêtre de navigateur. Cela revient à utiliser la commande Aperçu dans le
navigateur.
Arguments
browserName.
• L'argument browserName est le nom du navigateur tel qu'il est défini dans les préférences d'aperçu dans le navigateur. Si
cet argument n'est pas défini, le navigateur principal de l'utilisateur est utilisé par défaut.
Valeurs renvoyées
Aucune.
site.canAddLink()
Disponibilité
Dreamweaver 3.
Description
Vérifie si Dreamweaver peut effectuer une opération Lier au [ fichier existant | nouveau fichier ].
ADOBE DREAMWEAVER 9.0 434
Guide des API
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le document sélectionné dans la carte du site est un fichier HTML ; false dans le cas contraire.
site.canChangeLink()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Modifier le lien.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si un fichier HTML ou Flash est lié au fichier sélectionné dans la carte du site ; false dans le cas
contraire.
site.canCheckIn()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Archiver.
Arguments
siteOrURL.
• L'argument siteOrURL doit être soit le mot-clé site, indiquant que la fonction doit agir sur l'élément sélectionné dans le
panneau Site, soit l'URL d'un fichier.
Valeurs renvoyées
Valeur booléenne : true si les conditions suivantes sont vraies ; false dans le cas contraire.
• Un site distant a été défini.
• Dans le cas où une fenêtre de document est active, le fichier a été enregistré sur un site local ou, dans le cas où le panneau
Site est actif, un ou plusieurs fichiers ou dossiers sont sélectionnés.
• La fonction Check In/Check Out est activée pour le site.
site.canCheckOut()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Extraire sur le ou les fichiers spécifiés.
ADOBE DREAMWEAVER 9.0 435
Guide des API
Arguments
siteOrURL.
• L'argument siteOrURL doit être soit le mot-clé site, indiquant que la fonction doit agir sur l'élément sélectionné dans le
panneau Site, soit l'URL d'un fichier.
Valeurs renvoyées
Valeur booléenne : true si toutes les conditions suivantes sont vraies ; false dans le cas contraire.
• Un site distant a été défini.
• Dans le cas où une fenêtre de document est active, le fichier appartient à un site local et il n'est pas déjà extrait ou, dans
le cas où le panneau Site est actif, plusieurs fichiers ou dossiers sont sélectionnés et au moins un des fichiers sélectionnés
n'a pas encore été extrait.
• La fonction Check In/Check Out est activée pour le site.
site.canCloak()
Disponibilité
Dreamweaver MX.
Description
Détermine si Dreamweaver peut effectuer une opération de voilage.
Arguments
siteOrURL.
• L'argument siteOrURL doit être soit le mot-clé site, indiquant que la fonction canCloak() doit agir sur l'élément sélectionné dans le panneau Site, soit l'URL d'un dossier donné, indiquant que la fonction canCloak() doit agir sur le dossier
spécifié et l'ensemble de son contenu.
Valeurs renvoyées
Valeur booléenne : true si Dreamweaver peut exécuter l'opération de voilage sur le site en cours ou le dossier spécifié ;
false dans le cas contraire.
site.canCompareFiles()
Disponibilité
Dreamweaver 8.
Description
Cette fonction vérifie si Dreamweaver peut exécuter la fonction Comparer sur des fichiers sélectionnés.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si deux fichiers (un fichier local et un fichier distant, deux fichiers locaux ou deux fichiers distants)
sont sélectionnés ; false dans le cas contraire.
site.canConnect()
Disponibilité
Dreamweaver 3.
ADOBE DREAMWEAVER 9.0 436
Guide des API
Description
Vérifie si Dreamweaver peut se connecter au site distant.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le site distant en cours est un site FTP ; false dans le cas contraire.
site.canDisplaySyncInfoForFile()
Disponibilité
Dreamweaver CS3.
Description
Détermine si Dreamweaver peut effectuer l'opération displaySyncInfoForFile.
Arguments
path, 'site'
•
path est l'URL pointant vers un fichier local.
• 'site' indique que la fonction utilise le fichier sélectionné dans le panneau Site.
Valeurs renvoyées
Renvoie la valeur true si un fichier est sélectionné dans l'affichage local des fichiers (si 'site' en est le paramètre) ou true si
le chemin transmis fait partie d'un site. Renvoie false dans le cas contraire.
site.canFindLinkSource()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Rechercher la source du lien.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne indiquant que le lien sélectionné dans la carte du site n'est pas la page d'accueil.
site.canGet()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Acquérir.
Arguments
siteOrURL.
• L'argument siteOrURL doit être soit le mot-clé site, indiquant que la fonction doit agir sur l'élément sélectionné dans le
panneau Site, soit l'URL d'un fichier.
ADOBE DREAMWEAVER 9.0 437
Guide des API
Valeurs renvoyées
Si l'argument est site, valeur booléenne indiquant si un ou plusieurs fichiers ou dossiers sont sélectionnés dans le panneau
Site et si un site distant a été défini. Si l'argument est une URL, valeur booléenne indiquant si le document appartient à un
site pour lequel un site distant a été défini.
site.canLocateInSite()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Retrouver sur le site local ou Retrouver sur le site distant (en
fonction de l'argument)
Arguments
localOrRemote, siteOrURL.
• L'argument localOrRemote doit être local ou remote.
• L'argument siteOrURL doit être soit le mot-clé site, indiquant que la fonction doit agir sur l'élément sélectionné dans le
panneau Site, soit l'URL d'un fichier.
Valeurs renvoyées
L'une des valeurs suivantes :
• si le premier argument est le mot-clé local et le second une URL, valeur booléenne indiquant si le document appartient
à un site ;
• si le premier argument est le mot-clé remote et le second une URL, valeur booléenne indiquant si le document appartient
à un site pour lequel un site local a été défini et, si le type de serveur est Local/Réseau, si le lecteur est monté ;
• si le second argument est le mot-clé site, valeur booléenne indiquant si les deux fenêtres contiennent des fichiers de site
(et non la carte du site) et si la sélection se trouve dans le volet opposé à l'argument.
site.canMakeEditable()
Disponibilité
Dreamweaver 3.
Description
Vérifie si Dreamweaver peut effectuer une opération Désactiver le mode Lecture seule.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si Dreamweaver peut effectuer une opération Désactiver le mode Lecture seule ; false si un ou
plusieurs des fichiers sélectionnés sont verrouillés.
site.canMakeNewFileOrFolder()
Disponibilité
Dreamweaver 3.
Description
Vérifie si Dreamweaver peut effectuer une opération Nouveau fichier ou Nouveau dossier dans le panneau Site.
ADOBE DREAMWEAVER 9.0 438
Guide des API
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si des fichiers sont visibles dans le volet sélectionné du panneau Site ; false dans le cas contraire.
site.canOpen()
Disponibilité
Dreamweaver 3.
Description
Vérifie si Dreamweaver peut ouvrir les fichiers ou les dossiers actuellement sélectionnés dans le panneau Site.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si des fichiers ou des dossiers sont sélectionnés dans le panneau Site ; false dans les autres cas.
site.canPut()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Placer.
Arguments
siteOrURL.
• L'argument siteOrURL doit être soit le mot-clé site, indiquant que la fonction doit agir sur l'élément sélectionné dans le
panneau Site, soit l'URL d'un fichier.
Valeurs renvoyées
L'une des valeurs suivantes :
• si l'argument est le mot-clé site, renvoie la valeur true si des fichiers ou des dossiers sont sélectionnés dans le panneau
Site et si un site distant a été défini ; renvoie la valeur false dans les autres cas ;
• si l'argument est une URL, renvoie la valeur true si le document appartient à un site pour lequel un site distant a été
défini ; renvoie la valeur false dans le cas contraire.
site.canRecreateCache()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Recréer le cache du site.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si l'option Utiliser le cache pour accélérer les mises à jour des liens est activée pour le site en cours.
ADOBE DREAMWEAVER 9.0 439
Guide des API
site.canRefresh()
Disponibilité
Dreamweaver 3.
Description
Vérifie si Dreamweaver peut effectuer une opération Actualiser [local | distant].
Arguments
localOrRemote.
• L'argument localOrRemote doit être le mot-clé local ou remote.
Valeurs renvoyées
Valeur true si l'argument localOrRemote est le mot-clé local ; sinon, une valeur booléenne indiquant si un site distant a
été défini.
site.canRemoveLink()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Supprimer le lien.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne indiquant qu'un fichier HTML ou Flash est lié au fichier sélectionné dans la carte du site.
site.canSetLayout()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Mise en forme.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si la carte du site est visible ; false dans les autres cas.
site.canSelectAllCheckedOutFiles()
Disponibilité
Dreamweaver 4.
Description
Détermine si la fonction Archiver/Extraire est activée sur le site en cours.
Arguments
Aucun.
ADOBE DREAMWEAVER 9.0 440
Guide des API
Valeurs renvoyées
Valeur booléenne : true si le site autorise l'archivage et l'extraction ; false dans le cas contraire.
site.canSelectNewer()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Sélectionner [distants | locaux] plus récents.
Arguments
localOrRemote.
• L'argument localOrRemote doit être le mot-clé local ou remote.
Valeurs renvoyées
Valeur booléenne indiquant si le document appartient à un site pour lequel un site distant a été défini.
site.canShowPageTitles()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Afficher les titres de page.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si la carte du site est visible; false dans le cas contraire.
site.canSynchronize()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Synchroniser.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne indiquant si un site distant a été défini.
site.canUncloak()
Disponibilité
Dreamweaver MX.
Description
Détermine si Dreamweaver peut effectuer une opération de suppression du voile.
ADOBE DREAMWEAVER 9.0 441
Guide des API
Arguments
siteOrURL.
• L'argument siteOrURL doit être le mot-clé site, indiquant que la fonction canUncloak() doit agir sur l'élément sélectionné dans le panneau Site, ou l'URL d'un dossier spécifique, ce qui signifie que la fonction canUncloak() doit agir sur
le dossier spécifié et l'ensemble de son contenu.
Valeurs renvoyées
Valeur booléenne : true si Dreamweaver peut exécuter l'opération de désactivation du voilage sur le site en cours ou le
dossier spécifié ; false dans le cas contraire.
site.canUndoCheckOut()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Annuler extraction.
Arguments
siteOrURL.
• L'argument siteOrURL doit être soit le mot-clé site, indiquant que la fonction doit agir sur l'élément sélectionné dans le
panneau Site, soit l'URL d'un fichier.
Valeurs renvoyées
Valeur booléenne : true si le fichier spécifié ou l'un des fichiers sélectionnés, au moins, a été extrait.
site.canViewAsRoot()
Disponibilité
Dreamweaver 3.
Description
Détermine si Dreamweaver peut effectuer une opération Afficher comme racine.
Arguments
Aucun.
Valeurs renvoyées
Valeur booléenne : true si le fichier spécifié est un fichier HTML ou Flash ; false dans le cas contraire.
ADOBE DREAMWEAVER 9.0 442
Guide des API
443
Index
A
DWfile.read() 10
SCS_SetDesignNotes() 90
A propos des boîtes de dialogue 106
DWfile.remove() 11
SCS_SiteDeleted() 84
acquisition
DWfile.setAttributes() 11
SCS_SiteRenamed() 84
DOM en cours 223
objets de connexion nommés 43
activateApp() 104
DWfile.write() 12
API d'intégration de commande
source
SCS_UndoCheckout() 87
API d'intégration de Fireworks
à propos 31
activeViewScale() 347
à propos 77
bringDWToFront() 31
addBehavior() 266
SCS_AfterGet() 95
bringFWToFront() 31
addDebugContextData() 140
SCS_AfterPut() 96
execJsInFireworks() 32
addItem() 135
SCS_BeforeGet() 94
getJsResponse() 32
addJavaScript() 288
SCS_BeforePut() 95
mayLaunchFireworks() 33
addLinkToExistingFile() 188
SCS_canCheckin() 93
optimizeInFireworks() 33
addLinkToNewFile() 189
SCS_canCheckout() 92
addResultItem() 131
SCS_canConnect() 91
addSpacerToColumn() 339
SCS_canDelete() 94
à propos 38
administration ODBC 52
SCS_canGet() 92
SWFFile.createFile() 38
affichage
SCS_canNewFolder() 93
SWFFile.getNaturalSize() 39
assistances visuelles 141
SCS_canPut() 92
SWFFile.getObjectType() 40
codes de touche 129
SCS_canRename() 94
validateFireworks() 34
API d'objets Flash
SWFFile.readFile() 40
affichage de Dreamweaver au
premier plan 31
SCS_CanUndoCheckout() 93
SCS_Checkin() 86
à propos 41
affichage de Fireworks au premier
plan 31
SCS_Checkout() 86
fonctions d'accès 53
SCS_Connect() 79
affichage des tableaux 61
fonctions de connexion 42
SCS_Delete() 82
afficher la barre d'outils 151
MMDB.deleteConnection() 42
SCS_Disconnect() 79
Afficher la boîte de dialogue lors de
l'insertion d'un objet 105
SCS_Get() 81
MMDB.getColdFusionDsnList()
43
API de base de données
SCS_GetCheckoutName() 85
MMDB.getColumnAndTypeList()
54
SCS_GetConnectionInfo() 84
MMDB.getColumnList() 54
SCS_GetDesignNotes() 90
MMDB.getColumns() 55
SCS_GetErrorMessage() 88
MMDB.getColumnsOfTable() 56
SCS_GetErrorMessageLength()
88
MMDB.getConnection() 43
annulation, extraction de fichiers 87
annuler 114, 115, 116, 120
SCS_GetFileCheckoutList() 88
MMDB.getConnectionName() 45
état 118
SCS_GetFolderList() 81
MMDB.getConnectionString() 45
répéter 113
SCS_GetFolderListLength() 80
MMDB.getDriverName() 46
SCS_GetMaxNoteLength() 89
alerte audio 105
align() 332
alignement
calques 332
tracé de l'image 337
API d'E/S des fichiers
SCS_GetAgentInfo() 78
MMDB.getConnectionList() 44
à propos 5
SCS_GetNewFeatures() 85
MMDB.getDriverUrlTemplateList
() 46
DWfile.copy() 5
SCS_GetNoteCount() 89
MMDB.getLocalDsnList() 47
DWfile.createFolder() 6
SCS_GetNumCheckedOut() 87
MMDB.getPassword() 47
DWfile.exists() 6
SCS_GetNumNewFeatures() 85
MMDB.getPrimaryKeys() 56
DWfile.getAttributes() 7
SCS_GetRootFolder() 80
MMDB.getProcedures() 57
DWfile.getCreationDate() 8
SCS_GetRootFolderLength() 80
MMDB.getRdsPassword() 47
DWfile.getCreationDateObj() 9
SCS_IsConnected() 79
MMDB.getRdsUserName() 48
DWfile.getModificationDate() 7
SCS_IsRemoteNewer() 91
MMDB.getRemoteDsnList() 48
DWfile.getModificationDateObj()
9
SCS_ItemExists() 83
MMDB.getRuntimeConnectionTy
pe() 48
DWfile.getSize() 9
DWfile.listFolder() 10
SCS_NewFolder() 82
SCS_Put() 82
SCS_Rename() 83
MMDB.getSPColumnList() 58
MMDB.getSPColumnListNamedP
arams() 58
INDEX
MMDB.getSPParameters() 59
MMJB.getEvents() 74
assetPalette.insertOrApply() 260
MMDB.getSPParamsAsString()
60
MMJB.getMethods() 75
assetPalette.locateInSite() 260
MMJB.getProperties() 73
assetPalette.newAsset() 261
MMDB.getTables() 60
MMDB.getUserName() 49
API SCS. Voir API d'intégration de
commande source
MMDB.getViews() 61
API, types
MMDB.hasConnectionWithName
() 49
MMDB.needToPromptForRdsInf
o() 49
MMDB.needToRefreshColdFusio
nDsnList() 50
MMDB.popupConnection() 50
assetPalette.recreateLibraryFromDoc
ument() 261
base de données 41
assetPalette.refreshSiteAssets() 262
boîte de dialogue de connexion à
une base de données 66
assetPalette.removeFromFavorites()
262
Design Notes 19
assetPalette.renameNickname() 262
E/S de fichiers 5
assetPalette.setSelectedCategory()
262
HTTP 13
MMDB.setRdsPassword() 51
intégration de commande source
78
MMDB.setRdsUserName() 51
intégration de Fireworks 31
MMDB.showColdFusionAdmin()
51
JavaBeans 73
MMDB.showConnectionMgrDial
og() 51
assetPalette.newFolder() 261
assetPalette.setSelectedView() 263
assistances visuelles 141, 146, 328,
329
Arrière-plans des blocs de mise en
forme 317, 319, 329
objets Flash 38
Contours des blocs de mise en
forme 318, 320
application
MMDB.showOdbcDialog() 52
ouverture des fichiers 102
MMDB.showRdsUserDialog() 52
sélection 102
Modèle de boîte des blocs de mise
en forme 317, 320, 328
MMDB.showRestrictDialog() 52
application des styles 316
attachExternalStylesheet() 321
MMDB.showResultset() 62
applications externes, fonctions 97
attributs
MMDB.showSPResultset() 62
applications, fonctions globales 105
acquisition 7
MMDB.showSPResultsetNamedP
arams() 63
applyCharacterMarkup() 373
balise de fragment de code 283
applyComment() 179
fichiers, définition 11
MMDB.testConnection() 53
applyConnection() 68
API de boîte de dialogue de
connexion à une base de
données
à propos 66
applyConnection() 68
fichiers de définition 70
fichiers, inclus générés 69
findConnection() 67
inspectConnection() 68
API de connectivité à une base de
données. Voir API de boîte de
dialogue de connexion à une
base de données
API HTTP
applyCSSStyle() 316
B
applyFontMarkup() 374
backspaceKey() 125
applyLayout() 313
balanceBracesTextView() 394
applySelectedStyle() 321
applyTemplate() 278
balise de fragment de code, attributs
283
archivage de fichiers 86, 96
balise de police 374
arrange() 332
balise serverdebuginfo 140
arrangeFloatingPalettes() 338
balises
arrêter
contenu d'un plug-in 338
insertion 108
enregistrement 116
police 374
arrowDown() 123, 393
Barre d'outils, afficher 151
arrowLeft() 123, 393
Barre Insertion
à propos 13
arrowRight() 124, 393
MMHttp.clearServerScriptsFolder
() 13
arrowUp() 124, 394
MMHttp.clearTemp() 14
MMHttp.getFile() 15
MMHttp.getFileCallback() 16
MMHttp.getTextCallback() 17
MMHttp.postText() 17
MMHttp.postTextCallback() 18
API JavaBeans
à propos 73
MMJB.getClasses() 73
MMJB.getClassesFromPackage()
76
MMJB.getErrorMessage() 76
calques 334
menus 121
recharger les objets 122
assetPalette.addToFavoritesFromDo
cument() 257
barres d'outils, fonctions 158
assetPalette.addToFavoritesFromSite
Assets() 258
bases de données
bascule, fonctions 141
API de base de données 41
assetPalette.addToFavoritesFromSite
Window() 258
API de boîte de dialogue de
connexion 66
assetPalette.canEdit() 418
assetPalette.canInsertOrApply() 418
fichiers, définition de type de
connexion 70
assetPalette.copyToSite() 258
fonctions d'accès 53
assetPalette.edit() 259
fonctions de connexion 42
assetPalette.getSelectedCategory()
259
assetPalette.getSelectedItems() 259
assetPalette.getSelectedView() 260
modes 61
bases de données, connexions à 50
mots de passe 47
444
INDEX
noms d'utilisateur 49
suppression 42
test d'existence 49
beep() 105, 107, 184, 185, 212
bibliothèque partagée MMNotes
nom de version 21, 27
blocs
canCut() 429
Sélectionnez la source de l'image
335
canDecreaseRowspan() 411
Texte dynamique 106
bordures 344
blocs 345
numéro de version 22, 27
bip système 105
Sélectionner un éditeur externe
102
divs 345
BridgeTalk
bringToFront() 109
bordures 344, 345
send() 110
coloration 343, 345
suppressStartupScreen() 110
canDecreaseColspan() 411
canDeleteTableColumn() 412
canDeleteTableRow() 412
canDisplaySyncInfoForFile() 436
canEditColumns() 412
canEditNoFramesContent() 413
canEditSelectedRule() 425
canEditSelection() 428
canExportCSS() 420
bringAttentionToFloater() 164
canExportTemplateDataAsXML()
420
bringDWToFront() 31
canFindLinkSource() 436
bringFWToFront() 31
canFindNext() 420
bringToFront() 109
canGet() 436
A propos 106
browseDocument() 97, 433
canIncreaseColspan() 413
Administrateur de source de
données ODBC 52
browseForFileURL() 219
canIncreaseRowspan() 413
browseForFolderURL() 220
canInsertTableColumns() 413
Administration ODBC système 52
browseInBridge() 111
canInsertTableRows() 414
Choisissez le dossier 220
bruit 105
canLocateInSite() 437
ID 344, 346
boîte de dialogue Collage spécial 107
boîte de dialogue Enregistrer comme
commande 119
boîtes de dialogue
ColdFusion Administrator 51
canMakeEditable() 437
Collage spécial 107
C
Convertir les calques en tableaux
215
cadres
Convertir les tableaux en calques
216
canMakeNewEditableRegion() 414
canMarkSelectionAsEditable() 414
listes 330
canMergeTableCells() 415
Définition de la taille 140
cadres et jeux de cadres, fonctions
330
Définition du style 323
calques 334
Données dynamiques 106
alignement 332
Enregistrer comme commande
119
balise HTML 334
Enregistrer comme modèle 230
Enregistrer sous 228, 229
Exporter les régions modifiables
sous XML 223
canMakeNewFileOrFolder() 437
fractionnement 331
déplacement 333
dimensionnement 333
calques en tableaux, conversion 215
calques, fonctions 332
Exporter les styles dans un fichier
CSS 222
canAddLinkToFile() 433
Gestionnaire de connexions 51
canApplyLayout() 314
Modifier feuille de style 323
canApplyTemplate() 409
Modifier la liste des commandes
216
canArrange() 409
Navigateurs cibles 240
canCheckIn() 434
Nouveau document 225
canCheckOut() 434
Nouveau style 326
canClear() 429
Nouveau style CSS 321
canClipCopy() 418
Ouvrir dans un cadre 227
canClipCopyText() 410
Paramètres de la grille 339
canClipCut() 419
Préférences 102, 105, 107
canClipPaste() 410, 419
Propriétés de la page 234
canClipPasteText() 410
Rechercher 373
canCloak() 435
Remplacer 373
canConnect() 435
Restreindre 52
canConvertLayersToTable() 411
Sélecteur de balise 108
canConvertTablesToLayers() 411
canAlign() 409
canChangeLink() 434
canCopy() 429
canOpen() 438
canOpenInBrowser() 430
canOpenInEditor() 430
canOpenInFrame() 421
canPaste() 429
canPlayPlugin() 415
canPlayRecordedCommand() 421
canPopupEditTagDialog() 422
canPut() 438
canRecreateCache() 438
canRedo() 415, 422
canRefresh() 439
canRemoveEditableRegion() 415
canRemoveLink() 439
canRevertDocument() 422
canSave() 430
canSaveAll() 423
canSaveDocument() 423
canSaveDocumentAsTemplate() 423
canSaveFrameset() 423
canSaveFramesetAs() 424
canSelectAll() 424, 431
canSelectAllCheckedOutFiles() 439
canSelectNewer() 440
canSelectTable() 416
canSetLayout() 439
canSetLinkHref() 416
445
INDEX
canShowFindDialog() 424
clés
types de 54
coloration
canShowListPropertiesDialog() 416
dans Design Notes 20
canSplitFrame() 416
canSplitTableCell() 417
dans les fichiers Design Notes 21,
24
Arrière-plans des blocs de mise en
forme 329
canStopPlugin() 417
liste des 26
blocs 343, 345
canSynchronize() 440
Page précédente 127
boîte, modèles 328, 345, 346
canUncloak() 440
Page suivante 127
code 365, 368
canUndo() 417, 425
principaux 56
divs 343, 345
canUndoCheckOut() 441
récupération des valeurs 25
canViewAsRoot() 441
Retour arrière 125
coloration de la syntaxe 155
carte d'images, fonctions 332
suppression des fichiers Design
Notes 23
coloration du code 368
cascade() 165
chaînes
contenu du fichier 10
écriture dans des fichiers 12
chaînes d'ID, suppression 121
changeLink() 189
changeLinkSitewide() 189
changement de nom
fichiers 83
styles 327
checkIn() 190
Supprimer 125
clés de Design Note 89
repères 352
commandes
exécution 217
mémorisées 115
clipCopy() 274, 276
commandes mémorisées 115
clipCopyText() 274
commentaires, appliquer 179
clipCut() 274, 276
clipPaste() 275, 277
comparaison, fichiers locaux et
distants 91
clipPasteText() 275
compare() 186
cloak() 191, 192
compareFiles() 185
closeDocument() 220
comportements, fonctions 266
CloseNotesFile() 24
serveur 305
checkLinks() 190
code de touche, traduire en caractère
129
conception, fonctions 313
checkOut() 191
code, fonctions
connection_includefile.edml 70
checkSpelling() 231
code, indicateurs et coloration 365
connectivité à une base de données,
présentation 65
checkTargetBrowsers() 191, 231
Fragments de code, panneau 282
connectivité, présentation 65
chemin d'accès du dossier
Configuration 240
mode Code 390
connexion à des systèmes de
commande source 79
chemin d'accès du fichier local,
conversion en URI relative du
site 184, 185
chemin du lecteur local
conversion à partir d'une URL de
fichier 22
conversion en URL de fichier 20,
24
chemins
document 241
Dossier Configuration 240
dossier temporaire 242
navigateur secondaire 100
vers une application Flash MX 99
chemins, fonctions 240
classes, introspection des JavaBeans
74, 75
clavier, fonctions 123
clé primaire 56
codeHints.addFunction() 367
codeHints.addMenu() 366
codeHints.resetMenu() 367
codeHints.showCodeHints() 368
ColdFusion Administrator 51
ColdFusion Component Explorer
196, 197, 200
collage 107
collapseFullTag() 175
collapseSelectedCodeFragment()
173
connexion, chaînes de 44, 45
évaluation 53
connexions 50
acquisition d'un nom spécifique
45
acquisition de la liste des 44, 53
définition 68
détection 67
collapseSelectedCodeFragmentInver
se() 174, 177
génération de balises HTML 68
collpaseSelectedCodeFragment()
176
systèmes de commande source 79,
84
colonnes 54, 55, 56
JDBC 46
connexions JDBC 46
acquisition à partir d'instructions
54
connexions nommées 45
acquisition à partir de tableaux 56
contenu d'un plug-in
cleanupXHTML() 218
acquisition à partir des procédures
stockées 58
clear() 132
dans SQL SELECT 54
clearGuides() 350
dimensionnement 342, 343
clearServerScriptsFolder() 13
jeux de résultats 58
clearSteps() 116
largeurs dans la fenêtre de
résultats 137
clearTemp() 14
connexion à la base de données
(MMDB), fonctions 42
noms de 56
procédures 57
arrêter 338
lire 335
contenu de page web, fonctions 257
contenu de page, fonctions 257
contenu Flash, taille naturelle 39
conventions typographiques 4
conventions, dans le manuel 4
446
INDEX
conversion
chemin d'accès du fichier local en
URI relative du site 184
chemin d'accès du fichier local en
URL de fichier 24
cssStylePalette.canDeleteSelectedStyl
e() 426
MMNotes.getKeyCount() 20
cssStylePalette.canEditStyleSheet()
427
MMNotes.getSiteRootForFile() 21
cut() 133
MMNotes.getKeys() 21
MMNotes.getVersionName() 21
MMNotes.getVersionNum() 22
chemin d'accès du lecteur local en
URL de fichier 20
D
de pixels en pourcentage 356
Data Manager 299
de pourcentage en pixels 356
detachFromLibrary() 278
dbi.setExpanded() 299
URI relative du site en chemin
d'accès du fichier local 185
detachFromTemplate() 279
début de document 128
dimensionnement
URL de fichier en chemin d'accès
du lecteur local 22, 27
conversion en XHTML 218
conversions, fonctions 215
convertActiveContent() 122
convertLayersToTable() 215
convertNextActiveContent() 122
convertTablesToLayers() 216
convertToXHTML() 218
convertWidthsToPercent() 356
convertWidthsToPixels() 356
copie
étapes de l'historique 117
fichiers 5
sélection 274
Copy() 132
copy() 5
copyAssets() 288
copySteps() 117
createDocument() 221
createFolder() 6
MMNotes.localURLToFilePath()
22
déconnexion des systèmes de
commande source 79
decreaseColspan() 356
decreaseRowspan() 357
defineSites() 192
définition de connexion, fichier 70
deleteConnection() 42
deleteHorizontalGuide() 351
deleteKey() 125
deleteSelectedItem() 263
deleteSelectedStyle() 322
deleteSelectedTemplate() 265
deleteSelection() 192, 374, 385
deleteTableColumn() 357
deleteTableRow() 357
deleteVerticalGuide() 351
déplacement
calques 333
point d'insertion 123, 124
zones réactives 333
deployFilesToTestingServerBin()
193
calques 333
zones réactives 333
diminution
étendue de colonnes 356
étendue de lignes 357
displaySyncInfoForFile() 193
disposition
panneaux flottants 338
zones réactives 332
divs
bordures 344, 345
coloration 343, 345
ID 344, 346
documents
création 221, 226
début de 128
enregistrement 228, 229
fermeture 220
ouverture 225, 226
rétablir 228
validation 232
createHorzontalGuide() 350
description, attribut 283
documents ouverts, liste 165
createLayoutCell() 339
Design Notes
documents XHTML, nettoyage 218
createLayoutTable() 340
API C 24
documents, fonctions globales 231
createResultsWindow() 135
longueur 89
doDeferredTableUpdate() 358
createVerticalGuide() 351
structure de fichier 19
doesColumnHaveSpacer() 340
createXHTMLDocument() 221
systèmes de commande source 90
doesGroupHaveSpacers() 341
createXMLDocument() 222
Design Notes, fichiers
dom
acquisition d'une clé 20
addBehavior() 266
documents 221
clés 21, 24
addJavaScript() 288
dossiers 6, 82
création de paires clé/valeur 23, 29
addSpacerToColumn() 339
Fenêtre Résultats 135
enregistrement 19
align() 332
fichiers XML 222, 223
fermeture 24
applyCharacterMarkup() 373
nombre de paires clé/valeur 25
applyCSSStyle() 316
ouverture 22, 28
applyFontMarkup() 374
paires clé/valeur 20
applyLayout() 313
racine du site 21, 26
applyTemplate() 278
suppression de clés 23, 28
arrange() 332
création
Création, mode
définir l'option afficher/masquer
164
visible 164
CSS en balises HTML, conversion
215
cssRuleTracker.canEditSelectedRule(
) 425
cssStyle.canEditSelectedStyle() 427
cssStylePalette.canApplySelectedStyl
e() 426
Design Notes, fonctions
arrowDown() 123
MMNotes.close() 19
arrowLeft() 123
MMNotes.filePathToLocalURL()
20
arrowRight() 124
MMNotes.get() 20
backspaceKey() 125
arrowUp() 124
447
INDEX
canAlign() 409
copyAssets() 288
getOpenPathName() 178
canApplyLayout() 314
createHorizontalGuide() 350
getParseMode() 232
canApplyTemplate() 409
createLayoutCell() 339
getPreventLayerOverlaps() 142
canArrange() 409
createLayoutTable() 340
getRulerOrigin() 334
canClipCopyText() 410
createVerticalGuide() 351
getRulerUnits() 334
canClipPaste() 410
decreaseColspan() 356
getSelectedEditableRegion() 280
canClipPasteText() 410
decreaseRowspan() 357
getSelectedNode() 243
canConvertLayersToTable() 411
deleteHorizontalGuide() 351
getSelection() 243
canConvertTablesToLayers() 411
deleteKey() 125
getShowAutoIndent() 142
canDecreaseColspan() 411
deleteSelection() 374
getShowBlockBackgrounds() 343
canDecreaseRowspan() 411
deleteTableColumn() 357
getShowBlockBorders() 344
canDeleteTableColumn() 412
deleteTableRow() 357
getShowBlockIDs() 344
canDeleteTableRow() 412
deleteVerticalGuide() 351
getShowBoxModel() 345
canEditNoFramesContent() 413
detachFromLibrary() 278
getShowDivBackgrounds() 317
canIncreaseColspan() 413
detachFromTemplate() 279
getShowDivBoxModel() 317
canIncreaseRowspan() 413
doDeferredTableUpdate() 358
getShowDivOutlines() 318
canInsertTableColumns() 413
doesColumnHaveSpacer() 340
getShowFrameBorders() 142
canInsertTableRows() 414
doesGroupHaveSpacers() 341
getShowGrid() 143
canMakeNewEditableRegion()
414
editAttribute() 374
getShowHeadView() 143
endOfDocument() 125
getShowHiddenCharacters() 178
canMarkSelectionAsEditable()
414
endOfLine() 126
getShowImageMaps() 143
exitBlock() 375
getShowInvalidHTML() 143
expandAllCodeFragments() 174
getShowInvisibleElements() 144
canRedo() 415
expandSelectedCodeFragments()
175
getShowLayerBorders() 144
canRemoveEditableRegion() 415
forceToolbarUpdate() 158
canSelectTable() 416
getShowLayoutView() 341
formatRange() 390
canSetLinkHref() 416
getShowLineNumbers() 144
formatSelection() 391
canShowListPropertiesDialog()
416
getShowNoscript() 391
getAttachedTemplate() 279
getShowRulers() 144
getAutoValidationCount() 391
getShowSyntaxColoring() 145
getBehavior() 267
getShowTableBorders() 145
canMergeTableCells() 415
canPlayPlugin() 415
canSplitFrame() 416
canSplitTableCell() 417
getShowLayoutTableTabs() 341
getBlockElements() 292
getShowTableWidths() 358
getCharSet() 375
getShowToolbar() 145
getClickedHeaderColumn() 341
getShowToolbarIconLabels() 159
getDefaultAssetFolder() 290
getShowTracingImage() 146
getEditableRegionList() 279
getShowWordWrap() 146
getEditNoFramesContent() 141
getSnapToGrid() 146
getElementView() 316
getTableExtent() 358
getFocus() 163
getTagSelectorTag() 404
getFontMarkup() 375
getTextAlignment() 377
getFrameNames() 330
getTextFormat() 377
getHeaderElements() 294
getToolbarIdArray() 159
getHideAllVisualAids() 141
getToolbarItemValue() 159
getInlineElements() 293
getToolbarLabel() 160
collapseSelectedCodeFragmentInv
erse() 174
getIsLibraryDocument() 279
getToolbarVisibility() 160
getIsTemplateDocument() 280
getTracingImageOpacity() 335
convertActiveContent() 122
getIsXHTMLDocument() 219
getView() 164
convertLayersToTable() 215
getLineFromOffset() 375
getWindowTitle() 164
convertNextActiveContent() 122
getLinkHref() 376
guidesColor() 352
convertTablesToLayers() 216
getLinkTarget() 376
guidesDistanceColor() 352
convertToXHTML() 218
getListElements() 294
guidesLocked 353
convertWidthsToPercent() 356
getListTag() 376
guidesSnapToElements 353
convertWidthsToPixels() 356
getMinDisplayWidth() 292
guidesVisible 354
canStopPlugin() 417
canUndo() 417
checkSpelling() 231
checkTargetBrowsers() 231
cleanupXHTML() 218
clearGuides() 350
clipCopy() 274
clipCopyText() 274
clipCut() 274
clipPaste() 275
clipPasteText() 275
collapseSelectedCodeFragment()
173
448
INDEX
hasCharacterMarkup() 377
removeSpacerFromColumn() 343
setShowFrameBorders() 147
hasGuides 354
resetAllElementViews() 318
setShowGrid() 148
hasHorizontalGuide() 354
resizeSelection() 381
setShowHeadView() 148
hasTracingImage() 418
resizeSelectionBy() 333
setShowHiddenCharacters() 179
hasVerticalGuide() 355
runTranslator() 252
setShowImageMaps() 149
hideInfoMessagePopup() 232
runValidation() 232
setShowInvalidHTML() 148
increaseColspan() 359
saveAllFrames() 331
setShowInvisibleElements() 149
increaseRowspan() 359
selectAll() 245
setShowLayerBorders() 149
indent() 378
selectChild() 388
setShowLayoutTableTabs() 346
insertFiles() 103
selectParent() 389
setShowLayoutView() 347
insertFlashElement() 38, 120
selectTable() 361
setShowLineNumbers() 150
insertHTML() 378
setShowNoscript() 392
insertLibraryItem() 280
serverModel.getAppURLPrefix()
307
insertObject() 378
serverModel.getDelimiters() 307
setShowSyntaxColoring() 150
insertTableColumns() 359
serverModel.getDisplayName()
308
setShowTableBorders() 150
serverModel.getFolderName()
308
setShowToolbar() 151
insertTableRows() 360
insertText() 379
setShowRulers() 150
setShowTableWidths() 362
serverModel.getServerExtension()
308
setShowToolbarIconLabels() 161
setShowWordWrap() 151
isSelectionValid() 392
serverModel.getServerIncludeUrl
Patterns() 309
loadTracingImage() 335
serverModel.getServerInfo() 310
setTableCellTag() 362
makeCellWidthsConsistent() 342
serverModel.getServerLanguage()
- déconseillé 310
setTableColumns() 362
isColumnAutostretch() 342
isDesignViewUpdated() 392
isDocumentInFrame() 331
makeSizesEqual() 333
markSelectionAsEditable() 281
mergeTableCells() 360
serverModel.getServerName()
311
setShowTracingImage() 151
setSnapToGrid() 152
setTableRows() 363
setTextAlignment() 383
serverModel.getServerSupportsCh
arset() 311
setTextFieldKind() 384
setToolbarItemAttribute() 161
newEditableRegion() 281
serverModel.getServerVersion()
312
nextParagraph() 126
serverModel.testAppServer() 312
setToolbarVisibility() 162
nextWord() 126
setAttributeWithErrorChecking()
382
setTracingImageOpacity() 337
moveSelectionBy() 333
newBlock() 379
nodeToOffsets() 244
notifyFlashObjectChanged() 380
offsetsToNode() 244
outdent() 380
pageDown() 127
pageUp() 127
playAllPlugins() 335
playPlugin() 336
previousParagraph() 127
previousWord() 128
reapplyBehaviors() 267
redo() 113
removeAllSpacers() 342
removeAllTableHeights() 360
removeAllTableWidths() 361
removeBehavior() 267
removeCharacterMarkup() 380
removeColumnWidth() 361
removeCSSStyle() 318
removeEditableRegion() 281
removeFontMarkup() 381
removeLink() 381
setColumnAutostretch() 343
setEditNoFramesContent() 146
setElementView() 319
setHideAllVisualAids() 147
setTextFormat() 384
setToolbarPosition() 162
setTracingImagePosition() 337
setView() 164
showFontColorDialog() 384
showInfoMessagePopup() 234
setLayerTag() 334
showInsertTableRowsOrColumns
Dialog() 363
setLinkHref() 382
showListPropertiesDialog() 383
setLinkTarget() 382
showPagePropertiesDialog() 234
setListBoxKind() 383
snapToGuides() 355
setListTag() 383
setPreventLayerOverlaps() 147
snapTracingImageToSelection()
337
setRulerOrigin() 336
source.applyComment() 179
setRulerUnits() 336
source.arrowDown() 393
setSelectedNode() 245
source.arrowLeft() 393
setSelection() 245
source.arrowRight() 393
setShowBlockBackgrounds() 345
source.arrowUp() 394
setShowBlockBorders() 345
setShowBlockIDs() 346
source.balanceBracesTextView()
394
setShowBoxModel() 346
source.endOfDocument() 394
setShowDivBackgrounds() 319
source.endOfLine() 395
setShowDivBoxModel() 320
source.endPage() 395
setShowDivOutlines() 320
source.getCurrentLines() 395
source.getLineFromOffset() 396
449
INDEX
behaviorInspector.setSelectedBeha
vior() 273
source.getSelection() 396
placement 82
source.getText() 396
suppression 13, 82
source.getValidationErrorsForOff
set() 396
système de commande source 80,
81
bringAttentionToFloater() 164
test d'existence 83
browseForFileURL() 219
source.indentTextView() 397
browseDocument() 97
source.insert() 397
dossiers transmis, fichiers dans 81
browseForFolderURL() 220
source.nextWord() 398
doURLDecoding() 235
canClipCopy() 418
source.outdentTextView() 398
doURLEncoding() 249
canClipCut() 419
source.pageDown() 398
Dreamweaver
canClipPaste() 419
source.pageUp() 399
affichage au premier plan 31
canExportCSS() - déconseillé 420
source.previousWord() 399
quitter 106
canExportTemplateDataAsXML()
420
source.refreshVariableCodeHints(
) 180
dreamweaver
activateApp() 104
canFindNext() 420
source.removeComment() 180
activeViewScale() 347
canOpenInFrame() 421
source.replaceRange() 400
arrangeFloatingPalettes() 338
canPlayRecordedCommand() 421
source.scrollEndFile() 400
assetPalette.addToFavoritesFrom
Document() 257
canPopupEditTagDialog() 422
assetPalette.addToFavoritesFromS
iteAssets() 258
canRevertDocument() 422
assetPalette.addToFavoritesFromS
iteWindow() 258
canSaveDocument() 423
source.scrollLineDown() 400
source.scrollLineUp() 401
source.scrollPageDown() 401
source.scrollPageUp() 401
source.scrollTopFile() 401
canRedo() 422
canSaveAll() 423
assetPalette.canEdit() 418
canSaveDocumentAsTemplate()
423
source.setCurrentLine() 402
assetPalette.canInsertOrApply()
418
canSaveFrameset() 423
source.startOfDocument() 402
assetPalette.copyToSite() 258
source.startOfLine() 403
assetPalette.edit() 259
source.topPage() 403
assetPalette.getSelectedCategory()
259
source.selectParentTag() 402
source.wrapSelection() 404
canSaveFramesetAs() 424
canSelectAll() 424
canShowFindDialog() 424
canUndo() 425
cascade() 165
splitTableCell() 363
assetPalette.getSelectedItems()
259
startOfDocument() 128
assetPalette.getSelectedView() 260
clipCut() 276
startOfLine() 128
assetPalette.insertOrApply() 260
clipPaste() 277
stopAllPlugins() 338
assetPalette.locateInSite() 260
closeDocument() 220
stopPlugin() 338
assetPalette.newAsset() 261
codeHints.addFunction() 367
stripTag() 389
assetPalette.newFolder() 261
codeHints.addMenu() 366
synchronizeDocument() 404
assetPalette.recreateLibraryFrom
Document() 261
codeHints.resetMenu() 367
assetPalette.refreshSiteAssets()
262
compareFiles() 185
DOM, acquisition 223
assetPalette.removeFromFavorites
() 262
createResultsWindow() 135
Données dynamiques, boîte de
dialogue 106
assetPalette.renameNickname()
262
createXHTMLDocument() 221
Dossier Configuration/Temp 14, 15,
16
assetPalette.setSelectedCategory()
262
cssRuleTracker.canEditSelectedRu
le() 425
dossier racine local 241
assetPalette.setSelectedView() 263
dossiers
beep() 105, 107, 184, 185, 212
cssRuleTracker.editSelectedRule()
320
splitFrame() 331
undo() 114
updateCurrentPage() 282
wrapTag() 389
_mmServerScripts 13
acquisition des attributs 7
archivage 86
archivage et extraction de systèmes
de commande source 86
configuration 5
Configuration/Temp 14, 15, 16
contenu de 10
création 6, 82
behaviorInspector.getBehaviorAt(
) 270
behaviorInspector.getBehaviorCo
unt() 271
behaviorInspector.getSelectedBeh
avior() 271
behaviorInspector.moveBehavior
Down() 272
behaviorInspector.moveBehavior
Up() 272
clipCopy() 276
codeHints.showCodeHints() 368
createDocument() 221
createXMLDocument() 222
cssRuleTracker.newRule() 321
cssStyle.canEditSelectedStyle()
427
cssStylePalette.applySelectedStyle(
) 321
cssStylePalette.canApplySelectedSt
yle() 426
cssStylePalette.canDeleteSelectedS
tyle() 426
450
INDEX
cssStylePalette.canDuplicateSelect
edStyle() 426
getDocumentList() 165
cssStylePalette.canEditStyleSheet()
427
getElementRef() 235
cssStylePalette.deleteSelectedStyle(
) 322
getExtDataValue() 299
getDocumentPath() 241
getExtDataArray() 300
cssStylePalette.duplicateSelectedSt
yle() 322
getExtensionEditorList() 98
cssStylePalette.editSelectedStyle()
323
getExtGroups() 300
cssStylePalette.editSelectedStyleIn
Codeview() 323
getFlashPath() 99
cssStylePalette.editStyleSheet()
323
getFocus() 167
cssStylePalette.getDisplayStyles()
324
getExternalTextEditor() 99
getExtParticipants() 300
getFloaterVisibility() 166
getFontList() 385
getFontStyles() 386
cssStylePalette.getMediaType()
324
getHideAllFloaters() 152
cssStylePalette.getSelectedStyle()
324
getLiveDataInitTags() 301
cssStylePalette.getSelectedTarget()
325
getLiveDataParameters () 302
cssStylePalette.getStyles() 325
cssStylePalette.newStyle() 326
cssStylePalette.setDisplayStyles()
327
getKeyState() 386
getLiveDataMode() 301
getMenuNeedsUpdating() 129
getNaturalSize() 387
getNewDocumentDOM() 224
getObjectRefs() 236
historyPalette.saveAsCommand()
119
historyPalette.setSelectedSteps()
120
historyPalette.setUndoState() 120
htmlInspector.collapseFullTag()
175
htmlInspector.collapseSelectedCo
deFragment() 176
htmlInspector.collapseSelectedCo
deFragmentInverse() 177
htmlInspector.expandAllCodeFra
gments() 177
htmlInspector.expandSelectedCod
eFragments() 177
htmlInspector.getShowAutoInden
t() 152
htmlInspector.getShowHiddenCh
aracters() 181
htmlInspector.getShowHighlightI
nvalidHTML() 153
htmlInspector.getShowLineNumb
ers() 153
htmlInspector.getShowSyntaxCol
oring() 153
htmlInspector.getShowWordWra
p() 153
cssStylePalette.setMediaType()
327
getObjectTags() 237
dbi.getDataSources() 298
getPreferenceInt() 238
deleteSelection() 385
getPreferenceString() 238
doURLDecoding() 235
getPrimaryBrowser() 100
doURLEncoding() 249
getPrimaryExtensionEditor() 100
editCommandList() 216
getPrimaryView() 167
editFontList() 385
getRecentFileList() 225
editLockedRegions() 252
getRedoText() 114
exportCSS() - déconseillé 222
getSecondaryBrowser() 100
exportEditableRegionsAsXML() déconseillé 223
getSelection() 246
exportTemplateDataAsXML()
223
getShowDialogsOnInsert() 105
htmlStylePalette.canEditSelection(
) 428
getShowStatusBar() 152
importXMLIntoTemplate() 225
getSiteRoot() 241
isRecording() 428
getSnapDistance() 168
isReporting() 183
getSystemFontList() 387
latin1ToNative() 250
getTempFolderPath() 242
libraryPalette.deleteSelectedItem()
263
findNext() 369
fitAll() 348
fitSelection 348
fitWidth() 348
getActiveWindow() 165
getBehaviorElement() 268
getBehaviorEvent() 269
getBehaviorTag() 269
getBlockVisBoxModelColors()
328
getParticipants() 305
getServerModels() 312
getTokens() 249
getTranslatorList() 253
getUndoText() 114
historyPalette.clearSteps() 116
historyPalette.copySteps() 117
htmlInspector.setShowAutoInden
t() 154
htmlInspector.setShowHiddenCh
aracters() 181
htmlInspector.setShowHighightIn
validHTML() 154
htmlInspector.setShowLineNumb
ers() 154
htmlInspector.setShowSyntaxColo
ring() 155
htmlInspector.setShowWordWra
p() 155
libraryPalette.getSelectedItem()
263
libraryPalette.newFromDocument
() 264
libraryPalette.recreateFromDocu
ment() 264
getBlockVisOutlineProperties()
328
historyPalette.getSelectedSteps()
117
getBrowserList() 98
historyPalette.getStepCount() 118
libraryPalette.renameSelectedItem
() 264
getClipboardText() 277
historyPalette.getStepsAsJavaScrip
t() 118
liveDataTranslate() 303
getConfigurationPath() 240
getDivBackgroundColors() 329
getDocumentDOM() 223
historyPalette.getUndoState() 118
historyPalette.replaySteps() 119
loadSitesFromPrefs() 185
mapKeyCodeToChar() 129
minimizeRestoreAll() 168
451
INDEX
nativeToLatin1() 250
resultsPalette.clear() 132
showPreferencesDialog() 107
newDocument() 225
resultsPalette.Copy() 132
showProperties() 170
newFromTemplate() 226
resultsPalette.cut() 133
showQuickTagEditor() 390
nodeExists() 246
resultsPalette.debugWindow.add
DebugContextData() 140
showReportsDialog() 183
resultsPalette.openInBrowser()
133
showTagChooser() 108, 405
nodeToOffsets() 247
notifyMenuUpdated() 129
objectPalette.getMenuDefault()
121
resultsPalette.openInEditor() 134
showResults() 131
showTagLibraryEditor() 406
showTargetBrowsersDialog() 240
objectPalette.setMenuDefault()
121
resultsPalette.paste() 133
objet behaviorInspector 266
resultsPalette.selectAll() 134
objet cssStylePalette 313
objet historyPalette 113
resultsPalette.siteReports.addResu
ltItem() 131
objet libraryPalette 278
revealDocument() 104
siteSyncDialog.markPut() 187
objet templatePalette 278
revertDocument() 228
siteSyncDialog.markSynced() 188
offsetsToNode() 247
runCommand() 217
openDocument() 226
saveAll() 228
siteSyncDialog.toggleShowAllFiles
() 188
openDocumentFromSite() 227
saveDocument() 229
openInFrame() 227
saveDocumentAs() 229
snippetPalette.getCurrentSnippet
Path() 283
openWithApp() 102
saveDocumentAsTemplate() 230
snippetPalette.insert() 284
openWithBrowseDialog() 102
saveFrameset() 230
snippetPalette.insertSnippet() 285
openWithExternalTextEditor()
102
saveFramesetAs() 230
snippetPalette.newFolder() 283
saveSitesToPrefs() 186
snippetPalette.newSnippet() 284
openWithImageEditor() 103
scanSourceString() 250
snippetPalette.remove() 285
playRecordedCommand() 115
selectAll() 248
snippetPalette.rename() 285
popupAction() 270
serverBehaviorInspector.getServer
Behaviors() 306
startRecording() 115
popupCommand() 216
popupEditTagDialog() 405
popupInsertTagDialog() 405
popupServerBehavior() 306
resultsPalette.save() 134
serverComponents.getSelectedNo
de() 297
serverComponents.refresh() 297
siteSyncDialog.compare() 186
siteSyncDialog.markDelete() 186
siteSyncDialog.markGet() 187
siteSyncDialog.markIgnore() 187
snippetPalette.editSnippet() 284
stopRecording() 116
stylePalette.attachExternalStyleshe
et() 321
setActiveWindow() 168
tagLibrary.getImportedTagList()
407
printDocument() 104
setBlockVisOutlineProperties()
329
quitApplication() 106
tagLibrary.getSelectedLibrary()
406
setDivBackgroundColors() 330
redo() 115
tagLibrary.getSelectedTag() 407
setFloaterVisibility() 169
referencePalette.getFontSize() 265
setHideAllFloaters() 155
tagLibrary.getTagLibraryDOM()
406
referencePalette.setFontSize() 265
setLiveDataError() 303
refreshExtData() 301
setLiveDataMode() 304
relativeToAbsoluteURL() 242
setLiveDataParameters() 304
releaseDocument() 228
setPreferenceInt() 239
reloadCodeColoring() 368
setPreferenceString() 239
reloadMenus() 130
setPrimaryView() 170
reloadObjects() 122
setShowStatusBar() 155
templatePalette.renameSelectedTe
mplate() 266
replace() 369
setSnapDistance() 170
tileHorizontally() 171
replaceAll() 370
setUpComplexFind() 370
tileVertically() 171
resultsPalette.canClear() 429
setUpComplexFindReplace() 370
toggleFloater() 171
resultsPalette.canCopy() 429
setUpFind() 371
undo() 116
resultsPalette.canCut() 429
setUpFindReplace() 372
updatePages() 282
resultsPalette.canOpenInBrowser(
) 430
showAboutBox() 106
updateReference() 172
resultsPalette.canOpenInEditor()
430
showDynamicData() 106
useTranslatedSource() 253
showFindDialog() 373
validateFlash() 103
resultsPalette.canPaste() 429
showFindReplaceDialog() 373
zoomIn() 349
resultsPalette.canSave() 430
showGridSettingsDialog() 339
resultsPalette.canSelectAll() 431
showLiveDataDialog() 305
PrintCode() 387
tagLibrary.importDTDOrSchema(
) 407
templatePalette.deleteSelectedTem
plate() 265
templatePalette.getSelectedTempl
ate() 265
zoomOut() 349
DSN ODBC 47, 48
452
INDEX
DSN, ODBC 47, 48
isBlockElement() 295
étendue de lignes, diminution 357
duplicateSelectedStyle() 322
isHeaderElement() 296
événements, JavaBeans 74
duplication de styles 322
isInlineElement() 295
execJsInFireworks() 32
durée
isListElement() 296
existence, connexions aux bases de
données 49
date de modification du fichier 7
element
getTranslatedAttribute() 286
exists() 6
getTranslatedClassName 287
exitBlock() 375
browseInBridge() 111
removeTranslatedAttribute() 286
expandAllCodeFragments() 174, 177
dbi.setExpanded() 299
setTranslatedAttribute() 287
expandSelectedCodeFragments()
175, 177
heure de création du fichier 8
dw
getFilesForLayout() 315
getLayoutDescriptions() 315
getLayoutNames() 315
registerIdleHandler() 108
revokeIdleHandler() 109
DWfile, DLL 5
DWfile.copy() 5
DWfile.createFolder() 6
DWfile.exists() 6
DWfile.getAttributes() 7
DWfile.getCreationDate() 8
DWfile.getCreationDateObj() 9
DWfile.getModificationDate() 7
DWfile.getModificationDateObj() 9
DWfile.getSize() 9
DWfile.listFolder() 10
DWfile.read() 10
DWfile.remove() 11
DWfile.setAttributes() 11
DWfile.write() 12
translatedStyle 287
élément sélectionné du document
actif 163
éléments de bibliothèque et modèles,
fonctions 278
éléments de menu
échelle de l'affichage 347
editAttribute() 374
exportEditableRegionsAsXML() déconseillé 223
exportSite() 194
exportTemplateDataAsXML() 223
Annuler 116
Extension Data Manager 299
Annuler l'extraction 93
extraction de fichiers 86
Archiver 93
annulation 87
Nouveau _dossier 93
nombres 87
Renommer 94
Répéter 116
F
Supprimer 94
Fenêtre Résultats
éléments de plug-in, lecture 336
ajout 135
éléments Flash, insertion 37, 120
ajout d'entrée de résultats 131
endOfDocument() 125, 394
appel de la fonction processFile()
processFile() 137
endOfLine() 126, 395
endPage() 395
enregistrement
arrêter 116
Design Notes, fichiers 19
documents 228, 229
E
exportCSS() - déconseillé 222
étapes 115
étapes de l'historique 119
création 135
définir les boutons 137
définition de l'élément sélectionné
138
extraction d'un tableau d'éléments
136
extraction du nombre d'éléments
136
editColumns() 194
environnement de mise en forme,
fonctions 334
extraire l'index de l'élément
sélectionné 136
editCommandList() 216
envoi
fonctions 130
éditeur d'image 103
éditeur de texte externe 99, 102
données 17
largeurs de colonne 137
texte 18
titre 138
éditeur de texte, externe 99
envoi HTTP 17, 18
éditeurs, listes des 98
editFontList() 385
équivalent JavaScript, étapes de
l'historique 118
editLockedRegions() 252
errata 4
editSelectedRule() 320
espacements
traitement des fichiers 138, 139
fenêtres
en cascade 165
réduction 168
fenêtres de document en cascade 165
editSelectedStyle() 323
création 339
fenêtres, fonctions 163
editSnippet() 284
suppression 342
fermeture
editStyleSheet() 323
effacement du panneau Historique
116
elem
étapes
dans le panneau Historique 118
enregistrement 119
étapes de l'historique
getBlockElements() 292
copie 117
getComputedStyleProp() 290
équivalent JavaScript 118
getHeaderElements() 294
reproduction 119
getInlineElements() 293
sélection 120
getListElements() 294
étendue de colonnes, diminution 356
Design Notes, fichiers 19, 24
documents 220
feuilles de style 321
feuilles de style en cascade en balises
HTML, conversion 215
fichier de définition, pour type de
connexion 70
fichier EDML, fonctions 299
fichier menus.xml 130
453
INDEX
fichiers
fichiers XML
manipulations de chaîne 249
acquisition de contenu 16, 17
création 222
menu 129
acquisition des attributs 7
fragments de code 283
Mise en forme CSS 313
Aide 101
importation 225
mode Code 390
annulation de l'extraction 87
archivage 86, 96
attributs 11
changement de nom 83
comparer 185
connection_includefile.edml 70
copie 5
création (fichiers HTML) 221
création (fichiers non-HTML) 12
création (fichiers XHTML) 221
création (fichiers XML) 222
dans les dossiers transmis 81
date de modification 7
écriture 12
écriture des chaînes dans 12
éditeur principal 100
enregistrement 15, 16
extraction 86
extraits 88
Fenêtre Résultats 138
fichiers, définition de type de
connexion de bases de données
70
FilePathToLocalURL() 24
findConnection() 67
mode Mise en forme 339
Modèle de serveur 307
modification de tableaux 356
modification générale 373
findLinkSource() 196
nouvelles fonctions de
Dreamweaver CS3 2
findNext() 369
panneau Actifs 257
Fireworks
path 240
affichage au premier plan 31
presse-papiers 274
exécution de JavaScript 32
quick tag editor 388
session d'optimisation 33
rapport 183
transmission de JavaScript à 32
recherche/remplacement 369
version 34
réduction du code 172
fitall() 348
repère 350
fitSelection() 348
sélection 243
fitWidth() 348
serveur, comportement 305
Flash MX, définition de version 103
site 184
Flash, chemin vers 99
source de données 298
fonction d'activateur, présentation
409
fragments de code 283
fonctionnalités, systèmes de
commande source 85
heure de création 8
fonctions
supprimées dans CS3 4
toolbar 158
translation 252
transmission du contenu des
fichiers 17
inclus, générés 69
activateur 409
lecture 10
application externe 97
vérification de la compatibilité
avec les navigateurs 290
lecture du contenu dans une
chaîne 10
application globale 105
widgets Spry
nombre extrait 87
basculer 141
ouverture dans l'application
spécifiée 102
bibliothèque et modèles 278
ouverture dans l'éditeur d'image
spécifié 103
cadres et jeux de cadres, 330
barre d'outils du mode Code 178
bibliothèques de balises 404
insertion 288
modification 286
window 163
XSLT 253
zoom 347
placement 82, 96
calques et cartes graphiques 332
récents 225
code 365
suppression 11, 14, 82
command 216
systèmes de commande source 81
comportement 266
fonctions de l'éditeur de balises et de
la bibliothèque de balises 404
taille de 9
composants de serveur 297
fonctions de repère 350
test d'existence 6, 83
conversion 215
traitement 139
document global 231
fonctions de vérification de la
compatibilité avec les
navigateurs 290
fichiers accessibles en écriture 11
éditeur de balises 404
fichiers d'aide, ouverture 101
environnement de mise en forme
334
fichiers de configuration 5
fichiers de configuration de
l'utilisateur 5
fonctions de communication avec
Bridge 109
fonctions du panneau Actifs (palette)
257
Extension Data Manager 299
Fonctions du panneau Fragments de
code 282
fenêtre de résultats 130
fonctions relatives aux applications
fichiers distants 91
fragments de code, panneau 282
communication avec Bridge 109
fichiers en lecture seule 11
historique 113
externes 97
fichiers inclus
impression 387
globales 105
définition de type de connexion 70
insertion d'objets 120
fonctions relatives aux rapports 183
inclus générés 69
keyboard 123
fonctions relatives aux zooms 347
fichiers masqués 11
Live Data 301
fonctions supprimées 4
fichiers visibles 11
manipulation de fichiers 217
dreamweaver.canExportCSS() 420
454
INDEX
dreamweaver.exportCSS() 222
getColdFusionDsnList() 43
getImportedTagList() 407
dreamweaver.exportEditableRegio
nsAsXML() 223
getColumnAndTypeList() 54
getInlineElements() 293
getColumnList() 54
getIsLibraryDocument() 279
dreamweaver.libraryPalette.recrea
teFromDocument() 264
getColumns() 55
getIsTemplateDocument() 280
dreamweaver.libraryPalette.renam
eSelectedItem() 264
getColumnsOfTable() 56
getIsXHTMLDocument() 219
getComputedStyleProp() 290
getItem() 130, 136
forceToolbarUpdate() 158
getConfigurationPath() 240
getItemCount() 130, 136
formatRange() 390
getConnection() 43
getJsResponse() 32
formatSelection() 391
getConnectionList() 44
getKeyState() 386
formulaires, envoi 17, 18
getConnectionName() 45
getLayoutDescriptions() 315
fractionnement de cadres 331
getConnectionState() 199
getLayoutNames() 315
FTP, connexion 130
getConnectionString() 45
getLineFromOffset() 375, 396
FWLaunch.bringDWToFront() 31
getCreationDate() 8
getLinkHref() 376
FWLaunch.bringFWToFront() 31
getCreationDateObj() 9
getLinkTarget() 376
FWLaunch.execJsInFireworks() 32
getCurrentLines() 395
getLinkVisibility() 200
FWLaunch.getJsResponse() 32
getCurrentSite() 199
getListElements() 294
FWLaunch.mayLaunchFireworks()
33
getDataSources() 298
getListTag() 376
getDeclaredStyle() 291
getLiveDataInitTags() 301
FWLaunch.optimizeInFireworks()
33
getDefaultAssetFolder() 290
getLiveDataMode() 301
getDelimiters() 307
getLiveDataParameters () 302
FWLaunch.validateFireworks() 34
getDisplayName() 308
getLocalDsnList() 47
getDivBackgroundColors() 329
getLocalPathToFiles() 200
G
getDocumentDOM() 223
getMediaType() 324
génération de fichiers Objet Flash 38
getDocumentList() 165
getMenuDefault() 121
Gestionnaire de connexions 44, 50,
51
getDocumentPath() 241
getMenuNeedsUpdating() 129
getDriverName() 46
getMethods() 75
getDriverUrlTemplateList() 46
getMinDisplayWidth() 292
getDynamicBindings() 42
getModificationDate() 7
getEditableRegionList() 279
getModificationDateObj() 9
getEditNoFramesContent() 141
getNaturalSize() 387
getElementRef() 235
getNewDocumentDOM() 224
getErrorMessage() 76
GetNote() 24
getEvents() 74
GetNoteLength() 25
getExtDataArray() 300
GetNotesKeyCount() 25
getExtDataValue() 299
GetNotesKeys() 26
getExtensionEditorList() 98
getObjectRefs() 236
getExternalTextEditor() 99
getObjectTags() 237
getExtGroups() 300
getOpenpathName() 178
getExtParticipants() 300
getParseMode() 232
getFile() 15
getParticipants() 305
getFileCallback() 16
getPassword() 47
getFilesForLayout() 315
getPreferenceInt() 238
getFlashPath() 99
getPreferenceString() 238
getFloaterVisibility() 166
getPreventLayerOverlaps() 142
getFocus() 163, 167, 199
getPrimaryBrowser() 100
getFolderName() 308
getPrimaryExtensionEditor() 100
getFontList() 385
getPrimaryKeys() 56
getFontMarkup() 375
getPrimaryView() 167
getFontStyles() 386
getProcedures() 57
getFrameNames() 330
getProperties() 73
getHeaderElements() 294
getRdsPassword() 47
getHideAllFloaters() 152
getRdsUserName() 48
getHideAllVisualAids() 141
getRecentFileList() 225
get() 196
getActiveWindow() 165
getAppServerAccessType() 196
getAppServerPathToFiles() 197
getAppURLPrefix() 307
getAppURLPrefixForSite() 197
getAttachedTemplate() 279
getAttributes() 7
getAutoValidationCount() 391
getBehavior() 267
getBehaviorAt() 270
getBehaviorCount() 271
getBehaviorElement() 268
getBehaviorEvent() 269
getBehaviorTag() 269
getBlockElements() 292
getBlockVisBoxModelColors() 328
getBlockVisOutlineProperties() 328
getBrowserList() 98
getCharSet() 375
getCheckOutUser() 198
getCheckOutUserForFile() 198
getClasses() 73
getClassesFromPackage() 76
getClickedHeaderColumn() 341
getClipboardText() 277
getCloakingEnabled() 198
455
INDEX
getRedoText() 114
getShowTableWidths() 358
guidesColor() 352
getRemoteDsnList() 48
getShowToolbar() 145
guidesDistanceColor() 352
getRulerOrigin() 334
getShowToolbarIconLabels() 159
guidesLocked 353
getRulerUnits() 334
getShowToolTips() 157
guidesSnapToElements 353
getRuntimeConnectionType() 48
getShowTracingImage() 146
guidesVisible 354
getSecondaryBrowser() 100
getShowWordWrap() 146
getSelectedBehavior() 271
getSiteForURL() 201
H
getSelectedEditableRegion() 280
getSiteRoot() 241
hasCharacterMarkup() 377
getSelectedItem() 130, 263
GetSiteRootForFile() 26
hasConnectionWithName() 49
getSelectedLibrary() 406
getSites() 201
hasGuides() 354
getSelectedNode() 243, 297
getSize() 9
hasHorizontalGuide() 354
getSelectedSteps() 117
getSnapDistance() 168
hasTracingImage() 418
getSelectedStyle() 324
getSnapToGrid() 146
hasVerticalGuide() 355
getSelectedTag() 407
getSPColumnList() 58
hideInfoMessagePopup() 232
getSelectedTarget() 325
getSPColumnListNamedParams()
58
historique, fonctions 113
getSelectedTemplate() 265
getSelection() 200, 243, 246, 396
getSPParameters() 59
getServerBehaviors() 306
getSPParamsAsString() 60
getServerExtension() 308
getStepCount() 118
afficher code incorrect 143
getServerIncludeUrlPatterns() 309
getStepsAsJavaScript() 118
balise 334
getServerInfo() 310
getStyles() 325
connexions 68
getServerLanguage() - déconseillé
310
getSystemFontList() 387
conversion en XHTML 218
getTableExtent() 358
getServerModels() 312
getTables() 60
création de nouveaux documents
221
getServerName() 311
getTagLibraryDOM() 406
feuilles de style en cascade 215
getServerSupportsCharset() 311
getTagSelectorTag() 404
getServerVersion() 312
getTempFolderPath() 242
HTML non valide 142, 143, 154
getShowAutoIndent() 142
getText() 396
htmlInspector.collapseFullTag() 175
getShowBlockBackgrounds() 343
getTextAlignment() 377
getShowBlockBorders() 344
getTextCallback() 17
htmlInspector.collapseSelectedCode
Fragment() 176
getShowBlockIDs() 344
getTextFormat() 377
getShowBoxModel() 345
getTokens() 249
getShowDependents() 156
getToolbarIdArray() 159
getShowDialogsOnInsert() 105
getToolbarItemValue() 159
getShowFrameBorders() 142
getToolbarLabel() 160
getShowGrid() 143
getToolbarVisibility() 160
getShowHeadView() 143
getTracingImageOpacity() 335
getShowHiddenCharacters() 178,
181
getTranslatedAttribute() 286
getShowHiddenFiles() 156
getTranslatorList() 253
getShowImageMaps() 143
getUndoState() 118
getShowInvalidHTML() 143
getUndoText() 114
getShowInvisibleElements() 144
getUserName() 49
getShowLayerBorders() 144
getValidationErrorsForOffset() 396
getShowLayoutTableTabs() 341
GetVersionName() 27
getShowLayoutView() 341
GetVersionNum() 27
getShowLineNumbers() 144
getView() 164
getShowNoscript() 391
getViews() 61
getShowPageTitles() 156
getWindowTitle() 164
getShowRulers() 144
getXML() 253
getShowStatusBar() 152
getXMLSchema() 254
getShowSyntaxColoring() 145
getXMLSourceURI() 254
getShowTableBorders() 145
groupes de fichiers 94, 95
getTranslatedClassName 287
Historique, panneau 116, 117
étapes dans 118
HTML
insertion 378
htmlInspector.collapseSelectedCode
FragmentInverse() 177
htmlInspector.expandAllCodeFragm
ents( 177
htmlInspector.expandSelectedCodeF
ragments() 177
htmlInspector.getShowAutoIndent()
152
htmlInspector.getShowHiddenChara
cters() 181
htmlInspector.getShowHighlightInv
alidHTML() 153
htmlInspector.getShowLineNumbers
() 153
htmlInspector.getShowSyntaxColori
ng() 153
htmlInspector.getShowWordWrap()
153
htmlInspector.setShowAutoIndent()
154
htmlInspector.setShowHiddenChara
cters() 181
htmlInspector.setShowHighlightInva
lidHTML() 154
htmlInspector.setShowLineNumbers
() 154
456
INDEX
htmlInspector.setShowSyntaxColori
ng() 155
isRecording() 428
makeSizesEqual() 333
isReporting() 183
htmlInspector.setShowWordWrap()
155
isSelectionValid() 392
manipulations de fichiers, fonctions
217
itemInfo, structure 81
mapKeyCodeToChar() 129
markDelete() 186
I
identificateur unique 56
importDTDOrSchema() 407
J
markGet() 187
JavaBeans
markIgnore() 187
importSite() 202
importXMLIntoTemplate() 225
increaseColspan() 359
increaseRowspan() 359
indent() 378
indentTextView() 397
indicateurs, code 365
informations de connexion, RDS 49,
52
informations relatives aux
documents 223
événements 74
markSelectionAsEditable() 281
introspection des classes 74, 75
markSynced() 188
messages d'erreur 74
masquer la barre d'outils 151
méthodes 75
mayLaunchFireworks() 33
noms de classe 73
menu Commande, fonctions 216
propriétés 74, 75
menus
propriétés en écriture seule 76
Acquérir 92
propriétés en lecture seule 75
Barre Insertion 121
Connecter 91
exécution dans Fireworks 32
Extraire 92
transmission à Fireworks 32
mise à jour 129
jeux de cadres 331
enregistrement 331
insertFlashElement() 38, 120
insertHTML() 378
markPut() 187
JavaScript
insert() 284, 397
insertFiles() 103
classes 73
jeux de résultats 58, 62, 63
Placer 92
rechargement 130
menus, fonctions
Commande, menu 216
insertion
balises 108
L
chaîne dans un document 106
latin1ToNative() 250
Eléments Flash 37, 120
launchXMLSourceDialog() 255
optimisation et chargement des
menus 129
reproduction des fonctions Live
data 301
insertion d'objets, fonctions 120
lecture, fichier Objet Flash 40
mergeTableCells() 360
insertLibraryItem() 280
ligne, début de 128
message d'avertissement 105
insertObject() 378
lire
messages d'erreur 88
insertSnippet() 285
commandes mémorisées 115
JavaBeans 74
insertTableColumns() 359
contenu d'un plug-in 335
systèmes de commande source 88
insertTableRows() 360
éléments de plug-in 336
systèmes de commande source de
longueur 88
insertText() 379
liste de favoris
inspectConnection() 68
ajout à 257, 258
méthodes, JavaBeans 75
Inspecteur de code
suppression de 262
minimizeRestoreAll() 168
coloration de la syntaxe 153
listes des
mise à jour
HTML non valide 153, 154
documents ouverts 165
menus 129
numéros de ligne 153
éditeurs 98
renvoi des mots à la ligne 153, 155
fichiers récents 225
paires clé/valeur dans des fichiers
Design Notes 23
retrait automatique 154
navigateurs 98
mise en retrait 142
listFolder() 10
MMDB.deleteConnection() 42
acquisition des colonnes à partir
de 54
Live data, fonctions 301
MMDB.getColdFusionDsnList() 43
liveDataTranslate() 303
affichage des résultats 62
loadSitesFromPrefs() 185
MMDB.getColumnAndTypeList()
54
instructions SQL 62
invertSelection() 202
loadTracingImage() 335
isBlockElement() 295
LocalURLToFilePath() 27
isCloaked() 202
locateInSite() 203
isColumnAutostretch() 342
isDesignViewUpdated() 392
M
isDocumentInFrame() 331
makeCellWidthsConsistent() 342
isHeaderElement() 296
makeEditable() 203
isInlineElement() 295
makeNewDreamweaverFile() 203
isListElement() 296
makeNewFolder() 204
MMDB.getColumnList() 54
MMDB.getColumns() 55
MMDB.getColumnsOfTable() 56
MMDB.getConnection() 43
MMDB.getConnectionList() 44
MMDB.getConnectionName() 45
MMDB.getConnectionString() 45
MMDB.getDriverName() 46
MMDB.getDriverUrlTemplateList()
46
457
INDEX
MMDB.getLocalDsnList() 47
MMNotes.remove() 23
nettoyage, documents XHTML 218
MMDB.getPassword() 47
MMNotes.set() 23
newBlock() 379
MMDB.getPrimaryKeys() 56
MMXSLT.getXML() 253
newDocument() 225
MMDB.getProcedures() 57
MMXSLT.getXMLSchema() 254
newEditableRegion() 281
MMDB.getRdsPassword() 47
MMXSLT.getXMLSourceURI() 254
newFromDocument() 264
MMDB.getRdsUserName() 48
MMXSLT.launchXMLSourceDialog(
) 255
newFromTemplate() 226
mode
newRule() 321
MMDB.getRemoteDsnList() 48
MMDB.getRuntimeConnectionType
() 48
newHomePage() 204
détermination 164
newSite() 204
MMDB.getSPColumnList() 58
sélection 164
newSnippet() 284
MMDB.getSPColumnListNamedPar
ams() 58
visible 167
newStyle() 326
mode Code 164
nextParagraph() 126
MMDB.getSPParameters() 59
bascule vers 323
MMDB.getSPParamsAsString() 60
nextWord() 126, 398
coloration de la syntaxe 145
MMDB.getTables() 60
nodeExists() 246
HTML non valide 142
MMDB.getUserName() 49
nodeToOffsets() 244, 247
numéros de ligne 144, 150
MMDB.getViews() 61
renvoi des mots à la ligne 146, 151
nom de version, bibliothèque
partagée MMNotes 21, 27
retrait automatique 142
nombres, de fichiers extraits 87
MMDB.hasConnectionWithName()
49
MMDB.needToPromptForRdsInfo()
49
MMDB.needToRefreshColdFusionD
snList() 50
mode de Mise en forme, fonctions
339
noms
des colonnes 56
mode Mise en forme 341, 347
extraction 85
mode Standard 341
système de commande source 78
MMDB.popupConnection() 50
modèles de boîte, coloration 345
noms d'extraction 85
MMDB.setRdsPassword() 51
modèles et éléments de bibliothèque,
fonctions 278
noms d'utilisateur 49
MMDB.setRdsUserName() 51
MMDB.showColdFusionAdmin()
51
noms d'extraction 85
modes 61
RDS 48, 51, 52
modification des tableaux, fonctions
356
noms de classe, JavaBeans 73
mot précédent 128
noms de connexion 45
MMDB.showOdbcDialog() 52
mot suivant 126
noms de pilotes 46
MMDB.showRdsUserDialog() 52
mots de passe
noms des dossiers racines 80
MMDB.showConnectionMgrDialog(
) 51
MMDB.showRestrictDialog() 52
bases de données, connexion à 47
MMDB.showResultset() 62
bases de données, connexions à 47
MMDB.showSPResultset() 62
RDS 47, 51, 52
noms des sources de données
ColdFusion 43
noms des sources de données dans
ColdFusion 43
MMDB.showSPResultsetNamedPara
ms() 63
moveBehaviorDown() 272
_notes, dossier 19
moveBehaviorUp() 272
notifyFlashObjectChanged() 380
MMDB.testConnection() 53
moveSelectionBy() 333
notifyMenuUpdated() 129
MMHttp.clearServerScriptsFolder()
13
N
MMHttp.clearTemp() 14
name, attribut 283
MMHttp.getFile() 15
nativeToLatin1() 250
MMHttp.getFileCallback() 16
navigateur principal 100
numéro de version, bibliothèque
partagée MMNotes 22, 27
MMHttp.getTextCallback() 17
navigateur secondaire 100
numéros de ligne 144, 150, 153, 154
MMHttp.postText() 17
navigateurs
nouveaux documents 226
Nouvelles fonctions de Dreamweaver
CS3 2
MMHttp.postTextCallback() 18
cibles 130
O
MMJB.getClasses() 73
liste des 98
Objet Flash, fichier
MMJB.getClassesFromPackage() 76
ouverture d'une URL 97
MMJB.getErrorMessage() 76
principaux 100
génération 38
lecture 40
MMJB.getEvents() 74
secondaires 100
objets de connexion 43
MMJB.getMethods() 75
vérification des documents dans
231
Obtient 114
MMJB.getProperties() 73
propriétés 67
MMNotes, DLL 19
needToPromptForRdsInfo() 49
offsetsToNode() 244, 247
MMNotes, objet 19
needToRefreshColdFusionDsnList()
50
opacité, tracé de l'image 335
MMNotes.open() 22
open() 22, 205
458
INDEX
openDocument() 226
pilotes, JDBC 46
R
openDocumentFromSite() 227
placement des fichiers 82, 96
openInBrowser() 133
playAllPlugins() 335
racine du site, fichiers Design Notes
21, 26
openInEditor() 134
playPlugin() 336
rapports
openInFrame() 227
playRecordedCommand() 115
OpenNotesFile() 28
point d'insertion
dans le panneau Résultats 130
rapports du site 130
RDS
OpenNotesFilewithOpenFlags() 28
début de document 128
openWithApp() 102
début de ligne 128
informations de connexion 49, 52
openWithBrowseDialog() 102
début de paragraphe suivant 126
mots de passe 47, 51
openWithExternalTextEditor() 102
déplacement 123, 124
noms d'utilisateur 48, 51
openWithImageEditor() 103
fin de document 125
read() 10
optimizeInFireworks() 33
fin de ligne 126
reapplyBehaviors() 267
options, Afficher la boîte de dialogue
lors de l'insertion d'un objet 105
mot précédent 128
rechargement 368
mot suivant 126
objets de la barre Insertion 122
orthographe, vérification 231
paragraphe précédent 127
recherches 130
outdent() 380
une page vers le bas 127
recreateCache() 205
outdentTextView() 398
popupAction() 270
recreateFromDocument() 264
ouverture
popupCommand() 216
redo() 113, 115
Design Notes, fichiers 22, 28
popupConnection() 50
réduction des fenêtres 168
documents 225, 226
popupEditTagDialog() 405
referencePalette.getFontSize() 265
documents dans un éditeur de
texte externe 102
popupInsertTagDialog() 405
referencePalette.setFontSize() 265
popupServerBehavior() 306
refresh() 206, 297
postText() 17
refreshExtData() 301
postTextCallback() 18
refreshVariableCodeHints() 180
Préférences, boîte de dialogue 107
registerIdleHandler() 108
premier plan
règle
fichiers d'aide 101
fichiers dans l'application spécifiée
102
fichiers dans l'éditeur d'image
spécifié 103
affichage de Fireworks au 31
afficher Dreamweaver au 31
P
origine 334
units. 334
page d'insertion 127
Presse-papiers, fonctions 274
relativeToAbsoluteURL() 242
Page précédente 127
preview, attribut 283
releaseDocument() 228
Page suivante 127
previousParagraph() 127
reloadCodeColoring() 368
pageDown() 127, 398
previousWord() 128, 399
reloadMenus() 130
pageUp() 127, 399
PrintCode() 387
reloadObjects() 122
paires clé/valeur
printDocument() 104
remoteIsValid() 206
création 29
procédures nommées 59
création dans les fichiers Design
Notes 23
procédures stockées 58, 59, 62, 63
remove()
(dreamweaver.snippetPalette.re
move) 285
à propos 53
dans les fichiers Design Notes 20
remove() (DWfile.remove) 11
acquisition de paramètres pour 60
nombre de 25
remove() (MMNotes.remove) 23
acquisition des colonnes à partir
de 58
removeAllSpacers() 342
panneau de résultats
messages 132, 133
affichage des résultats 62, 63
suppression 132
paramètres 60
panneau flottant de résultats 131
procédures, connexions nommées 57
panneau flottant, fonctions 163
programme de validation, méthode
130
panneau Site, fonctions de sélection
184
removeAllTableHeights() 360
removeAllTableWidths() 361
removeBehavior() 267
removeCharacterMarkup() 380
removeColumnWidth() 361
removeComment() 180
panneaux flottants, disposition 338
propriété data des objets httpReply
13
paquets, classes JavaBeans 73
propriétés de contour 328, 329
removeEditableRegion() 281
paragraphe précédent 127
propriétés, JavaBeans 74, 75, 76
removeFontMarkup() 381
paragraphe suivant 126
put() 205
removeLink() 206, 381
paramètre, de procédures stockées
60
Q
removeSpacerFromColumn() 343
paste() 133
quitApplication() 106
removeTranslatedAttribute() 286
pilotes JDBC 46
quitter Dreamweaver 106
rename() 285
removeCSSStyle() 318
RemoveNote() 28
459
INDEX
extraction 87
renameSelectedItem() 264
SCS_GetFolderList() 81
renameSelectedTemplate() 266
retrait 154
SCS_GetFolderListLength() 80
renameSelection() 207
revealDocument() 104
SCS_GetMaxNoteLength() 89
rendu
revertDocument() 228
SCS_GetNewFeatures() 85
revokeIdleHandler() 109
SCS_GetNoteCount() 89
renvoi des mots à la ligne 151, 153,
155
runCommand() 217
SCS_GetNumCheckedOut() 87
runTranslator() 252
SCS_GetNumNewFeatures() 85
repères
runValidation() 207, 232
SCS_GetRootFolder() 80
styles 324
utilisation 350
verrouillage 353
SCS_GetRootFolderLength() 80
S
SCS_IsConnected() 79
répéter une étape 113
save() 134
SCS_IsRemoteNewer() 91
replace() 369
saveAll() 228
SCS_ItemExists() 83
replaceAll() 370
saveAllFrames() 331
SCS_NewFolder() 82
replaceRange() 400
saveAsCommand() 119
SCS_Put() 82
replaySteps() 119
saveAsImage() 207
SCS_Rename() 83
reproduction des étapes de
l'historique 119
saveDocument() 229
SCS_SetDesignNotes() 90
saveDocumentAs() 229
SCS_SiteDeleted() 84
saveDocumentAsTemplate() 230
SCS_SiteRenamed() 84
saveFrameset() 230
SCS_UndoCheckout() 87
saveFramesetAs() 230
SELECT 54
saveSitesToPrefs() 186
selectAll() 134, 208, 245, 248
scanSourceString() 250
selectChild() 388
scrollEndFile() 400
scrollLineDown() 400
Sélecteur de balises, boîte de dialogue
108
scrollLineUp() 401
selectHomePage() 208
scrollPageDown() 401
sélection 163
resizeSelection() 381
resizeSelectionBy() 333
Restreindre, boîte de dialogue 52
résultats, groupe de panneaux 130
resultsPalette.canClear() 429
resultsPalette.canCopy() 429
resultsPalette.canCut() 429
resultsPalette.canOpenInBrowser()
430
resultsPalette.canOpenInEditor()
430
scrollPageUp() 401
suppression 374
resultsPalette.canPaste() 429
scrollTopFile() 401
sélection, étapes de l'historique 120
resultsPalette.canSave() 430
SCS_AfterPut() 95, 96
sélection, fonctions
resultsPalette.canSelectAll() 431
SCS_BeforeGet() 94
resultsPalette.clear() 132
SCS_BeforePut() 95
dans les documents ouverts 243
dans le panneau Site 184
resultsPalette.Copy() 132
SCS_canCheckin() 93
selectNewer() 208, 209
resultsPalette.cut() 133
SCS_canCheckout() 92
selectParent() 389
resultsPalette.debugWindow.addDeb
ugContextData() 140
SCS_canConnect() 91
selectParentTag() 402
SCS_canDelete() 94
selectTable() 361
resultsPalette.openInBrowser() 133
SCS_canGet() 92
send() 110
resultsPalette.openInEditor() 134
SCS_canNewFolder() 93
serveur
resultsPalette.paste() 133
SCS_canPut() 92
comportements, fonctions 305
resultsPalette.save() 134
SCS_canRename() 94
débogage 139
resultsPalette.selectAll() 134
SCS_CanUndoCheckout() 93
resultsPalette.siteReports.addResultIt
em() 131
resWin.addItem() 135
resWin.addResultItem() 131
resWin.getItem() 136
resWin.setCallbackCommands()
137
resWin.setColumnWidths() 137
resWin.setFileList() 138
resWin.setTitle() 138
resWin.startProcessing() 139
resWin.stopProcessing() 139
rétablir
documents 228
fonctions de composants 297
SCS_Checkin() 86
session d'optimisation, Fireworks 33
SCS_Checkout() 86
set() 23
SCS_Connect() 79
setActiveWindow() 168
SCS_Delete() 82
setAsHomePage() 209
SCS_Disconnect() 79
setAttributes() 11
SCS_Get() 81
setAttributeWithErrorChecking()
382
SCS_GetAgentInfo() 78
SCS_GetCheckoutName() 85
SCS_GetConnectionInfo() 84
SCS_GetDesignNotes() 90
SCS_GetErrorMessage() 88
SCS_GetErrorMessageLength() 88
SCS_GetFileCheckoutList() 88
setBlockVisOutlineProperties() 329
setCallbackCommands() 137
setCloakingEnabled() 209
setColumnAutostretch() 343
setColumnWidths() 137
setConnectionState() 210
460
INDEX
setCurrentLine() 402
setShowLineNumbers() 150
showReportsDialog() 183
setCurrentSite() 210
setShowNoscript() 392
showRestrictDialog() 52
setDivBackgroundColors() 330
setShowPageTitles() 157
showResults() 131
setEditNoFramesContent() 146
setShowRulers() 150
showResultset() 62
setExpanded() 299
setShowStatusBar() 155
showSPResultset() 62
setFileList() 138
setShowSyntaxColoring() 150
showSPResultsetNamedParams() 63
setFloaterVisibility() 169
setShowTableBorders() 150
showTagChooser() 108, 405
setFocus() 210
setShowTableWidths() 362
showTagLibraryEditor() 406
setHideAllFloaters() 155
setShowToolbar() 151
showTargetBrowsersDialog() 240
setHideAllVisualAids() 147
setShowToolbarIconLabels() 161
site
setLayerTag() 334
setShowToolTips() 158
addLinkToExistingFile() 188
setLayout() 211
setShowTracingImage() 151
addLinkToNewFile() 189
setLinkHref() 382
setShowWordWrap() 151
browseDocument() 433
setLinkTarget() 382
setSnapDistance() 170
canAddLinkToFile() 433
setLinkVisibility() 211
setSnapToGrid() 152
canChangeLink() 434
setListBoxKind() 383
setTableCellTag() 362
canCheckIn() 434
setListTag() 383
setTableColumns() 362
canCheckOut() 434
setLiveDataError() 303
setTableRows() 363
canCloak() 435
setLiveDataMode() 304
setTextAlignment() 383
canConnect() 435
setLiveDataParameters() 304
setTextFieldKind() 384
canDisplaySyncInfoForFile() 436
setMediaType() 327
setTextFormat() 384
canEditColumns() 412
setMenuDefault() 121
setTitle() 138
canFindLinkSource() 436
SetNote() 29
setToolbarItemAttribute() 161
canGet() 436
setPreferenceInt() 239
setToolbarPosition() 162
canLocateInSite() 437
setPreferenceString() 239
setToolbarVisibility() 162
canMakeEditable() 437
setPreventLayerOverlaps() 147
setTracingImageOpacity() 337
canMakeNewFileOrFolder() 437
setPrimaryView() 170
setTracingImagePosition() 337
canOpen() 438
setRdsPassword() 51
setTranslatedAttribute() 287
canPut() 438
setRdsUserName() 51
setUndoState() 120
canRecreateCache() 438
setRulerOrigin() 336
setUpComplexFind() 370
canRefresh() 439
setRulerUnits() 336
setUpComplexFindReplace() 370
canRemoveLink() 439
setSelectedBehavior() 273
setUpFind() 371
setSelectedItem() 130
setUpFindReplace() 372
canSelectAllCheckedOutFiles()
439
setSelectedNode() 245
setView() 164
canSelectNewer() 440
setSelectedSteps() 120
showAboutBox() 106
canSetLayout() 439
setSelection() 211, 245, 248
showColdFusionAdmin() 51
canSynchronize() 440
setShowBlockBackgrounds() 345
showConnectionMgrDialog() 51
canUncloak() 440
setShowBlockBorders() 345
showDynamicData() 106
canUndoCheckOut() 441
setShowBlockIDs() 346
showFindDialog() 373
canViewAsRoot() 441
setShowBoxModel() 346
showFindReplaceDialog() 373
changeLink() 189
setShowDependents() 157
showFontColorDialog() 384
changeLinkSitewide() 189
setShowFrameBorders() 147
showGridSettingsDialog() 339
checkIn() 190
setShowGrid() 148
showInfoMessagePopup() 234
checkLinks() 190
setShowHeadView() 148
showInsertTableRowsOrColumnsDi
alog() 363
checkOut() 191
showListPropertiesDialog() 383
cloak() 191, 192
setShowHiddenFiles() 157
showLiveDataDialog() 305
defineSites() 192
setShowImageMaps() 149
showOdbcDialog() 52
deleteSelection() 192
setShowInvalidHTML() 148
showPagePropertiesDialog() 234
setShowInvisibleElements() 149
showPreferencesDialog() 107
deployFilesToTestingServerBin()
193
setShowLayerBorders() 149
showProperties() 170
displaySyncInfoForFile() 193
setShowLayoutTableTabs() 346
showQuickTagEditor() 390
editColumns() 194
setShowLayoutView() 347
showRdsUserDialog() 52
exportSite() 194
setShowHiddenCharacters() 179,
181
checkTargetBrowsers() 191
461
INDEX
styles
findLinkSource() 196
synchronize() 212
get() 196
uncloak() 212
acquisition de noms 324
getAppServerAccessType() 196
uncloakAll() 213
application 316, 321
getAppServerPathToFiles() 197
undoCheckOut() 213
changement de nom 327
getAppURLPrefixForSite() 197
viewAsRoot() 213
duplication 322
getCheckOutUserForFile() 198
site, informations pour tous les sites
185
getCloakingEnabled() 198
sites
getCheckOutUser() 198
listes 325
rendu 324, 327
suppression 318, 322
getConnectionState() 199
dossier racine local 241
styles CSS, fonctions 313
getCurrentSite() 199
renommé(s) 84
suppression
getFocus() 199
supprimé(s) 84
bases de données, connexions à 42
getLinkVisibility() 200
sites renommés 84
chaînes d'ID 121
getLocalPathToFiles() 200
sites, fonctions 184
dossiers 13
getSelection() 200
siteSyncDialog.compare() 186
espacements 342
getShowDependents() 156
siteSyncDialog.markDelete() 186
sélection 374
getShowHiddenFiles() 156
siteSyncDialog.markGet() 187
getShowPageTitles() 156
siteSyncDialog.markIgnore() 187
getShowToolTips() 157
siteSyncDialog.markPut() 187
suppression de clés des fichiers
Design Notes 28
getSiteForURL() 201
siteSyncDialog.markSynced() 188
suppressStartupScreen() 110
getSites() 201
siteSyncDialog.toggleShowAllFiles()
188
SWFFile.createFile() 38
snapToGuides() 355
SWFFile.getObjectType() 40
snapTracingImageToSelection() 337
SWFFile.readFile() 40
locateInSite() 203
snippetPalette.getCurrentSnippetPat
h() 283
synchronize() 212
makeEditable() 203
snippetPalette.newFolder() 283
makeNewDreamweaverFile() 203
source, validation 130
makeNewFolder() 204
source.applyComment() 179
newHomePage() 204
newSite() 204
source.refreshVariableCodeHints()
180
clés de Design Note 89
open() 205
source.removeComment() 180
connexion à 79
put() 205
sources de données
connexions 84
importSite() 202
invertSelection() 202
isCloaked() 202
styles 318, 322
SWFFile.getNaturalSize() 39
synchronizeDocument() 404
systèmes de commande source 86
ajout de commentaire 94
changement de nom des fichiers 83
recreateCache() 205
ColdFusion 50
création de dossiers 82
refresh() 206
ODBC 52
déconnexion de 79
remoteIsValid() 206
sources de données ColdFusion 50
Design Notes 90
removeLink() 206
splitFrame() 331
dossiers transmis 81
renameSelection() 207
splitTableCell() 363
éléments de dossier 80
runValidation() 207
Spry
fichiers 81
saveAsImage() 207
selectAll() 208
selectHomePage() 208
selectNewer() 208, 209
setAsHomePage() 209
setCloakingEnabled() 209
setConnectionState() 210
setCurrentSite() 210
setFocus() 210
setLayout() 211
setLinkVisibility() 211
setSelection() 211
setShowDependents() 157
setShowHiddenFiles() 157
setShowPageTitles() 157
setShowToolTips() 158
fonctions de modification des
widgets 286
fichiers distants 91
insertion de fonctions relatives aux
widgets 288
longueur de Design Notes 89
groupes de fichiers 94, 95, 96
SQL SELECT 54
longueur des noms des dossiers
racines 80
startOfDocument() 128, 402
messages d'erreur 88
startOfLine() 128, 403
nom d'extraction 85
startProcessing() 139
noms 78
startRecording() 115
noms des dossiers racines 80
statusCode, propriété 13
nouvelles fonctionnalités 85
stopAllPlugins() 338
placement des fichiers 82
stopPlugin() 338
sites renommés 84
stopProcessing() 139
sites supprimés 84
stopRecording() 116
suppression de fichiers 82
stripTag() 389
test d'existence des fichiers 83
structure InfoPrefs 26
test des connexions 79
versions 78
462
INDEX
T
updateReference() 172
Z
tableaux
URL
zones réactives
acquisition de la liste des 60
acquisition des fichiers 15, 16
déplacement 333
acquisition des colonnes 56
dimensionnement 333
colonnes dans 55, 56
acquisition du contenu des
fichiers 16
conversion en calques 215
décodage 235
zones réactives, fonctions 332
disposition 340
envoi de données 17
zoom 347
espacements dans 339, 341
ouverture dans un navigateur 97
zoomIn() 349
tableaux de base de données 60
relatives 242
zoomOut() 349
URL absolue de fichier 242
taille
vers une application Flash MX 99
des fichiers 9
Flash, contenu 39
URL de fichier
conversion en chemin d'accès du
fichier local 20
test, chaînes de connexion 53
testAppServer() 312
conversion en chemin d'accès du
lecteur local 22, 27
testConnection() 53
texte
acquisition 114
useTranslatedSource() 253
utilisateurs, extraction de fichiers 88
envoi 18
opération de modification 114
Texte dynamique, boîte de dialogue
106
tileHorizontally() 171
tileVertically() 171
V
validateFireworks() 34
validateFlash() 103
validation de documents 232
toggleFloater() 171
vérification de documents dans le
navigateur 231
toggleShowAllFiles() 188
vérification de liens 130
topPage() 403
vérification orthographique 231
Touche Retour arrière, pression 125
verrouillage, repères 353
touche Suppr 125
versions
tracé de l'image
Fireworks 34
alignement 337
Flash MX 103
opacité 335
système de commande source 78
traduction, fonctions 252
viewAsRoot() 213
traitement des connexions, base de
données 42
visible 164
traitement des fichiers 138, 139
translatedStyle 287
transmission de JavaScript à
Fireworks 32
W
widgets, Spry
fonctions de modification 286
type d'objet Flash 40
insertion de fonctions 288
type d'objet, Flash 40
window.getDeclaredStyle() 291
type, attribut 283
wrapSelection() 404
types de connexion
wrapTag() 389
création 65
write() 12
exécution 48
types, colonnes 54
X
XHTML
U
conversion 218
uncloak() 212
création 221
uncloakAll() 213
nettoyage 218
undo() 114, 116
test d'un document 219
undoCheckOut() 213
une page vers le haut 127
updateCurrentPage() 282
updatePages() 282
disposition 332
463
INDEX
464