® Dreamweaver® CS4 API-Referenzhandbuch für Windows® und Mac OS
Adobe
Wenn dieses Handbuch mit Software vertrieben wird, die eine Endbenutzer-Lizenzvereinbarung umfasst, werden dieses Handbuch sowie die darin beschriebene
Software unter Lizenz bereitgestellt und dürfen nur entsprechend den Bedingungen der Lizenz verwendet oder vervielfältigt werden. Kein Teil dieser
Dokumentation darf ohne vorherige schriftliche Genehmigung von Adobe Systems Incorporated reproduziert, in Datenbanken gespeichert oder in irgendeiner
Form – elektronisch, mechanisch, auf Tonträgern oder auf irgendeine andere Weise – übertragen werden, es sei denn, die Lizenz gestattet dies ausdrücklich.
Beachten Sie, dass der Inhalt dieses Handbuchs urheberrechtlich geschützt ist, auch wenn er nicht zusammen mit Software vertrieben wird, die eine
Endbenutzer-Lizenzvereinbarung umfasst. Der Inhalt dieses Handbuchs dient lediglich Informationszwecken, kann jederzeit ohne Vorankündigung geändert
werden und stellt keinerlei Verpflichtung seitens Adobe Systems Incorporated dar. Adobe Systems Incorporated übernimmt keine Verantwortung oder Haftung
für Fehler oder Ungenauigkeiten in den in diesem Handbuch enthaltenen Informationen.
Bitte beachten Sie, dass Bildmaterial oder Bilder, die Sie in Ihr Projekt aufnehmen möchten, eventuell urheberrechtlich geschützt sind. Die nicht genehmigte
Verwendung von solchem Material in Ihrer Arbeit kann eine Verletzung der Urheberrechte des Inhabers der Rechte bedeuten. Bitte denken Sie daran, die
entsprechenden Genehmigungen vom Inhaber des Urheberrechts einzuholen. Alle in den Mustervorlagen erwähnten Firmennamen dienen lediglich zur
Veranschaulichung und nehmen keinerlei Bezug auf tatsächlich bestehende Unternehmen.
Adobe, the Adobe logo, ColdFusion, Dreamweaver, Fireworks, Flash, Photoshop, and Shockwave are either registered trademarks or trademarks of Adobe
Systems Incorporated in the United States.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the United States and other countries. Windows is either a registered trademark or a
trademark of Microsoft Corporation in the United States and/or other countries. Macintosh and Mac OS are trademarks of Apple Inc., registered in the United
States and other countries. All other trademarks are the property of their respective owners.
This work is licensed under the Creative Commons Attribution Non-Commercial 3.0 License. To view a copy of this license, visit
http://creativecommons.org/licenses/by-nc/3.0/us/
This product includes software developed by the Apache Software Foundation (
GIF is a Service Mark property of CompuServe Incorporated.
MPEG Layer-3 audio compression technology licensed by Fraunhofer IIS and Thomson Multimedia (
compressed audio within the Software for real time or live broadcasts. If you require an MP3 decoder for real time or live broadcasts, you are responsible for
obtaining this MP3 technology license.
Speech compression and decompression technology licensed from Nellymoser, Inc. (
This product includes software developed by Fourthought, Inc. (
This product includes software developed by CollabNet (
Adobe Systems Incorporated, 345 Park Avenue, San Jose, California 95110, USA.
Notice to U.S. Government End Users. The Software and Documentation are “Commercial Items,” as that term is defined at 48 C.F.R. §2.101, consisting of
“Commercial Computer Software” and “Commercial Computer Software Documentation,” as such terms are used in 48 C.F.R. §12.212 or 48 C.F.R. §227.7202,
as applicable. Consistent with 48 C.F.R. §12.212 or 48 C.F.R. §§227.7202-1 through 227.7202-4, as applicable, the Commercial Computer Software and
Commercial Computer Software Documentation are being licensed to U.S. Government end users (a) only as Commercial Items and (b) with only those rights
as are granted to all other end users pursuant to the terms and conditions herein. Unpublished rights reserved under the copyright laws of the United States.
Adobe Systems Incorporated, 345 Park Avenue, San Jose, CA 95110-2704, USA. For U.S. Government End Users, Adobe agrees to comply with all applicable
equal opportunity laws including, if appropriate, the provisions of Executive Order 11246, as amended, Section 402 of the Vietnam Era Veterans Readjustment
Assistance Act of 1974 (38 USC 4212), and Section 503 of the Rehabilitation Act of 1973, as amended, and the regulations at 41 CFR Parts 60-1 through 60-60,
60-250, and 60-741. The affirmative action clause and regulations contained in the preceding sentence shall be incorporated by reference.
™ video compression and decompression technology licensed from Sorenson Media, Inc.
Im Adobe Dreamweaver CS4 API-Referenzhandbuch werden die Anwendungsprogrammierschnittstellen (APIs)
beschrieben. Mit APIs können Sie während der Entwicklung von Adobe® Dreamweaver® CS4-Erweiterungen und
beim Hinzufügen von Programmcode zu Dreamweaver-Webseiten verschiedene unterstützende Aufgaben ausführen.
Eine der wichtigsten APIs ist die JavaScript-API, die Zugriff auf die meisten Kernfunktionen von Dreamweaver bietet.
Unter die Kernfunktionen von Dreamweaver fallen generell alle menügesteuerten Aktionen. Hinzu kommen
verschiedene Dienstprogramm-APIs für gängige Aufgaben wie das Schreiben und Lesen von Dateien, die
Datenübertragung mit HTTP und die Kommunikation mit Fireworks und Flash.
Mit der umfangreichen JavaScript-API können Sie vielfältige kleinere Aufgaben erledigen. Dabei handelt es sich in der
Mehrzahl um Arbeitsschritte, die ein Benutzer i. d. R. beim Erstellen oder Bearbeiten von Dreamweaver-Dokumenten
ausführt. Diese API-Funktionen sind nach den betreffenden Komponenten der Dreamweaver-Benutzeroberfläche
gruppiert. So umfasst die JavaScript-API beispielsweise Arbeitsbereichfunktionen, Dokumentfunktionen,
Designfunktionen usw. Mit den API-Funktionen können Sie einige der folgenden Aufgaben und vieles mehr
ausführen:
• Öffnen neuer Dokumente
• Abrufen oder Festlegen einer Schriftgröße
• Suchen nach einem Suchstring im HTML-Code
• Sichtbarmachen von Symbolleisten
1
Erweiterungen
In diesem Buch wird davon ausgegangen, dass Sie Kenntnisse in Dreamweaver, HTML, XML, der JavaScriptProgrammierung und eventuell der Programmierung in C haben. Wenn Sie Erweiterungen zum Erstellen von
Webanwendungen programmieren, sollten Sie auch mit serverbasierten Skripts auf mindestens einer Plattform
vertraut sein, z. B. Active Server Pages (ASP), ASP.NET, PHP Hypertext Preprocessor (PHP), Adobe ColdFusion oder
Java Server Pages (JSP).
Erweitern von Dreamweaver
Weitere Informationen über das Dreamweaver-Framework und die API zur Erstellung von DreamweaverErweiterungen finden Sie im Handbuch Dreamweaver erweitern. Im Handbuch Dreamweaver erweitern werden die
API-Funktionen beschrieben, die Dreamweaver zur Implementierung von Objekten, Menüs, schwebenden
Bedienfeldern, Serververhalten usw. aufruft, welche die verschiedenen Funktionen von Dreamweaver umfassen.
Mithilfe dieser APIs können Sie dem Produkt Objekte, Menüs, schwebende Bedienfelder oder andere Funktionen
hinzufügen. Im Handbuch Dreamweaver erweitern wird darüber hinaus erläutert, wie Sie Dreamweaver an Ihre
spezifischen Anforderungen anpassen. Durch das Bearbeiten und Hinzufügen von Tags zu verschiedenen HTML- und
XML-Dateien können Sie beispielsweise Menüelemente oder Dokumenttypen hinzufügen.
DREAMWEAVER CS4 API-REFERENZHANDBUCH
Einführung
Weitere Ressourcen für das Programmieren von
Erweiterungen
Wenn Sie sich mit anderen Entwicklern austauschen möchten, die ebenfalls Erweiterungen erstellen, können Sie der
Dreamweaver Extensibility Newsgroup beitreten. Die Website für diese Newsgroup befindet sich unter
Die folgenden neuen Funktionen wurden der JavaScript-API von Dreamweaver CS4 hinzugefügt. Die Überschriften
beziehen sich auf die Kapitel und Abschnitte, die die neuen Funktionen enthalten.
Dynamische Dokumente
Die folgenden Funktionen wurden zum Kapitel „Dynamische Dokumente“ hinzugefügt.
Live-Ansichtsfunktionen
• „dom.getDesignViewMode()“ auf Seite 343
• „dom.setDesignViewMode()“ auf Seite 343
• „dom.getLiveViewUsingServer()“ auf Seite 343
• „dom.setLiveViewUsingServer()“ auf Seite 344
• „dom.getLiveViewDefaultsToUsingServer()“ auf Seite 344
• „dom.getLiveViewDependentsUsingServer()“ auf Seite 344
• „dom.setLiveViewDependentsUsingServer()“ auf Seite 345
• „dom.showLiveViewParametersDialog()“ auf Seite 345
• „dom.browser.getSelection()“ auf Seite 345
• „dom.browser.getStatusText()“ auf Seite 346
• „dom.browser.getWindow()“ auf Seite 346
• „browserEle.loadHTML()“ auf Seite 346
2
Photoshop-Integration
Die folgenden neuen Funktionen wurden zum Kapitel „Photoshop-Integration“ hinzugefügt.
API für Smart Objekte
• „dreamweaver.assetPalette.canUpdateSmartObjectFromOriginal()“ auf Seite 53
• „dreamweaver.assetPalette.updateSmartObjectFromOriginal()“ auf Seite 53
• „dreamweaver.getSmartObjectState()“ auf Seite 54
• „dreamweaver.getSmartObjectOriginalWidth()“ auf Seite 54
• „dreamweaver.getImageWidth()“ auf Seite 55
• „dreamweaver.getImageHeight()“ auf Seite 55
DREAMWEAVER CS4 API-REFERENZHANDBUCH
• „dreamweaver.resolveOriginalAssetFileURLToAbsoluteLocalFilePath()“ auf Seite 55
• „dreamweaver.canUpdateSmartObjectFromOriginal()“ auf Seite 56
• „dreamweaver.updateSmartObjectFromOriginal()“ auf Seite 56
Arbeitsbereich
Die folgenden neuen Funktionen wurden zum Kapitel „Arbeitsbereich“ hinzugefügt.
Funktionen für zugehörige Dateien
• „dreamweaver.getRelatedFiles()“ auf Seite 198
• „dreamweaver.openRelatedFile()“ auf Seite 198
• „dreamweaver.getActiveRelatedFilePath()“ auf Seite 198
Funktionen für die Informationsleiste
• „dom.showInfoBar()“ auf Seite 197
• „dom.hideInfoBar()“ auf Seite 197
Funktionen für die vertikal geteilte Ansicht
• „dreamweaver.getSplitViewOrientation()“ auf Seite 199
• „dreamweaver.setSplitViewOrientation()“ auf Seite 199
• „dreamweaver.getPrimaryView()“ auf Seite 200
• „dreamweaver.setPrimaryView()“ auf Seite 200
• „dom.isRelatedFileViewOpen()“ auf Seite 201
3
Einführung
Symbolleistenfunktionen
• „dreamweaver.reloadToolbars()“ auf Seite 185
Flash-Integration
Die folgenden neuen Funktionen wurden zum Kapitel „Flash-Integration“ hinzugefügt.
Funktionen für Flash-Bedienfelder und Flash-Dialogfelder
• „dreamweaver.flash.newControl()“ auf Seite 44
• „dreamweaver.flash.requestStateChange()“ auf Seite 46
• „dreamweaver.flash.controlEvent()“ auf Seite 48
• „dreamweaver.flash.setMenu()“ auf Seite 49
• „dreamweaver.flash.evalScript()“ auf Seite 50
• „dreamweaver.flash.executeScript()“ auf Seite 51
• „dreamweaver.flash.controlExists“ auf Seite 52
DREAMWEAVER CS4 API-REFERENZHANDBUCH
Site
Die folgenden neuen Funktionen wurden zum Kapitel „Site“ hinzugefügt.
• „site.getLocalRootURL()“ auf Seite 233
• „site.getSiteRootForURL()“ auf Seite 234
Dokument
Die folgenden neuen Funktionen wurden zum Kapitel „Dokument“ hinzugefügt.
• „dom.getSelectorsDefinedInStylesheet()“ auf Seite 276
• „dreamweaver.absoluteURLToDocRelative()“ auf Seite 272
Code
Die folgenden neuen Funktionen wurden zum Kapitel „Code“ hinzugefügt.
• „dom.source.doCodeNavItem()“ auf Seite 449
4
Einführung
Entfernte Funktionen
Die folgenden Funktionen wurden aus der Dreamweaver CS4-API entfernt, da die dazugehörigen Funktionen nicht
mehr im Produkt enthalten sind.
dreamweaver.libraryPalette.get
SelectedItem() (abgelöst in
Dreamweaver 4)
dreamweaver.libraryPalette.recr
eateFromDocument() (abgelöst
in Dreamweaver 4)
dreamweaver.templatePalette.d
eleteSelectedTemplate()
(abgelöst in Dreamweaver 4)
dreamweaver.templatePalette.r
enameSelectedTemplate()
(abgelöst in Dreamweaver 4)
dom.clipPasteText() (abgelöst in
Dreamweaver 8)
dom.serverModel.getServerLan
guage() (abgelöst in
Dreamweaver MX)
dreamweaver.getObjectRefs()
(abgelöst in Dreamweaver 3)
dreamweaver.getSelection()
(abgelöst in Dreamweaver 3)
(abgelöst in Dreamweaver 4)
dreamweaver.libraryPalette.newFromDocument()
(abgelöst in Dreamweaver 4)
dreamweaver.libraryPalette.renameSelectedItem()
(abgelöst in Dreamweaver 4)
dreamweaver.templatePalette.getSelectedTempla
te() (abgelöst in Dreamweaver 4)
dreamweaver.getBehaviorEvent() (abgelöst in
Dreamweaver 2)
dreamweaver.popupCommand() (abgelöst in
Dreamweaver 3)
dom.serverModel.getServerExtension() (abgelöst
in Dreamweaver MX)
dreamweaver.getObjectTags() (abgelöst in
Dreamweaver 3)
dreamweaver.nodeToOffsets() (abgelöst in
Dreamweaver 3)
dreamweaver.offsetsToNode()
(abgelöst in Dreamweaver 3)
dreamweaver.exportEditableRe
gionsAsXML() (abgelöst in
Dreamweaver MX)
MMDB.getDriverUrlTemplateLis
t() (abgelöst in Dreamweaver
MX)
dreamweaver.setSelection() (abgelöst in
Dreamweaver 3)
dreamweaver.cssStylePalette.getSelectedTarget()
(abgelöst in Dreamweaver MX)
Weitere Informationen zu diesen veralteten APIs finden Sie im Dreamweaver CS3 API-Referenzhandbuch.
In diesem Handbuch verwendete Konventionen
Typografische Konventionen
In diesem Handbuch werden die folgenden typografischen Konventionen verwendet:
• Codeschrift kennzeichnet Codefragmente und API-Literale, z. B. Klassennamen, Methodennamen,
Funktionsnamen, Typnamen, Skripts, SQL-Anweisungen, HTML- und XML-Tag-Namen sowie Attributnamen.
• Kursive Codeschrift kennzeichnet Platzhalterelemente im Code.
• Das Fortsetzungssymbol (¬) weist darauf hin, dass ein langer Code über mehrere Zeilen umbrochen wurde. Da die
Zeilenlänge in diesem Handbuch durch die im Format festgelegten Ränder begrenzt ist, muss Code, der eigentlich
fortlaufend ist, auf mehrere Zeilen verteilt werden. Löschen Sie beim Kopieren der Codezeilen das
Fortsetzungssymbol und geben Sie die Zeilen ohne Umbruch ein.
DREAMWEAVER CS4 API-REFERENZHANDBUCH
Einführung
• Geschweifte Klammern ({ }), die ein Argument einschließen, weisen darauf hin, dass es sich um ein optionales
Argument handelt.
• Funktionsnamen mit dem Präfix dreamweaver.Funktionsname können beim Programmieren von Code als
dw.Funktionsname abgekürzt werden. In diesem Handbuch wird das ausführliche Präfix dreamweaver. bei der
Definition der Funktion und im Index verwendet. In vielen Beispielen wird jedoch das kürzere Präfix
dw.
verwendet.
Namengebungskonventionen
Folgende Namengebungskonventionen werden in diesem Handbuch verwendet:
• Sie – die Person, die für das Programmieren von Erweiterungen verantwortlich ist (also der Entwickler).
• Der Benutzer – die Person, die Dreamweaver verwendet.
6
Kapitel 2: API für Datei-E/A
Adobe® Dreamweaver® CS4 enthält eine gemeinsam genutzte C-Bibliothek mit dem Namen „DWfile“. Mithilfe von
DWfile können Autoren von Objekten, Befehlen, Verhalten, Datenübersetzern, schwebenden Bedienfeldern und
Eigenschafteninspektoren im lokalen Dateisystem Dateien lesen und schreiben. In diesem Kapitel werden die API für
Datei-E/A und deren Verwendung erläutert.
Allgemeine Informationen über das Zusammenwirken von C-Bibliotheken mit dem JavaScript-Interpreter in
Dreamweaver finden Sie in Dreamweaver erweitern unter „C-Level-Erweiterbarkeit“.
Konfigurationsordner
Unter Microsoft Windows 2000, Windows XP und Mac OS X verfügen die Benutzer über eigene Kopien der
Konfigurationsdateien. Wenn Dreamweaver in eine Konfigurationsdatei schreibt, übernimmt Dreamweaver diese
Änderung in den Ordner „Configuration“ des Benutzers. Auch beim Lesen einer Konfigurationsdatei sucht
Dreamweaver zunächst im Ordner „Configuration“ des Benutzers und erst dann im Ordner „Configuration“ von
Dreamweaver. DWfile-Funktionen arbeiten nach dem gleichen Prinzip. Wenn also Ihre Erweiterung eine Datei im
Dreamweaver-Ordner „Configuration“ schreibt oder liest, greift sie dabei auch auf den Ordner „Configuration“ des
Benutzers zu. Weitere Informationen zu Konfigurationsordnern in Mehrbenutzersystemen finden Sie im Handbuch
Dreamweaver erweitern.
7
Funktionen der API für Datei-E/A
Alle Funktionen der API für Datei-E/A sind Methoden des Objekts DWfile.
DWfile.copy()
Verfügbarkeit
Dreamweaver 3.
Beschreibung
Diese Funktion kopiert die angegebene Datei an einen neuen Ort.
Argumente
originalURL, copyURL
• Das Argument originalURL ist die Datei, die Sie kopieren möchten, im URL-Format „file://“.
• Das Argument copyURL ist der Speicherort, an dem Sie die kopierte Datei speichern möchten, im URL-Format
„file://“.
Rückgabewerte
Ein boolescher Wert:
true, wenn der Kopiervorgang erfolgreich ist, andernfalls false.
DREAMWEAVER CS4 API-REFERENZHANDBUCH
API für Datei-E/A
Beispiel
Der folgende Code kopiert die Datei „myconfig.cfg“ nach „myconfig_backup.cfg“:
var fileURL = "file:///c|/Config/myconfig.cfg";
var newURL ="file:///c|/Config/myconfig_backup.cfg";
DWfile.copy(fileURL, newURL);
DWfile.createFolder()
Verfügbarkeit
Dreamweaver 2.
Beschreibung
Diese Funktion erstellt einen Ordner am angegebenen Ort.
Argumente
folderURL
• Das Argument folderURL ist der Speicherort des Ordners, den Sie erstellen möchten, im URL-Format „file://“.
8
Rückgabewerte
Ein boolescher Wert:
true, wenn der Ordner erfolgreich erstellt wurde, andernfalls false.
Beispiel
Der folgende Code erstellt den Ordner „tempFolder“ im Stammverzeichnis von Laufwerk C: und teilt in einem
Dialogfeld mit, ob der Vorgang erfolgreich ausgeführt wurde:
var folderURL = "file:///c|/tempFolder";
if (DWfile.createFolder(folderURL)){
alert("Created " + folderURL);
}else{
alert("Unable to create " + folderURL);
}
DWfile.exists()
Verfügbarkeit
Dreamweaver 2.
Beschreibung
Diese Funktion prüft das Vorhandensein einer bestimmten Datei.
Argumente
fileURL
• Das Argument fileURL ist die angeforderte Datei im URL-Format „file://“.
Rückgabewerte
Ein boolescher Wert:
true, wenn die Datei vorhanden ist, andernfalls false.
DREAMWEAVER CS4 API-REFERENZHANDBUCH
Beispiel
Der folgende Code sucht die Datei „mydata.txt“ und teilt in einer Meldung mit, ob sie vorhanden ist:
var fileURL = "file:///c|/temp/mydata.txt";
if (DWfile.exists(fileURL)){
alert(fileURL + " exists!");
}else{
alert(fileURL + " does not exist.");
}
DWfile.getAttributes()
Verfügbarkeit
Dreamweaver 2.
Beschreibung
Diese Funktion ruft die Attribute der angegebenen Datei bzw. des angegebenen Ordners ab.
Argumente
fileURL
9
API für Datei-E/A
• Das Argument fileURL ist die Datei oder der Ordner, für die bzw. den Sie Attribute abrufen möchten, im URL-
Format „file://“.
Rückgabewerte
Ein String, der die Attribute der angegebenen Datei bzw. des angegebenen Ordners darstellt. Existiert die Datei oder
der Ordner nicht, gibt die Funktion den Wert
null zurück. Die Attribute werden durch folgende Zeichen im String
dargestellt:
• R (schreibgeschützt)
• D (Ordner)
• H (verborgen)
• S (Systemdatei oder Ordner)
Beispiel
Der folgende Code fragt die Attribute der Datei „mydata.txt“ ab und zeigt eine Warnmeldung an, falls die Datei
schreibgeschützt ist:
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()
Verfügbarkeit
Dreamweaver 2.
DREAMWEAVER CS4 API-REFERENZHANDBUCH
API für Datei-E/A
Beschreibung
Diese Funktion fragt den Zeitpunkt der letzten Änderung einer Datei ab.
Argumente
fileURL
• Das Argument fileURL ist die Datei, deren Zeitpunkt der letzten Änderung Sie überprüfen, im URL-Format
„file://“.
Rückgabewerte
Ein String mit einer hexadezimalen Zahl, die die Anzahl der seit dem Ausgangszeitpunkt verstrichenen Zeiteinheiten
angibt. Die jeweilige Bedeutung der Zeiteinheiten und des Ausgangszeitpunkts hängt von der verwendeten Plattform
ab. So beträgt in Windows eine Zeiteinheit 100 ns und als Ausgangszeitpunkt wird der 1. Januar 1600 verwendet.
Beispiel
Sie sollten die Funktion zweimal aufrufen und die Rückgabewerte vergleichen, da der Rückgabewert dieser Funktion
plattformabhängig ist und keine direkt lesbaren Datums- und Uhrzeitwerte darstellt. Der folgende Code fragt das
Änderungsdatum von „file1.txt“ und „file2.txt“ ab und zeigt eine Meldung an, in der angegeben wird, welche der
beiden Dateien aktueller ist:
10
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()
Verfügbarkeit
Dreamweaver 4.
Beschreibung
Diese Funktion fragt den Zeitpunkt ab, zu der die Datei erstellt wurde.
Argumente
fileURL
• Das Argument fileURL ist die Datei, deren Zeitpunkt der Erstellung Sie überprüfen, im URL-Format „file://“.
Rückgabewerte
Ein String mit einer hexadezimalen Zahl, die die Anzahl der seit dem Ausgangszeitpunkt verstrichenen Zeiteinheiten
angibt. Die jeweilige Bedeutung der Zeiteinheiten und des Ausgangszeitpunkts hängt von der verwendeten Plattform
ab. So beträgt in Windows eine Zeiteinheit 100 ns und als Ausgangszeitpunkt wird der 1. Januar 1600 verwendet.
DREAMWEAVER CS4 API-REFERENZHANDBUCH
Beispiel
Sie können diese Funktion und die Funktion
DWfile.getModificationDate() aufrufen, um das Änderungsdatum
einer Datei mit ihrem Erstelldatum zu vergleichen:
var file1 = "file:///c|/temp/file1.txt";
var time1 = DWfile.getCreationDate(file1);
var time2 = DWfile.getModificationDate(file1);
if (time1 == time2){
alert("file1 has not been modified since it was created");
}else if (time1 < time2){
alert("file1 was last modified on " + time2);
}
DWfile.getCreationDateObj()
Verfügbarkeit
Dreamweaver MX.
Beschreibung
Diese Funktion ruft das JavaScript-Objekt für den Zeitpunkt ab, zu dem die Datei erstellt wurde.
11
API für Datei-E/A
Argumente
fileURL
• Das Argument fileURL ist die Datei, deren Zeitpunkt der Erstellung Sie überprüfen, im URL-Format „file://“.
Rückgabewerte
Ein JavaScript
Date-Objekt für Datum und Uhrzeit der Erstellung einer Datei.
DWfile.getModificationDateObj()
Verfügbarkeit
Dreamweaver MX.
Beschreibung
Diese Funktion ruft das JavaScript
Argumente
fileURL
• Das Argument fileURL ist die Datei, deren Zeitpunkt der letzten Änderung Sie überprüfen, im URL-Format
„file://“.
Rückgabewerte
Ein JavaScript
Date-Objekt für Datum und Uhrzeit der letzten Änderung an einer Datei.
Date-Objekt für den Zeitpunkt der letzten Änderung an einer Datei ab.
DREAMWEAVER CS4 API-REFERENZHANDBUCH
DWfile.getSize()
Verfügbarkeit
Dreamweaver MX.
Beschreibung
Diese Funktion ruft die Größe einer Datei ab.
Argumente
fileURL
• Das Argument fileURL ist die Datei, deren Größe Sie überprüfen, im URL-Format „file://“.
Rückgabewerte
Eine Ganzzahl für die tatsächliche Größe (in Byte) einer Datei.
DWfile.listFolder()
12
API für Datei-E/A
Verfügbarkeit
Dreamweaver 2.
Beschreibung
Diese Funktion erstellt eine Liste mit dem Inhalt des angegebenen Ordners.
Argumente
folderURL, {constraint}
• Das Argument folderURL ist der Ordner, für den Sie eine Inhaltsliste erstellen möchten, im URL-Format „file://“
gefolgt von einem optionalen Dateimasken-Platzhalter. Gültige Platzhalter sind Sternchen (*) für ein oder mehrere
Zeichen und Fragezeichen (?) für ein Zeichen.
• Das Argument constraint, falls angegeben, muss entweder "files" (nur Dateien zurückgeben) oder
"directories" (nur Ordner zurückgeben) lauten. Falls das Argument nicht angegeben wird, werden sowohl
Dateien als auch Ordner berücksichtigt.
Rückgabewerte
Ein String-Array mit den einzelnen Elementen des Ordners.
Beispiel
Der folgende Code erstellt eine Liste aller Textdateien (TXT) im Ordner „C:/temp“. Die Liste wird in einer Meldung
angezeigt:
var folderURL = "file:///c|/temp";
var fileMask = "*.txt";
var list = DWfile.listFolder(folderURL + "/" + fileMask, "files");
if (list){
Diese Funktion liest den Inhalt der angegebenen Datei und schreibt ihn in einen String.
Argumente
fileURL
• Das Argument fileURL ist die Datei, die Sie lesen möchten, im URL-Format „file://“.
Rückgabewerte
Ein String, in dem sich der Inhalt der Datei befindet, oder der Wert
Beispiel
Der folgende Code liest die Datei „mydata.txt“ und zeigt bei einem erfolgreichen Lesevorgang eine Meldung mit dem
Inhalt der Datei an:
null, wenn der Lesevorgang fehlgeschlagen ist.
13
var fileURL = "file:///c|/temp/mydata.txt";
var str = DWfile.read(fileURL);
if (str){
alert(fileURL + " contains: " + str);
}
DWfile.remove()
Verfügbarkeit
Dreamweaver 3.
Beschreibung
Diese Funktion löscht die angegebene Datei.
Argumente
fileURL
• Das Argument fileURL ist die Datei, die Sie entfernen möchten, im URL-Format „file://“.
Rückgabewerte
Ein boolescher Wert:
Beispiel
Im folgenden Beispiel wird mit
confirm() ein Ja/Nein-Dialogfeld in der Benutzeroberfläche angezeigt:
true, wenn der Vorgang erfolgreich ist, andernfalls false.
DWfile.getAttributes() ermittelt, ob eine Datei schreibgeschützt ist, und mit
DREAMWEAVER CS4 API-REFERENZHANDBUCH
function deleteFile(){
var delAnyway = false;
var selIndex = document.theForm.menu.selectedIndex;
var selFile = document.theForm.menu.options[selIndex].value;
if (DWfile.getAttributes(selFile).indexOf('R') != -1){
delAnyway = confirm('This file is read-only. Delete anyway?');
if (delAnyway){
DWfile.remove(selFile);
}
}
}
DWfile.setAttributes()
Verfügbarkeit
Dreamweaver MX.
Beschreibung
Diese Funktion legt die Attribute auf Systemebene für eine bestimmte Datei fest.
14
API für Datei-E/A
Argumente
fileURL, strAttrs
• Das Argument fileURL identifiziert die Datei, für die Sie die Attribute festlegen, im URL-Format „file://“.
• Das Argument strAttrs legt die Attribute auf Systemebene für die von fileURL bezeichnete Datei fest. In der
folgenden Tabelle sind gültige Attributwerte und ihre Bedeutungen aufgeführt:
AttributwertBeschreibung
R
W
H
V
Gültige Werte für den
R und W schließen sich gegenseitig aus und sollten daher nicht gemeinsam verwendet werden. Werden sie in der
strAttrs-String sind R, W, H, V, RH, RV, WH und WV.
Kombination eingesetzt, wird
H und V schließen sich gegenseitig aus. Wenn Sie sie kombinieren, wird H außer Kraft gesetzt und die Datei wird
auf sichtbar (
Legen Sie
unverändert. Wenn Sie
V) gesetzt.
H oder V ohne das Lese-/Schreibattribut R oder W fest, bleibt das aktuelle Lese-/Schreibattribut der Datei
R oder W festlegen, ohne das Attribut H oder V anzugeben, wird das aktuelle
Schreibgeschützt
Kein Schreibschutz (überschreibt R)
Verborgen
Sichtbar (überschreibt H)
R außer Kraft gesetzt und der Schreibschutz für die Datei wird aufgehoben (W). Auch
Sichtbarkeitsattribut der Datei nicht geändert.
Rückgabewerte
Keine.
DREAMWEAVER CS4 API-REFERENZHANDBUCH
API für Datei-E/A
DWfile.write()
Verfügbarkeit
Dreamweaver 2.
Beschreibung
Diese Funktion schreibt den festgelegten String in die angegebene Datei. Wenn die angegebene Datei noch nicht
vorhanden ist, wird sie erstellt.
Argumente
fileURL, text, {mode}
• Das Argument fileURL im URL-Format „file://“ ist die Datei, in die geschrieben wird.
Hinweis: Wenn der Pfad Leerzeichen enthält, werden mit dieser Funktion keine Dateien geschrieben.
• Das Argument text gibt den zu schreibenden String an.
• Als mode-Argument (falls angegeben) muss append verwendet werden. Falls dieses Argument nicht angegeben
wird, überschreibt der String den Dateiinhalt.
15
Rückgabewerte
Ein boolescher Wert:
true bei erfolgreichem Schreibvorgang, andernfalls false.
Beispiel
Der folgende Code schreibt den String
Schreibvorgang eine Meldung aus. Anschließend wird der String
xxx in die Datei „mydata.txt“ und gibt nach einem erfolgreichen
aaa an die Datei angefügt. Wenn dieser Vorgang
erfolgreich verläuft, wird eine zweite Meldung ausgegeben. Nach Ausführung des Skripts enthält die Datei
„mydata.txt“ lediglich den Text
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);
}
xxxaaa.
Kapitel 3: HTTP-API
Die Einsatzmöglichkeiten der Erweiterungen beschränken sich nicht auf das lokale Dateisystem. Adobe®
Dreamweaver® bietet einen Mechanismus, mit dem über HTTP (Hypertext Transfer Protocol) Informationen von
einem Webserver abgerufen bzw. an diesen gesendet werden können. In diesem Kapitel werden die HTTP-API und
deren Verwendung erläutert.
Funktionsweise der HTTP-API
Alle Funktionen der HTTP-API sind Methoden des Objekts MMHttp. Bei den meisten dieser Funktionen wird als
Argument eine URL verwendet und die meisten geben ein Objekt zurück. Als Standardanschluss für URL-Argumente
wird Anschluss 80 verwendet. Wenn Sie einen anderen Anschluss verwenden möchten, fügen Sie einen Doppelpunkt
und die Nummer des Anschlusses an die URL an, wie im folgenden Beispiel gezeigt:
MMHttp.getText("http://www.myserver.com:8025");
Bei Funktionen, die ein Objekt zurückgeben, verfügt das Objekt über zwei Eigenschaften: statusCode und data.
16
Die Eigenschaft
• 200: Status OK
• 400: Unverständliche Anforderung
• 404: Angeforderte URL nicht gefunden
• 405: Server unterstützt angeforderte Methode nicht
• 500: Unbekannter Serverfehler
• 503: Serverkapazität erreicht
Eine umfassende Liste der Statuscodes für Ihren Server erhalten Sie bei Ihrem Internetdienstanbieter oder
Systemadministrator.
Der Wert der Eigenschaft
Funktionsbeschreibungen angegeben.
Funktionen, die ein Objekt zurückgeben, sind jeweils auch in einer sogenannten Callback-Version vorhanden. Bei
Callback-Funktionen können andere Funktionen ausgeführt werden, während der Webserver eine HTTPAnforderung bearbeitet. Dies ist dann nützlich, wenn Sie in Dreamweaver mehrere HTTP-Anforderungen ausgeben.
Die Callback-Version einer Funktion übergibt ihre ID und ihren Rückgabewert direkt an die als ihr erstes Argument
definierte Funktion.
statusCode gibt den Status der Operation an. Mögliche Werte sind unter anderem:
data ist von der jeweiligen Funktion abhängig. Die möglichen Werte sind bei den einzelnen
Funktionen der HTTP-API
In diesem Abschnitt werden die Funktionen, bei denen es sich um Methoden des Objekts MMHttp handelt, ausführlich
erläutert.
DREAMWEAVER CS4 API-REFERENZHANDBUCH
HTTP-API
MMHttp.clearServerScriptsFolder()
Verfügbarkeit
Dreamweaver MX.
Beschreibung
Löscht den Ordner „_mmServerScripts“ und alle darin enthaltenen Dateien im Stammordner der aktuellen lokalen
Site oder Remote-Site. Der Ordner „_mmServerScripts“ befindet sich im Ordner
„Configuration/Connections/Scripts/Servermodell/_mmDBScripts“.
Argumente
serverScriptsfolder
• serverScriptsfolder ist ein String, der einen bestimmten Ordner relativ zum Ordner „Configuration“ auf dem
Anwendungsserver bezeichnet, von dem Sie Serverskripts abrufen und löschen möchten.
Rückgabewerte
Ein Objekt, das die Antwort vom Server repräsentiert. Die Eigenschaft
Inhalt der gelöschten Skripts. Wenn ein Fehler auftritt, zeigt Dreamweaver diesen in der Eigenschaft
zurückgegebenen Objekts an.
data dieses Objekts ist ein String mit dem
statusCode des
17
Beispiel
Wenn der folgende Code in einer Menübefehlsdatei im Ordner „Configuration/Menus“ steht, entfernt er beim Aufruf
über ein Menü alle Dateien aus dem Ordner „_mmServerScripts“:
Diese Funktion löscht alle Dateien aus dem Ordner „Configuration/Temp“, der sich im Anwendungsordner von
Dreamweaver befindet.
Argumente
Keine.
Rückgabewerte
Keine.
DREAMWEAVER CS4 API-REFERENZHANDBUCH
HTTP-API
Beispiel
Wenn der folgende Code als Datei im Ordner „Configuration/Shutdown“ gespeichert wird, werden beim Beenden von
Dreamweaver alle Dateien aus dem Ordner „Configuration/Temp“ gelöscht:
<html>
<head>
<title>Clean Up Temp Files on Shutdown</title>
</head>
<body onLoad="MMHttp.clearTemp()">
</body>
</html>
MMHttp.getFile()
Beschreibung
Diese Funktion ruft die Datei unter der angegebenen URL ab und speichert sie im Ordner „Configuration/Temp“, der
sich im Anwendungsordner von Dreamweaver befindet. Dreamweaver erstellt automatisch Unterordner, durch die
die Ordnerstruktur des Servers nachgeahmt wird. Lautet der angegebene Pfad beispielsweise
„www.dreamcentral.com/people/index.html“, speichert Dreamweaver die Datei „index.html“ im Unterordner
„People“ des Ordners „www.dreamcentral.com“.
18
Argumente
URL, {prompt}, {saveURL}, {titleBarLabel}
• Das Argument URL ist eine absolute URL auf einem Webserver. Wenn http:// in der URL nicht angegeben wird,
geht Dreamweaver davon aus, dass HTTP verwendet wird.
• Das optionale Argument prompt ist ein boolescher Wert, der angibt, ob der Benutzer zum Speichern der Datei
aufgefordert wird. Wenn sich saveURL auf einen Speicherort außerhalb des Ordners „Configuration/Temp“
bezieht, wird beim Argument prompt der Wert
false aus Sicherheitsgründen ignoriert.
• Das optionale Argument saveURL ist der Speicherort auf der Festplatte des Benutzers, an dem die Datei gespeichert
werden soll (im URL-Format „file://“). Wenn für „prompt“ der Wert
true definiert wurde oder sich saveURL auf
einen Speicherort außerhalb des Ordners „Configuration/Temp“ bezieht, kann der Benutzer saveURL im
Dialogfeld „Speichern“ überschreiben.
• Das optionale Argument titleBarLabel ist die Bezeichnung, die in der Titelleiste des Dialogfelds „Speichern“
angezeigt werden soll.
Rückgabewerte
Ein Objekt, das die Antwort vom Server repräsentiert. Die Eigenschaft
Speicherort der Datei enthält (im URL-Format „file://“). Normalerweise enthält die Eigenschaft
data dieses Objekts ist ein String, der den
statusCode des
Objekts den vom Server empfangenen Statuscode. Wenn jedoch beim Speichern auf dem lokalen Laufwerk ein
Datenträgerfehler aufgetreten ist und der Vorgang nicht erfolgreich ausgeführt werden kann, enthält die Eigenschaft
statusCode einen Fehlercode in Form eines der folgenden ganzzahligen Werte:
• 1: Unbekannter Fehler
• 2: Datei nicht gefunden
• 3: Ungültiger Pfad
• 4: Zu viele Dateien geöffnet
• 5: Zugriff verweigert
DREAMWEAVER CS4 API-REFERENZHANDBUCH
HTTP-API
• 6: Ungültiges Datei-Handle
• 7: Aktueller Arbeitsordner kann nicht entfernt werden
• 8: Keine weiteren Ordnereinträge
• 9: Fehler beim Setzen des Dateizeigers
• 10: Hardwarefehler
• 11: Zugriffsverletzung
• 12: Sperrverletzung
• 13: Festplatte voll
• 14: Dateiende erreicht
Beispiel
Mit dem folgenden Code wird zunächst eine HTML-Datei abgerufen. Dann werden alle Dateien im Ordner
„Configuration/Temp“ gespeichert und die lokale Kopie der HTML-Datei wird in einem Browser geöffnet:
var httpReply = MMHttp.getFile("http://www.dreamcentral.com/people/profiles/scott.html",
false);
if (Boolean == 200){
var saveLoc = httpReply.data;
dw.browseDocument(saveLoc);
}
19
MMHttp.getFileCallback()
Beschreibung
Diese Funktion ruft die Datei unter der angegebenen URL ab, speichert die Datei im Ordner „Configuration/Temp“
innerhalb des Anwendungsordners von Dreamweaver und ruft anschließend die angegebene Funktion mit der
Anforderungs-ID und dem Antwortergebnis auf. Wenn die Datei lokal gespeichert wird, erstellt Dreamweaver
automatisch Unterordner, durch die die Ordnerstruktur des Servers nachgeahmt wird. Lautet der angegebene Pfad
beispielsweise „www.dreamcentral.com/people/index.html“, speichert Dreamweaver die Datei „index.html“ im
Unterordner „People“ des Ordners „www.dreamcentral.com“.
• Das Argument callbackFunction ist der Name der JavaScript-Funktion, die nach erfolgter HTTP-Anfrage
aufgerufen werden soll.
• Das Argument URL ist eine absolute URL auf einem Webserver. Wenn http:// in der URL nicht angegeben wird,
geht Dreamweaver davon aus, dass HTTP verwendet wird.
• Das optionale Argument prompt ist ein boolescher Wert, der angibt, ob der Benutzer zum Speichern der Datei
aufgefordert wird. Wenn sich saveURL auf einen Speicherort außerhalb des Ordners „Configuration/Temp“
bezieht, wird beim Argument prompt der Wert
• Das optionale Argument saveURL ist der Speicherort auf der Festplatte des Benutzers, an dem die Datei gespeichert
werden soll (im URL-Format „file://“). Wenn für „prompt“ der Wert
einen Speicherort außerhalb des Ordners „Configuration/Temp“ bezieht, kann der Benutzer saveURL im
Dialogfeld „Speichern“ überschreiben.
false aus Sicherheitsgründen ignoriert.
true definiert wurde oder sich saveURL auf
DREAMWEAVER CS4 API-REFERENZHANDBUCH
HTTP-API
• Das optionale Argument titleBarLabel ist die Bezeichnung, die in der Titelleiste des Dialogfelds „Speichern“
angezeigt werden soll.
Rückgabewerte
Ein Objekt, das die Antwort vom Server repräsentiert. Die Eigenschaft
Speicherort der Datei enthält (im URL-Format „file://“). Normalerweise enthält die Eigenschaft
data dieses Objekts ist ein String, der den
statusCode des
Objekts den vom Server empfangenen Statuscode. Wenn jedoch beim Speichern auf dem lokalen Laufwerk ein
Datenträgerfehler aufgetreten ist, enthält die Eigenschaft
statusCode einen ganzzahligen Fehlercode. Eine Liste der
möglichen Fehlercodes finden Sie unter „MMHttp.getFile()“ auf Seite 18.
MMHttp.getText()
Verfügbarkeit
Dreamweaver UltraDev 4, verbessert in Dreamweaver MX.
Beschreibung
Ruft den Inhalt des Dokuments unter der angegebenen URL ab.
20
Argumente
URL, {serverScriptsFolder}
• Das Argument URL ist eine absolute URL auf einem Webserver. Wenn http:// in der URL nicht angegeben wird,
geht Dreamweaver davon aus, dass HTTP verwendet wird.
• Das Argument serverScriptsFolder ist ein optionaler String, der einen bestimmten Ordner relativ zum Ordner
„Configuration“ auf dem Anwendungsserver bezeichnet, von dem Sie Serverskripts abrufen möchten. Zum
Abrufen der Skripts verwendet Dreamweaver das entsprechende Übertragungsprotokoll (z. B. FTP, WebDAV oder
Remote-Dateisystem). Dreamweaver kopiert diese Dateien in den Unterordner „_mmServerScripts“ im
Stammordner der aktuellen Site.
Wenn ein Fehler auftritt, zeigt Dreamweaver diesen in der Eigenschaft
statusCode des zurückgegebenen Objekts an.
MMHttp.getTextCallback()
Verfügbarkeit
Dreamweaver UltraDev 4, verbessert in Dreamweaver MX.
Beschreibung
Ruft den Inhalt des Dokuments unter der angegebenen URL ab und übergibt ihn an die angegebene Funktion.
Argumente
callbackFunc, URL, {serverScriptsFolder}
• Das Argument callbackFunc ist die JavaScript-Funktion, die nach erfolgter HTTP-Anfrage aufgerufen werden soll.
• Das Argument URL ist eine absolute URL auf einem Webserver. Wenn http:// in der URL nicht angegeben wird,
geht Dreamweaver davon aus, dass HTTP verwendet wird.
DREAMWEAVER CS4 API-REFERENZHANDBUCH
HTTP-API
• Das Argument serverScriptsFolder ist ein optionaler String, der einen bestimmten Ordner relativ zum Ordner
„Configuration“ auf dem Anwendungsserver bezeichnet, von dem Sie Serverskripts abrufen möchten. Zum
Abrufen der Skripts verwendet Dreamweaver das entsprechende Übertragungsprotokoll (z. B. FTP, WebDAV oder
Remote-Dateisystem). Dreamweaver ruft diese Dateien ab und übergibt sie an die Funktion, die durch
callbackFunc angegeben wird.
Wenn ein Fehler auftritt, zeigt Dreamweaver MX diesen in der Eigenschaft
statusCode
des zurückgegebenen Objekts an.
MMHttp.postText()
Verfügbarkeit
Dreamweaver UltraDev 4, verbessert in Dreamweaver MX.
Beschreibung
Führt einen HTTP-Sendevorgang durch, um die angegebenen Daten an die angegebene URL zu übertragen. In der
Regel handelt es sich dabei um formularkodierten Text, doch kann mit der Funktion jeder beliebige Datentyp
übertragen werden, den der Server erwartet.
• Das Argument URL ist eine absolute URL auf einem Webserver. Wenn http:// in der URL nicht angegeben wird,
geht Dreamweaver davon aus, dass HTTP verwendet wird.
• Das Argument dataToPost gibt die zu sendenden Daten an. Wenn das dritte Argument "application/x-www-
form-urlencoded" lautet oder weggelassen wird, muss das Argument dataToPost gemäß Abschnitt 8.2.1 der
Spezifikation RFC 1866 (zu finden unter www.faqs.org/rfcs/rfc1866.html) formularkodiert sein.
• Das optionale Argument contentType bezeichnet den Inhaltstyp der Daten, die durch das post-Verfahren
übertragen werden sollen. Bei fehlendem Argument wird als Standardwert
urlencoded" verwendet.
"application/x-www-form-
• Das Argument serverScriptsFolder ist ein optionaler String, der einen bestimmten Ordner relativ zum Ordner
„Configuration“ auf dem Anwendungsserver bezeichnet, auf den Sie Daten übertragen möchten. Zum Senden der
Daten verwendet Dreamweaver das entsprechende Übertragungsprotokoll (z. B. FTP, WebDAV oder RemoteDateisystem).
Wenn ein Fehler auftritt, zeigt Dreamweaver diesen in der Eigenschaft
statusCode des zurückgegebenen Objekts an.
Beispiel
Im folgenden Beispiel für einen
MMHttp.postText()-Funktionsaufruf wird davon ausgegangen, dass ein Entwickler
die Datei „myScripts.cfm“ im Ordner „DeployScripts“ abgelegt hat, der sich im Ordner „Configuration“ des lokalen
Computers befindet:
MMHttp.postText(
"http://ultraqa8/DeployScripts/myScripts.cfm",
"arg1=Foo",
"application/x-www-form-urlencoded",
"Configuration/DeployScripts/"
)
DREAMWEAVER CS4 API-REFERENZHANDBUCH
HTTP-API
Sobald Dreamweaver diesen Funktionsaufruf ausführt, läuft Folgendes ab:
1 Die Datei „myScripts.cfm“ im Ordner „Configuration/DeployScripts“ des lokalen Computers wird in einen
anderen Ordner „DeployScripts“ kopiert, der ein Unterordner des Stammordners der Website „ultraqa8“ ist. Zum
Bereitstellen der Dateien verwendet Dreamweaver das bei der Konfiguration der Site angegebene Protokoll.
2 Dreamweaver verwendet das HTTP-Protokoll, um die arg1=Foo-Daten an den Webserver zu übertragen.
3 Das Ergebnis der Übertragungsanfrage ist, dass der Webserver von „ultraqa8“ das Skript „myScripts.cfm“ unter
Verwendung der
arg1-Daten ausführt.
MMHttp.postTextCallback()
Verfügbarkeit
Dreamweaver UltraDev 4, verbessert in Dreamweaver MX.
Beschreibung
Führt einen HTTP-Sendevorgang durch, um den Text an die angegebene URL zu übertragen, und übergibt die
Antwort vom Server an die angegebene Funktion. In der Regel handelt es sich dabei um formularkodierten Text, doch
kann mit der Funktion jeder beliebige Datentyp übertragen werden, den der Server erwartet.
• Das Argument callbackFunc ist der Name der JavaScript-Funktion, die nach erfolgter HTTP-Anfrage aufgerufen
werden soll.
• Das Argument URL ist eine absolute URL auf einem Webserver. Wenn http:// in der URL nicht angegeben wird,
geht Dreamweaver davon aus, dass HTTP verwendet wird.
• Das Argument dataToPost gibt die zu sendenden Daten an. Wenn das dritte Argument "application/x-www-
form-urlencoded" lautet oder nicht angegeben ist, müssen die Daten entsprechend Abschnitt 8.2.1 der
Spezifikation RFC 1866 (zu finden unter www.faqs.org/rfcs/rfc1866.html) als Formular kodiert sein.
• Das optionale Argument contentType bezeichnet den Inhaltstyp der Daten, die durch das post-Verfahren
übertragen werden sollen. Bei fehlendem Argument wird als Standardwert
urlencoded" verwendet.
"application/x-www-form-
• serverScriptsFolder ist ein optionaler String. Er bezeichnet einen bestimmten Ordner relativ zum Ordner
„Configuration“ auf dem Anwendungsserver, an den Sie Daten senden möchten. Zum Senden der Daten
verwendet Dreamweaver das entsprechende Übertragungsprotokoll (z. B. FTP, WebDAV oder RemoteDateisystem). Dreamweaver ruft diese Daten ab und übergibt sie an die Funktion, die durch callbackFunc
angegeben wird.
Wenn ein Fehler auftritt, zeigt Dreamweaver diesen in der Eigenschaft
statusCode des zurückgegebenen Objekts an.
Kapitel 4: API für Design Notes
Mit Adobe® Dreamweaver®, Adobe® Fireworks® und Adobe® Flash® haben Webdesigner und Webentwickler die
Möglichkeit, zusätzliche Informationen über Dokumente zu speichern und abzurufen. Diese Informationen sind in
Dateien gespeichert, die als „Design Notes“ bezeichnet werden. Zu diesen Informationen zählen
Revisionskommentare, Änderungshinweise oder die Quelldateien für GIF- oder JPEG-Dateien.
Weitere Informationen zur Verwendung von Design Notes in Dreamweaver finden Sie in der Dokumentation
Dreamweaver verwenden.
Funktionsweise von Design Notes
In jeder Design Notes-Datei sind Informationen zu einem einzigen Dokument gespeichert. Wenn mit einem oder
mehreren Dokumenten in einem Ordner eine Design Notes-Datei verknüpft ist, erstellt Dreamweaver einen
Unterordner mit dem Namen „_notes“, in dem Design Notes-Dateien gespeichert werden können. Der Ordner
„_notes“ und die darin enthaltenen Design Notes-Dateien werden im Bedienfeld „Dateien“ nicht angezeigt, jedoch im
Finder (Macintosh) bzw. in Windows Explorer. Design Notes-Dateinamen bestehen aus dem Hauptdateinamen und
der Erweiterung „.mno“. Die Design Notes-Datei für die Datei „avocado8.gif“ trägt beispielsweise den Namen
„avocado8.gif.mno“.
23
Design Notes-Dateien sind XML-Dateien, in denen Informationen in einer Folge von Schlüssel-Wert-Paaren
gespeichert sind. Der Schlüssel beschreibt den gespeicherten Informationstyp und der Wert stellt die eigentlichen
Informationen dar. Schlüssel können höchstens 64 Zeichen lang sein.
Im folgenden Beispiel ist die Design Notes-Datei für die Datei „foghorn.gif.mno“ dargestellt:
foghorn.png" />
<infoitem key="Author" value="Heidi B." />
<infoitem key="Status" value="Final draft, approved by Jay L." />
</info>
JavaScript-API für Design Notes
Alle Funktionen der JavaScript-API für Design Notes sind Methoden des MMNotes-Objekts. MMNotes ist eine
gemeinsam genutzte C-Bibliothek, mit deren Hilfe die Autoren von Erweiterungen Design Notes-Dateien lesen und
schreiben können. Wie die gemeinsam genutzte Bibliothek DWfile verfügt auch MMNotes über eine JavaScript-API,
über die Sie die Funktionen aufrufen können. Die Funktionen werden über Objekte, Befehle, Verhalten, schwebende
Bedienfelder, Eigenschafteninspektoren und Datenübersetzer der Bibliothek aufgerufen. Die gemeinsam genutzte
Bibliothek MMNotes kann unabhängig von Dreamweaver verwendet werden, selbst wenn Dreamweaver nicht
installiert ist.
DREAMWEAVER CS4 API-REFERENZHANDBUCH
API für Design Notes
MMNotes.close()
Beschreibung
Diese Funktion schließt die angegebene Design Notes-Datei und speichert alle Änderungen. Wenn alle SchlüsselWert-Paare entfernt wurden, löscht Dreamweaver die Design Notes-Datei. Wenn es sich um die letzte Design NotesDatei im Ordner „_notes“ handelt, wird auch der Ordner gelöscht.
24
Hinweis: Rufen Sie nach Verwendung von Design Notes immer die Funktion
Dreamweaver das Schreiben in die Datei abschließt.
Argumente
fileHandle
MMNotes.close() auf, damit
• Das Argument fileHandle ist das von der Funktion MMNotes.open() zurückgegebene Datei-Handle.
Rückgabewerte
Keine.
Beispiel
Siehe „MMNotes.set()“ auf Seite 28.
MMNotes.filePathToLocalURL()
Beschreibung
Diese Funktion wandelt den angegebenen lokalen Laufwerkspfad in das URL-Format „file://“ um.
Argumente
drivePath
• Das Argument drivePath ist ein String, der den vollständigen Laufwerkspfad enthält.
Rückgabewerte
Ein String mit der URL der angegebenen Datei im URL-Format „file://“.
MMNotes.filePathToLocalURL('C:\sites\webdev\index.htm') wird der String
MMNotes.get()
Beschreibung
Diese Funktion ruft den Wert des angegebenen Schlüssels in einer Design Notes-Datei ab.
Argumente
fileHandle, keyName
• Das Argument fileHandle ist das von MMNotes.open() zurückgegebene Datei-Handle.
• Das Argument keyName ist ein String, der den Namen des Schlüssels enthält.
DREAMWEAVER CS4 API-REFERENZHANDBUCH
API für Design Notes
Rückgabewerte
Ein String mit dem Wert des Schlüssels.
Beispiel
Siehe „MMNotes.getKeys()“ auf Seite 25.
MMNotes.getKeyCount()
Beschreibung
Diese Funktion ruft die Anzahl der Schlüssel-Wert-Paare in der angegebenen Design Notes-Datei ab.
Argumente
fileHandle
• Das Argument fileHandle ist das von der Funktion MMNotes.open() zurückgegebene Datei-Handle.
Rückgabewerte
Eine Ganzzahl, die die Anzahl der Schlüssel-Wert-Paare in der Design Notes-Datei angibt.
25
MMNotes.getKeys()
Beschreibung
Diese Funktion ruft eine Liste sämtlicher Schlüssel in einer Design Notes-Datei ab.
Argumente
fileHandle
• Das Argument fileHandle ist das von der Funktion MMNotes.open() zurückgegebene Datei-Handle.
Rückgabewerte
Ein String-Array, in dem jeder String den Namen eines Schlüssels enthält.
Beispiel
Der folgende Code kann in einem benutzerdefinierten schwebenden Bedienfeld verwendet werden, um die
Design Notes-Informationen für das aktive Dokument anzuzeigen.
var noteHandle = MMNotes.open(dw.getDocumentDOM().URL);
var theKeys = MMNotes.getKeys(noteHandle);
var noteString = "";
var theValue = "";
for (var i=0; i < theKeys.length; i++){