DREAMWEAVER CS4 - Éditeur HTML ADOBE - Notice d'utilisation et mode d'emploi gratuit

Name: DREAMWEAVER CS4
Brand: ADOBE
Rating: 8.5 (156 reviews)

Retrouvez gratuitement la notice de l'appareil DREAMWEAVER CS4 ADOBE au format PDF.

📄 526 pages

FR ⬇ Télécharger 💬 Question IA ❓ 10 questions ⚙️ Specs

Choisissez votre langue et indiquez votre email : nous vous enverrons une version traduite specifiquement.

Cette notice n'est pas disponible dans votre langue

Langue souhaitee Votre adresse email

Type de produit	Éditeur HTML et environnement de développement Web
Version	CS4 (Creative Suite 4)
Éditeur	Adobe Systems
Plateformes supportées	Windows XP/Vista, Mac OS X
Configuration minimale recommandée	1 Go RAM, processeur 1 GHz, 1 Go espace disque
Langues disponibles	Français, anglais, allemand, japonais, et autres
Fonctions principales	Édition visuelle et code, gestion de site, intégration avec Fireworks/Flash/Photoshop, prise en charge des API, modèles et bibliothèques
Extensibilité	API JavaScript, C, HTTP, Design Notes, intégration de sources
Formats de fichiers	HTML, CSS, JavaScript, XML, PHP, ASP, JSP, ColdFusion
Outils de conception	Mode fractionné, affichage en direct, repères, zoom, panneaux flottants
Gestion de site	FTP, WebDAV, système de fichiers distant, design notes
Mise à jour	Via Adobe Application Manager ou site officiel
Assistance technique	Forums Adobe, documentation en ligne, support payant
Licence	Licence commerciale, essai gratuit limité
Entretien	Mises à jour de sécurité et correctifs via Adobe
Sécurité	Aucun danger particulier ; suivre les recommandations Adobe
Pièces détachées et réparabilité	Non applicable (logiciel)
Informations générales	Notice d'utilisation PDF 526 pages, référence des API

FOIRE AUX QUESTIONS - DREAMWEAVER CS4 ADOBE

Comment installer Adobe Dreamweaver CS4 ?

Exécutez le programme d'installation à partir du DVD ou du téléchargement. Suivez les instructions à l'écran. Une connexion Internet peut être nécessaire pour l'activation.

Quels sont les formats de fichiers supportés par Dreamweaver CS4 ?

Dreamweaver prend en charge HTML, CSS, JavaScript, XML, PHP, ASP, JSP, ColdFusion, ainsi que des images (GIF, JPEG, PNG) et des fichiers Flash (SWF).

Comment créer une extension pour Dreamweaver CS4 ?

Utilisez l'API JavaScript et les bibliothèques C fournies. Consultez le guide des API (chapitre 1) pour les bases. Les extensions sont déposées dans le dossier Configuration.

Comment intégrer Fireworks ou Photoshop dans Dreamweaver ?

Dreamweaver propose des API dédiées (FWLaunch, objets dynamiques Photoshop) pour ouvrir et optimiser des images depuis Fireworks ou éditer des objets dynamiques depuis Photoshop.

Comment utiliser les Design Notes ?

Les Design Notes stockent des métadonnées (auteur, état) sous forme de paires clé/valeur. Utilisez l'API MMNotes (chapitre 4) pour les lire/écrire en JavaScript ou C.

Comment mettre à jour Dreamweaver CS4 ?

Adobe publie des mises à jour de sécurité et des correctifs. Téléchargez-les depuis le site Adobe ou via Adobe Application Manager.

Comment créer un nouveau document HTML ?

Cliquez sur Fichier > Nouveau, choisissez Page vierge > HTML, puis validez. Vous pouvez aussi utiliser des modèles ou des exemples.

Comment insérer un comportement JavaScript ?

Sélectionnez un élément, ouvrez le panneau Comportements (Fenêtre > Comportements), cliquez sur +, choisissez une action (ex: Appel JavaScript) et configurez-la.

Où trouver l'aide et la documentation ?

La notice PDF de 526 pages est incluse dans l'installation. Vous pouvez aussi consulter le forum Adobe ou le site d'aide en ligne d'Adobe.

Comment résoudre un problème de plantage ?

Vérifiez la configuration minimale, mettez à jour les pilotes graphiques et réinstallez le logiciel. Consultez le fichier d'erreur ou contactez le support Adobe.

Questions des utilisateurs sur DREAMWEAVER CS4 ADOBE

0 question sur cet appareil. Repondez a celles que vous connaissez ou posez la votre.

Poser une nouvelle question sur cet appareil

Aucune question pour l'instant. Soyez le premier à en poser une.

Téléchargez la notice de votre Éditeur HTML au format PDF gratuitement ! Retrouvez votre notice DREAMWEAVER CS4 - ADOBE et reprennez votre appareil électronique en main. Sur cette page sont publiés tous les documents nécessaires à l'utilisation de votre appareil DREAMWEAVER CS4 de la marque ADOBE.

MODE D'EMPLOI DREAMWEAVER CS4 ADOBE

ADOBE® DREAMWEAVER® CS4 Référence des API

Guide des API d'Adobe ^® Dreamweaver ^® CS4 pour Windows ^® et Mac OS

Si le présent guide est distribué avec un logiciel sous contrat de licence de l'utilisateur final, ce guide, de même que le logiciel dont il traite, est cédé sous licence et ne peut être copié ou utilisé que conformément à cette licence. Sauf autorisation spécifiée dans la licence, aucune partie de cette publication ne peut être reproduite, enregistrée sur un système de recherche ou transmise sous quelque forme ou par quelque moyen que ce soit (enregistrement électronique, mécanique ou autre), sans l'autorisation écrite préalable d'Adobe Systems Incorporated. Notez que le contenu de ce manuel est protégé par des droits d'auteur, même s'il n'est pas distribué avec un logiciel accompagné d'un contrat de licence pour l'utilisateur final. Les informations contenues dans ce guide sont fournies à titre informatif uniquement ; elles sont susceptibles d'être modifiées sans préavis et ne doivent pas être interprétées comme étant un engagement de la part d'Adobe Systems Incorporated. Adobe Systems Incorporated n'accepte aucune responsabilité quant aux erreurs ou inexactitudes pouvant être contenues dans le présent guide.

Nous attirons votre attention sur le fait que les illustrations ou images que vous pouvez être amené à incorporer à vos projets peuvent être protégées par des droits d'auteur. L'inclusion non autorisée de tels éléments dans vos nouveaux travaux peut constituer une violation des droits du détenteur du copyright. Veuillez vous assurer que vous obtenez toute autorisation nécessaire auprès du détenteur du copyright. Toute référence à des noms de sociétés dans les modèles types n'est utilisée qu'à titre d'exemple et ne fait référence à aucune société réelle.

Adobe, le logo Adobe, ColdFusion, Dreamweaver, Fireworks, Flash, Photoshop et Shockwave sont des marques déposées ou des marques commerciales d'Adobe Systems Incorporated aux Etats-Unis.

Java est une marque ou une marque déposée de Sun Microsystems, Inc. aux Etats-Unis et/ou dans d'autres pays. Windows est une marque ou une marque déposée de Microsoft Corporation aux Etats-Unis et/ou dans d'autres pays. Macintosh et Mac OS sont des marques commerciales d'Apple Computer, Inc., déposées aux Etats-Unis et dans d'autres pays. Toutes les autres marques citées sont la propriété de leurs détenteurs respectifs.

