Mode d'emploi MACROMEDIA DREAMWEAVER 8 GUIDE DES API DE DREAMWEAVER

[. . . ] Guide des API de Dreamweaver Marques commerciales 1 Step RoboPDF, ActiveEdit, ActiveTest, Authorware, Blue Sky Software, Blue Sky, Breeze, Breezo, Captivate, Central, ColdFusion, Contribute, Database Explorer, Director, Dreamweaver, Fireworks, Flash, FlashCast, FlashHelp, Flash Lite, FlashPaper, Flex, Flex Builder, Fontographer, FreeHand, Generator, HomeSite, JRun, MacRecorder, Macromedia, MXML, RoboEngine, RoboHelp, RoboInfo, RoboPDF, Roundtrip, Roundtrip HTML, Shockwave, SoundEdit, Studio MX, UltraDev et WebHelp sont soit des marques de commerce, soit des marques déposées de Macromedia, Inc. qui peuvent être déposées aux Etats-Unis ou sous toute autre juridiction. Les autres noms de produits, logos, graphiques, mises en page, titres, mots ou phrases mentionnés dans cette publication peuvent être des marques, des marques de service ou des noms de marque appartenant à Macromedia, Inc. ou à d'autres entités et peuvent être déposés dans certains pays, états ou provinces. [. . . ] Si fileURL est une chaîne vide, Dreamweaver invite l'utilisateur à choisir un fichier XML à importer. Valeurs renvoyées Valeur booléenne : true si le fichier XML nommé existe et si la création du site réussit et false dans le cas contraire. 288 Site site. invertSelection() Disponibilité Dreamweaver 3. Description Inverse la sélection dans la carte du site. Arguments Aucun. Valeurs renvoyées Aucune. site. isCloaked() Disponibilité Dreamweaver MX. Description Détermine si la sélection en cours dans le panneau Site ou le dossier spécifié est voilé. Arguments siteOrURL L'argument siteOrURL doit contenir l'une des deux valeurs suivantes : le mot-clé "site", qui indique que la fonction isCloaked() doit tester la sélection dans le panneau Site ; l'URL de fichier d'un dossier particulier, qui indique si isCloaked() doit tester le dossier spécifié. Valeurs renvoyées Valeur booléenne : true si l'objet spécifié est voilé et false dans le cas contraire. Fonctions relatives aux sites 289 site. locateInSite() Disponibilité Dreamweaver 3. Description Recherche le ou les fichiers indiqués dans le volet spécifié du panneau Site et sélectionne les fichiers. Arguments localOrRemote, siteOrURL L'argument localOrRemote doit avoir la valeur "local" ou "remote". L'argument siteOrURL doit être soit le mot-clé "site", indiquant que la fonction doit agir sur l'élément sélectionné dans le panneau Site, soit l'URL d'un fichier. Valeurs renvoyées Aucune. Activateur Voir site. canLocateInSite(), page 609. site. makeEditable() Disponibilité Dreamweaver 3. Description Désactive le drapeau de lecture seule sur les fichiers sélectionnés. Arguments Aucun. Valeurs renvoyées Aucune. Activateur Voir site. canMakeEditable(), page 609. 290 Site site. makeNewDreamweaverFile() Disponibilité Dreamweaver 3. Description Crée un nouveau fichier Dreamweaver dans le panneau Site (dans le même dossier que le premier fichier ou dossier sélectionné). Arguments Aucun. Valeurs renvoyées Aucune. Activateur Voir site. canMakeNewFileOrFolder(), page 610. site. makeNewFolder() Disponibilité Dreamweaver 3. Description Crée un nouveau dossier dans le panneau Site (dans le même dossier que le premier fichier ou dossier sélectionné). Arguments Aucun. Valeurs renvoyées Aucune. Activateur Voir site. canMakeNewFileOrFolder(), page 610. Fonctions relatives aux sites 291 site. newHomePage() Disponibilité Dreamweaver 3. Description Ouvre la boîte de dialogue Nouvelle page d'accueil pour permettre à l'utilisateur de créer une nouvelle page d'accueil. REMARQUE 292 Cette fonction agit seulement sur les fichiers de l'affichage Carte du site. Arguments Aucun. Valeurs renvoyées Aucune. site. newSite() Disponibilité Dreamweaver 3. Description Ouvre la boîte de dialogue Définition du site pour définir un nouveau site. Arguments Aucun. Valeurs renvoyées Aucune. Site site. open() Disponibilité Dreamweaver 3. Description Ouvre les fichiers actuellement sélectionnés dans le panneau Site. Si des dossiers sont sélectionnés, ils sont développés dans l'affichage Fichiers du site. Arguments Aucun. Valeurs renvoyées Aucune. Activateur Voir site. canOpen(), page 610. 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 téléchargés et aucune boîte de dialogue ne s'affiche. Arguments siteOrURL L'argument siteOrURL doit être soit le mot-clé "site", indiquant que la fonction doit agir sur l'élément sélectionné dans le panneau Site, soit l'URL d'un fichier. Fonctions relatives aux sites 293 Valeurs renvoyées Aucune. Activateur Voir site. canPut(), page 611. site. recreateCache() Disponibilité Dreamweaver 3. Description Recrée le cache du site en cours. Arguments Aucun. Valeurs renvoyées Aucune. Activateur Voir site. canRecreateCache(), page 611. site. refresh() Disponibilité Dreamweaver 3. Description Actualise la liste des fichiers sur le côté spécifié du panneau Site. Arguments whichSide L'argument whichSide doit avoir la valeur "local" ou "remote". Si la carte du site est active et que whichSide a pour valeur "local", la carte du site est actualisée. Valeurs renvoyées Aucune. 294 Site Activateur Voir site. canRefresh(), page 612. site. remoteIsValid() Disponibilité Dreamweaver 3. Description Détermine si le site distant est valide. Arguments Aucun. Valeurs renvoyées Valeur booléenne qui indique si un site distant a été défini et, dans le cas où le type de serveur est Local/Réseau, si le lecteur est monté. site. removeLink() Disponibilité Dreamweaver 3. Description Supprime le lien sélectionné du document situé au-dessus de lui dans la carte du site. Arguments Aucun. Valeurs renvoyées Aucune. Activateur Voir site. canRemoveLink(), page 612. site. renameSelection() Disponibilité Dreamweaver 3. Fonctions relatives aux sites 295 Description Transforme le nom du fichier sélectionné en champ de texte et permet à l'utilisateur de renommer le fichier. Si plusieurs fichiers sont sélectionnés, cette fonction agit sur le dernier. Arguments Aucun. Valeurs renvoyées Aucune. site. runValidation() Disponibilité Dreamweaver MX. Description Exécute le validateur sur la totalité du site ou uniquement sur les éléments mis en surbrillance. Arguments selection L'argument selection est le paramètre qui spécifie que le validateur doit vérifier les éléments mis en surbrillance uniquement ; dans le cas contraire, le validateur vérifie l'ensemble du site en cours. Valeurs renvoyées Aucune. site. saveAsImage() Disponibilité Dreamweaver 3. Description Ouvre la boîte de dialogue Enregistrer sous pour permettre à l'utilisateur d'enregistrer la carte du site sous forme d'image. Arguments fileType 296 Site L'argument fileType correspond au type d'image à enregistrer. Pour Windows, les valeurs autorisées sont "bmp" et "png", et pour Macintosh "pict" et "jpeg". Si cet argument n'est pas défini ou que sa valeur n'est pas valide sur la plate-forme en cours, il prend par défaut la valeur "bmp" pour Windows et "pict" pour Macintosh. Valeurs renvoyées Aucune. site. selectAll() Disponibilité Dreamweaver 3. Description Sélectionne tous les fichiers de l'affichage actif (à savoir soit la carte du site, soit les fichiers de site). Arguments Aucun. Valeurs renvoyées Aucune. site. selectHomePage() Disponibilité Dreamweaver 3. Description Ouvre la boîte de dialogue d'ouverture de fichier pour permettre à l'utilisateur de sélectionner une nouvelle page d'accueil. REMARQUE Cette fonction agit seulement sur les fichiers de l'affichage Carte du site. Arguments Aucun. Fonctions relatives aux sites 297 Valeurs renvoyées Aucune. site. selectNewer() Disponibilité Dreamweaver 3. Description Sélectionne tous les fichiers les plus récents sur le côté spécifié du panneau Site. Arguments whichSide L'argument whichSide doit avoir la valeur "local" ou "remote". Valeurs renvoyées Aucune. Activateur Voir site. canSelectNewer(), page 613. 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. 298 Site Exemple L'exemple suivant, extrait du fichier menus. xml, affiche un élément de menu s'il n'y a pas d'activité du serveur (et si un site est actuellement spécifié dans Dreamweaver) : <menuitem name="Remove Connection Scripts" enabled="!site. serverActivity() && site. getCurrentSite() != ''" command="alert(MMDB. removeConnectionScripts())" id="SiteOptionsSiteMenu_RemoveConnectionScripts" /> site. setAsHomePage() Disponibilité Dreamweaver 3. Description Désigne le fichier sélectionné dans l'affichage Fichiers du site comme étant la page d'accueil du site. Arguments Aucun. Valeurs renvoyées Aucune. site. setCloakingEnabled() Disponibilité Dreamweaver MX. Description Détermine s'il est nécessaire d'activer le voilage pour le site en cours. Arguments enable L'argument enable est une valeur booléenne qui indique s'il est nécessaire d'activer le voilage. Une valeur true active le voilage pour le site en cours ; une valeur false désactive le voilage pour le site en cours. Valeurs renvoyées Aucun. Fonctions relatives aux sites 299 site. setConnectionState() Disponibilité Dreamweaver 3. Description Définit l'état de connexion du site en cours. Arguments bConnected L'argument bConnected est une valeur booléenne qui indique s'il existe une connexion (true) ou non (false) au site en cours. Valeurs renvoyées Aucune. site. setCurrentSite() Disponibilité Dreamweaver 3. Description Ouvre le site spécifié dans le volet local du panneau Site. Arguments whichSite L'argument whichSite est le nom d'un site défini (tel qu'il apparaît dans la liste des sites en cours, dans le panneau Site ou dans la boîte de dialogue Modifier les sites). Valeurs renvoyées Aucune. Exemple Si trois sites sont définis (avocado8, dreamcentral et testsite, par exemple), un appel à la fonction site. setCurrentSite("dreamcentral") fait de dreamcentral le site en cours. 300 Site site. setFocus() Disponibilité Dreamweaver 3. Description Active le volet spécifié du panneau Site. Si le volet spécifié n'est pas affiché, la fonction l'affiche et l'active. Arguments whichPane L'argument whichPane doit correspondre à l'une des chaînes suivantes : "local", "remote" ou "site map". Valeurs renvoyées Aucune. site. setLayout() Disponibilité Dreamweaver 3. Description Ouvre le volet Mise en forme de la carte du site dans la boîte de dialogue Définition du site. Arguments Aucun. Valeurs renvoyées Aucune. Activateur Voir site. canSetLayout(), page 613. site. setLinkVisibility() Disponibilité Dreamweaver 3. Fonctions relatives aux sites 301 Description Affiche ou masque le lien en cours. Arguments bShow L'argument bShow est une valeur booléenne qui indique si le lien en cours ne doit plus être identifié comme masqué. Valeurs renvoyées Aucune. site. setSelection() Disponibilité Dreamweaver 3. Description Sélectionne les fichiers ou les dossiers visibles dans le volet actif du panneau Site. Arguments arrayOfURLs L'argument arrayOfURLs est un tableau de chaînes correspondant aux chemins d'accès aux fichiers et aux dossiers du site sélectionné, exprimés sous la forme d'une URL de type file://. REMARQUE Pour les chemins de dossier, ne tapez pas la barre oblique (/) à la fin du chemin. Valeurs renvoyées Aucune. site. siteRelativeToLocalPath() Disponibilité Dreamweaver 8. 302 Site Description Convertit une référence d'URI relative de site en un chemin d'accès de fichier local. Arguments siteRelativeURI L'argument obligatoire siteRelativeURI est une chaîne contenant l'URI relative du site. Valeurs renvoyées Chaîne indiquant le chemin d'accès à un fichier local sur votre ordinateur local. Exemple L'exemple suivant var filePath = site. siteRelativeToLocalPath("/myWebApp/myFile. xlml"); renvoie "C:\Inetpub\wwwroot\siteA\myFile. xml", en fonction de vos mappages de site et de l'adresse HTTP spécifiée dans la section Infos locales de la boîte de dialogue Définition du site. site. synchronize() Disponibilité Dreamweaver 3. Description Ouvre la boîte de dialogue Synchroniser les fichiers. Arguments Aucun. Valeurs renvoyées Aucune. Activateur Voir site. canSynchronize(), page 614. site. uncloak() Disponibilité Dreamweaver MX. Fonctions relatives aux sites 303 Description Dévoile la sélection dans le panneau Site ou le dossier spécifié. Arguments siteOrURL L'argument siteOrURL doit contenir l'une des deux valeurs suivantes : le mot-clé "site", qui indique que la fonction unCloak() doit agir sur la sélection dans le panneau Site ; l'URL d'un dossier particulier, qui indique que la fonction unCloak() doit agir sur le dossier spécifié et tout son contenu. Valeurs renvoyées Aucune. Activateur Voir site. canUncloak(), page 615. site. uncloakAll() Disponibilité Dreamweaver MX. Description Dévoile tous les dossiers dans le site sélectionné et désactive la case à cocher Voiler les fichiers se terminant avec : dans les Paramètres de voilage. Arguments Aucune. Valeurs renvoyées Aucune. Activateur Voir site. canUncloak(), page 615. site. undoCheckOut() Disponibilité Dreamweaver 3. 304 Site Description Retire des sites locaux et distants les fichiers verrouillés associés aux fichiers sélectionnés et remplace leur copie locale par la copie distante. Arguments siteOrURL L'argument siteOrURL doit être soit le mot-clé "site", indiquant que la fonction doit agir sur l'élément sélectionné dans le panneau Site, soit l'URL d'un fichier. Valeurs renvoyées Aucune. Activateur Voir site. canUndoCheckOut(), page 615. site. viewAsRoot() Disponibilité Dreamweaver 3. Description Place provisoirement le fichier sélectionné en première position sur la carte du site. Arguments Aucun. Valeurs renvoyées Aucune. Activateur Voir site. canViewAsRoot(), page 616. Fonctions relatives aux sites 305 306 Site CHAPITRE 13 Document Les fonctions Document de Macromedia Dreamweaver 8 permettent d'effectuer des opérations dans le document modifié par l'utilisateur. Ces fonctions permettent notamment de convertir les tableaux en calques, d'exécuter une commande du dossier Configuration/ Commands, de rechercher l'URL d'un fichier, de vérifier l'orthographe ou de définir les propriétés d'une page, de convertir une URL relative en URL absolue, d'obtenir le noeud parent sélectionné, d'effectuer l'encodage URL d'une chaîne ou d'exécuter un traducteur sur le document. 13 Fonctions relatives aux conversions Ces fonctions permettent de convertir des tableaux en calques, des calques en tableaux et des feuilles de style en cascade (CSS) en balises HTML. Chacune de ces fonctions se comporte exactement comme une commande de conversion du menu Fichier ou Modifier. dom. convertLayersToTable() Disponibilité Dreamweaver 3. Description Ouvre la boîte de dialogue Convertir les calques en tableau. Arguments Aucun. Valeurs renvoyées Aucune. Activateur Voir dom. canConvertLayersToTable(), page 572. 307 dom. convertTablesToLayers() Disponibilité Dreamweaver 3. Description Ouvre la boîte de dialogue Convertir les tableaux en calques. Arguments Aucun. Valeurs renvoyées Aucune. Activateur Voir dom. canConvertTablesToLayers(), page 572. Fonctions relatives aux commandes Ces fonctions permettent d'exploiter au mieux les fichiers figurant dans le dossier Configuration/Commands. Elles permettent de gérer le menu Commandes et d'appeler des commandes à partir d'autres types de fichiers d'extension. dreamweaver. editCommandList() Disponibilité Dreamweaver 3. Description Ouvre la boîte de dialogue Modifier la liste de commandes. Arguments Aucun. Valeurs renvoyées Aucune. 308 Document dreamweaver. popupCommand() (déconseillée) Disponibilité Dreamweaver 2, déconseillée depuis la version 3 : utiliser à la place dreamweaver. runCommand(). Description Cette fonction exécute la commande spécifiée. Pour l'utilisateur, cela revient à choisir la commande dans un menu ; si une boîte de dialogue est associée à la commande, elle s'affiche. Cette fonction permet d'appeler une commande à partir d'un autre fichier d'extension. L'utilisateur ne peut effectuer aucune autre modification tant qu'il n'a pas fermé la boîte de dialogue. REMARQUE Cette fonction peut être appelée à partir de la fonction objectTag(), d'un script de fichier de commande ou du fichier d'inspecteur de propriétés. Arguments commandFile L'argument commandFile correspond au nom d'un fichier de commandes du dossier Configuration/Commands ("Format Table. htm", par exemple). Valeurs renvoyées Aucune. dreamweaver. runCommand() Disponibilité Dreamweaver 3. Fonctions relatives aux commandes 309 Description Exécute la commande spécifiée ; cette fonction équivaut à choisir la commande dans un menu. Si une boîte de dialogue est associée à la commande, elle apparaît et le script de la commande bloque les autres modifications jusqu'à ce que l'utilisateur ferme la boîte de dialogue. Cette fonction permet d'appeler une commande à partir d'un autre fichier d'extension. REMARQUE Cette fonction peut être appelée à partir de la fonction objectTag(), d'un script de fichier de commande ou du fichier d'inspecteur de propriétés. Arguments commandFile, {commandArg1}, {commandArg2}, . . . {commandArgN} L'argument commandFile est un nom de fichier dans le dossier Configuration/ Commands. Les autres arguments (commandArg1, commandArg2, etc. ) sont facultatifs. Ils sont transmis à la fonction receiveArguments() dans l'argument commandFile. Valeurs renvoyées Aucune. Exemple Vous pouvez créer un inspecteur de propriétés personnalisé pour les tableaux. [. . . ] La grille de propriété pouvant afficher les règles dans les fichiers verrouillés, la valeur de renvoi true ne garantit pas que les règles peuvent être modifiées. Arguments Aucun. Valeurs renvoyées Valeur booléenne : true si l'éditeur de grille de propriété peut s'appliquer à la règle sélectionnée ; false dans le cas contraire. 592 Activateurs Exemple Le code suivant vérifie que la fonction de l'activateur a été définie sur la valeur true avant d'autoriser les modifications sur la règle sélectionnée : if(dw. cssRuleTracker. canEditSelectedRule()){ dw. cssRuleTracker. editSelectedRule(); } dreamweaver. cssStylePalette. canApplySelectedStyle() Disponibilité Dreamweaver MX. Description Vérifie si le style sélectionné peut être appliqué au document actif. Arguments { pane } L'argument facultatif pane est une chaîne spécifiant le volet du panneau Styles auquel cette fonction est appliquée. Les valeurs possibles sont les suivantes : "stylelist", qui correspond à la liste des styles dans le mode "Tout" ; "cascade", qui correspond à la liste des règles applicables concernées dans le mode "Courant" ; "summary", qui correspond à la liste des propriétés de la sélection en cours dans le mode "Courant" et "ruleInspector", qui correspond à la liste ou grille de propriétés modifiable dans le mode "Courant". La valeur par défaut est "stylelist". Valeurs renvoyées Valeur booléenne : true si le style sélectionné comporte un sélecteur de classes ; false dans le cas contraire. dreamweaver. cssStylePalette. canDeleteSelectedStyle() Disponibilité Dreamweaver MX. Description Vérifie si le style sélectionné peut être supprimé de la sélection en cours. Activateurs 593 Arguments { pane } L'argument facultatif pane est une chaîne spécifiant le volet du panneau Styles auquel cette fonction est appliquée. Les valeurs possibles sont les suivantes : "stylelist", qui correspond à la liste des styles dans le mode "Tout" ; "cascade", qui correspond à la liste des règles applicables concernées dans le mode "Courant" ; "summary", qui correspond à la liste des propriétés de la sélection en cours dans le mode "Courant" et "ruleInspector", qui correspond à la liste ou grille de propriétés modifiable dans le mode "Courant". [. . . ]