Ce produit inclut des logiciels développés par Apache Software Foundation (http://www.apache.org/).

Le format GIF© (Graphics Interchange Format) fait l'objet d'un copyright appartenant CompuServe Incorporated.

GIF est une marque de service de CompuServe Incorporated.

Technologie de compression audio MPEG Layer-3 utilisée sous licence de Fraunhofer IIS et Thomson Multimedia (http://www.mp3licensing.com). Vous n'êtes pas autorisé à utiliser les données audio MP3 compressées fournies avec le Logiciel pour les diffusions en temps réel ou en direct. Si vous nécessitez un décodeur MP3 pour ce type de diffusion, vous devez acquérir une licence pour cette technologie MP3.

Ce produit est fourni avec un logiciel développé par le groupe OpenSymphony (http://www.opensymphony.com/)

Sorenson Spark.

La technologie de compression et de décompression vidéo Sorenson Spark ^™ est cédée sous licence par Sorenson Media, Inc.

Adobe Systems Incorporated, 345 Park Avenue, San Jose, Californie 95110, Etats-Unis d'Amérique.

Avertissements à l'attention des utilisateurs finaux du gouvernement des Etats-Unis. Le logiciel et la documentation sont des « Commercial Items » (articles commerciaux), selon la définition de ces termes dans l'article 48 C.F.R. §2.101, composés d'un « Commercial Computer Software » (logiciel commercial) et d'une « Commercial Computer Software Documentation » (documentation), selon la définition de ces termes dans l'article 48 C.F.R. §12.212 ou 48 C.F.R. §227.7202, selon le cas. Conformément aux documents 48 C.F.R. §12.212 ou 48 C.F.R. §§227.7202-1 à 227.7202-4, le cas échéant, le Logiciel informatique commercial et la Documentation du Logiciel informatique commercial ne sont conférés en licence aux utilisateurs finals du Gouvernement des Etats-Unis (a) que sous la forme d'Articles commerciaux et (b) exclusivement avec les droits qui sont accordés à tout autre utilisateur final conformément aux conditions générales ci-incluses. Les droits non publiés sont réservés conformément aux lois des Etats-Unis en matière de copyright. Adobe Systems Incorporated, 345 Park Avenue, San Jose, CA 95110-2704, Etats-Unis d'Amérique. Pour les utilisateurs finals du Gouvernement des Etats-Unis, Adobe s'engage à respecter toutes les lois en vigueur en matière d'égalité, dont, le cas échéant, les dispositions du Executive Order 11246, tel qu'amendé, Section 402 de la loi Vietnam Era Veterans Readjustment Assistance Act de 1974 (38 USC 4212), et la Section 503 de la loi Rehabilitation Act de 1973, telle qu'amendée, ainsi que les dispositions des documents 41 CFR parties 60-1 à 60-60, 60-250 et 60-741. La clause d'action positive et les réglementations figurant dans la phrase qui précède seront incorporées par référence.

Sommaire

Chapitre 1 : Introduction

A propos des extensions 1

Extension de Dreamweaver 1

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

Nouvelles fonctions de Dreamweaver CS4 2

Fonctions supprimées 4

Conventions utilisées dans ce manuel 6

Chapitre 2 : API d'E/S des fichiers

A propos des dossiers de configuration 7

A propos de l'API d'E/S des fichiers 7

Chapitre 3 : API HTTP

Fonctionnement de l'API HTTP 16

L'API HTTP 16

Chapitre 4 : API de Design Notes

Fonctionnement des Design Notes 23

L'API JavaScript de Design Notes 23

L'API C de Design Notes 28

Chapitre 5 : Intégration de Fireworks

L'API FWLaunch 35

Chapitre 6 : Intégration de Flash

L'API des objets Flash 42

Fonctions des panneaux et des boîtes de dialogue de Flash 45

Chapitre 7 : Intégration de Photoshop

Fonctionnement des objets dynamiques 54

L'API des objets dynamiques 54

Chapitre 8 : API de base de données

Fonctionnement de l'API de base de données 58

Fonctions de connexion à une base de données 59

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

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

Sélection d'un nouveau type de connexion 83

Création d'un nouveau type de connexion 83

L'API de connexion 84

Fichier inclus généré 87

Fichier de définition pour votre type de connexion 88

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

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

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

Fonctions requises de l'API d'intégration de commande source 92

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

Activateurs 106

Chapitre 11 : Application

Fonctions relatives aux applications externes 112

Fonctions globales relatives aux applications 120

Fonctions de communication avec Bridge 125

Chapitre 12 : Espace de travail

Fonctions d'historique 128

Fonctions d'insertion d'objets 137

Fonctions relatives au clavier 139

Fonctions relatives aux menus 146

Fonctions de la fenêtre de résultats 148

Fonctions de bascule 160

Fonctions relatives aux barres d'outils 179

Fonctions relatives aux fenêtres 185

Fonctions de la barre d'information 195

Fonctions des fichiers apparentés 196

Fonctions du mode Fractionnement vertical 197

Fonctions relatives au fractionnement des codes 200

Fonctions relatives aux barres d'outils du mode Code 206

Fonctions des couleurs 210

Chapitre 13 : Site

Fonctions relatives aux rapports 212

Chapitre 14 : Document

Fonctions relatives aux conversions 245

Fonctions relatives aux commandes 246

Fonctions relatives aux manipulations de fichiers 247

Fonctions relatives à l'ensemble d'un document 262

Fonctions relatives aux chemins 270

Fonctions relatives à la sélection 273

Fonctions de manipulation de chaînes 279

Fonctions relatives à la traduction 283

Fonctions XSLT 284

Chapitre 15 : Contenu de page

Fonctions du panneau Actifs 288

Fonctions relatives aux comportements 296

Presse-papiers, fonctions 306

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

Fonctions du panneau Fragments de code 315

Fonctions de modification de widgets Spry 319

Insertion de fonctions relatives aux widgets Spry 321

Fonctions de vérification de la compatibilité avec les navigateurs 324

Chapitre 16 : Documents dynamiques

Fonctions de composants de serveur 332

Fonctions relatives aux sources de données 333

Fonctions de l'Extension Data Manager 334

Fonctions Live data 336

Fonctions relatives au mode En direct 341

Fonctions relatives aux comportements de serveur 347

Fonctions de modèle de serveur 348

Chapitre 17 : Création

Fonctions relatives aux mises en forme CSS 355

Fonctions relatives aux cadres et aux jeux de cadres 375

Fonctions relatives aux calques et aux cartes d'images 377

Fonctions d'environnement de mise en forme 379

Fonctions relatives au mode de Mise en forme 385

Fonctions relatives aux zooms 391

Propriétés et fonctions de repère 394

Fonctions de modification des tableaux 401

Chapitre 18 : Code

Fonctions de code 411

Fonctions relatives à la recherche et au remplacement 416

Fonctions de modifications générales 421

Fonction relative à l'impression 437

Fonctions relatives à Quick Tag Editor 438

Fonctions relatives au mode Code 440

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

Chapitre 19 : Activateurs

Fonctions d'activateur 463

Index 500

Chapitre 1 : Introduction

Le Guide des API de Adobe Dreamweaver CS4 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® CS4 et ajoutez des codes de programme à vos pages Web Dreamweaver. Les API comprennent l'API JavaScript principale, qui permet d'accéder à la plupart des fonctionnalités essentielles de Dreamweaver. Les fonctionnalités essentielles de Dreamweaver sont à peu près tout ce qui peut être effectué via un menu, et bien plus encore. Il s'agit aussi de diverses API utilitaires destinées à des tâches aussi courantes que la lecture de fichiers et leur écriture, le transfert d'informations à l'aide de HTTP et la communication avec Fireworks et Flash.

L'API JavaScript vous permet d'exécuter un large éventail de tâches plus réduites. L'utilisateur exécute nombre de ces tâches lorsqu'il crée ou modifie des documents Dreamweaver. Ces fonctions d'API sont regroupées selon les parties de l'interface utilisateur de Dreamweaver auxquelles elles se rapportent. Ainsi, l'API JavaScript comprend les fonctions relatives à l'espace de travail, aux documents, à la conception, etc. Les fonctions de l'API permettent de réaliser quelques-unes des tâches suivantes, et bien plus encore :

• Ouverture d'un nouveau document
- Obtention ou définition d'une taille de police
- Recherche de l'occurrence d'une chaîne de recherche dans le code HTML
- Activation de la visibilité d'une barre d'outils

A propos des extensions

Ce manuel suppose une bonne maîtrise de Dreamweaver, HTML, XML, de la programmation JavaScript et, le cas échéant, de la programmation C. Pour rédiger vos propres extensions afin de créer des applications Web, vous devez connaître les langages de script côté serveur et au moins l'une des plates-formes suivantes : Active Server Pages (ASP), ASP.NET, PHP: Hypertext Preprocessor (PHP), Adobe ColdFusion ou Java Server Pages (JSP).

Extension de Dreamweaver

Pour en savoir plus sur la plate-forme Dreamweaver et l'API permettant de développer des extensions de Dreamweaver, voir Extension de Dreamweaver. Le manuel Extension de Dreamweaver décrit les fonctions des API que Dreamweaver appelle pour implémenter les objets, menus, panneaux flottants, comportements de serveur, etc., qui composent les diverses fonctionnalités de Dreamweaver. Ces API permettent d'ajouter des objets, des menus, des panneaux flottants et d'autres fonctions au produit. Extension de Dreamweaver explique également comment personnaliser Dreamweaver en modifiant et en ajoutant des balises à différents fichiers HTML et XML, de façon à ajouter des éléments de menus ou des types de documents, etc.

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

Pour entrer en contact avec d'autres développeurs d'extensions, rejoignez le forum de discussion consacré à l'extensibilité de Dreamweaver. Vous trouverez ce forum à l'adresse http://www.adobe.com/cfusion/webforums/forum/categories.cfm?forumid=12&catid=190&entercat=y.

Nouvelles fonctions de Dreamweaver CS4

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

Documents dynamiques

Les fonctions suivantes ont été ajoutées au chapitre Documents dynamiques.

Fonctions relatives au mode En direct

« dom.getDesignViewMode() » à la page 341
« dom.setDesignViewMode() » à la page 342
« dom.getLiveViewUsingServer() » à la page 342
« dom.setLiveViewUsingServer() » à la page 342
« dom.getLiveViewDefaultsToUsingServer() » à la page 343
« dom.getLiveViewDependentsUsingServer() » à la page 343
« dom.setLiveViewDependentsUsingServer() » à la page 343
« dom.showLiveViewParametersDialog() » à la page 344
« dom.browser.getSelection() » à la page 344
« dom.browser.getStatusText() » à la page 344
« dom.browser.getWindow() » à la page 345
« browserEle.loadHTML() » à la page 345

Intégration de Photoshop

Les fonctions suivantes ont été ajoutées au chapitre Intégration de Photoshop.

API des objets dynamiques

« dreamweaver.assetPalette.canUpdateSmartObjectFromOriginal() » à la page 54
« dreamweaver.assetPalette.updateSmartObjectFromOriginal() » à la page 55
« dreamweaver.getSmartObjectState() » à la page 55
« dreamweaver.getSmartObjectOriginalWidth() » à la page 56
« dreamweaver.getImageWidth() » à la page 56
« dreamweaver.getImageHeight() » à la page 56
« dreamweaver.resolveOriginalAssetFileURLToAbsoluteLocalFilePath() » à la page 57
« dreamweaver.canUpdateSmartObjectFromOriginal() » à la page 57
« dreamweaver.updateSmartObjectFromOriginal() » à la page 57

Espace de travail

Les fonctions suivantes ont été ajoutées au chapitre Espace de travail.

Fonctions des fichiers apparentés

« dreamweaver.getRelatedFiles() » à la page 196
« dreamweaver.openRelatedFile() » à la page 197
« dreamweaver.getActiveRelatedFilePath() » à la page 197

Fonctions de la barre d'information

« dom.showInfoBar() » à la page 195
« dom.hideInfoBar() » à la page 196

Fonctions du mode Fractionnement vertical

« dreamweaver.getSplitViewOrientation() » à la page 197
« dreamweaver.setSplitViewOrientation() » à la page 198
« dreamweaver.getPrimaryView() » à la page 198
« dreamweaver.setPrimaryView() » à la page 199
« dom.isRelatedFileViewOpen() » à la page 199

Fonctions relatives aux barres d'outils

- « dreamweaver.reloadToolbars() » à la page 184

Intégration de Flash

Les fonctions suivantes ont été ajoutées au chapitre Intégration de Flash.

Fonctions des panneaux et des boîtes de dialogue de Flash

« dreamweaver.flash.newControl() » à la page 45
« dreamweaver.flash.requestStateChange() » à la page 47
« dreamweaver.flash.controlEvent() » à la page 48
« dreamweaver.flash FluclMenu() » à la page 50
« dreamweaver.flash.evalScript() » à la page 51
« dreamweaver.flash.executeScript() » à la page 52
« dreamweaver.flash.controlExists » à la page 53

Site

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

« site.getLocalRootURL() » à la page 231
« site.getSiteRootForURL() » à la page 232

Document

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

« dom.getSelectorsDefinedInStylesheet() » à la page 274
« dreamweaver.absoluteURLToDocRelative() » à la page 270

Code

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

- « dom.source.doCodeNavItem() » à la page 446

Fonctions supprimées

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

site.setShowPageTitles()	site.removeLink()
site.canShowPageTitles()	site.invertSelection()
site.getShowPageTitles()	site.selectHomePage()
site.setShowHiddenFiles()	site.newHomePage()
site.getShowHiddenFiles()	site.setLayout()
site.setShowDependents()	dom.createLayoutCell()
site.getShowDependents()	dom.createLayoutTable()
site.canFindLinkSource()	dom percentColumnAutostretch()
site.findLinkSource()	dom.isColumnAutostretch()
site.viewAsRoot()	dom.doesColumnHaveSpacer()
site.setAsHomePage()	dom.doesGroupHaveSpacer()
site.canSetLayout()	dom.addSpacerToColumn()
site.canRemoveLink()	dom.removeSpacerFromColumn()
site.canChangeLink()	dom.removeAllSpacers()
site.canAddLink()	dom.makeCellWidthsConsistent()
site.addLinkToNewFile()	dom.insertFlashElement()
site.getLinkVisibility()	dreamweaver.exportCSS() (supprimée dans CS3)
site.setLinkVisibility()	dreamweaver.canExportCSS() (supprimée dans CS3)
site.saveAsImage()	dreamweaver.libraryPalette.deleteSelectedItem() (supprimée dans Dreamweaver 4)
dreamweaver.libraryPalette.get SelectedItem() (supprimée dans Dreamweaver 4)	dreamweaver.libraryPalette.newFromDocument() (supprimée dans Dreamweaver 4)
dreamweaver.libraryPalette recreateFromDocument() (supprimée dans Dreamweaver 4)	dreamweaver.libraryPalette.renameSelectedItem() (supprimée dans Dreamweaver 4)
dreamweaver.libraryPalette.deleteSelectedTemplate() (supprimée dans Dreamweaver 4)	dreamweaver.libraryPalette.getSelectedTemplate() (supprimée dans Dreamweaver 4)
dreamweaver.libraryPalette.renameSelectedTemplate() (supprimée dans Dreamweaver 4)	dreamweaver.getBehaviorEvent() (supprimée dans Dreamweaver 2)
dreamweaver.clipPasteText() (supprimée dans Dreamweaver 8)	dreamweaverthernCommand() (supprimée dans Dreamweaver 3)
dom.serverModel.getServerLanguage() (supprimée dans Dreamweaver MX)	dom.serverModel.getServerExtension() (supprimée dans Dreamweaver MX)
dreamweaver.getObjectRefs() (supprimée dans Dreamweaver 3)	dreamweaverobjectTags() (supprimée dans Dreamweaver 3)
dreamweaver.getSelection() (supprimée dans Dreamweaver 3)	dreamweaver.nodeToOffsets() (supprimée dans Dreamweaver 3)
dreamweaver.offsetsToNode() (supprimée dans Dreamweaver 3)	dreamweaver.setSelection() (supprimée dans Dreamweaver 3)
dreamweaver.exportEditableRegionsAsXML() (supprimée dans Dreamweaver MX)	dreamweaver.cssStylePalette.getSelectedTarget() (supprimée dans Dreamweaver MX)
MMDB.getDriverUrlTemplateList() (supprimée dans Dreamweaver MX)

Pour plus d'informations sur ces API supprimées, voir Guide des API de Dreamweaver CS3.

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

Conventions de dénomination

Ce manuel utilise les conventions de dénomination suivantes :

Vous — le développeur responsable de la rédaction des extensions
• L'utilisateur — la personne utilisant Dreamweaver

Chapitre 2 : API d'E/S des fichiers

Adobe® Dreamweaver® CS4 comprend une bibliothèque partagée C, appelée DWfile, qui donne aux auteurs d'objets, de commandes, de comportements, de traducteurs de données, de panneaux flottants et d'inspecteurs Propriétés la possibilité de lire et d'écrire des fichiers sur le système de fichiers local. Ce chapitre décrit l'API d'entrée/sortie des fichiers et son utilisation.

Pour obtenir des informations générales sur la façon dont les bibliothèques C interagissent avec l'interpréteur JavaScript dans Dreamweaver, voir « Extensibilité de niveau C » dans le manuel Extension de Dreamweaver.

A propos des dossiers de configuration

Sur les plates-formes Microsoft Windows 2000, Windows XP et Mac OS X, les utilisateurs disposent de leur propre copie des fichiers de configuration. Lorsque Dreamweaver écrit dans un fichier de configuration, il le fait dans le dossier Configuration de l'utilisateur. De même, lorsqu'il lit un fichier de configuration, Dreamweaver commence par rechercher ce fichier dans le dossier Configuration de l'utilisateur, puis dans le dossier Configuration de l'application. Les fonctions DWfile procèdent de la même manière. En d'autres termes, si une extension lit ou écrit un fichier dans le dossier Configuration de l'application, elle se reporte aussi au dossier Configuration de l'utilisateur. Pour plus d'informations sur les dossiers Configuration dans un environnement multiutilisateur, voir Extension de Dreamweaver.

A propos de l'API d'E/S des fichiers

Toutes les fonctions de l'API d'E/S des fichiers sont des méthodes associées à l'objet DWfile.

DWfile.copy()

Disponibilité

Dreamweaver 3.

Description

Cette fonction copie le fichier spécifié vers un nouvel emplacement.

Arguments

originalURL, copyURL

L'argument originalURL, exprimé sous la forme d'une URL de type file://, représente le fichier que vous souhaitez copier.
L'argument copyURL, exprimé sous la forme d'une URL de type file://, représente l'emplacement où vous souhaitez enregistrer le fichier copié.

Valeurs renvoyées

Valeur booléenne, true si la copie réussit, false dans le cas contraire.

Exemple

Le code suivant copie un fichier appelé myconfig.cfg vers myconfig_backup.cfg :

var fileURL = "file:///c|/Config/myconfig.cfg";
var newURL = "file:///c|/Config/myconfig_backup.cfg";
DWfile.copy(fileURL, newURL);

DWfile.createFolder()

Disponibilité

Dreamweaver 2.

Description

Cette fonction crée un dossier à l'emplacement spécifié.

Arguments

folderURL

- L'argument folderURL, exprimé sous la forme d'une URL de type file://, représente l'emplacement dans lequel vous souhaitez créer le dossier.

Valeurs renvoyées

Valeur booléenne : true si le dossier est bien créé, false en cas d'échec.

Exemple

Le code suivant tente de créer un dossier nommé tempFolder à la racine du lecteur C et affiche un message d'avertissement indiquant si l'opération a réussi.

var folderURL = "file:///c|/tempFolder";
if (DWfile.createFolder(folderURL)) {
    alert("Created " + folderURL);
} else {
    alert("Unable to create " + folderURL);
}

DWfile.exists()

Disponibilité

Dreamweaver 2.

Description

Cette fonction vérifie l'existence du fichier spécifié.

Arguments

fileURL

- L'argument fileURL, exprimé sous la forme d'une URL de type file://, représente le fichier requis.

Valeurs renvoyées

Valeur booléenne : true si le fichier existe, false dans le cas contraire.

Exemple

Le code suivant recherche le fichier mydata.txt et affiche un message d'avertissement indiquant à l'utilisateur si le fichier existe :

var fileURL = "file:///c|/temp/mydata.txt";
if (DWfile.exists(fileURL)) {
    alert(fileURL + " exists!");
} else {
    alert(fileURL + " does not exist.");
}

DWfile.getAttributes()

Disponibilité

Dreamweaver 2.

Description

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

Arguments

fileURL

- L'argument fileURL, exprimé sous la forme d'une URL de type file://, représente le fichier ou dossier dont vous souhaitez obtenir les attributs.

Valeurs renvoyées

Chaîne représentant les attributs du fichier ou du dossier spécifié. Si le fichier ou le dossier n'existe pas, cette fonction renvoie la valeur null. Les caractères suivants de la chaîne représentent les attributs :

• R signifie lecture seule.
• D signifie dossier.
• H signifie masqué.
• s indique un fichier ou dossier système.

Exemple

Le code suivant obtient les attributs du fichier mydata.txt et affiche un message d'avertissement si le fichier est en lecture seule :

var fileURL = "file:///c|/temp/mydata.txt";
var str = DWfile.getAttributes(fileURL);
if (str && (str.indexOf("R") != -1)) {
    alert(fileURL + " is read only!");
}

DWfile.getModificationDate()

Disponibilité

Dreamweaver 2.

Description

Cette fonction renvoie l'heure à laquelle le fichier a été modifié pour la dernière fois.

Arguments

fileURL

- L'argument fileURL, exprimé sous la forme d'une URL de type file://, représente le fichier dont vous vérifiez l'heure de la dernière modification.

Valeurs renvoyées

Chaîne qui contient un nombre hexadécimal représentant le nombre d'unités de temps écoulées depuis une base de temps donnée. La signification exacte des unités de temps et de la base de temps dépend de la plate-forme ; sous Windows, par exemple, une unité de temps est égale à 100 ns et la base de temps est le 1 janvier 1600.

Exemple

Comme la valeur renvoyée par cette fonction n'est pas une date et une heure identifiables et qu'elle dépend de la 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 and file2 were saved at the same time");
} else if (time1 < time2){
    alert("file1 older that file2");
} else {
    alert("file1 is newer than file2");
}

DWfile.getCreationDate()

Disponibilité

Dreamweaver 4.

Description

Cette fonction renvoie l'heure à laquelle le fichier a été créé.

Arguments

fileURL

- L'argument fileURL, exprimé sous la forme d'une URL de type file://, représente le fichier dont vous vérifiez l'heure de création.

Valeurs renvoyées

Exemple

Description

Cette fonction obtient une liste du contenu du dossier spécifié.

Arguments

folderURL, {constraint}

L'argument folderURL est le dossier dont vous souhaitez obtenir le contenu, exprimé sous la forme d'une URL de type file:// et d'un masque de fichier facultatif composé de caractères génériques. Les caractères génériques valides sont les astérisques (*), qui représentent un ou plusieurs caractères, et les points d'interrogation (?), qui représentent un seul caractère.
L'argument constraint, s'il est fourni, doit être soit "files" (renvoyer uniquement les fichiers), soit "directories" (renvoyer uniquement les dossiers). Si cet argument n'est pas spécifié, la fonction renvoie aussi bien des fichiers que des dossiers.

Valeurs renvoyées

Tableau de chaînes représentant le contenu du dossier.

Exemple

Le code suivant obtient une liste de tous les fichiers texte (TXT) du dossier C:/Temp et affiche la liste dans un message d'avertissement.

var folderURL = "file:///c|/temp";
var fileMask = "*.txt";
var list = DWfile.listFolder(folderURL + "/" + fileMask, "files");
if (list){
    alert(folderURL + " contains: " + list.join("\n"));
}

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 + " contains: " + str);
}

DWfile.remove()

Disponibilité

Dreamweaver 3.

Description

Cette fonction permet de supprimer le fichier spécifié.

Arguments

fileURL

- L'argument fileURL, exprimé sous la forme d'une URL de type file://, représente le fichier que vous souhaitez supprimer.

Valeurs renvoyées

Valeur booléenne, true si l'opération réussit, false dans le cas contraire.

Exemple

L'exemple suivant utilise la fonction DWfile.getAttribute( ) 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 DatAttributes(selFile).indexOf('R') != -1) {
    delAnyway = confirm('This file is read-only. Delete anyway?');
    if (delAnyway) {
    DWfile.remove(selFile);
    }
    }
}

DWfile.setAttribute()

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.

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 écrit la chaîne spécifiée dans le fichier spécifié. Si le fichier spécifié n'existe pas, il est créé.

Arguments

fileURL, text, {mode}

- L'argument fileURL, exprimé sous la forme d'une URL de type file://, représente le fichier dans lequel vous écrivez une chaîne.

Remarque : Si le chemin d'accès contient des espaces, cette fonction n'écrira pas les fichiers.

L'argument text indique la chaîne que la fonction doit écrire.
L'argument mode, s'il est fourni, doit être append. Si cet argument est omis, la chaîne écrase le contenu du fichier.

Valeurs renvoyées

Valeur booléenne : true si l'écriture de la chaîne dans le fichier a réussi et false dans le cas contraire.

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("Wrote xxx to " + fileURL);
}
if (DWfile.write(fileURL, "aaa", "append")) {
    alert("Appended aaa to " + fileURL);
}

Chapitre 3 : API HTTP

Les extensions ne fonctionnent pas uniquement dans le système de fichiers local. Adobe® Dreamweaver® permet d'échanger des informations avec un serveur Web via le protocole HTTP (Hypertext Transfer Protocol). Ce chapitre décrit l'API HTTP et son utilisation.

Fonctionnement de l'API HTTP

Toutes les fonctions de l'API HTTP sont des méthodes associées à l'objet MMHttp. La plupart d'entre elles acceptent au moins une URL comme argument et la plupart renvoient un objet. Le port par défaut pour les arguments URL est 80. Pour spécifier un port différent, ajoutez deux points (:) et le numéro de port à la suite de l'URL, comme dans l'exemple suivant :

MMHttp.getText("http://www.myserver.com:8025");

Pour les fonctions qui renvoient un objet, cet objet possède deux propriétés : statusCode et data.

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.

L'API HTTP

Cette section présente en détail les fonctions qui sont des méthodes de l'objet MMHttp.

MMHttp.clearServerScriptsFolder()

Disponibilité

Dreamweaver MX.

Description

Supprime le dossier _mmServerScripts (et tous ses fichiers) sous le dossier racine du site en cours, qu'il soit local ou distant. Le dossier _mmServerScripts se trouve dans le dossier Configuration/Connections/Scripts/server-model/_mmDBScripts.

Arguments

serverScriptsfolder

- L'argument serverScriptsfolder est une chaîne qui nomme un dossier donné, en liaison avec le dossier Configuration du serveur d'application, à partir duquel vous pouvez extraire et supprimer les scripts de serveur.

Valeurs renvoyées

Un objet représentant la réponse du serveur. La propriété 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>Clear Server Scripts</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>Clean Up Temp Files on Shutdown</title>
</head>
<body onLoad="MMHttp.clearTemp()">
</body>
</html>

MMHttp.getFile()

Description

Cette fonction obtient le fichier situé à l'URL spécifiée et l'enregistre dans le dossier Configuration/Temp situé dans le dossier de l'application Dreamweaver. Dreamweaver crée automatiquement des sous-dossiers qui reproduisent la structure de dossiers du serveur ; par exemple, si le fichier spécifié est dans

www.dreamcentral.com/people/index.html, Dreamweaver enregistre le fichier index.html dans le sous-dossier People du dossier www.dreamcentral.com.

Arguments

URL, {prompt}, {saveURL}, {titleBarLabel}

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

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

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.

L'argument URL est une URL absolue sur un serveur Web ; si http:// n'est pas indiqué dans l'URL, Dreamweaver considère qu'il s'agit du protocole HTTP.
L'argument dataToPost représente les données à envoyer. Si le troisième argument est "application/x-www-form-urlencoded" ou s'il n'est pas spécifié, dataToPost doit être codé en formulaire conformément à la section 8.2.1 de la spécification RFC 1866 (disponible à l'adresse www.faqs.org/rfcs/rfc1866.html).
L'argument facultatif contentType est le type de contenu des données à envoyer. S'il n'est pas spécifié, il prend par défaut la valeur "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é.

Exemple

Dans l'exemple suivant d'appel de la fonction MMHttp.setText(), 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 :

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

Description

Exécute un envoi HTTP du texte à l'URL spécifiée et transmet la réponse du serveur à la fonction spécifiée. En règle générale, les données associées à une opération d'envoi se présentent sous la forme de texte codé en formulaire, mais il peut s'agir de tout type de données que le serveur peut accepter.

Arguments

callbackFunc, URL, dataToPost, {contentType}, {serverScriptsFolder}

L'argument callbackFunc est le nom de la fonction JavaScript à appeler lorsque la requête HTTP est terminée.
L'argument URL est une URL absolue sur un serveur Web ; si http:// n'est pas indiqué dans l'URL, Dreamweaver considère qu'il s'agit du protocole HTTP.
L'argument dataToPost représente les données à envoyer. Si le troisième argument est "application/x-www-form-urlencoded" ou s'il n'est pas spécifié, data doit être codé en formulaire conformément à la section 8.2.1 de la spécification RFC 1866 (disponible à l'adresse www.faqs.org/rfcs/rfc1866.html).
L'argument facultatif contentType correspond au type de contenu des données à envoyer. S'il n'est pas spécifié, il prend par défaut la valeur "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é.

Chapitre 4 : API de Design Notes

Adobe® Dreamweaver®, Adobe® Fireworks® et Adobe® Flash® offrent aux concepteurs et développeurs Web une méthode permettant de stocker et de récupérer des informations supplémentaires sur les documents. Ces informations sont stockées dans des fichiers baptisés « Design Notes ». Il peut s'agir d'informations supplémentaires sur les documents, comme des commentaires de relecture, des notes de modification ou le fichier source d'une image GIF ou JPEG.

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

Fonctionnement des Design Notes

Chaque fichier Design Notes stocke des informations relatives à un seul document. Si un fichier Design Notes est associé à un ou plusieurs documents dans un dossier, Dreamweaver crée un sous-dossier _notes pour y stocker les fichiers Design Notes. Le dossier _notes et les fichiers Design Notes qu'il contient ne sont pas visibles dans la fenêtre Site, mais ils s'affichent dans le Finder Macintosh ou dans l'Explorateur Windows. Un nom de fichier Design Notes est composé du nom du fichier principal suivi de l'extension .mno. Par exemple, le fichier Design Notes associé à avocado8.gif est avocado8.gif.mno.

Les fichiers Design Notes sont des fichiers XML stockant des informations sous la forme d'une série de paires clé/valeur. La clé décrit le type des informations stockées et la valeur représente les informations. Les clés sont limitées à 64 caractères.

L'exemple suivant illustre le fichier Design Notes associé au fichier foghorn.gif.mno :

<?xml version="1.0" encoding="iso-8859-1" ?>
<info>
    <infoitem key="FW_source" value="file:///C|sites/dreamcentral/images/sourceFiles/foghorn.png" />
    <infoitem key="Author" value="Heidi B." />
    <infoitem key="Status" value="Final draft, approved by Jay L." />
</info>

L'API JavaScript de Design Notes

Toutes les fonctions de l'API JavaScript de Design Notes sont des méthodes associées à l'objet MMNotes. MMNotes est une bibliothèque C partagée qui permet aux auteurs d'extensions de lire et d'écrire dans les fichiers Design Notes. Tout comme la bibliothèque partagée DWfile, MMNotes comprend une API JavaScript qui permet d'appeler les fonctions. Ces fonctions sont appelées à partir d'objets, de commandes, de comportements, de panneaux flottants, d'inspecteurs Propriétés et de traducteurs de données dans la bibliothèque. La bibliothèque partagée MMNotes peut être utilisée indépendamment de Dreamweaver, que celui-ci soit installé ou non.

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.

Arguments

fileHandle

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

Valeurs renvoyées

Aucune.

Exemple

Voir « MMNotes.set() » à la page 28.

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

Voir « MMNotes.getKeys() » à la page 25.

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

MMNotes.getKeys()

Description

Cette fonction renvoie une liste de toutes les clés d'un fichier Design Notes.

Arguments

fileHandle

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

Valeurs renvoyées

Un tableau de chaînes, chacune d'elles contenant le nom d'une clé.

Exemple

Le code suivant peut être utilisé dans un panneau flottant personnalisé afin d'afficher les informations Design Notes relatives au document actif :

var noteHandle = MMNotes.open(dw.getDocumentDOM().URL);
var theKeys = MMNotes.getKeys(noteHandle);
var noteString = "";
var theValue = "";
for (var i=0; i < theKeys.length; i++) {
    theValue = MMNotes.get(noteHandle, theKeys[i]);
    noteString += 0theKeys[i] + " = " theValue + "\n";
}
document.theForm.bigTextField.value = noteString;
// always close noteHandle
MMNotes.close(noteHandle);

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.

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

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 si l'opération a réussi, false dans le cas contraire.

MMNotes.set()

Description

Cette fonction crée ou met à jour une paire clé/valeur dans un fichier Design Notes.

Arguments

fileHandle, keyName, valueString

L'argument fileHandle est l'identificateur de fichier renvoyé par la fonction MMNotes.open().
L'argument keyName est une chaîne contenant le nom de la clé.
L'argument valueString est une chaîne contenant la valeur.

Valeurs renvoyées

Valeur booléenne : true si l'opération a réussi, false dans le cas contraire.

Exemple

L'exemple suivant ouvre le fichier Design Notes associé à un fichier situé sur le site dreamcentral appelé peakhike99/index.html, ajoute une nouvelle paire clé/valeur, modifie la valeur d'une clé existante, puis ferme le fichier Design Notes :

var noteHandle = MMNotes.open('file:///c|/sites/dreamcentral/peakhike99/index.html', true);
if (noteHandle > 0) {
    MMNotes.set(noteHandle, "Author", "M. G. Miller");
    MMNotes.set(noteHandle, "Last Changed", "August 28, 1999");
    MMNotes.close(noteHandle);
}

L'APIC 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

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 si l'opération a réussi, false dans le cas contraire. 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.

Valeurs renvoyées

Valeur booléenne : true si l'opération a réussi, false dans le cas contraire. L'argument valueBuf reçoit la valeur de la clé.

Exemple

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

FileHandle noteHandle = OpenNotesFile("file:///c|/sites/avocado8/iwjs/welcome.html");
if (noteHandle > 0) {
    int valueLength = GetNoteLength( noteHandle, "comments");
    char* valueBuffer = new char[valueLength + 1];
    GetNote(noteHandle, "comments", valueBuffer, valueLength + 1);
    printf("Comments: %s", valueBuffer);
    CloseNotesFile(noteHandle);
}

int GetNoteLength()

Description

Cette fonction obtient la longueur de la valeur associée à la clé spécifiée.

Arguments

FileHandle noteHandle, const char keyName[64]

L'argument noteHandle est l'identificateur de fichier renvoyé par la fonction OpenNotesFile().
L'argument keyName[64] est une chaîne contenant le nom de la clé.

Valeurs renvoyées

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

Exemple

Voir « BOOL GetNote() » à la page 29.

int GetNotesKeyCount()

Description

Cette fonction obtient le nombre de paires clé/valeur du fichier Design Notes spécifié.

Arguments

FileHandle noteHandle

- L'argument noteHandle est l'identificateur de fichier renvoyé par la fonction OpenNotesFile().

Valeurs renvoyées

Un nombre entier représentant le nombre de paires clé/valeur du fichier Design Notes spécifié.

BOOL GetNotesKeys()

Description

Cette fonction renvoie une liste de toutes les clés d'un fichier Design Notes.

Arguments

FileHandle noteHandle, char* keyBufArray[64], int keyArrayMaxLen

- L'argument noteHandle est l'identificateur de fichier renvoyé par OpenNotesFile().

L'argument keyBufArray[64] est le tableau en mémoire tampon où les clés sont stockées.
L'argument keyArrayMaxLen est le nombre entier renvoyé par GetNotesKeyCount (noteHandle), indiquant le nombre maximum d'éléments contenus dans le tableau en mémoire tampon des clés.

Valeurs renvoyées

Valeur booléenne : true si l'opération a réussi, false dans le cas contraire. L'argument keyBufArray reçoit les noms de clé.

Exemple

Le code suivant imprime les noms de clé et les valeurs de toutes les clés du fichier Design Notes associé au fichier welcome.html :

typedef char[64] InfoKey;
FileHandle noteHandle = OpenNotesFile("file:///c|/sites/avocado8/iwjs/welcome.html");
if (noteHandle > 0) {
    int keyCount = GetNotesKeyCount(noteHandle);
    if (keyCount <= 0)
    return;
    InfoKey* keys = new InfoKey[keyCount];
    BOOL succeeded = GetNotesKeys(noteHandle, keys, keyCount);
    if (succeeded) {
    for (int i=0; i < keyCount; i++) {
    printf("Key is: %s\n", keys[i]);
    printf("Value is: %s\n\n", GetNote(noteHandle, keys[i]);
    }
    }
    delete []keys;
}
CloseNotesFile(noteHandle);

BOOL GetSiteRootForFile()

Description

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

Arguments

const char*filePath, char*siteRootBuf, intsiteRootBufMaxLen, {InfoPrefs* infoPrefs}

L'argument filePath est l'URL de type file:// du fichier dont vous souhaitez obtenir la racine du site.
L'argument siteRootBuf est la zone de mémoire tampon où la racine du site est stockée.
L'argument siteRootBufMaxLen est la taille maximale de la mémoire tampon référencée par siteRootBuf.
L'argument facultatif infoPrefs est une référence à un struct dans lequel les préférences du site sont stockées.

Valeurs renvoyées

Valeur booléenne : true si l'opération a réussi, false dans le cas contraire. 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. La structure InfoPrefs possède deux variables : bUseDesignNotes et bUploadDesignNotes, toutes deux de type BOOL.

BOOL GetVersionName()

Description

Cette fonction renvoie le nom de version de la bibliothèque partagée MMNotes indiquant l'application qui l'a implémentée.

Arguments

char* versionNameBuf, intversionNameBufMaxLen

L'argument versionNameBuf est la zone de mémoire tampon où le nom de version est stocké.
L'argument versionNameBufMaxLen est la taille maximale de la mémoire tampon référencée par versionNameBuf.

Valeurs renvoyées

Valeur booléenne : true si l'opération a réussi, false dans le cas contraire. 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, intversionNumBufMaxLen

L'argument versionNumBuf est la zone de mémoire tampon où le numéro de version est stocké.
L'argument versionNumBufMaxLen est la taille maximale de la mémoire tampon référencée par versionNumBuf.

Valeurs renvoyées

Valeur booléenne : true si l'opération a réussi, false dans le cas contraire. 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

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

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 si l'opération a réussi, false dans le cas contraire.

BOOL SetNote()

Description

Cette fonction crée ou met à jour une paire clé/valeur dans un fichier Design Notes.

Arguments

FileHandle noteHandle, const char keyName[64], const char* value

L'argument noteHandle est l'identificateur de fichier renvoyé par la fonction OpenNotesFile().
L'argument keyName[64] est une chaîne contenant le nom de la clé.
L'argument value est une chaîne contenant la valeur.

Valeurs renvoyées

Valeur booléenne : true si l'opération a réussi, false dans le cas contraire.

Chapitre 5 : Intégration de Fireworks

FWLaunch est une bibliothèque C partagée qui permet aux auteurs d'objets, de commandes, de comportements et d'inspecteurs Propriétés de communiquer avec Adobe® Fireworks®. A l'aide de FWLaunch, vous rédigez du code JavaScript pour ouvrir l'interface utilisateur de Fireworks et fournissez des commandes à Fireworks via sa propre API JavaScript, au sujet duquel vous trouverez plus d'informations dans Extension de Fireworks. Pour obtenir des informations générales sur l'interaction des bibliothèques avec l'interpréteur JavaScript dans Adobe® Dreamweaver® CS4 et pour plus de détails sur les extensions C, voir Extension de Dreamweaver.

L'API FWLaunch

L'objet FWLaunch permet aux extensions d'ouvrir Fireworks, d'exécuter des opérations Fireworks à l'aide de l'API JavaScript de Fireworks et de renvoyer les valeurs à Dreamweaver. Ce chapitre décrit l'API de communication FWLaunch et son utilisation.

Cette fonction affiche Dreamweaver au premier plan.

Arguments

Aucun.

Valeurs renvoyées

Aucune.

Cette fonction permet d'afficher Fireworks au premier plan s'il est en cours d'exécution.

Arguments

Aucun.

Valeurs renvoyées

Aucune.

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

javascript OrFile URL

- L'argument javascript OrFile URL, 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 javascript OrFile URL est spécifié comme ayant la valeur null ou comme une chaîne vide.
Erreur d'E/S de fichier, ce qui indique que Fireworks ne peut pas créer de fichier réponse car le disque est saturé.
Erreur informant Dreamweaver que l'utilisateur n'exécute pas une version valide de Dreamweaver (version 3 ou ultérieure).
Erreur lors du démarrage de Fireworks, ce qui indique que la fonction n'ouvre pas une version valide de Fireworks (version 3 ou ultérieure).
• L'utilisateur a annulé l'opération.

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 informant Dreamweaver que l'utilisateur n'exécute pas une version valide de Dreamweaver (version 3 ou ultérieure).
Erreur lors du démarrage de Fireworks, ce qui indique que la fonction n'ouvre pas une version valide de Fireworks (version 3 ou ultérieure).
• L'utilisateur a annulé l'opération.

Exemple

Le code suivant transmet la chaîne "prompt('Please enter your name:')" à FWLaunch.execJsInFireworks() et vérifie le résultat :

var progressCookie = FWLaunch.execJsInFireworks("prompt('Please enter your name:')");
var doneFlag = false;
while (!doneFlag){
    // check for completion every 1/2 second
    setTimeout('checkForCompletion()',500);
}
function checkForCompletion(){
    if (progressCookie != null) {
    var response = FWLaunch.getJsResponse(progressCookie);
    if (response != null) {
    if (typeof(response) == "number") {
    // error or user-cancel, time to close the window
    // and let the user know we got an error
    window.close();
    alert("An error occurred.");
    }else{
    // got a valid response!
    alert("Nice to meet you, " + response);
    window.close();
    }
    doneFlag = true;
    }
    }
}

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

Arguments

Aucun.

Valeurs renvoyées

Valeur booléenne indiquant si la plate-forme est Windows ou Macintosh ; sur Macintosh, la valeur indique si une autre session d'optimisation de Fireworks est déjà en cours d'exécution.

FWLaunch.optimizeInFireworks()

Disponibilité

Dreamweaver 2, Fireworks 2.

Description

Cette fonction ouvre une session d'optimisation de Fireworks pour l'image spécifiée.

Arguments

docURL, imageURL, {targetWidth}, {targetHeight}

L'argument docURL est le chemin d'accès du document actif, exprimé sous la forme d'une URL de type file://.
L'argument imageURL est le chemin de l'image sélectionnée. Si le chemin est relatif, sa référence sera le chemin spécifié dans l'argument docURL.
L'argument targetWidth (facultatif) définit la largeur par rapport à laquelle l'image doit être redimensionnée.
L'argument targetHeight (facultatif) définit la hauteur par rapport à laquelle l'image doit être redimensionnée.

Valeurs renvoyées

Zéro (0) si une session d'optimisation de Fireworks a été lancée avec succès pour l'image spécifiée; sinon, un code d'erreur non nul indiquant que l'une des erreurs suivantes s'est produite :

Utilisation non valide, ce qui indique que l'argument docURL, l'argument imageURL, ou les deux, ont été spécifiés comme étant null ou sous forme d'une chaîne vide.
Erreur d'E/S de fichier, ce qui indique que Fireworks ne peut pas créer de fichier réponse car le disque est saturé.
Erreur informant Dreamweaver que l'utilisateur n'exécute pas une version valide de Dreamweaver (version 2 ou ultérieure).
Erreur lors du démarrage de Fireworks, ce qui indique que la fonction n'ouvre pas une version valide de Fireworks (version 2 ou ultérieure).
• L'utilisateur a annulé l'opération.

FWLaunch.validateFireworks()

Disponibilité

Dreamweaver 2, Fireworks 2.

Description

Cette fonction recherche la version spécifiée de Fireworks sur le disque dur de l'utilisateur.

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

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

<html>
<head>
<title>Prompt in Fireworks</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<script>

function commandButtons() {
    return new Array("Prompt", "promptInFireworks()", "Cancel", "readyToCancel()", "Close", "window.close()");
}

var gCancelClicked = false;
var gProgressTrackerCookie = null;

function readyToCancel() {
    gCancelClicked = true;
}

function promptInFireworks() {
    var isFireworks3 = FWLaunch.validateFireworks(3.0);
    if (!isFireworks3) {
    alert("You must have Fireworks 3.0 or later to use this command");
    return;
}

// Tell Fireworks to execute the prompt() method.
gProgressTrackerCookie = FWLaunch.execJsInFireworks
("prompt('Please enter your name:')");

// null means it wasn't launched, a number means an error code

Chapitre 6 : Intégration de Flash

Adobe® Dreamweaver® prend en charger l'API d'objet Flash, qui s'appuie sur le modèle Flash Generator pour créer de nouveaux objets Flash. La section L'API des objets Flash fournit des détails sur la création d'objets Flash (fichiers SWF) à partir de modèles Flash Generator (fichiers SWT).

Pour plus d'informations sur l'ajout de contenu Flash à des objets ou des commandes Dreamweaver, voir Extension de Dreamweaver.

L'API des objets Flash

L'API des objets Flash permet aux développeurs d'extensions de construire des objets pour créer des fichiers SWF simples via Flash Generator. Cette API fournit un moyen de définir des paramètres dans un modèle Flash Generator pour réaliser un fichier SWF ou d'image. Elle permet de créer de nouveaux objets Flash mais aussi de lire et de manipuler des objets Flash existants.

Le fichier de modèle Flash Generator SWT contient toutes les informations indispensables à la construction d'un fichier d'objet Flash. Ces fonctions d'API permettent de créer un fichier SWF (ou un fichier d'image) à partir d'un fichier SWT. Le fichier SWF est créé en remplaçant les paramètres du fichier SWT par des valeurs réelles. Pour plus d'informations sur Flash, consultez le manuel correspondant. Les fonctions suivantes sont des méthodes de l'objet SWFFile.

Cette fonction génère un nouveau fichier d'objet Flash à partir du modèle et du tableau des paramètres spécifiés. Elle crée également des versions GIF, PNG, JPEG et MOV du titre si les noms de fichier sous ces formats sont précisés.

Pour pouvoir spécifier un paramètre facultatif placé après des paramètres facultatifs que vous ne voulez pas spécifier, vous devez insérer des chaînes vides dans ces paramètres. Par exemple, si vous souhaitez spécifier un fichier PNG, mais pas de fichier GIF, vous devez insérer une chaîne vide avant de spécifier le nom du fichier PNG.

Arguments

templateFile, templateParams, swfFileName, {gifFileName}, {pngFileName}, {jpgFileName}, {movFileName}, {generatorParams}

L'argument templateFile est le chemin d'accès du fichier modèle, exprimé sous la forme d'une URL de type file://. Il peut s'agir d'un fichier SWT.
L'argument templateParams est un tableau de paires nom/valeur dans lequel les noms identifient les paramètres du fichier SWT et les valeurs correspondent à la définition que vous voulez leur attribuer. Pour que Dreamweaver puisse reconnaître un fichier SWF comme objet Flash, le premier paramètre doit être "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.
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 de l'argument templateParams étaient incorrectes.
"initGeneratorFailed" signifie que Generator n'a pas pu être initialisé.
"OutOfMemory" signifie que l'opération n'a pas pu se terminer correctement faute de mémoire.
"unknownError" signifie qu'une erreur inconnue s'est produite.

Exemple

Le code JavaScript suivant crée un fichier objet Flash de type "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é.

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 d'objet Flash. Il s'agit généralement d'un fichier SWF.

Valeurs renvoyées

Une chaîne représentant le type d'objet ou contenant la valeur null si le fichier n'est pas un fichier d'objet Flash ou s'il est introuvable.

Exemple

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

if (SWFFile.getObjectType("file:///MyMac/test.swf") == "myType") {
    alert ("This is a myType object.");
} else {
    alert ("This is not a myType object.");
}

SWFFile.readFile()

Description

Cette fonction lit un fichier d'objet Flash.

Arguments

fileName

- L'argument fileName, exprimé sous la forme d'une URL de type file://, correspond au chemin d'accès à un fichier d'objet Flash.

Valeurs renvoyées

Un tableau de chaînes dans lequel le premier élément est le chemin d'accès complet du fichier modèle SWT. Les chaînes suivantes représentent les paramètres (paires nom/valeur) de l'objet. Dans le tableau, chaque nom est suivi de sa valeur. La première paire nom/valeur est "dwType", suivie par sa valeur. La fonction renvoie une valeur null si le fichier est introuvable ou s'il ne s'agit pas d'un fichier d'objet Flash.

Exemple

L'appel du code var params = SWFFile.readFile("file:///MyMac/test.swf") renvoie les valeurs suivantes dans le tableau des paramètres :

"file:///MyMac/test.swt"    // template file used to create this .swf file
"dwType"    // first parameter
"myType"    // first parameter value
"text"    // second parameter
"Hello World"    // second parameter value

Fonctions des panneaux et des boîtes de dialogue de Flash

Les API suivantes permettent d'ajouter des fichiers SWF dans les panneaux et les boîtes de dialogue.

dreamweaver.flash.newControl()

Disponibilité

Dreamweaver CS4.

Description

Cette fonction permet de créer un contrôle Flash. Elle est prise en référence plus tard par l'intermédiaire du paramètre controlID. Le contrôle affiche le fichier Flash (.swf) spécifié par le chemin d'accès SWF. Le contrôle possède une position et une taille spécifiées dans le paramètre defaultGeometry.

Remarque : Dreamweaver affiche les contrôles Flash lorsque vous appelez flash.requestStateChange. Dreamweaver affiche les contrôles de boîte de dialogue newControl ; il n'est pas nécessaire d'appeler flash.requestStateChange.

Arguments

controlID, controlType, controlData

L'argument controlID est une valeur de chaîne.
L'argument controlType spécifie si le panneau est une extension standard ("standard"), une extension standard approuvée ("trusted") ou une extension plus (toute autre valeur). S'il s'agit d'une extension plus, la valeur est un identificateur connu spécifiquement de l'application hôte et qui indique le type d'intégration personnalisée requise. Si l'application ne comprend pas le type d'intégration personnalisée, elle renvoie une erreur.
controlData est un objet. Voici quelques-unes des propriétés essentielles de cet argument :

Propriété	Description	Valeurs
controlData.swfUTF8Path	Emplacement du fichier SWF. Cette propriété, obligatoire, est transmise sous la forme d'une chaîne de caractères Unicode, car tous les caractères dans JavaScript sont en format Unicode.	Valeurs admises pour controlData.windowTypePanelWindow.Le tableau qui suit ce tableau énumère les spécifications pour cette valeur.ModalDialogWindow
{controlData.scriptPath}	Chemin d'accès au fichier.js contenant les fonctions à exécuter depuis .swf à l'aide d'un appel d'interface externe. Cette propriété est facultative. Si vous voulez effectuer un rappel dans le code JavaScript de Dreamweaver à partir du fichier .swf au moyen d'une interface externe, vous pouvez fournir un fichier.js contenant des fonctions que vous pourrez ensuite appeler depuis le fichier .swf. Pour plus d'informations, voir l'appeldw.flash.executeScript.
controlData.defaultGeometry	Les valeurs defaultGeometry sont représentées sous la forme de coordonnées d'écran à partir du coin supérieur gauche de l'écran. Cette propriété est obligatoire.Object /!< default creation geometry, including positioning /{ topleftx: Number, toplefty: Number, width: Number, height: Number }

Le tableau suivant énumère les spécifications de PanelWindow :

Options	Type	Descriptions
name	Chaîne	Le nom du panneau qui s'affiche dans l'onglet. Si vous ne le précisez pas, il est nommé « UNDEFINED ». Tous les noms de panneaux sont en majuscules. Vous ne pouvez pas les convertir en minuscules.
{controlData.minSize}	Objet	minSize ne s'applique qu'aux contrôles de type PanelWindow. Cette option détermine la taille minimale à laquelle le panneau peut être réduit. Cette option est facultative. Si la valeur minSize n'est pas précisée, elle utilise par défaut la largeur et la hauteur définies dans defaultGeometry. Il est dès lors impossible de redimensionner le panneau.{ width: Number, height: Number }
{controlData.maxSize}	Objet	maxSize ne s'applique qu'aux contrôles de type PanelWindow. Cette option est facultative. Cette option détermine la taille maximale à laquelle le panneau peut être agrandi. Si la valeur maxSize n'est pas précisée, elle utilise par défaut la largeur et la hauteur définies dans defaultGeometry. Il est dès lors impossible de redimensionner le panneau.{ width: Number, height: Number }
{iconPathNormal}	Chaîne	Chemin d'accès à l'icône qui doit être employée dans le panneau flottant lorsqu'il est réduit en icône. Cette option est facultative.
{iconPathRollOver}	Chaîne	Chemin d'accès à l'icône qui doit être employée dans le panneau flottant lorsqu'il est réduit en icône et que l'utilisateur le survole. Cette option est facultative.
{iconPathDisable}	Chaîne	Chemin d'accès à l'icône qui doit être employée dans le panneau flottant lorsqu'il est réduit en icône et désactivé. Cette option est facultative.

Valeurs renvoyées

L'un des codes de réussite ou d'erreur suivants :

Le code PlugPlugErrorCode_success indique que la création du contrôle a réussi.
Le code PlugPlugErrorCode_extensionRegistrationFailed indique que vous n'avez pas réussi à enregistrer le contrôle.

dreamweaver.flash.requestStateChange()

Disponibilité

Dreamweaver CS4.

Description

Cette fonction modifie l'état du panneau flottant identifié par uniqueID pour l'extension possédant l'ID extensionID.

Arguments

controlID, stateChange, stateData

- L'argument controlID est une valeur de chaîne.

- L'argument stateChange est une chaîne qui peut avoir l'une des valeurs suivantes :

Valeur	Description
Move	Modification d'origine, mais pas de taille
Resize	Nouvelle taille et éventuellement nouvelle origine
Show	Visibilité uniquement, mais pas de modifications géométriques
Hide	Visibilité uniquement, mais pas de modifications géométriques
Minimize	Similaire à hide, mais explique la raison du masquage.
Restore	Similaire à show, mais explique la raison de l'affichage.
Ouvrir	La fenêtre est créée et son extension est chargée.
Close	L'extension contenue est déchargée.

- Les valeurs de l'argument stateData sont des chaînes, comme le montre le tableau suivant :

Valeur de stateChange	Valeur de stateData
Move	eventData = { topleftx: Number, toplefty: Number }
Resize	eventData = { width: Number, height: Number }

Valeurs renvoyées

Le tableau suivant contient les valeurs renvoyées, qui sont des chaînes :

Valeur	Description
RequestPosted	Un événement ou une commande d'exécution de la demande a été placé en file d'attente dans l'application hôte.
RequestComplete	L'application hôte a terminé la demande.
RequestFailed	L'application hôte a tenté de terminer la demande, mais a échoué.
RequestDenied	L'application hôte a refusé la demande, généralement parce qu'elle ne prend pas en charge l'action demandée.

Exemple

controlData = {};
controlData.defaultGeometry = {topleftx : 100, toplefty : 100, width : 200, height : 200};
controlData.minSize = {width : 100; height : 100};
controlData.maxSize = {width : 300; height : 300};
var swfPath = dw.getConfigurationPath();
swfPath += '/flash/PhotoAlbum.swf';
controlData.swfUTF8Path = swfPath;
// open the window
flash.requestStateChange("com.adobe.extension.foo", "Open", controlData.defaultGeometry);

dreamweaver.flash.controlEvent()

Disponibilité

Dreamweaver CS4.

Description

Cette fonction permet de transmettre des événements à un contrôle Flash. Les appels d'événements sont transmis sous la forme d'une chaîne XML qui capture la fonction et les paramètres appropriés. La chaîne XML capture la fonction à démarrer dans le fichier SWF.

Arguments

• L'argument inControlID est une chaîne.
- L'argument inXMLString est une chaîne. Transmettez le inXMLString suivant pour appeler la fonction dans le fichier Flash flashCallback et transmettez une chaîne unique, 'Hello', en tant qu'argument.

<invoke name="flashCallback" returntype="xml">
    <arguments>
    <string>Hello</string>
    </arguments>
</invoke>

Valeurs renvoyées

Renvoie une chaîne XML.

Exemple

L'exemple suivant appelle la fonction flashCallback depuis JavaScript. Dans cet exemple, vous transmettre le nom de la fonction de rappel et ses arguments sous la forme d'une chaîne XML.

var xmlString = '<invoke name="flashCallback" returntype="xml">
    <arguments>
    <string>Hello</string>
    </arguments>
    </invoke>';
</img>

Dans cet exemple, vous utilisez dw.flash.controlEvent pour effectuer un rappel dans le fichier Flash (.swf) :

dw.flash.controlEvent('Flickr', xmlString);

Les arguments suivants sont utilisés dans cette fonction :

Flickr, qui est l'ID de l'extension transmis lorsque le contrôle .swf a été créé avec dw.flash.newControl.
La chaîne XML contenant la fonction de rappel et les arguments.

L'exemple suivant est la mise en oeuvre de la fonction flashcallback implémentée dans flashcallback.mxml. Dans l'exemple suivant, ajoutez la fonction flashcallback. Cette fonction doit être appelée à partir d'applications externes.

public function initApp(): void {
    ExternalInterface.addCallback("flashCallback", flashCallback);
}

Cette fonction est rappelée depuis l'extérieur du fichier Flash (.swf).

Remarque : Veillez à appeler ExternalInterface.addCallback ("flashCallback",flashCallback) avant de tenter d'appeler cette fonction.

public function flashCallback(inputStr:String):String
{
    out.text += inputStr + " got flashCallback!\n";
    return "it worked!";
}

dreamweaver.flash FluclMenu()

Disponibilité

Dreamweaver CS4.

Description

Cette fonction permet de fournir des commandes de survol pour les extensions de type "PanelWindow".

Arguments

inControlID est un ID d'extension. L'appel de la fonction influe sur le menu de survol d'un panneau ouvert qui héberge l'extension. Si cet argument n'est pas défini, l'appel influe sur les menus principaux de l'application.
inMenuPosition est une chaîne qui décrit où les commandes données doivent être placées.

- Si cette chaîne n'est pas définie, un menu entier est remplacé.

- Si cette chaîne concerne un panneau, toute la zone définissable par l'utilisateur du menu de survol est remplacée. L'application réserve certains éléments de survol fixes.

- Si cette chaîne concerne l'application, tout le sous-menu Contrôles par défaut du menu Fenêtre est remplacé.

- Si cette chaîne est une chaîne XML dans un schéma restant à déterminer pour la définition de sections de menus, ce formulaire est fourni pour une compatibilité future.

- inMenu équivaut à MenuItem. Cet argument indique une liste de commandes qui sont ajoutées à l'emplacement indiqué dans le menu. Il remplace tout élément antérieur qui a été ajouté à cet endroit par un appel précédent.

Valeurs renvoyées

L'un des codes de réussite ou d'erreur suivants :

Le code PlugPlugErrorCode_success indique une réussite.
Le code PlugPlugErrorCode_extensionMenuCreationFailed indique que la création du menu de l'extension a échoué.
Le code PlugPlugErrorCode_unknown indique que la fonction a échoué pour une raison inconnue.

Exemple

L'exemple suivant sert à configurer le menu :

function initializeMenuItem(menuID,名单Name,extensionID, submenu)
{
    var menuItem = {};
    menuItem.menuId =军团ID; //!< unique menu ID, if NULL menu is disabled
    menuItem.nameUtf8 =名单Name; //!< Item title, if "---" item is a separator
    menuItem.extensionId = extensionID; //!< optional extension ID, used for panels only
    menuItem.submenu = submenu; //!< if non-NULL, this is a submenu
    return menuItem;
}
function setupMenu()
{
    var menus = new Array();
    menuItems.push(initializeMenuItem('id1', 'Call .swf ActionScript', undefined, undefined));
    menuItems.push(initializeMenuItem('id0', '---', undefined, undefined));
    menuItems.push(initializeMenuItem('id2', 'Call Dw JavaScript', undefined, undefined));
    dw.flash.setMenu('Flickr', controlID, menuItems);
}

Remarque : Spécifiez une fonction nommée "onSelectMenuItem" dans le fichier JavaScript indiqué dans le scriptPath de l'objet transmis à newControl.

onSelectMenuItem est un gestionnaire d'élément de menu. Il est appelé avec l'ID de menu correspondant lorsqu'une commande est sélectionnée depuis le menu de survol de l'objet flottant.

L'exemple suivant spécifie la définition du gestionnaire de rappel dans « Configuration/flash/Flickr.js » :

function onSelectMenuItem(menuID)
{
    if (menuID == 'id1') {
    var flashCallbackString = '<invoke name="flashCallback"
    returntype="xml">
    <arguments><string>Hello</string></arguments></invoke>';
    dw.flash.control Event('Flickr', flashCallbackString);
    return("PlugPlugRequestCompleted");
    } else {
    alert ('You selected: menuID = ' + menuID);
    return ("PlugPlugRequestCompleted");
    }
}

dreamweaver.flash.evalScript()

Disponibilité

Dreamweaver CS4.

Description

Cette fonction sert à appeler une fonction JavaScript dans l'un des buts suivants :

Exécution d'une fonction JavaScript définie dans le fichier de script associé à l'extension (pour les extensions CSXS)
Le fichier .js défini dans le paramètre scriptPath pour les extensions non basées sur CSXS.

Arguments

controlID, javascript function call

controlID est l'ID de l'extension qui doit exécuter le script. Cet ID doit correspondre à l'ID spécifié comme premier paramètre de dw.flash.newControl().
L'argument d'appel de fonction JavaScript permet à l'utilisateur d'appeler une fonction avec n'importe quel nombre de paramètres.

Valeurs renvoyées

Valeur booléenne, true si l'exécution de la fonction a réussi et false dans le cas contraire. dans le cas contraire.

dreamweaver.flash.executeScript()

Disponibilité

Dreamweaver CS4.

Description

Cette fonction sert à exécuter des fonctions dans un fichier .js. Le code ActionScript dans le fichier .swf démarre la fonction dreamweaver.flash.executeScript().

Arguments

javascript function call

Remarque : Définissez un chemin d'accès au fichier .js contenant les fonctions que vous voulez appeler.

Valeurs renvoyées

Chaîne XML qui se sérialise en un objet ActionScript.

Exemple

L'exemple suivant contient un fichier d'exemple, Sample.mxml, ainsi qu'une fonction JavaScript dans un fichier JavaScript, Sample.js.

private function executeScript(): void
{
    if (ExternalInterface.available)
    {
    out.text += "SwfCalledHost\n";
    var scriptText:String = "helloWorld('scott');\n";
    var resultStr:Object =
    ExternalInterface.call("dw.flash.executeScript",scriptText);
    out.text += "Result: " + resultStr.strResult + '\n';
    }
}

Le fichier JavaScript suivant contient une fonction JavaScript helloWorld() qui est appelée depuis le fichier .swf. Cette fonction emploie l'appel dw.getAppLanguage() pour renvoyer un code à cinq lettres de la langue dans laquelle Dreamweaver s'exécute dans Sample.js.

function helloWorld(nameStr)
{
    alert('hello ' + nameStr);
    var appLanguage = dw getAppLanguage();
    var returnStr = '<object><property id="strResult"><string>Language: ' + appLanguage + '</string></property></object>'
    alert(returnStr);
    return (returnStr);
}

Voir aussi

« dreamweaver.flash.newControl() » à la page 45

dreamweaver.flash.controlExists

Disponibilité

Dreamweaver CS4.

Description

Cette fonction sert à vérifier l'existence des contrôles. Les contrôles PanelWindow sont enregistrés entre les lancements de Dreamweaver.

Arguments

controlID

Valeurs renvoyées

Valeur booléenne : true si le contrôle a déjà été créé et false dans le cas contraire.

Chapitre 7 : Intégration de Photoshop

Adobe® Dreamweaver CS4® facilite une intégration compacte avec Adobe® Photoshop®. L'utilisateur peut insérer des images Photoshop sous la forme d'objets dynamiques dans Dreamweaver. La fonctionnalité Objets dynamiques met automatiquement à jour les images dans Dreamweaver si des modifications sont apportées aux images d'origine à l'aide de Photoshop.

Fonctionnement des objets dynamiques

Les images Photoshop sont insérées dans Dreamweaver sous la forme d'objets dynamiques. Les objets dynamiques restent liés aux images Photoshop d'origine. Lorsqu'un utilisateur modifie l'image dans Photoshop, il peut voir une image mise à jour dans Dreamweaver. Un objet dynamique possède un état spécifique, qui résulte principalement de la connexion de l'image Web à son fichier d'actif initial. L'utilisateur peut déterminer visuellement l'état d'un objet dynamique. L'état de synchronisation d'un objet dynamique est indiqué par le badge Sync.

L'API des objets dynamiques

Les fonctions des objets dynamiques traitent des opérations relatives à l'intégration de Dreamweaver et de Photoshop. Ces fonctions permettent d'effectuer les opérations suivantes :

• Récupération de l'état d'une image
- Récupération de la hauteur et de la largeur d'une image

dreamweaver.assetPalette.canUpdateSmartObjectFromOriginal()

Disponibilité

Dreamweaver CS4.

Description

Activateur : Cette fonction vérifie si un objet dynamique, sur lequel on peut émettre la commande Mettre à jour depuis l'original, est sélectionné dans le panneau actif.

Arguments

Aucun.

Valeurs renvoyées

Valeur booléenne : true si la commande Mettre à jour depuis l'original peut être appliquée à la sélection actuelle. false dans le cas contraire.

dreamweaver.assetPalette.updateSmartObjectFromOriginal()

Disponibilité

Dreamweaver CS4.

Description

Cette fonction recrée l'image Web sélectionnée sur la base du contenu actuel du fichier source d'origine connecté.

Arguments

Aucun.

Valeurs renvoyées

Aucun.

dreamweaver.getSmartObjectState()

Disponibilité

Dreamweaver CS4.

Description

Cette fonction renvoie l'état d'une image Web en termes de fonctionnalités d'objets dynamiques.

Arguments

URL locale absolue d'une image Web.

Valeurs renvoyées

L'état de l'objet dynamique sous la forme d'une valeur numérique, comme :

Valeur numérique	Description
-10	Erreur inconnue
0	Pas d'objet dynamique.
1	Synchronisé avec le contenu du fichier d'actif d'origine.
100	Image Web modifiée après la dernière synchronisation.
200	Actif d'origine modifié après la dernière synchronisation.
+2	Les dimensions de l'actif d'origine diffèrent des attributs de largeur et de hauteur dans le code HTML.
+4	Les dimensions de l'image Web diffèrent des attributs de largeur et de hauteur dans le code HTML.
10	Impossible d'accéder au fichier d'actif d'origine.
20	Impossible d'accéder au fichier d'image Web.

dreamweaver.getSmartObjectOriginalWidth()

Disponibilité

Dreamweaver CS4.

Description

Cette fonction évalue et renvoie la largeur en pixels du fichier d'actif d'origine d'un objet dynamique.

Arguments

URL locale absolue de l'image Web.

Valeurs renvoyées

Largeur en pixels du fichier d'actif d'origine.

dreamweaver.getImageWidth()

Disponibilité

Dreamweaver CS4.

Description

Cette fonction évalue et renvoie la largeur en pixels d'une image.

Arguments

URL locale absolue d'une image Web.

Valeurs renvoyées

Largeur en pixels de l'image.

dreamweaver.getImageHeight()

Disponibilité

Dreamweaver CS4.

Description

Cette fonction évalue et renvoie la hauteur en pixels d'une image.

Arguments

URL locale absolue d'une image Web.

Valeurs renvoyées

Hauteur en pixels de l'image.

dreamweaver.resolveOriginalAssetFileURLToAbsoluteLocalFilePath()

Description

Cette fonction met à jour une image Web sur la base du contenu actuel d'un fichier source d'origine.

Arguments

URL locale absolue d'une image Web.

Valeurs renvoyées

Aucun.

Chapitre 8 : API de base de données

Les fonctions de l'API de base de données permettent de gérer les connexions aux bases de données et d'accéder aux informations stockées dans ces dernières. L'API de base de données est divisée en deux fonctions distinctes : gestion des connexions aux bases de données et accès aux connexions de bases de données.

Les fonctions de l'API de base de données sont utilisées au moment de la conception, lorsque les utilisateurs développent leurs applications Web, et non au moment de l'exécution, c'est-à-dire lorsque l'application Web est déployée.

Il est possible d'utiliser ces fonctions dans n'importe quelle extension. En fait, les API de comportement de serveur, de format des données et de source de données de Adobe® Dreamweaver® CS4 utilisent toutes ces fonctions de base de données.

Fonctionnement de l'API de base de données

L'exemple suivant illustre la façon dont la fonction de comportement de serveur, getDynamicBindings(), est définie pour Recordset.js. Cet exemple utilise la fonction MMDB.getColumnAndTypeList():

function getDynamicBindings(ss)
{
    var serverModel = dw.getDocumentDOM().serverModel.getServerName();
    var bindingsAndTypeArray = new Array();
    var connName=ss.connectionName;
    var statement = ss.source;
    var rsName= ss.rsName;

    // remove SQL comments
    statement = statement.replace(/\/\*\[\S\s]*?\*\//g, " ");
    var bIsSimple = ParseSimpleSQL(statement);
    statement = stripCFIFSimple(statement);

    if (bIsSimple) {
    statement = RemoveWhereClause(statement,false);
    } else {
    var pa = new Array();

    if (ss.ParamArray != null) {
    for (var i = 0; i < ss.ParamArray.length; i++) {
    pa[i] = new Array();
    pa[i][0] = ss.ParamArray[i].name;
    pa[i][1] = ss.ParamArray[i].value;
    }
    }

    var statement = replaceParamsWithVals(statement, pa, serverModel);
    }
    bindingsAndTypeArray = MMDB.getColumnAndTypeList(connName, statement);
    return bindingsAndTypeArray;
}

Fonctions de connexion à une base de données

Les fonctions de connexion à une base de données vous permettent d'établir et de gérer toutes les connexions, y compris les connexions ADO de Dreamweaver, ColdFusion et JDBC.

Ces fonctions interagissent avec le Gestionnaire de connexions uniquement ; elles n'accèdent pas aux bases de données. Pour les fonctions qui accèdent aux bases de données, voir « Fonctions d'accès à la base de données » à la page 71.

Dans le cadre de la gestion des connexions de bases de données, vous pouvez obtenir le nom d'utilisateur et le mot de passe afin d'accomplir des activités telles que :

Etablissement d'une connexion à une base de données
Ouverture d'une boîte de dialogue de connexion à une base de données

MMDB.deleteConnection()

Disponibilité

Dreamweaver MX.

Description

Cette fonction permet de supprimer la connexion à la base de données nommée.

Arguments

connName

- L'argument connName est le nom de la connexion à la base de données tel qu'il est spécifié dans le Gestionnaire de connexions. Cet argument identifie la connexion à la base de données à supprimer en fonction de son nom.

Valeurs renvoyées

Aucune.

Exemple

L'exemple suivant supprime une connexion à une base de données :

function clickedDelete()
{
    var selectedObj = dw.serverComponents.getSelectedNode();
    if (selectedObj && selectedObj.objectType=="Connection")
    {
    var connRec = MMDB.getConnection(selectedObj.name);
    if (connRec)
    {
    MMDB.deleteConnection(selectedObj.name);
    dw.serverComponents.refresh();
    }
    }
}

MMDB.getColdFusionDsnList()

Disponibilité

Dreamweaver UltraDev 4.

Description

Cette fonction extrait les noms des sources de données (DSN) ColdFusion du serveur du site, en utilisant les fonctions getRDSUserName() et getRDSPassword().

Arguments

Aucun.

Valeurs renvoyées

Tableau contenant les DSN ColdFusion définis sur le serveur pour le site en cours.

MMDB.getConnection()

Disponibilité

Dreamweaver UltraDev 4, amélioré dans Dreamweaver MX.

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
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, voir « MMDB.getProcedures() » à la page 74)
schema	Utilisé pour restreindre les métadonnées qui apparaissent (pour plus d'informations, voir « MMDB.getProcedures() » à la page 74)
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"].

MMDB.getConnectionName()

Disponibilité

Dreamweaver UltraDev 1.

Description

Extrait un nom de connexion correspondant à la chaîne de connexion spécifiée. Cette fonction est utile lorsque vous devez resélectionner un nom de connexion dans l'interface utilisateur (UI) à partir des données de la page.

Si vous avez une chaîne de connexion faisant référence à deux pilotes différents, vous pouvez spécifier à la fois la chaîne de connexion et le pilote correspondant au nom de connexion que vous souhaitez obtenir. Par exemple, vous pourriez avoir deux connexions :

- Connexion 1 possède les propriétés suivantes :

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.

Exemple

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

Pour une connexion ADO, la chaîne suivante peut renvoyer :
"dsn=EmpDB;uid=;pwd=";
Pour une connexion JDBC, la chaîne suivante peut renvoyer :

"jdbc:inetdae:192.168.64.49:1433?database=pubs&user=JoeUser&password=joesSecret"

MMDB.getDriverName()

Disponibilité

Dreamweaver UltraDev 1.

Description

Extrait le nom du pilote associé à la connexion spécifiée. Seules les connexions JDBC ont des noms de pilote.

Arguments

connName

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

MMDB.getRemoteDsnList()

Disponibilité

Dreamweaver UltraDev 4, amélioré dans 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 d'expressions nom=valuer, 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

Valeurs renvoyées

Chaîne correspondant au type de connexion. Cette fonction peut renvoyer l'une des valeurs suivantes : "ADO", "ADODSN", "JDBC" ou "CFDSN".

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

Aucun.

Valeurs renvoyées

Aucune.

MMDB拼音Connection()

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/Connections/server-model. Ce fichier HTML définit la boîte de dialogue qui crée une connexion. Ce fichier doit déployer trois fonctions d'API JavaScript : 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, voir « API de connectivité à une base de données » à la page 83.

connRec est une référence à un objet de connexion existant.
• bDuplicate est une valeur booléenne.

Valeurs renvoyées

Aucune. La boîte de dialogue de connexion définie s'ouvre.

MMDB.setRDSPassword()

Disponibilité

Dreamweaver UltraDev 4.

Description

Définit le mot de passe RDS.

Arguments

password

- password est une chaîne contenant le mot de passe RDS.

Valeurs renvoyées

Aucune.

MMDB.setRDSUserName()

Disponibilité

Dreamweaver UltraDev 4.

Description

Définit le nom d'utilisateur RDS.

Arguments

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.

MMDB.testConnection()

Disponibilité

Dreamweaver UltraDev 4.

Description

Teste les paramètres de connexion. Affiche une boîte de dialogue modale qui décrit les résultats.

Arguments

serverPropertiesArray

Cette fonction attend un seul argument, un objet de tableau contenant les valeurs de la liste suivante adaptées au modèle de serveur en cours. Pour les propriétés qui ne s'appliquent pas à la connexion testée, laissez-les vides ( " " ).

type indique, lorsque useHTTP est une valeur false, quelle DLL utiliser pour se connecter à une base de données au moment de la conception, pour tester les paramètres de connexion.
string est la chaîne de connexion ADO ou l'URL JDBC.
• dsn est le nom de la source de données.
driver est le pilote JDBC.
username est le nom d'utilisateur.
• L'argument password est le mot de passe.
L'argument useHTTP est une valeur booléenne. Une valeur true spécifie que Dreamweaver doit utiliser une connexion HTTP au moment de la conception ; dans le cas contraire, Dreamweaver utilise une DLL.

Valeurs renvoyées

Valeur booléenne, true si le test de connexion est réussi, false dans le cas contraire.

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

Les fonctions d'accès à la base de données vous permettent de faire une recherche dans la base de données.

L'accès aux informations de base de données permet par exemple d'extraire les métadonnées qui décrivent le schéma ou la structure d'une base de données. Ces métadonnées incluent des informations telles que les noms des tables, des colonnes, des procédures stockées et des affichages. Vous pouvez également afficher les résultats de l'exécution d'une requête de base de données ou d'une procédure stockée. Lorsque vous accédez à une base de données par le biais de cette API, vous utilisez des instructions SQL (Structured Query Language).

Pour l'ensemble des fonctions qui gèrent une connexion à une base de données, voir « Fonctions de connexion à une base de données » à la page 59.

La liste suivante décrit certains des arguments communs à toutes les fonctions disponibles :

La plupart des fonctions d'accès à une base de données utilisent un nom de connexion comme argument. Pour obtenir une liste des noms de connexion valides, utilisez le Gestionnaire de connexions ou la fonction MMDB.getConnectionList(). Cette dernière vous permet d'obtenir par programmation une liste de tous les noms de connexion.
Les procédures stockées exigent souvent des paramètres. Vous pouvez spécifier des valeurs de paramètre pour les fonctions d'accès à la base de données de deux façons. En premier lieu, vous pouvez fournir un tableau de valeurs de paramètre (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.

MMDB.getColumnAndTypeList()

Disponibilité

Dreamweaver UltraDev 1.

Description

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

Arguments

connName, déclaration

connName est un nom de connexion spécifié dans le Gestionnaire de connexions. Il identifie la chaîne de connexion que Dreamweaver doit utiliser pour connecter la base de données à une source de données active.
L'argument statement est la déclaration SQL SELECT à exécuter.

Valeurs renvoyées

Un tableau de chaînes qui représente une liste de colonnes (et leur type) qui correspondent à la déclaration SELECT, ou bien une erreur si la déclaration SQL n'est pas valide ou si la connexion n'a pas pu s'établir.

Exemple

Le code var columnArray = MMDB.getColumnAndTypeList("EmpDB", "Select * from Employees") renvoie le tableau de chaînes suivant :

columnArray[0] = "EmpName"
columnArray[1] = "varchar"
columnArray[2] = "EmpFirstName"
columnArray[3] = "varchar"
columnArray[4] = "Age"
columnArray[5] = "integer"

MMDB.getColumnList()

Disponibilité

Dreamweaver UltraDev 1.

Description

Cette fonction extrait la liste de colonnes d'une déclaration SQL 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 = MMDB.getColumnList("EmpDB", "Select * from Employees") renvoie le tableau de chaînes suivant :

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

MMDB.getColumns()

Disponibilité

Dreamweaver MX, arguments mis à jour dans MX 2004.

Description

Renvoie un tableau d'objets qui décrivent les colonnes de la table spécifiée.

Arguments

connName, tableName

L'argument connName est le nom de la connexion. Cette valeur identifie la connexion qui contient la chaîne que Dreamweaver doit utiliser pour établir une connexion de base de données à une source de données active.
tableName est la table à interroger.

Valeurs renvoyées

Un tableau d'objets, à raison d'un objet par colonne. Chaque objet définit les trois propriétés suivantes pour la colonne à laquelle il est associé.

Nom de propriété	Description
name	Nom de la colonne (par exemple, price)
datatype	Type de données de la colonne (par exemple, small money)
definedsize	Taille définie de la colonne (par exemple, 8)
nullable	Indique si la colonne peut contenir des valeurs null

Exemple

L'exemple suivant utilise MMDB.getColumns() pour définir la valeur du texte de l'infobulle :

var columnNameObj = MMDB.getColumns(connName, tableName);
var databaseType = MMDB.getDatabaseType(connName);
for (i = 0; i < columnNameObj.length; i++)
{
    var columnIndex = columnNameObj[i];
    var columnName = columnIndex.name;
    var typename = columnIndex.datatype;
    if (dwscripts.isNumber(typename))
    {
    // it already is a num
    typename = dwscripts.getDBColumnTypeAsString(typename, databaseType);
    }
    var toltiptext = typename;
}

MMDB.getColumnsOfTable()

Disponibilité

Dreamweaver UltraDev 1.

Description

Cette fonction extrait une liste de toutes les colonnes de la table spécifiée.

Arguments

connName, tableName

connName est un nom de connexion spécifié dans le Gestionnaire de connexions. Il identifie la chaîne de connexion que Dreamweaver doit utiliser pour connecter la base de données à une source de données active.
L'argument tableName est le nom d'une table de la base de données désignée par l'argument connName.

Valeurs renvoyées

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

Exemple

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

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

MMDB.getPrimaryKeys()

Disponibilité

Dreamweaver MX.

Description

Renvoie les noms de colonne qui s'associent pour former la clé primaire de la table nommée. Une clé primaire sert d'identificateur unique pour une ligne de base de données et se compose d'une colonne minimum.

Arguments

connName, tableName

connName est un nom de connexion spécifié dans le Gestionnaire de connexions. Il identifie la chaîne de connexion que Dreamweaver doit utiliser pour connecter la base de données à une source de données active.
L'argument tableName est le nom de la table pour laquelle vous souhaitez restituer l'ensemble des colonnes comprenant la clé primaire de cette table.

Valeurs renvoyées

Tableau de chaînes. Le tableau contient une chaîne pour chaque colonne comprenant la clé primaire.

Exemple

L'exemple suivant renvoie la clé primaire de la table spécifiée.

var connName = componentRec.parent.parent.parent.name;
var tableName = componentRec.name;
var primaryKeys = MMDB.getPrimaryKeys(connName,tableName);

MMDB.getProcedures()

Disponibilité

Dreamweaver MX.

Description

Cette fonction renvoie un tableau d'objets de procédure associés à une connexion nommée.

Arguments

connName

Valeurs renvoyées

Un tableau d'objets de procédure dans lequel chaque objet de procédure a les trois propriétés suivantes :

Nom de propriété	Description
schema	Nom du schéma associé à l'objet.Cette propriété identifie l'utilisateur associé à la procédure stockée dans la base de données SQL et à laquelle accède la fonction getProcedures( ). La base de données à laquelle accède cette fonction dépend du type de connexion.Pour les connexions ODBC, la source de données ODBC définit la base de données. Le DSN est spécifié par la propriété dsn dans l'objet de 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.
catalog	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.

Remarque : Dreamweaver se connecte à la base de données et en extrait toutes les tables chaque fois que vous modifiez un jeu d'enregistrements. Si la base de données contient de nombreuses tables, la procédure de leur extraction par Dreamweaver sur certains systèmes peut prendre beaucoup de temps. Si votre base de données contient un schéma ou un catalogue, vous pouvez l'utiliser pour limiter le nombre d'éléments de base de données que Dreamweaver récupère au moment de la conception. Pour commencer, créez un schéma ou un catalogue dans votre application de base de données de façon à pouvoir ensuite l'appliquer dans Dreamweaver. Consultez la documentation de votre système de base de données ou consultez votre administrateur système.

Exemple

Le code suivant extrait une liste de procédures :

var procObjects = MMDB.getProcedures(connectionName);
for (i = 0; i < procObjects.length; i++)
{
    var thisProcedure = procObjects[i]
    thisSchema = Trim(thisProcedure.schema)
    if (thisSchema.length == 0)
    {
    thisSchema = Trim(thisProcedure.catalog)
    }
    if (thisSchema.length > 0)
    {
    thisSchema += "."
    }

    var procName = String(thisSchema + thisProcedure.procedure);
}

MMDB.getSPColumnList()

Disponibilité

Dreamweaver UltraDev 1.

Description

Cette fonction extrait une liste de colonnes de jeu de résultats générées par un appel à la procédure stockée spécifiée.

Arguments

connName, statement, paramValuesArray

connName est un nom de connexion spécifié dans le Gestionnaire de connexions. Il identifie la chaîne de connexion que Dreamweaver doit utiliser pour connecter la base de données à une source de données active.
L'argument statement est le nom de la procédure stockée qui renvoie le jeu de résultats lorsqu'elle est exécutée.
L'argument paramValuesArray est un tableau contenant une liste de valeurs tests de paramètre au moment de la conception. Spécifiez les valeurs de paramètre dans l'ordre attendu par la procédure stockée. Vous pouvez utiliser la fonction MMDB.getSPParamsAsString() pour obtenir les paramètres de la procédure stockée.

Valeurs renvoyées

Tableau de chaînes représentant la liste des colonnes. Cette fonction renvoie une erreur lorsque l'instruction SQL ou la chaîne de connexion est incorrecte.

Exemple

Le code suivant peut renvoyer une liste de colonnes de jeux de résultats générées à partir de la procédure stockée exécutée, getNewEmployeesMakingAtLeast :

var paramValueArray = new Array("2/1/2000", "50000")
var columnArray = MMDB.getSPColumnList("EmpDB", ¬" FalconEEM puyeeesMakingAtLeast", paramValueArray)
The following values return:
columnArray[0] = "EmpID", columnArray[1] = "LastName", columnArray[2] = "startDate", columnArray[3] = "salary"

MMDB.getSPColumnListNamedParams()

Disponibilité

Dreamweaver UltraDev 1.

Description

Cette fonction extrait une liste de colonnes de jeu de résultats générées par un appel à la procédure stockée spécifiée.

Arguments

connName, statement, paramNameArray, paramValuesArray

connName est un nom de connexion spécifié dans le Gestionnaire de connexions. Il identifie la chaîne de connexion que Dreamweaver doit utiliser pour connecter la base de données à une source de données active.
L'argument statement est le nom de la procédure stockée qui renvoie le jeu de résultats lorsqu'elle est exécutée.
L'argument paramNameArray est un tableau contenant une liste de noms de paramètres. Vous pouvez utiliser la fonction MMDB.getSPParamsAsString() pour obtenir les paramètres de la procédure stockée.
L'argument paramValuesArray est un tableau contenant une liste de valeurs tests de paramètre au moment de la conception. Vous pouvez spécifier si oui ou non la procédure requiert des paramètres pendant l'exécution. Si vous avez fourni des noms de paramètre dans paramNameArray, spécifiez les valeurs de paramètre dans l'ordre dans lequel leurs noms apparaissent dans paramNameArray. Si vous n'avez pas indiqué paramNameArray, spécifiez les valeurs dans l'ordre attendu par la procédure stockée.

Valeurs renvoyées

Tableau de chaînes représentant la liste des colonnes. Cette fonction renvoie une erreur lorsque l'instruction SQL ou la chaîne de connexion est incorrecte.

Exemple

Le code suivant peut renvoyer une liste de colonnes de jeux de résultats générées à partir de la procédure stockée exécutée, 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 sont retournées :

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.

Exemple

L'exemple suivant extrait les objets de paramètre pour la procédure spécifiée et crée une infobulle pour chaque objet qui utilise ses propriétés.

var paramNameObj = MMDB.getSPParameters(connName, procName);
for (i = 0; i < paramNameObj.length; i++)
{
    var paramObj = paramNameObj[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 des virgules et contenant la liste des paramètres pris par la procédure stockée.

Arguments

connName, procName

connName est un nom de connexion spécifié dans le Gestionnaire de connexions. Il identifie la chaîne de connexion que Dreamweaver doit utiliser pour connecter la base de données à une source de données active.
L'argument procName est le nom de la procédure stockée.

Valeurs renvoyées

Chaîne délimitée par virgules contenant la liste des paramètres requis par la procédure stockée. Les noms, la direction et le type de données des paramètres sont inclus, séparés par des points-virgules (;).

Exemple

Le code 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 de table possède trois propriétés : table, schema et catalog.

Arguments

connName

Valeurs renvoyées

Tableau d'objets possédant chacun 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.

Exemple

L'instruction MMDB.getTables ("EmpDB"); pourrait produire un tableau de deux objets. Les propriétés du premier objet peuvent ressembler à l'exemple suivant :

object1[table:"Employees", schema:"personnel", catalog:"syscat"]

Les propriétés du second objet peuvent ressembler à l'exemple suivant :

object2 [table:"Departments", schema:"demo", catalog:"syscat2"]

MMDB.getViews()

Disponibilité

Dreamweaver UltraDev 4.

Description

Extrait une liste de tous les modes d'affichage définis pour la base de données spécifiée. Chaque objet mode d'affichage a les propriétés catalog, schema et view.

Arguments

connName

Valeurs renvoyées

Tableau d'objets de mode possédant chacun trois propriétés : catalog, schema et view. Catalog ou schema permet de restreindre/filtrer le nombre de modes d'affichage rattachés à un nom de schéma individuel ou à un nom de catalogue défini comme faisant partie des informations de connexion.

Exemple

L'exemple suivant renvoie les modes pour une valeur de connexion donnée, 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))
}

MMDB.showResultset()

Disponibilité

Dreamweaver UltraDev 1.

Description

Affiche une boîte de dialogue contenant les résultats de l'exécution de la déclaration SQL spécifiée. La boîte de dialogue contient une grille dont l'en-tête reflète les informations de colonnes qui décrivent le jeu de résultats. Si la chaîne de connexion ou l'instruction SQL n'est pas valide, une erreur apparaît. Cette fonction valide l'instruction SQL.

Arguments

connName, SQLstatement

connName est un nom de connexion spécifié dans le Gestionnaire de connexions. Il identifie la chaîne de connexion que Dreamweaver doit utiliser pour connecter la base de données à une source de données active.
L'argument SQLstatement désigne l'instruction SQL SELECT.

Valeurs renvoyées

Aucune. Cette fonction renvoie une erreur lorsque l'instruction SQL ou la chaîne de connexion est incorrecte.

Exemple

Le code suivant affiche le résultat de l'instruction SQL exécutée :

MMDB.showResultset("EmpDB", "Select EmpName, EmpFirstName, Age from Employees")

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)

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)

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

En tant que développeur, vous pouvez créer de nouveaux types de connexion et les boîtes de dialogue correspondantes pour les modèles de serveur nouveaux et existants de Adobe® Dreamweaver®. L'utilisateur peut ensuite créer un objet de connexion lors de la configuration d'un site afin d'entamer la création de pages. Pour créer un objet de connexion, l'utilisateur doit tout d'abord sélectionner le type de connexion spécifique que vous avez créé.

Sélection d'un nouveau type de connexion

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

Dans le panneau Application, l'utilisateur peut cliquer sur le bouton Plus (+) et sélectionner Jeu d'enregistrements. Dans la boîte de dialogue Jeu d'enregistrements, il peut agrandir la fenêtre de la liste Connexion.
Il peut cliquer sur le bouton Plus (+) et sélectionner Nom de la source de données dans l'onglet Base de données du panneau Bases de données.

Création d'un nouveau type de connexion

Les étapes suivantes expliquent le processus de création d'un nouveau type de connexion :

1 Définissez la mise en forme de la boîte de dialogue de connexion.

Créez un fichier HTML mettant en forme l'interface utilisateur de votre boîte de dialogue de connexion. Donnez un nom à ce fichier en utilisant le nom de la connexion (par exemple myConnection.htm). Pour plus d'informations sur la création d'une boîte de dialogue, voir Bien démarrer avec Dreamweaver.

Assurez-vous que ce fichier HTML contient bien une référence au fichier de mise en œuvre JavaScript défini à l'étape 2, Créez un fichier JavaScript mettant en œuvre au moins les éléments suivants, comme le montre l'exemple suivant :

<head>
    <script SRC="../myConnectionImpl.js"></script>
</head>

Stockez ce fichier HTML, qui définit votre boîte de dialogue de connexion, dans le dossier Configuration/Connections/modèle_serveur/plate-forme (où la plate-forme est Windows ou Macintosh).

Par exemple, la boîte de dialogue de connexion ADO par défaut pour un document ASP JavaScript sur une 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.

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 œuvre, mais il doit comporter une extension .js (par exemple, myConnectionImpl.js). Vous pouvez stocker ce fichier de mise en œuvre sur votre ordinateur local ou distant. Si vous le souhaitez, vous pouvez également le stocker dans le sous-dossier approprié du dossier Configuration/Connections.

Remarque : Le fichier HTML défini à l'étape 1, Définissez la mise en forme de la boîte de dialogue de connexion, doit contenir ce fichier de mise en œuvre du type de connexion.

Ces deux étapes constituent les conditions minimales pour créer une nouvelle boîte de dialogue de connexion, sauf si vous avez besoin de définir des paramètres de connexion autres que ceux fournis dans le fichier standard connection_includefile.edml.

Remarque : Le titre de la boîte de dialogue que voit l'utilisateur se trouve dans la balise 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 » à la page 59.

L'API de connexion

Pour créer un nouveau type de connexion, y compris la boîte de dialogue avec laquelle les utilisateurs interagissent, vous devez implémenter les trois fonctions suivantes : findConnection(), inspectConnection() et applyConnection(). Vous devez rédiger ces trois fonctions et les inclure dans le fichier de mise en œuvre JavaScript associé à votre nouveau type de connexion (voir Etape 2, Créez un fichier JavaScript qui implémente au moins les éléments suivants :).

La fonction applyConnection() renvoie une source HTML dans un fichier inclus. Vous trouverez des exemples de source HTML dans la section « Fichier inclus généré » à la page 87. La fonction findConnection() prend la source HTML et en extrait les propriétés. Vous pouvez mettre en œuvre findConnection() pour utiliser les modèles de recherche dans les fichiers XML afin d'extraire les informations renvoyées à partir de applyConnection(). Si vous souhaitez voir un exemple de ce type de mise en œuvre, étudiez les deux fichiers JavaScript suivants :

Le fichier connection_ado_conn_string.js se trouve dans le dossier Configuration/Connections/ASP_Js.
Le fichier connection_common.js se trouve dans le dossier Configuration/Connections/Shared.

Lorsque l'utilisateur ouvre un site, Dreamweaver parcourt tous les fichiers dans le dossier Connections, les ouvre et transmet leur contenu à la fonction 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.

Lorsque l'utilisateur clique sur OK dans une boîte de dialogue de connexion, Dreamweaver déclenche la fonction applyConnection() pour construire la page HTML, placée dans le fichier inclus de connexion résidant dans le dossier Configuration/Connections. La fonction applyConnection() renvoie une chaîne vide qui indique une erreur dans l'un des champs. La boîte de dialogue ne doit pas être fermée. Le fichier inclus a un type d'extension de fichier par défaut pour le modèle de serveur en cours.

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 d'utiliser la connexion HTTP au moment de la conception, et false d'utiliser une 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	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 « Création d'un nouveau type de connexion » à la page 83) 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.

Fichier inclus généré

Le fichier inclus que applyConnection() génère déclare toutes les propriétés d'une connexion. Le nom du fichier inclus est le nom de la connexion. Il possède l'extension définie pour le modèle de serveur associé au site actuel.

Remarque : Les connexions étant partagées, définissez la valeur allowMultiple sur false. Elle garantit que le fichier de connexion n'est inclus qu'une fois dans le document. En outre, elle garantit que le script de serveur reste sur la page si d'autres comportements de serveur l'utilisent.

Vous trouverez quelques exemples de fichiers inclus que applyConnection() génère pour divers modèles de serveur par défaut illustrés dans les sections suivantes.

Remarque : Pour créer un format de fichier inclus de connexion, définissez un nouveau fichier de mappage EDML, similaire à connection_includefile.edml, comme l'explique la section « Fichier de définition pour votre type de connexion » à la page 88.

ASP JavaScript

Le fichier inclus ASP et JavaScript doit être nommé MyConnection1.asp, où MyConnection1 est le nom de la connexion. L'exemple suivant est un fichier inclus pour une chaîne de connexion ADO :

<%
    // Filename="Connection_ado_conn_string.htm"
    // Type="ADO"
    // HTTP="true"
    // Catalog=""
    // Schema=""
    var MM_MyConnection1_STRING = "dsn=pubs";
%>

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

<!--#include file="../Connections/MyConnection1.asp"-->

ColdFusion

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

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 :

Le fichier du comportement de serveur inclut cette connexion en utilisant l'instruction cfinclude, comme le montre l'exemple suivant :

Fichier de définition pour votre type de connexion

Pour tous les modèles de serveur, il existe un fichier connection_includefile.edml qui définit le type de connexion et associe les propriétés définies dans le fichier inclus aux éléments de l'interface Dreamweaver.

Par défaut, Dreamweaver fournit des fichiers de définition, un pour chacun des modèles de serveur prédéfinis, comme l'illustre le tableau suivant.

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

<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 œuvre JavaScript.

Toutes les boîtes de dialogue de connexion par défaut de Dreamweaver utilisent le fichier de correspondance connection_includefile.edml. Pour permettre à Dreamweaver de trouver ce fichier, son nom est défini dans le fichier de mise en œuvre JavaScript, comme le montre l'exemple suivant :

Lors de la création d'un type de connexion personnalisée, vous pouvez utiliser n'importe quel fichier de correspondance dans vos boîtes de dialogue personnalisées. Si vous créez un fichier de correspondance, vous pouvez utiliser un nom différent de connection_includefile pour votre fichier EDML. Si vous utilisez un autre nom, vous devez l'utiliser dans votre fichier de mise en œuvre JavaScript lorsque vous indiquez la valeur assignée à la variable PARTICIPANT_FILE comme le montre l'exemple suivant :

var PARTICIPANT_FILE = "myConnection_mappingfile";

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

L'API d'intégration de commande source permet de rédiger des bibliothèques partagées. Ces API vous permettent d'étendre la fonctionnalité Archivage/Extraction d'Adobe® Dreamweaver® à l'aide de systèmes de commande source (tels que Sourcesafe ou CVS).

Vos bibliothèques doivent prendre en charge un minimum de fonctions API pour que Dreamweaver puisse être intégré au système de commande source. En outre, vos bibliothèques doivent se trouver dans le dossier Program Files/Adobe/Adobe Dreamweaver CS4/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 s'affichent dans l'onglet. Ces choix s'affichent en plus des éléments standard de l'onglet. Ces DLL sont chargées depuis le dossier Program Files/Adobe/Adobe Dreamweaver CS4/Configuration/SourceControl.

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

<menu name="Source Control" id="DWMenu_MainSite_Site_Source_Control"><menu item dynamic name="None"file="Menus/MM/">
File_SCSItems.htm" id="DWMenu_MainSite_Site_NewFeatures_Default" />
</menu>

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

Lorsqu'un utilisateur Dreamweaver choisit des fonctions de connexion au serveur, de transfert de fichiers ou de Design Notes, Dreamweaver appelle la version de la DLL de la fonction API correspondante (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.

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

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, Dreamweaver utilise l'extension de fichier pour déterminer le type, comme il le fait à présent)
size	int	En octets

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

bool SCS\_Rename()

Description

Renomme ou déplace un fichier ou un dossier selon les valeurs spécifiées dans les arguments oldRemotePath et newRemotePath. Ainsi, si les valeurs de oldRemotePath et 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 réussite, false dans le cas contraire.

bool SCS\_ItemExists()

Description

Détermine si un fichier ou un dossier existe sur le serveur.

Arguments

void *connectionData, const char *remotePath

L'argument connectionData est un pointeur vers les données de l'agent transférées à Dreamweaver pendant l'appel de la fonction Connect().
remotePath est le chemin d'accès d'un fichier ou d'un dossier distant.

Valeurs renvoyées

Valeur booléenne : true en cas de réussite, false dans le cas contraire.

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

L'API d'intégration de commande source comporte des fonctions obligatoires et facultatives. Les fonctions répertoriées dans cette section sont facultatives.

bool SCS\_GetConnectionInfo()

Description

Affiche une boîte de dialogue qui permet à l'utilisateur de modifier ou de définir les informations de connexion du site. N'établit pas la connexion. Cette fonction est appelée lorsque l'utilisateur clique sur le bouton Paramètres dans la section Infos distantes de la boîte de dialogue Modifier les sites.

Arguments

void **connectionData, const char siteName[64]

L'argument connectionData est un descripteur des données que l'agent veut recevoir de Dreamweaver lorsqu'il appelle d'autres fonctions API.
L'argument siteName est une chaîne qui pointe vers le nom du site. Ce nom ne peut pas comporter plus de 64 caractères.

Valeurs renvoyées

Valeur booléenne : true en cas de réussite, false dans le cas contraire.

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

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

menuItemsList 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.
L'argument functionList est renseigné par la DLL ; il indique les routines de la DLL à appeler lorsque l'utilisateur choisit l'élément de menu correspondant.
L'argument 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é.

- L'argument 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 réussite, 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.

Valeurs renvoyées

Valeur booléenne : true en cas de réussite, 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 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 réussite, false dans le cas contraire.

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.

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 depuis fichier MNO.

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.
L'argument noteCount correspond au nombre de Design Notes jointes à un fichier ou dossier ; cette valeur est renvoyée par la fonction GetNoteCount().

- L'argument 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 réussite, 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éta-informations 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.
L'argument noteCount correspond au nombre de Design Notes jointes à un fichier ou dossier ; ce nombre permet à la DLL de connaître la taille des listes spécifiées. Si noteCount a pour valeur 0, toutes les Design Notes sont supprimées du fichier.
L'argument noteLength est la longueur de la Design Note la plus longue pour le fichier ou le dossier spécifié.

Valeurs renvoyées

Valeur booléenne : true en cas de réussite, false dans le cas contraire.

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[], constchar*localPathList[], int remoteIsNewerList[], const int numItems

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

remotePathList est une liste de noms de chemin d'accès aux fichiers ou aux dossiers à comparer pour connaître ceux dotés des états les plus récents.
L'argument localPathList est une liste miroir des noms de chemin d'accès aux fichiers ou aux dossiers locaux.
remoteIsNewerList est une liste de nombres entiers complétée par la DLL pour permettre à Dreamweaver d'identifier le fichier le plus récent du côté distant. Les valeurs suivantes sont admises : 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 réussite, 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

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

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 réussite, 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

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

Exemple

Voir « bool SCS_BeforePut() » à la page 110.

Chapitre 11 : Application

Les fonctions relatives aux applications effectuent des opérations ayant trait à la façon dont Adobe® Dreamweaver® 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).

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

- L'argument browser 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 est omis, l'URL est ouverte dans le navigateur principal de l'utilisateur.

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

Valeurs renvoyées

Aucune.

Exemple

La fonction suivante utilise la fonction dreamweaver.browseDocument() pour ouvrir la page d'accueil Adobe dans un navigateur :

function goToadobe() {
    dreamweaver.browseDocument('http://www.adobe.com/');
}

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 goToadobe() {
    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.adobe.com/',theBrowser);
}

Pour plus d'informations sur la fonction dreamweaver.getBrowserList(), consultez la section « dreamweaver.getBrowserList() » à la page 113.

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.

Exemple

Un appel à la fonction dreamweaver.getExtensionEditorList(".gif") pourrait renvoyer un tableau contenant les chaînes suivantes :

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 FlashMX 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 FlashMX. 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]);
}

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.

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

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

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 ci-dessous é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

Valeur booléenne : true en cas de réussite et false si Dreamweaver ne peut pas ouvrir le fichier spécifié dans le visualisateur d'aide.

Exemple

openHelpURL("DW_Using:index.htm");

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.

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.

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 FlashMX (ou une version ultérieure) est installé sur l'ordinateur local.

fileName

- fileName est une chaîne qui contient le nom du fichier à afficher, exprimé sous la forme d'une URL.

Valeurs renvoyées

Aucune

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("Is your order complete?")
    {
    dreamweaver.beep();
    alert("Click OK to submit your order");
    }
}

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

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. Mis à jour dans CS4.

Description

La fonction ouvre la boîte de dialogue Préférences.

Arguments

{strCategory}

- L'argument facultatif strCategory doit être l'une des chaînes suivantes pour ouvrir la catégorie correspondante de 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,"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, la boîte de dialogue ouvre le dernier volet actif. Il en va de même si aucun argument n'est défini.

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

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

L'argument id est une chaîne unique permettant d'identifier 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.
L'argument idleFunction est la fonction JavaScript à appeler au cours du temps de traitement inactif.
L'argument interval est le nombre de secondes entre les appels de la fonction idleFunction, soumis à la disponibilité du temps d'inactivité.

Valeurs renvoyées

Valeur booléenne indiquant si la tâche d'inactivité a été enregistrée correctement.

Exemple

L'exemple suivant entraîne l'émission par le système d'un bip sonore toutes les 5 secondes :

dw.registerIdleHandler("acme_beep_task", function() { dw.beep();}, 5);

dw.revokeldleHandler()

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

- L'id est 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 supprime 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.

Fait de l'application spécifiée le processus de premier plan en appelant la fonction BridgeTalk::bringToFront().

Arguments

applicationID

- L'argument applicationID est une chaîne, par exemple, bridge ou dreamweaver, qui indique quelle application activer.

Valeurs renvoyées

Aucune

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. est l'application cible. Dans le cas présent, il suffit de l'application Bridge. Son identificateur est bridge. est le message à envoyer. En règle générale, 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é à la propriété .

if (!JSBridge.isRunning('bridge'))
{
    var bt = new BridgeTalk;
    var scriptSavePath = browsePath.replace(/['"\]/g, "$&");
    var script = "app.document.thumbail = new Thumbnail(decodeURI('" + scriptSavePath + ''));";
    // Send the script to bridge and give it 10 sec to launch before assuming an error.
    bt.target = "bridge";
    bt.body = script;
    result = bt.send(10);
}
if (result)
BridgeTalk.bringToFront('bridge');

Bridgetalk.send()

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.

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 position0 (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 CS4 - Exemple - 1

text_image

Historique Image: ADOBE DREAMWEAVER CS4 - Exemple - 2

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.

Exemple

if(!dom.convertActiveContent(true)) { alert(dw.loadString("ActiveContent/notAllConverted")); }

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.

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

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.

dreamweaver.mapKeyCodeToChar()

Disponibilité

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

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.

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, voir « Fenêtre de résultats indépendante » à la page 153.

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

Description

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.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 d'Adobe 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().

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 nœuds
context	Nom de l'élément qui apparaît dans la liste de contexte
icon	Icône à utiliser pour le nœud d'arborescence
name	Nom à afficher
value	Valeur à afficher
timestamp	Uniquement applicable au nœud 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

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>

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 signifie que les numéros de ligne sont visibles et false qu'ils ne le sont pas. Valeurs renvoyées Aucune.

dom.setShowRulers()

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

var dom = dw.getDocumentDOM();
if(dom != null && dom.getToolbarVisibility("myEditbar") == false)
{
    dom.setToolbarVisibility("myEditbar", true);
{

Exemple

L'exemple suivant ouvre le panneau Actifs et le fait clignoter : dw.bringAttentionToFloater("library");

dreamweaver.cascade()

Disponibilité

Dreamweaver 3, mise à jour dans CS4.

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, où floaterName correspond au nom d'un panneau flottant. Les valeurs de floaterName pour les panneaux 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"

Bases de données = "databases"

Cadres = "frames"

Historique = "history"

Barre Insertion = "objects"

Calques = "layers"

Bibliothèque = "library"

Vérificateur de liens (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"

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 l'argument floaterName ne correspond pas à l'un des noms de panneau flottant réservés, Dreamweaver recherche dans le dossier Configuration/Floaters un fichier nommé floaterName.htm. Si Dreamweaver ne trouve aucun panneau flottant portant le nom floaterName, cette fonction n'a aucun effet. Les valeurs de floaterName pour les panneaux 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"

Bases de données = "databases"

Cadres = "frames"

Historique = "history"

Styles HTML = "html styles"

Barre Insertion = "objects"

Calques = "layers"

Bibliothèque = "library"

Vérificateur de liens (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"

Fragments de code = "snippets"

Inspecteur de balises = "tag inspector"

Vérification de la compatibilité avec les navigateurs = "bcc"

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é

Fonctions de la barre d'information

La barre d'information sert à afficher des messages d'erreur sans interrompre les activités. Les fonctions suivantes de la barre d'information servent à masquer ou à afficher la barre d'information contenant des messages d'erreur.

dom.showInfoBar()

Disponibilité

Dreamweaver CS4.

Description

Cette fonction affiche la barre d'information contenant le message transmis. Si la barre d'information est déjà affichée, son contenu est mis à jour en fonction du nouveau message transmis. Si aucun message n'est transmis, une erreur JS se produit.

Arguments

Message.

Valeurs renvoyées

Aucun.

dom.hideInfoBar()

Disponibilité

Valeurs renvoyées

Chaîne contenant le nom du mode d'affichage principal, qui peut être l'une des valeurs suivantes :

Valeur	Description
code	L'affichage principal est la fenêtre Code.
design	L'affichage principal est la fenêtre Création.
related file	L'affichage principal est la fenêtre des fichiers apparentés. Cette valeur est renvoyée lorsque l'affichage utilisé pour le document est Code fractionné et qu'un fichier apparenté a été ouvert.

dreamweaver.setPrimaryView()

Disponibilité

Dreamweaver CS4.

Description

Cette fonction modifie le mode d'affichage principal. En mode Fractionné ou Code fractionné, le mode principal est la fenêtre supérieure ou de gauche, en fonction de l'orientation du mode Fractionné.

Arguments

Chaîne contenant le nom du mode d'affichage principal, qui peut être l'une des valeurs suivantes :

Valeur	Description
code	L'affichage principal est la fenêtre Code.
design	L'affichage principal est la fenêtre Création.
related file	L'affichage principal est la fenêtre des fichiers apparentés. Cette valeur est utilisée lorsque l'affichage utilisé pour le document est Code fractionné et qu'un fichier apparenté a été ouvert.

Valeurs renvoyées

Valeur booléenne : true en cas de réussite, false dans le cas contraire.

dom.isRelatedFileViewOpen()

Disponibilité

Dreamweaver CS4.

Description

Cette fonction détermine si l'affichage contient une fenêtre de fichiers apparentés.

Arguments

Aucun.

Valeurs renvoyées

Valeur booléenne : true si une fenêtre de fichiers apparentés est ouverte, false dans le cas contraire.

Fonctions relatives au fractionnement des codes

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 : Il existe deux barres d'outils de codage, l'une pour le mode Code et l'autre pour l'inspecteur ed 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.

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. Voir « dom.getShowHiddenCharacters() » à la page 207 pour un exemple.

Arguments

show \- 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('<!--', '-->')

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

Fonctions relatives aux sites

Ces fonctions permettent d'effectuer des opérations sur les fichiers de 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();

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.

site.checkIn()

Disponibilité

Activateur

Voir « site.canCheckOut() » à la page 492.

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 Fichiers 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 Fichiers ; \- l'URL d'un dossier particulier, qui indique si cloak() doit envelopper le dossier spécifié et tout son contenu.

Valeurs renvoyées

Aucune.

Activateur

Voir « site.canCloak() » à la page 492.

site.compareFiles()

Disponibilité

Dreamweaver 8.

Description

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

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
    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="Local Folder"
    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="right" 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="Modified"
    align="left" show="TRUE" share="FALSE" builtin="TRUE"
    localwidth="102" remotewidth="102" />
    <column name="Checked Out By"
    align="left" show="TRUE" share="FALSE" builtin="TRUE"
    localwidth="50" remotewidth="50" />
    <column name="Status" note="status"
    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>

site.get()

Disponibilité

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 site, 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();

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 "denise (deniseLaptop)". Si aucun nom d'extraction n'est spécifié, seul le nom d'utilisateur est renvoyé ("denise", par exemple).

site.getCheckOutUserForFile()

Disponibilité

Activateur

Voir « site.canConnect() » à la page 493.

site.getCurrentSite()

Disponibilité

Exemple

var dom = dw.getDocumentDOM(); var siteRoot = site.getSiteRootForURL(dom.URL);

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 =_siteURLPrefix();

site.importSite()

Disponibilité

Dreamweaver MX.

Description

Crée un site Dreamweaver à partir d'un fichier XML. Dreamweaver emploie l'attribut localroot de l'élément pour identifier le dossier racine local du site. Pendant l'importation, si ce dossier n'existe pas sur l'ordinateur local, Dreamweaver demande un dossier racine local différent. Dreamweaver se comporte de la même façon lorsqu'il tente de trouver le dossier images par défaut, spécifié par l'attribut imagefolder de l'élément .

Arguments

pathToSteFile \- L'argument pathToSteFile est une chaîne qui contient l'URL du fichier STE. Dreamweaver utilise ce fichier pour créer un site. Si pathToSteFile est une chaîne vide, Dreamweaver invite l'utilisateur à choisir un fichier STE à importer.

Valeurs renvoyées

Valeur booléenne : true si le fichier STE nommé existe et si la création du site réussit et false dans le cas contraire.

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.

site.open()

Disponibilité

Dreamweaver 3.

Description

Ouvre les fichiers actuellement sélectionnés dans le panneau Fichiers. 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

Voir « site.canOpen() » à la page 495.

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 Fichiers, soit l'URL d'un fichier. Valeurs renvoyées Aucune. Activateur Voir « site.canPut() » à la page 496.

site.recreateCache()

Disponibilité Dreamweaver 3. Description Recrée le cache du site en cours. Arguments Aucun. Valeurs renvoyées Aucune. Activateur Voir « site.canRecreateCache() » à la page 496.

site.refresh()

Activateur

Voir « site.canSelectNewer() » à la page 497.

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

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, mise à jour dans CS4.

Description

Active le volet spécifié du panneau Fichiers. Si le volet spécifié n'est pas affiché, la fonction l'affiche et l'active.

Arguments

whichPane, nextTextView - L'argument whichPane doit correspondre à l'une des chaînes suivantes : local ou remote. - L'argument nextTextView alterne les modes actifs en mode d'affichage fractionné.

Valeurs renvoyées

Aucune.

site.setSelection()

Disponibilité

Dreamweaver 3.

Description

Sélectionne les fichiers ou les dossiers visibles dans le volet actif du panneau Fichiers.

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.

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

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.

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.

Valeurs renvoyées

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

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}, {startFolder}, {allowDynamic}, {fileToLocate} - 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 la valeur de cet argument est true, la boîte de dialogue filtre les fichiers d'image ; si elle est omise, l'argument 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. - L'argument arrayOfExtensions (ajouté dans Dreamweaver 4) est un tableau de chaînes. Il définit le contenu par défaut de la liste Types de fichiers qui s'affiche dans le bas de la boîte de dialogue. La syntaxe de cet argument est menuEntryText | .xxx[; .yyy; .zzz] | CCCC|, où : - menuEntryText est le nom du type de fichier. - Vous pouvez définir les extensions sous la forme .xxx [; .yyy; .zzz] ou CCCC: - .xxx spécifie l'extension de nom de fichier pour le type de fichier. .yyy et .zzz permettent de spécifier plusieurs extensions de nom de fichier. - cccc est la constante de type de fichiers à quatre caractères pour Macintosh. L'exemple suivant fournit deux filtres dans votre boîte de dialogue de sélection, l'un pour les fichiers MP3 et l'autre pour tous les fichiers :

dw.browseForFileURL("select", "Please select an mp3", false, true, new Array("mp3 Files (*.MP3) | *.mp3 || ", "All Files (*.*) | *.* ||"));

- L'argument startfolder est une valeur de chaîne qui permet de spécifier l'URL de fichier du dossier dans lequel la recherche débute. Si cet argument n'est pas spécifié, la recherche débute à partir du dernier répertoire utilisé. Cet argument est facultatif. - L'argument allowdynamic est une valeur booléenne qui indique si les URL et les paramètres dynamiques sont autorisés ou non. Si cet argument a la valeur true, les URL et les paramètres dynamiques sont autorisés. Cet argument est facultatif. - L'argument fileToLocate est une valeur de chaîne qui sert à spécifier l'URL du fichier que vous voulez trouver. Cet argument est facultatif.

Valeurs renvoyées

Une chaîne contenant le nom du fichier, exprimé sous la forme d'une URL de type file://.

dreamweaver.browserForFolderURL()

Disponibilité

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>Untitled Document</title>
<meta http-equiv="Content-Type" content="text/html; charset=" />
</head>

<body bgcolor="#FFFFFF" text="#000000">

</body>
</html>

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

Voir « dreamweaver.canExportTemplateDataAsXML() » à la page 475. 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.

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.endsWithDocument();
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é

Activateur

Voir « dreamweaver.canOpenInFrame() » à la page 476.

Dreamweaver 3.

Description

Ouvre la boîte de dialogue Enregistrer sous.

Arguments

Valeurs renvoyées

Aucune.

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

Voir « dreamweaver.canSaveDocumentAsTemplate() » à la page 479.

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

Valeurs renvoyées

Aucune.

Activateur

Voir « dreamweaver.canSaveFrameset() » à la page 479.

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

Dreamweaver MX 2004.

Description

Masque le message qui peut s'afficher sous forme d'infobulle dans la fenêtre de document.

Arguments

Aucun.

Valeurs renvoyées

Aucune.

Voir aussi

« dom.showInfoMessagePopup() » à la page 265.

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() » à la page 238. Le validateur vérifie que le langage du document est conforme à celui qui a été spécifié dans le doctype du document (par exemple HTML 4.0 ou HTML 3.2) et à celui qui a été spécifié par le modèle de serveur (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.

Arguments

{controlString}, {bOpenResultsWindow}, {bShowInfoMessage} - L'argument controlString est une chaîne facultative qui possède quatre valeurs possibles : une chaîne vide, "xml", "auto-explicit" 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() » à la page 449 and « dom.autoValidationCount() » à la page 442), 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 est une valeur booléenne facultative : true ouvre la fenêtre Résultat de la validation, et false ne l'ouvre pas. 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 "auto-implicit". L'argument bShowInfoMessage est une valeur booléenne. true affiche un message d'information sous l'élément de barre d'outils, DW\_ValidatorErrors, indiquant le nombre d'erreurs trouvées. false n'affiche rien. 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);

dom.showInfoMessagePopup()

Disponibilité

Dreamweaver MX 2004.

Description

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

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

Valeurs renvoyées

var snapDist = getSnapDistance();
if (snapDist > 0)
{
    dreamweaver.setPreferenceInt("My Extension", "Snap Distance", snapDist);
}

dreamweaver.setPreferenceString()

Disponibilité

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.

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

Disponibilité

Dreamweaver 2.

Description

Lorsqu'elle reçoit une URL absolue et le chemin d'un document, cette fonction convertir l'URL absolue en un chemin d'accès relatif au document.

Arguments

docPathURL, siteRootURL, absoluteURL - L'argument docPathURL est le chemin d'accès à un document sur l'ordinateur de l'utilisateur (par exemple, le document actuel), exprimé sous la forme d'une URL file://. - L'argument siteRootURL est le chemin d'accès à la racine du site, exprimé sous la forme d'une URL file://. - L'argument absoluteURL est l'URL file:// à convertir en chemin d'accès relatif au document.

Valeurs renvoyées

Chaîne représentant le chemin d'accès au document à absoluteURL, exprimé de façon relative au document à docPathURL.

Exemple

Dans l'exemple suivant, si les valeurs de docPathURL et siteRootURL sont respectivement file://C:/sites/cherrystreet/archives/october.shtml et file://C:/sites/cherrystreet/, la valeur renvoyée est "../includes/header.html". Cette valeur permet de faire référence à /includes/header.html à partir de /archives/october.shtml.

var docPathURL = dw.getDocumentDOM().URL;
var siteRootURL = dw.getSiteRoot();
var absoluteURL= dw.relativeToAbsoluteURL(docPathURL, siteRootURL, "/includes/header.html");
var docRelPath = dw.absoluteURLToDocRelative(docPathURL, siteRootURL, absoluteURL);

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

Exemple

La fonction ci-dessous permet de 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);

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é

Exemple

Le code suivant permet d'obtenir un tableau de sélecteurs de type class :

var dom=dw.getDocumentDOM();  
var classSelectors = dom.getSelectorsDefinedInStylesheet('class');

Le code suivant permet d'obtenir un tableau de sélecteurs de type ID :

var dom=dw.getDocumentDOM();  
var classSelectors = dom.getSelectorsDefinedInStylesheet('ID');

dom.nodeToOffsets()

Disponibilité

Dreamweaver 3.

Description

Obtient la position d'un nœud 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 nœud 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 nœud, 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(offset[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(offset[0], offsets[1]);
if (theSelection.nodeType == Node.ELEMENT_NODE && theSelection.tagName == 'IMG') {
    alert('The current selection is an image.');
}

Exemple

L'exemple ci-dessous permet d'obtenir le nœud en cours, de localiser un tableau, puis d'appeler la fonction dw.nodeExists() afin de vérifier si le nœud original existe encore :

function applyFormatToSelectedTable() {
    // get current selection
    var selObj = dw.getDocumentDOM().getSelectedNode();
    alternateRows(dwscripts.findDOMObject("presetNames").selectedIndex, findTable());
    // restore original selection, if it still exists; if not, just select the
    // table.
    var selArr;
    if (dw.nodeExists(selObj))
    selArr = dom.nodeToOffsets(selObj);
    else 
    selArr = dom.nodeToOffsets(findTable());
    dom.setSelection(selArr[0],selArr[1]);
}

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

Voir « dreamweaver.canSelectAll() » à la page 480.

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

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 XML temporaire (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 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é.

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

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 XML temporaire (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 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

Exemple

L'exemple suivant ouvre la boîte de dialogue Document source XML sans indiquer de valeur : MMXSLT.launchXML SourceDialog()

Chapitre 15 : Contenu de page

Les fonctions relatives au contenu de page d'Adobe® Dreamweaver® permettent d'effectuer des opérations qui affectent le contenu d'une page Web. Ces opérations sont les suivantes : • Manipulation d'actifs dans le panneau Actifs - Ajout de comportements - Manipulation d'éléments en les coupant et en les collant dans le Presse-papiers • Application d'un modèle - Insertion d'un fragment de code - Création d'ensembles de données XML Spry - Modification améliorée de Spry et d'autres widgets - Insertion de widgets - Création de mises en page qui fonctionnent dans divers navigateurs, grâce aux fonctions de vérification de la compatibilité avec les navigateurs

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

Activateur

Voir « dreamweaver.assetPalette.canEdit() » à la page 473.

dreamweaver.assetPalette.getSelectedCategory()

Disponibilité

Dreamweaver 4.

Description

Renvoie la catégorie sélectionnée.

Arguments

Aucun.

Valeurs renvoyées

La catégorie actuellement sélectionnée, qui peut être l'une des suivantes : "templates", "library", "images", "movies", "shockwave", "flash", "scripts", "colors" ou "urls".

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, qui peut être "folder" ou 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.

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] = "MyFolderName"
items [1] = "//path/FolderName"
items [2] = "folder"
items [3] = "MyFavoriteURL"
items [4] = "http://www.MyFavoriteURL.com"
items [5] = "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.insert Or Apply()

Disponibilité

Dreamweaver 4.

Description

Insère les éléments sélectionnés ou applique l'élément à la sélection en cours. Cette fonction applique des modèles, des couleurs et des URL à la sélection. Elle insère également des URL et d'autres éléments au niveau du point d'insertion. Si aucun document n'est ouvert, la fonction n'est pas disponible.

Arguments

Aucun. Valeurs renvoyées Aucune. Activateur Voir « dreamweaver.assetPalette.canInsert Or Apply() » à la page 474.

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é. Arguments Aucun. Valeurs renvoyées Aucune.

dreamweaver.assetPalette.newAsset()

Valeurs renvoyées

Un objet DOM ou une valeur null. Cette 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 dreamweaver popupAction() démarre le script en cours d'exécution ; - 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() » à la page 299 afin de déterminer si l'action sélectionnée est appropriée pour la balise HTML sélectionnée. Elle s'en distingue par le fait qu'elle donne accès à plus d'informations au sujet de la balise et de ses attributs. Si vous écrivez une action qui ne peut être appliquée qu'à un lien hypertexte (A HREF) qui ne prend pas pour cible un autre cadre ou une autre fenêtre, vous pouvez utiliser la fonction getBehaviorElement(). Vous pouvez utiliser la fonction getBehaviorElement() au sein de la fonction qui initialise l'interface utilisateur pour la boîte de dialogue Paramètres. Ce principe est illustré dans l'exemple suivant :

function initializeUI() {
    var theTag = dreamweaver.getBehaviorElement();
    var CANBEAPPLIED = (theTag.tagName == "A" && ¬
    theTag.getAttribute("HREF") != null && ¬
    theTag.getAttribute("TARGET") == null);
    if (CANBEAPPLIED) {
    // display the action user interface
    } else {
    // display a helpful message that tells the user
    // that this action can only be applied to a
    // link without an explicit target]
    }
}

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 Paramètres :

function initializeUI() {
    var theTag = dreamweaver.getBehaviorTag().toUpperCase();
    var CANBEAPPLIED = (theTag.indexOf('HREF') != -1));
    if (CANBEAPPLIED) {
    // display the action UI
    } else {
    // display a helpful message that tells the user
    // that this action can only be applied to a
    // hyperlink
    }
}

dreamweaverthernAction()

Disponibilité

Dreamweaver 2, mise à jour dans CS4.

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 qui contient le nom d'un fichier dans le dossier Configuration/Behaviors/Actions. Ce fichier contient une action de comportement JavaScript (par exemple, « Swap Image .htm »). - L'argument facultatif funcCall est une chaîne contenant un appel de fonction pour l'action définie dans actionName (par exemple, "MM\_SwapImage(...)"). La fonction applyBehavior() du fichier d'action fournit cet argument, s'il a été spécifié.

Valeurs renvoyées

Appel de fonction de l'action de comportement. Lorsque l'utilisateur clique sur OK dans la boîte de dialogue Paramètres, le comportement est ajouté au document actuel. Les fonctions appropriées sont ajoutées à la section HEAD du document. Du code HTML est ajouté à la section BODY et d'autres modifications peuvent être apportées au document. L'appel de fonction ("MM\_SwapImage ( . . . )", 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 en base zéro, si le panneau Comportements affiche la liste, un appel de la fonction dreamweaver.behaviorInspector.getBehaviorAt(2) renvoie un tableau contenant deux éléments : "onMouseOver" et "MM\_changeProp('document.moon', 'document.moon', 'src', 'sun.gif', 'MG')".

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é 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, un appel de la fonction dreamweaver.behaviorInspector.getSelectedBehavior() renvoie 0.

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

L'appel de la fonction dreamweaver.behaviorInspector.moveBehaviorDown(2) inverse les positions des actions Précharger les images et Changer la propriété de 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. ![](images/bf26e23151ab561bd18bbd26fe5c1ead9633b6065c7fb2566d880c7ad08241c7.jpg)

text_image

Inspecteur de balises Attributes Comportements Balise onClick Appel JavaScript onFocus Lire le son onMouseDown Changer la propriété

Voir aussi

« dreamweaver.behaviorInspector.getSelectedBehavior() » à la page 301

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.

Exemple

L'appel de la fonction dreamweaver.behaviorInspector.moveBehaviorUp(3) inverse les positions des actions Précharger les images et Changer la propriété de 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. ![](images/f48b0868c2ad5cfaac46a543136d36471a83f9cea1fbe3c72af34d3ec0b97534.jpg)

text_image

Inspecteur de balises Attributes Comportements Balise onClick Appel JavaScript onFocus Lire le son onMouseDown Changer la propriété

Voir aussi

« dreamweaver.behaviorInspector.getSelectedBehavior() » à la page 301

dreamweaver.behaviorInspectorierceSelectedBehavior()

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

L'appel de la fonction dreamweaver.behaviorInspector.setSelection(2) sélectionne l'action Changer la propriété qui est associée à l'événement onMouseDown : ![](images/fb3c411cc287f58a70edb6f8e4023dbe130f31f51fe1f82eb8331bb7bbe11e67.jpg)

text_image

Inspecteur de balises Attributes Comportements Balise onClick Appel JavaScript onFocus Lire le son onMouseDown Changer la propriété

Voir aussi

« dreamweaver.behaviorInspector.getSelectedBehavior() » à la page 301

Presse-papiers, fonctions

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 cette fonction agit sur la sélection dans la fenêtre active : la fenêtre de document actuelle, l'inspecteur de code ou le 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.

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Untitled_Document</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
ABC Widgets</body>
</html>

Voir « dreamweaver.canClipPaste() » à la page 475.

Exemple

L'exemple suivant colle le contenu du Presse-papiers sous forme de texte : dw.clipPaste("text");

dreamweaver.getClipboardText()

Disponibilité

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 nœuds d'élément.

Exemple

« dom.getSelectedEditableRegion() » à la page 312.

dom.getIsLibraryDocument()

Disponibilité

Dreamweaver 3.

Description

Détermine si le document est un élément de bibliothèque.

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.getEditableRegionList(). Pour plus d'informations, voir « dom.getEditableRegionList() » à la page 311.

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

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

Aucune.

Activateur

Voir « dreamweaver.snippetpalette.canEditSnippet() » à la page 490.

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

Voir « dreamweaver.snippetpalette.canInsert() » à la page 491.

dreamweaver.snippetPalette.insertSnippet()

Disponibilité

Dreamweaver MX.

Description

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 nœud Attr ainsi que des nœuds 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";

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 . Si le document contient déjà un bloc JavaScript à cet endroit, Dreamweaver n'insérera pas de nouvelle balise