ADOBE Dreamweaver API CS3 User Manual [de]

ADOBE® DREAMWEAVER® CS

DREAMWEAVER API-REFERENZHANDBUCH

Adobe® Dreamweaver® für Windows® und Macintosh

Wenn dieses Handbuch mit Software verteilt wird, die einen Endnutzervertrag beinhaltet, stehen das Handbuch sowie die darin beschriebene Software unter dieser Lizenz und dürfen nur in Übereinstimmung mit den Bedingungen dieser Lizenz verwendet oder kopiert werden. Sofern nicht durch eine solche Lizenz gestattet, darf kein Teil dieses Handbuchs ohne die vorherige schriftliche Genehmigung durch Adobe Systems Incorporated in irgendeiner Form oder durch irgendwelche Mittel elektronisch, mechanisch, durch Aufzeichnung oder auf andere Weise reproduziert, in einem Abfragesystem gespeichert oder übertragen werden. Bitte beachten Sie, dass der Inhalt dieses Handbuchs durch Urheberrechtsgesetze geschützt ist, auch wenn es nicht mit Software verteilt wird, die einen Endnutzervertrag beinhaltet. Der Inhalt dieses Handbuchs ist nur für Informationszwecke vorgesehen, kann ohne vorherige Benachrichtigung geändert werden und sollte nicht als eine Verpflichtung durch Adobe Systems Incorporated ausgelegt werden. Adobe Systems Incorporated übernimmt keine Verantwortung oder Haftung für etwaige Fehler oder Ungenauigkeiten, die im informatorischen Inhalt in diesem Handbuch vorkommen mögen.

Bitte denken Sie daran, dass vorhandene Illustrationen oder Bilder, die Sie in Ihren Projekten möglicherweise verwenden wollen, durch Urheberrechtsgesetze geschützt sein können. Die unerlaubte Einbindung solcher Materialien in Ihr neues Werk könnte eine Verletzung der Rechte des Urheberrechtsinhabers darstellen. Bitte stellen Sie sicher, dass Sie jegliche erforderliche Genehmigung vom Urheberrechtsinhaber einholen. Die Bezugnahme auf Firmennamen in Beispielvorlagen dient ausschließlich Demonstrationszwecken und ist nicht als Bezugnahme auf irgendwelche tatsächlich existierenden Organisationen beabsichtigt.

Adobe, das Adobe-Logo, ActionScript, Adobe Bridge, ColdFusion, Creative Suite, Director, Dreamweaver, Fireworks, Flash, FlashPaper, HomeSite, JRun, Photoshop, Shockwave und Version Cue sind entweder eingetragene Marken oder Marken von Adobe Systems Incorporated in den USA.

ActiveX, Microsoft und Windows sind Marken oder eingetragene Marken der Microsoft Corporation in den USA und/oder anderen Ländern. Apple und Mac OS sind Marken von Apple Inc., eingetragen in den USA und anderen Ländern. Java und Solaris sind Marken oder eingetragene Marken von Sun Microsystems, Inc. in den USA und anderen Ländern. Linux ist eine eingetragene Marke von Linus Torvalds in den USA und anderen Ländern. UNIX ist eine Marke in den USA und in anderen Ländern, exk lusiv lizenziert durch X/Open Company, Ltd. Alle anderen Marken gehören den jeweiligen Eigentümern.

Dieses Produkt enthält Software, die von der Apache Software Foundation (http://www.apache.org/) entwickelt wurde. Das Graphics Interchange Format © ist urheberrechtlich Eigentum von CompuServe Incorporated. GIF(sm) ist eine Dienstleistungsmarke, die CompuServe Incorporated gehört. MPEG Layer-3 Audiokomprimierungstechnologie lizenziert durch Fraunhofer IIS und Thomson Multimedia (http://www.mp3licensing.com). Das in der Software enthaltene MP3-komprimierte Audio kann nicht für Echtzeitoder Live-Sendungen verwendet werden. Wenn Sie einen MP3-Decoder für Echtzeit- oder Live-Übertragungen benötigen, sind Sie dafür zuständig, die entsprechende MP3Lizenz zu erhalten. Sprachkomprimierungs- und -dekomprimierungsstechnologie n stehen unter der Lizenz der Firma Nellymoser, Inc. (www.nellymoser.com). Flash CS3 Video wird betrieben mit der On2 TrueMotion-Videotechnik. © 1992-2005 On2 Technologies, Inc. Alle Rechte vorbehalten. http://www.on2.com. Dieses Produkt enthält Software, die von der Open Symphony Group (http://www.opensymphony.com/) entwick elt wurde. Sorenson SparkTM Videok omprimierun gs- und -dekomprimierungsstechnologien stehen unter der Lizenz der Firma Sorenson Media, Inc.

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

Hinweis für Endnutzer der Regierung der Vereinigten Staaten. Die Software und das Begleitmaterial sind Handelswaren („Commercial Items“) im Sinne von 48 C.F.R. §2.101, bestehend aus kommerzieller Computersoftware („Commercial Computer Software“) und Begleitmaterial für kommerzielle Computersoftware („Commercial Computer Software Documentation“) im Sinne von 48 C.F.R. §12.212 bzw. 48 C.F.R. §227.7202. Gemäß 48 C.F.R. §12.212 bzw. 48 C.F.R. §§227.7202-1 bis 227.7202-4 werden die kommerzielle Computersoftware und das Begleitmaterial für kommerzielle Computersoftware für Endnutzer der vereinigten Staaten (a) nur als Handelswaren und (b) nur mit jenen Rechten zur Verfügung gestellt, die allen anderen Endnutzern gewährt werden, gemäß den Bestimmungen des Lizenzvertrags für Endnutzer von Adobe. Unveröffentlichte Rechte bleiben gemäß den Gesetzen zum Urheberrecht der Vereinigten Staaten vorbehalten. Adobe Systems Incorporated, 345 Park Avenue, San Jose, California 95110, USA. Für Endnutzer der Regierung der Vereinigten Staaten verpflichtet sich Adobe, alle anwendbaren Gesetze zur Chancengleichheit anzuwenden, einschließlich der Bestimmungen der Executive Order 11246, einschließlich Ergänzungen, Abschnitt 402 des Vietnam Era Veterans Readjustment Assistance Act von 1974 (38 USC 4212), und Abschnitt 503 des Rehabilitation Act von 1973, einschließlich Ergänzungen, sowie Vorschriften in 41 CFR, 60-1 bis 60-60, 60-250 und 60-741. Die Gesetze und Vorschriften über aktive Förderungsmaßnahmen zugunsten von Minderheiten im vorgenannten Satz sind als Bezug in diesen Vertrag aufzunehmen.

Inhaltsverzeichnis

Kapitel 1: Einführung

Hintergrund . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Dreamweaver erweitern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Weitere Ressourcen für das Schreiben von Erweiterungen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Neue Funktionen in Dreamweaver CS3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Entfernte Funktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

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

In diesem Handbuch verwendete Konventionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4

Kapitel 2: Die API für Datei-E/A

Auf Konfigurationsordner zugreifen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Die API für Datei-E/A . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Kapitel 3: Die HTTP-API

Funktionsweise der HTTP-API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Die HTTP-API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

iii

Kapitel 4: API für Design Notes

Funktionsweise von Design Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

JavaScript -API für Design Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23

C-API für Design Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27

Kapitel 5: Integration von Fireworks

FWLaunch-API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Kapitel 6: Flash-Integration

Funktionsweise von Flash-Elementen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Flash-Elemente einfügen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

API für Flash-Objekte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Kapitel 7: Datenbank-API

Funktionsweise der Datenbank-API-Funktion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44

Datenbankverbindungsfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Datenbankzugriffsfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Kapitel 8: Die Datenbank-Konnektivitäts-API

Neue Verbindungstypen entwickeln . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69

Die Verbindungs-API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Die generierte Include-Datei . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73

Definitionsdateien für Ihren Verbindungstyp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74

Kapitel 9: Die JavaBeans-API

Die JavaBeans-API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

Kapitel 10: API zur Integration der Quellcodeverwaltung

So funktioniert die Integration der Quellcodeverwaltung in Dreamweaver . . . . . . . . . . . . . . . . .81

Quellcode-Verwaltungssystemfunktionen hinzufügen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Erforderliche Funktionen für die API zur Integration der Quellcodeverwaltung . . . . . . . . . . . . .82

Optionale Funktionen für die API zur Integration der Quellcodeverwaltung . . . . . . . . . . . . . . . . 87

Enabler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Kapitel 11: Anwendung

Funktionen für externe Anwendungen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .101

Globale Anwendungsfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .109

Bridge-Kommunikationsfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .113

Kapitel 12: Arbeitsbereich

Verlaufsfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .117

Funktionen zum Einfügen von Objekten . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .124

Tastaturfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .126

Menüfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .133

Ergebnisfenster-Funktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .134

Umschaltfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .146

Symbolleistenfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .166

Fensterfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .171

Funktionen für das Ausblenden von Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .180

Symbolleistenfunktionen der Codeansicht . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .186

Kapitel 13: Site

Berichtfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .191

Sitefunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .191

Kapitel 14: Dokument

Konvertierungsfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .223

Befehlsfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .224

Dateibearbeitungsfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .225

Globale Dokumentfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .238

Pfadfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .247

Auswahlfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .249

Funktionen zur Behandlung von Strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .255

Übersetzungsfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .258

XSLT-Funktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .260

Kapitel 15: Seiteninhalt

Funktionen des Bedienfelds „Elemente“ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .263

Verhaltensfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .272

Zwischenablagefunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .279

Bibliotheks- und Vorlagenfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .284

Codefragmente (Bedienfeld), Funktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .289

Bearbeitungsfunktionen für Spry-Widgets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .292

Funktionen zum Einfügen von Spry-Widgets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .294

Funktionen für die Browserkompatibilitätsprüfung . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .296

Kapitel 16: Dynamische Dokumente

Funktionen von Serverkomponenten . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .303

Datenquellenfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .304

Extension Data Manager-Funktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .305

Live Data-Funktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .307

Serververhalten-Funktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .311

Servermodell-Funktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .313

Kapitel 17: Design

CSS-Layoutfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .319

Frame- und Frameset-Funktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .336

Ebenen- und Imagemap-Funktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .337

Funktionen für die Layout-Umgebung . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .340

Layoutansicht-Funktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .344

Vergrößerungsfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .353

Funktionen und Eigenschaften für Hilfslinien . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .355

Tabellenbearbeitungsfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .362

Kapitel 18: Code

Codefunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .371

Suchen- und Ersetzen-Funktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .374

Allgemeine Bearbeitungsfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .379

Druckfunktion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .393

Quick Tag Editor-Funktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .394

Codeansicht-Funktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .395

Tag-Editor- und Tag-Bibliothek-Funktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .410

Kapitel 19: Enabler

Enabler-Funktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .415

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .449

Kapitel 1: Einführung

Im Adobe Dreamweaver CS3 API-Referenzhandbuch werden die Anwendungsprogrammierschnittstellen (Application Programming Interfaces, APIs) beschrieben, mit denen Sie verschiedene Aufgaben bei der Entwicklung Adobe® Dreamweaver® CS3-Erweiterungen und beim Hinzufügen von Programmcode zu Ihren Dreamweaver-Webseiten ausführen können. Zu diesen APIs gehören die JavaScript-API, die Zugriff zu vielen Kernfunktionen von Dreamweaver (alles, was über Menüs ausgeführt werden kann, und mehr) bietet, sowie verschiedene Dienstprogramm-APIs für die Ausführung allgemeiner Aufgaben wie Lesen und Schreiben von Dateien, Übertragen von Informationen über HTTP und Kommunikation mit Fireworks und Flash.

Die Dienstprogramm-APIs enthalten eine Untergruppe von zusammenhängenden Funktionen, mit denen Sie bestimmte Aufgaben durchführen können. Es gibt folgende Dienstprogramm-APIs:

• Die API für Datei-E/A, mit der Sie Dateien im lokalen Dateisystem lesen und schreiben können.

• Die API für HTTP, mit der Sie Informationen von einem Webserver empfangen und an diesen senden können.

• Die API für Design Notes, mit der Sie Notizen über Dreamweaver-Dokumente speichern und abrufen können.

• Die API zur Integration von Fireworks, die die Kommunikation mit Adobe Fireworks ermöglicht.

• Die Flash-Integration, die Informationen über das Hinzufügen von Flash-Elementen zur Benutzeroberfläche von

Dreamweaver sowie Details zur Flash-Objekt-API enthält (letztere ermöglicht die Erstellung von Objekten für Adobe Flash-Inhalt).

• Die API für Datenbanken, die den Zugriff auf Informationen in Datenbanken und die Verwaltung von Datenbankver-

bindungen ermöglicht.

• Die API für die Datenbank-Konnektivität, mit deren Hilfe Sie einen neuen Verbindungstyp und die entsprechenden

Dialogfelder für neue oder vorhandene Servermodelle erstellen können.

• Die API für JavaBeans, die Klassennamen, Methoden, Eigenschaften und Ereignisse für von Ihnen definierte JavaBeans

abruft.

• Die API zur Integration der Quellcodeverwaltung, mit deren Hilfe Sie gemeinsam genutzte Bibliotheken schreiben

können, um die Funktionen zum Ein- und Auschecken von Dreamweaver zu erweitern.

Mithilfe der umfangreichen JavaScript-API können Sie diverse kleinere Aufgaben durchführen, bei denen es sich häufig um Aktionen handelt, die der Benutzer bei der Erstellung von Dreamweaver-Dokumenten durchführt. Diese APIFunktionen sind nach den betreffenden Komponenten der Dreamweaver-Benutzeroberfläche gruppiert. So umfasst die JavaScript-API beispielsweise Arbeitsbereichfunktionen, Dokumentfunktionen, Designfunktionen usw. Mithilfe dieser Funktionen können Sie Aufgaben wie das Öffnen eines neuen Dokuments, Abrufen oder Festlegen einer Schriftgröße, Suchen nach einem Suchstring im HTML-Code, Sichtbarmachen einer Symbolleiste usw. durchführen.

Hintergrund

In diesem Buch wird davon ausgegangen, dass Sie Kenntnisse über Dreamweaver, HTML, XML, die JavaScript-Programmierung und eventuell der Programmierung in C haben. Wenn Sie Erweiterungen zur Erstellung von Webanwendungen schreiben, sollten Sie darüber hinaus über Kenntnisse über serverbasierte Skripts auf mindestens einer Plattform verfügen, wie z. B. Active Server Pages (ASP), ASP.NET, PHP: Hypertext Preprocessor (PHP), ColdFusion oder Java Server Pages (JSP).

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Dreamweaver erweitern

Weitere Informationen über das Dreamweaver-Framework und die API zur Erstellung von Dreamweaver-Erweiterungen 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 Objekte, Menüs, schwebende Bedienfelder oder andere Funktionen zum Produkt hinzufügen. Im Handbuch Dreamweaver erweitern wird darüber hinaus erläutert, wie Dreamweaver durch das Bearbeiten und Hinzufügen von Tags zu verschiedenen HTML- und XML-Dateien angepasst werden kann, indem Menüelemente oder Dokumenttypen usw. hinzugefügt werden.

Weitere Ressourcen für das Schreiben von Erweiterungen

Wenn Sie mit anderen Entwicklern kommunizieren möchten, die Erweiterungen erstellen, können Sie der Dreamweaver Extensibility Newsgroup beitreten. Die Website dieser Newsgroup finden Sie (in englischer Sprache) unter folgender Adresse: www.adobe.com/support/dreamweaver/extend/form/.

Neue Funktionen in Dreamweaver CS3

Die folgenden Funktionen wurden der JavaScript-API von Dreamweaver CS3 hinzugefügt. Die Überschriften beziehen sich auf die Kapitel und Abschnitte, in denen die neuen Funktionen enthalten sind:

Anwendung

Die folgenden Funktionen wurden zum Kapitel „Anwendung“ hinzugefügt.

Funktionen für externe Anwendungen

• „dom.insertFiles()“ auf Seite 107

• „dreamweaver.activateApp()“ auf Seite 108

• „dreamweaver.printDocument()“ auf Seite 108

• „dreamweaver.revealDocument()“ auf Seite 108

Globale Anwendungsfunktionen

• „dw.registerIdleHandler()“ auf Seite 112

• „dw.revokeIdleHandler()“ auf Seite 113

Bridge-Kommunikation

• „BridgeTalk.bringToFront()“ auf Seite 113

• „Bridgetalk.send()“ auf Seite 114

• „BridgeTalk.suppressStartupScreen()“ auf Seite 114

• „dw.browseInBridge()“ auf Seite 115

Arbeitsbereich

Die folgenden neuen Funktionen für aktiven Inhalt und die Codeansicht wurden im Kapitel „Arbeitsbereich“ auf Seite 117 hinzugefügt.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Aktive Inhalte

• „dom.convertNextActiveContent()“ auf Seite 126

• „dom.convertActiveContent()“ auf Seite 126

Codeansicht

• „dom.source.refreshVariableCodeHints()“ auf Seite 188

Site

Die folgenden neuen Site-Funktionen wurden zum Kapitel „Site“ auf Seite 191 hinzugefügt.

• „site.displaySyncInfoForFile()“ auf Seite 201

• „site.canDisplaySyncInfoForFile()“ auf Seite 442

Dokumente

Die folgende neue XML-Datensatzfunktion wurde zum Kapitel „Dokument“ auf Seite 223 hinzugefügt.

• „MMXSLT.getXML()“ auf Seite 260

Seiteninhalt

Die folgenden neuen Funktionen wurden zum Kapitel „Seiteninhalt“ auf Seite 263 hinzugefügt. Sie betreffen das Erstellen von Spry-XML-Datensätzen, das verbesserte Bearbeiten von Spry- und anderen Widgets, das Einfügen von Spry-Widgets und das Überprüfen der Browserkompatibilität.

Spry-Widgets bearbeiten

• „element.removeTranslatedAttribute()“ auf Seite 293

• „element.setTranslatedAttribute()“ auf Seite 293

• „element.translatedClassName“ auf Seite 293

• „element.translatedStyle“ auf Seite 294

Spry-Widgets einfügen

• „dom.addJavaScript()“ auf Seite 294

• „dom.copyAssets()“ auf Seite 295

• „dom.getDefaultAssetFolder()“ auf Seite 296

Probleme bei der Browserkompatibilitätsprüfung

• „elem.getComputedStyleProp()“ auf Seite 296

• „window.getDeclaredStyle()“ auf Seite 297

• „dom.getMinDisplayWidth()“ auf Seite 298

• „dom.getBlockElements() elem.getBlockElements()“ auf Seite 298

• „dom.getInlineElements() elem.getInlineElements()“ auf Seite 299

• „dom.getHeaderElements() elem.getHeaderElements()“ auf Seite 300

• „dom.getListElements() elem.getListElements()“ auf Seite 300

• „elem.isBlockElement()“ auf Seite 301

• „elem.isInlineElement()“ auf Seite 301

• „elem.isHeaderElement()“ auf Seite 302

• „elem.isListElement()“ auf Seite 302

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Dynamische Dokumente

Die folgende neue Datenquellenfunktion wurde zum Kapitel „Dynamische Dokumente“ auf Seite 303 hinzugefügt.

• „dw.dbi.setExpanded()“ auf Seite 305

Design

Die folgenden neuen CSS-Layoutfunktionen wurden zum Kapitel „Design“ auf Seite 319 hinzugefügt.

CSS-Layout

• „dom.applyLayout()“ auf Seite 319

• „dom.canApplyLayout()“ auf Seite 320

• „dw.getLayoutNames()“ auf Seite 321

• „dw.getLayoutDescriptions()“ auf Seite 321

• „dw.getFilesForLayout()“ auf Seite 320

Entfernte Funktionen

Die folgenden Funktionen wurden aus der Dreamweaver CS3-API entfernt, da die dazugehörigen Funktionen nicht mehr im Produkt enthalten sind.

• „dreamweaver.exportCSS() (veraltet)“ auf Seite 230

• „dreamweaver.canExportCSS() (veraltet)“ auf Seite 426

Errata

Im Abschnitt zur Erweiterbarkeit, den Sie (in englischer Sprache) im Dreamweaver Support Center (www.adobe.com/support/dreamweaver/extend/extending_dwmx_errata) finden, steht eine aktualisierte Liste mit bekannten Problemen zur Verfügung.

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

onsnamen, Typnamen, Skripts, SQL-Anweisungen, HTML- und XML-Tagnamen sowie Attributnamen.

• Kursive Codeschrift kennzeichnet Elemente im Code, die zu ersetzen sind.

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

• 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 Schreiben von Code als dw.funktionsname

abgekürzt werden. In diesem Handbuch wird das ausführliche Präfix im Index verwendet. In vielen Beispielen wird jedoch das kürzere Präfix

dreamweaver. bei der Definition der Funktion und

dw. verwendet.

Namengebungskonventionen

Folgende Namengebungskonventionen werden in diesem Handbuch verwendet:

• Sie – die Person, die für das Schreiben von Erweiterungen verantwortlich ist (also der Entwickler).

• Der Benutzer – die Person, die Dreamweaver verwendet.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Kapitel 2: Die API für Datei-E/A

Adobe® Dreamweaver® CS3 enthält eine gemeinsam genutzte C-Bibliothek, die es Autoren von Objekten, Befehlen, Verhalten, Datenübersetzern, schwebenden Bedienfeldern und Eigenschafteninspektoren ermöglichen, auf dem lokalen Dateisystem Dateien zu lesen und zu 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 im Handbuch Dreamweaver erweitern unter „C-Level-Erweiterbarkeit“.

Auf Konfigurationsordner zugreifen

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

Die API für Datei-E/A

Alle Funktionen der API für Datei-E/A sind Methoden des Objekts DWfile.

DWfile.copy()

Ver fü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 im URL-Format „file://“ ist der Speicherort, an dem Sie die kopierte Datei speichern möchten.

Rückgabewerte

Ein Boolescher Wert: true bei einem erfolgreichen Kopiervorgang, andernfalls false.

Beispiel

Der folgende Code kopiert die Datei myconfig.cfg in die Datei myconfig_backup.cfg:

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

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

DWfile.createFolder()

Ver fü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://“.

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

Ver fü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.

Beispiel

Der folgende Code sucht die Datei mydata.txt und zeigt in einer Meldung an, ob die Datei vorhanden ist:

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

alert(fileURL + " exists!");

} else {

alert(fileURL + " does not exist.");

}

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

DWfile.getAttributes()

Ver fügbarkeit

Dreamweaver 2.

Beschreibung

Diese Funktion ruft die Attribute der angegebenen Datei bzw. des angegebenen Ordners ab.

Argumente

fileURL

• 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 stellt:

• R (schreibgeschützt)

• D (Ordner)

• H (verborgen)

• S (Systemdatei oder Ordner)

null zurück. Die Attribute werden durch nachfolgende Zeichen im String darge-

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

Ver fügbarkeit

Dreamweaver 2.

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.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

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 Datei1.txt und Datei2.txt ab und zeigt eine Meldung an, in der angegeben wird, welche der beiden Dateien aktueller ist:

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

Ver fügbarkeit

Dreamweaver 4.

Beschreibung

Diese Funktion fragt die Uhrzeit 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

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

Ver fügbarkeit

Dreamweaver MX

Beschreibung

Diese Funktion ruft das JavaScript-Objekt für den Zeitpunkt ab, zu dem die Datei erstellt wurde.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

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

Ver fügbarkeit

Dreamweaver MX

Beschreibung

Diese Funktion ruft das JavaScript Date-Objekt für den Zeitpunkt der letzten Änderung an 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 JavaScript Date-Objekt für Datum und Uhrzeit der letzten Änderung an einer Datei.

DWfile.getSize()

Ver fü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()

Ver fü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.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

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

alert(folderURL + " contains: " + list.join("\n"));

}

DWfile.read()

Ver fügbarkeit

Dreamweaver 2.

Beschreibung

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 null, wenn der Lesevorgang fehlgeschlagen ist.

Beispiel

Der folgende Code liest die Datei mydata.txt und zeigt bei einem erfolgreichen Lesevorgang eine Meldung mit dem Inhalt der Datei an:

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

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

}

DWfile.remove()

Ver fü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: true bei einem erfolgreichen Vorgang, andernfalls false.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Beispiel

Im nachfolgenden Beispiel wird mit DWfile.getAttributes() ermittelt, ob eine Datei schreibgeschützt ist, und mit

confirm() ein Ja/Nein-Dialogfeld in der Benutzeroberfläche angezeigt:

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

Ver fügbarkeit

Dreamweaver MX

Beschreibung

Diese Funktion legt die Attribute auf Systemebene für eine bestimmte Datei fest.

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

genden Tabelle sind gültige Attributwerte und ihre Bedeutungen aufgeführt:

Attributwert Beschreibung

R Schreibgeschützt

W Kein Schreibschutz (überschreibt R)

H Verb orgen

V Sichtbar (überschreibt H)

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

nation eingesetzt, wird schließen sich gegenseitig aus. Wenn Sie sie kombinieren, wird

strAttrs-String sind R, W, H, V, RH, RV, WH oder WV.

R außer Kraft gesetzt, und der Schreibschutz für die Datei wird aufgehoben (W). Auch H und V

H außer Kraft gesetzt, und die Datei wird auf sichtbar (V)

gesetzt.

Legen Sie ändert. Wenn Sie

H oder V ohne das Lese-/Schreibattribut R oder W fest, bleibt das aktuelle Lese-/Schreibattribut der Datei unver-

R oder W, festlegen, ohne das Attribut H oder V anzugeben, bleibt das aktuelle Sichtbarkeitsattribut der Datei

ebenfalls bestehen.

Rückgabewerte

Keine

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

DWfile.write()

Ver fü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 ist die Datei, in die Sie schreiben, im URL-Format „file://“.

• Das Argument text ist der String, der geschrieben wird.

• Als mode-Argument (falls angegeben) muss "append" verwendet werden. Sollte dieses Argument nicht verwendet

werden, wird der Datei-Inhalt durch den String überschrieben.

Rückgabewerte

Ein Boolescher Wert: true bei erfolgreichem Schreibvorgang, andernfalls false.

Beispiel

Der folgende Code schreibt den String "xxx" in die Datei mydata.txt und gibt nach einem erfolgreichen Schreibvorgang eine Meldung aus. Anschließend wird der String wird eine zweite Meldung ausgegeben. Nach Ausführung des Skripts enthält die Datei mydata.txt lediglich den Text

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

"aaa" an die Datei angehängt. Falls dieser Vorgang erfolgreich verläuft,

Kapitel 3: Die HTTP-API

Die Einsatzmöglichkeiten der Erweiterungen beschränken sich nicht auf das lokale Dateisystem. Adobe® Dreamweaver® CS3 bietet einen Mechanismus, um über HTTP (Hypertext Transfer Protocol) Informationen von einem Webserver abzurufen bzw. an diesen zu senden. 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, besitzt das Objekt zwei Eigenschaften: statusCode und data.

Die Eigenschaft statusCode gibt den Status der Operation an. Mögliche Werte sind unter anderem:

• 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

Ein umfassende Liste der Statuscodes für Ihren Server erhalten Sie bei Ihrem Internet-Service-Provider oder Ihrem Systemadministrator.

Der Wert der Eigenschaft Funktionsbeschreibungen verzeichnet.

Funktionen, die ein Objekt zurückgeben, sind jeweils auch in einer so genannten Callback-Version vorhanden. Bei Callback-Funktionen können andere Funktionen ausgeführt werden, während der Webserver eine HTTP-Anforderung bearbeitet. Dies ist dann nützlich, wenn Sie in Dreamweaver mehrere HTTP-Anforderungen ausgeben. Die CallbackVersion einer Funktion übergibt ihre ID und ihren Rückgabewert direkt an die als ihr erstes Argument definierte Funktion.

data ist von der jeweiligen Funktion abhängig. Die möglichen Werte sind bei den einzelnen

Die HTTP-API

In diesem Abschnitt werden die Funktionen, bei denen es sich um Methoden des Objekts MMHttp handelt, ausführlich erläutert.

MMHttp.clearServerScriptsFolder()

Ver fü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\Connec-

tions\Scripts\

Servermodell\_mmDBScripts.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Argumente

serverScriptsfolder

• serverScriptsfolder ist ein String, der einen bestimmten Ordner relativ zum Ordner Configuration auf dem Anwen-

dungsserver bezeichnet, von dem Sie Serverskripts abrufen möchten.

Rückgabewerte

Ein Objekt, das die Antwort vom Server repräsentiert. Die Eigenschaft data dieses Objekts ist ein String mit dem Inhalt des gelöschten Skripts. Falls ein Fehler auftritt, zeigt Dreamweaver diesen in der Eigenschaft

statusCode des zurückgegebenen

Objekts an.

Beispiel

Wenn der folgende Code in einer Menübefehlsdatei im Ordner Configuration\Menus steht, entfernt er beim Aufruf von einem Menü aus alle Dateien aus dem Ordner _mmServerScripts:

<HTML> <head> <TITLE>Clear Server Scripts </TITLE> <SCRIPT SRC="ClearServerScripts.js"></SCRIPT> <SCRIPT LANGUAGE="javascript"> </SCRIPT> <body onLoad="MMHttp.clearServerScriptsFolder()"> </body> </html>

MMHttp.clearTemp()

Beschreibung

Diese Funktion löscht alle Dateien im Ordner Configuration\Temp, der sich im Anwendungsordner von Dreamweaver befindet.

Argumente

Keine

Rückgabewerte

Keine

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>

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

MMHttp.getFile()

Beschreibung

Diese Funktion ruft die Datei von 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.dream-

central.com/people/index.html, speichert Dreamweaver die Datei index.html im Unterordner People des Ordners www.dreamcentral.com.

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

fordert wird. Wenn sich We r t

false für das Argument prompt 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 Speicherort außerhalb des Ordners Configuration\Temp bezieht, kann der Benutzer überschreiben.

• Das optionale Argument titleBarLabel enthält die Bezeichnung, die in der Titelleiste des Dialogfelds Speichern

angezeigt wird.

saveURL auf einen Speicherort außerhalb des Ordners Configuration/Temp bezieht, wird der

prompt der Wert true definiert wurde oder sich saveURL auf einen

saveURL im Dialogfeld Speichern

Rückgabewerte

Ein Objekt, das die Antwort vom Server repräsentiert. Die Eigenschaft data dieses Objekts ist ein String, der den Speicherort enthält, an dem die Datei gespeichert ist (im URL-Format „file://“). Normalerweise enthält die Eigenschaft

statusCode des Objekts den vom Server empfangenen Statuscode. Wenn jedoch beim Speichern auf dem lokalen Laufwerk

ein Fehler aufgetreten ist und der Vorgang nicht erfolgreich ausgeführt werden kann, enthält die Eigenschaft als Fehlercode einen der folgenden ganzzahligen Werte:

statusCode

• 1: Unbekannter Fehler

• 2: Datei nicht gefunden

• 3: Ungültiger Pfad

• 4: Zu viele Dateien geöffnet

• 5: Zugriff verweigert

• 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

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

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

MMHttp.getFileCallback()

Beschreibung

Diese Funktion ruft die Datei von 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.dream-

central.com/people/index.html, speichert Dreamweaver die Datei index.html im Unterordner Peopl e des Ordners www.dreamcentral.com.

Argumente

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

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

fordert wird. Wenn sich We r t

false für das Argument prompt 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 Speicherort außerhalb des Ordners Configuration\Temp bezieht, kann der Benutzer überschreiben.

• Das optionale Argument titleBarLabel enthält die Bezeichnung, die in der Titelleiste des Dialogfelds Speichern

angezeigt wird.

saveURL auf einen Speicherort außerhalb des Ordners Configuration\Temp bezieht, wird der

prompt der Wert true definiert wurde oder sich saveURL auf einen

saveURL im Dialogfeld Speichern

Rückgabewerte

Ein Objekt, das die Antwort vom Server repräsentiert. Die Eigenschaft data dieses Objekts ist ein String, der den Ort enthält, an dem die Datei gespeichert wurde (im URL-Format „file://“). Normalerweise enthält die Eigenschaft

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

MMHttp.getText()

Ver fügbarkeit

Dreamweaver UltraDev 4; verbessert in Dreamweaver MX.

Beschreibung

Ruft den Inhalt des Dokuments von der angegebenen URL ab.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Argumente

URL, {serverScriptsFolder}

• Das Argument URL ist eine absolute URL auf einem Webserver. Auch wenn in der URL „http://“ nicht enthalten ist, geht

Dreamweaver davon aus, dass das HTTP-Protokoll verwendet wird.

• Das Argument serverScriptsFolder ist ein optionaler String, der einen bestimmten Ordner relativ zum Ordner Confi-

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

Falls ein Fehler auftritt, zeigt Dreamweaver diesen in der Eigenschaft

statusCode des zurückgegebenen Objekts an.

MMHttp.getTextCallback()

Ver fügbarkeit

Dreamweaver UltraDev 4, erweitert in Dreamweaver MX.

Beschreibung

Ruft den Inhalt des Dokuments von der angegebenen URL ab und leitet ihn an die angegebene Funktion weiter.

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.

• Das Argument serverScriptsFolder ist ein optionaler String, der einen bestimmten Ordner relativ zum Ordner Confi-

guration 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

Falls ein Fehler auftritt, zeigt Dreamweaver MX diesen in der Eigenschaft

statusCode des zurückgegebenen Objekts an.

callbackFunc angegeben wird.

MMHttp.postText()

Ver fü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.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Argumente

URL, dataToPost, {contentType}, {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 dataToPost gibt die zu sendenden Daten an. Wenn das dritte Argument "application/x-www-form-

urlencoded"

RFC 1866 (zu finden unter www.faqs.org/rfcs/rfc1866.html) formularkodiert sein.

lautet oder weggelassen wird, muss das Argument dataToPost gemäß Abschnitt 8.2.1 der Spezifikation

• Das optionale Argument contentType bezeichnet den Inhaltstyp der Daten, die durch das post-Verfahren übertragen

werden sollen. Bei fehlendem Argument wird als Standard

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

• Das Argument serverScriptsFolder ist ein optionaler String, der einen bestimmten Ordner relativ zum Ordner Confi-

guration 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 Remote-Dateisystem).

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

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 in den Eigenschaften zur Seitenkonfiguration 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 Ver w e ndung d er

arg1-Daten ausführt.

MMHttp.postTextCallback()

Ver fügbarkeit

Dreamweaver UltraDev 4; verbessert in Dreamweaver MX.

Beschreibung

Führt einen HTTP-Sendevorgang an die angegebene URL durch 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.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Argumente

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

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

(zu finden unter www.faqs.org/rfcs/rfc1866.html) formularkodiert sein.

lautet oder weggelassen wird, muss das Argument data gemäß Abschnitt 8.2.1 der Spezifikation RFC 1866

• Das optionale Argument contentType bezeichnet den Inhaltstyp der Daten, die durch das post-Verfahren übertragen

werden sollen. Bei fehlendem Argument wird als Standard

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

• serverScriptsFolder ist ein optionaler String. Er bezeichnet einen bestimmten Ordner relativ zum Ordner Configu-

ration auf dem Anwendungsserver, an den Sie Daten senden möchten. Zum Senden der Daten verwendet Dreamweaver

das entsprechende Übertragungsprotokoll (z. B. FTP, WebDAV oder Remote-Dateisystem). Dreamweaver ruft diese Daten ab und übergibt sie an die Funktion, die durch

Falls ein Fehler auftritt, zeigt Dreamweaver diesen in der Eigenschaft statusCode des zurückgegebenen Objekts an.

callbackFunc angegeben wird.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Kapitel 4: API für Design Notes

Mit Adobe® Dreamweaver® CS3, Fireworks und Flash haben Webdesigner und Webentwickler die Möglichkeit, zusätzliche Informationen über Dokumente zu speichern und abzurufen. Zu diesen Informationen gehören Revisionskommentare, Änderungshinweise oder der Name der Quelldatei einer GIF- oder JPEG-Grafik. Diese Informationen werden in Dateien gespeichert, die Design Notes genannt werden.

MMNotes ist eine gemeinsam genutzte C-Bibliothek, mit deren Hilfe die Autoren von Erweiterungen Design NotesDateien lesen und schreiben können. MMNotes weist wie die gemeinsam genutzte Bibliothek DWfile eine JavaScript-API auf, über die alle in der Bibliothek enthaltenen Funktionen von Objekten, Befehlen, Verhalten, schwebenden Bedienfeldern, Eigenschafteninspektoren und Datenübersetzern aus aufgerufen werden können.

MMNotes hat darüber hinaus eine C-API, die es anderen Anwendungen ermöglicht, Design Notes-Dateien zu lesen und zu schreiben. Die gemeinsam genutzte Bibliothek MMNotes kann unabhängig von Dreamweaver verwendet werden, sogar wenn Dreamweaver überhaupt nicht installiert ist.

Weitere Informationen über die Nutzung von Design Notes in Dreamweaver finden Sie in der Dokumentation Dream- weaver verwenden.

Funktionsweise von Design Notes

In jeder Design Notes-Datei sind Informationen über ein einziges 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 Site nicht angezeigt, jedoch im Finder (Macintosh) bzw. in Windows Explorer. Design Notes-Dateinamen bestehen aus dem Hauptdateinamen und der Erweiterung „.mno“. Die Design NotesDatei zur Datei avocado8.gif beispielsweise trägt den Namen avocado8.gif.mno.

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 eigentliche Information dar. Schlüssel können höchstens 64 Zeichen lang sein.

Das folgende Beispiel zeigt die Design Notes-Datei für die Beispieldatei foghorn.gif.mno:

<?xml version="1.0" encoding="iso-8859-1" ?> <info>

<infoitem key="FW

foghorn.png" /> <infoitem key="Author" value="Heidi B." /> <infoitem key="Status" value="Final draft, approved by Jay L." />

</info>

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

JavaScript -API für Design Notes

Alle Funktionen der JavaScript-API für Design Notes sind Methoden des Objekts MMNotes.

MMNotes.close()

Beschreibung

Diese Funktion schließt die angegebene Design Notes-Datei und speichert alle Änderungen. Wenn alle Schlüssel-WertPaare entfernt wurden, löscht Dreamweaver die Design Notes-Datei. Wenn es sich um die letzte Design Notes-Datei im Ordner _notes handelt, löscht Dreamweaver auch den Ordner.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Hinweis: Rufen Sie immer die Funktion MMNotes.close() auf, wenn Sie Ihre Arbeit mit Design Notes abgeschlossen haben, um Dreamweaver zu veranlassen, in die Datei zu schreiben.

Argumente

fileHandle

• Das Argument fileHandle ist das von der Funktion MMNotes.open() zurückgegebene Datei-Handle.

Rückgabewerte

Keine

Beispiel

Weitere Informationen finden Sie unter „MMNotes.set()“ auf Seite 27.

MMNotes.filePathToLocalURL()

Beschreibung

Diese Funktion wandelt den angegebenen lokalen Pfad 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://“).

Beispiel

Beim Aufruf von MMNotes.filePathToLocalURL('C:\sites\webdev\index.htm') wird der String

"file:///c|/sites/webdev/index.htm" zurückgegeben.

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.

Rückgabewerte

Ein String mit dem Wert des Schlüssels.

Beispiel

Weitere Informationen finden Sie unter „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.

ADOBE DREAMWEAVER 9.0

Rückgabewerte

Ein ganzzahliger Wert, der die Anzahl der Schlüssel-Wert-Paare in der Design Notes-Datei angibt.

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 könnte 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++){

theValue = MMNotes.get(noteHandle,theKeys[i]); noteString +=0theKeys[i] + " = " theValue + "\n";

} document.theForm.bigTextField.value = noteString; // noteHandle immer schließen MMNotes.close(noteHandle);

API-Referenzhandbuch

MMNotes.getSiteRootForFile()

Beschreibung

Diese Funktion bestimmt den Stammordner für die angegebene Design Notes-Datei.

Argumente

fileURL

• Das Argument fileURL im URL-Format „file://“ ist der Pfad zu einer lokalen Datei.

Rückgabewerte

Ein String, der den Pfad des lokalen Stammordners der Site enthält (im URL-Format „file://“), bzw. der leer ist, wenn Dreamweaver nicht installiert ist oder die Design Notes-Datei sich außerhalb einer mit Dreamweaver definierten Site befindet. Diese Funktion sucht nach allen Sites, die in Dreamweaver definiert sind.

MMNotes.getVersionName()

Beschreibung

Diese Funktion ruft den Versionsnamen der gemeinsam genutzten Bibliothek MMNotes ab, der gleichzeitig die implementierende Anwendung angibt.

Argumente

Keine

Rückgabewerte

Ein String mit dem Namen der Anwendung, die die gemeinsam genutzte Bibliothek MMNotes implementiert hat.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Beispiel

Wenn die Funktion MMNotes.getVersionName() von einem Dreamweaver-Befehl, einem Objekt, einem Verhalten, einem Eigenschafteninspektor, einem schwebenden Bedienfeld oder einem Datenübersetzer aus aufgerufen wird, wird der String

"Dreamweaver" zurückgegeben. Durch Aufrufen der Funktion MMNotes.getVersionName() von Fireworks aus wird auch "Dreamweaver" zurückgegeben, da Fireworks dieselbe Bibliotheksversion verwendet, die vom Dreamweaver-Entwick-

lungsteam erstellt wurde.

MMNotes.getVersionNum()

Beschreibung

Diese Funktion ruft die Versionsnummer der gemeinsam genutzten Bibliothek MMNotes ab.

Argumente

Keine

Rückgabewerte

Ein String, der die Versionsnummer enthält.

MMNotes.localURLToFilePath()

Beschreibung

Diese Funktion wandelt den angegebenen Pfad im URL-Format „file://“ in einen lokalen Pfad um.

Argumente

fileURL

• Das Argument fileURL im URL-Format „file://“ ist der Pfad zu einer lokalen Datei.

Rückgabewerte

Ein String, der den lokalen Laufwerkspfad für die angegebene Datei enthält.

Beispiel

Beim Aufruf von MMNotes.localURLToFilePath(‘file:///MacintoshHD/images/moon.gif’) wird der String "Macin-

toshHD:images:moon.gif"

zurückgegeben.

MMNotes.open()

Beschreibung

Diese Funktion öffnet die der angegebenen Datei zugeordnete Design Notes-Datei bzw. erstellt eine solche, falls noch keine existiert.

Argumente

filePath, {bForceCreate}

• Das Argument filePath im URL-Format „file://“ ist der Pfad zur Hauptdatei, mit der die Design Notes-Datei verknüpft

ist.

• Das Argument bForceCreate ist ein Boolescher Wert, der angibt, ob die Design Note auch dann erstellt werden soll,

wenn Design Notes für die Site deaktiviert sind oder

filePath mit keiner Site verknüpft ist.

Rückgabewerte

Das Datei-Handle für die Design Notes-Datei bzw. Null (0), wenn die Datei nicht geöffnet oder erstellt wurde.

Beispiel

Weitere Informationen finden Sie unter „MMNotes.set()“ auf Seite 27.

MMNotes.remove()

Beschreibung

Diese Funktion entfernt den angegebenen Schlüssel (und seinen Wert) aus einer Design Notes-Datei.

Argumente

fileHandle, keyName

• Das Argument fileHandle ist das von der Funktion MMNotes.open() zurückgegebene Datei-Handle.

• Das Argument keyName ist ein String, der den Namen des zu entfernenden Schlüssels enthält.

Rückgabewerte

Ein Boolescher Wert: true bei einem erfolgreichen Vorgang, andernfalls false.

MMNotes.set()

Beschreibung

Diese Funktion erstellt bzw. aktualisiert ein Schlüssel-Wert-Paar in einer Design Notes-Datei.

Argumente

fileHandle, keyName, valueString

• Das Argument fileHandle ist das von der Funktion MMNotes.open() zurückgegebene Datei-Handle.

• Das Argument keyName ist ein String, der den Namen des Schlüssels enthält.

• Das Argument valueString ist ein String, der den Wert enthält.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Rückgabewerte

Ein Boolescher Wert: true bei einem erfolgreichen Vorgang, andernfalls false.

Beispiel

Mit dem folgenden Beispielcode wird die mit der Site dreamcentral verknüpfte Design Notes-Datei peakhike99\index.html geöffnet, dieser ein neues Schlüssel-Wert-Paar hinzugefügt, der Wert eines bestehenden

Schlüssels geändert und danach die Design Notes-Datei geschlossen.

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

}

C-API für Design Notes

Abgesehen von der JavaScript-API enthält die gemeinsam genutzte Bibliothek MMNotes auch eine C-API, über die andere Anwendungen Design Notes-Dateien erstellen können. Wenn Sie die Bibliothek MMNotes in Dreamweaver verwenden, brauchen Sie diese C-Funktionen nicht direkt aufzurufen, da die entsprechenden JavaScript-Versionen der Funktionen dies für Sie übernehmen.

Dieser Abschnitt enthält eine Beschreibung der Funktionen und deren Argumente und Rückgabewerte. Sie finden die Definition der Funktionen und Datentypen in der Datei MMInfo.h im Ordner Extending\c_files innerhalb des Anwen- dungsordners von Dreamweaver.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

void CloseNotesFile()

Beschreibung

Diese Funktion schließt die angegebene Design Notes-Datei und speichert alle Änderungen. Wenn alle Schlüssel-WertPaare aus der Design Notes-Datei entfernt wurden, löscht Dreamweaver die Datei. Dreamweaver entfernt den Ordner _notes, nachdem die letzte Design Notes-Datei gelöscht wurde.

Argumente

noteHandle

• Das Argument noteHandle ist das von der Funktion OpenNotesFile() zurückgegebene Datei-Handle.

Rückgabewerte

Keine

BOOL FilePathToLocalURL()

Beschreibung

Diese Funktion wandelt den angegebenen lokalen Pfad in das URL-Format „file://“ um.

Argumente

const char* drivePath, char* localURLBuf, int localURLMaxLen

• Das Argument drivePath ist ein String, der den vollständigen Laufwerkspfad enthält.

• Das Argument localURLBuf bezeichnet den Puffer, in dem der URL-String „file://“ gespeichert wird.

• Das Argument localURLMaxLen ist die maximale Größe von localURLBuf.

Rückgabewerte

Ein Boolescher Wert: true bei einem erfolgreichen Vorgang, andernfalls false. Das Argument localURLBuf erhält den Wert des URL-Strings „file://“.

BOOL GetNote()

Beschreibung

Diese Funktion ruft den Wert des angegebenen Schlüssels in einer Design Notes-Datei ab.

Argumente

FileHandle noteHandle, const char keyName[64], char* valueBuf, int valueBufLength

• Das Argument noteHandle ist das von der Funktion OpenNotesFile() zurückgegebene Datei-Handle.

• Das Argument keyName[64] ist ein String, der den Namen des Schlüssels enthält.

• Das Argument valueBuf bezeichnet den Puffer, in dem der Wert gespeichert wird.

• Das Argument valueBufLength ist die Ganzzahl, die von GetNoteLength(noteHandle, keyName) zurückgegeben wird

und die maximale Länge des Wertepuffers angibt.

Rückgabewerte

Ein Boolescher Wert: true bei einem erfolgreichen Vorgang, andernfalls false. Das Argument valueBuf erhält den Wert des Schlüssels.

Beispiel

Mit dem folgenden Code wird der Wert des Schlüssels comments in der mit welcome.html verknüpften Design Notes-Datei abgerufen:

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

Beschreibung

Diese Funktion ruft die Länge des Werts für den angegebenen Schlüssel ab.

Argumente

FileHandle noteHandle, const char keyName[64]

• Das Argument noteHandle ist das von der Funktion OpenNotesFile() zurückgegebene Datei-Handle.

• Das Argument keyName[64] ist ein String, der den Namen des Schlüssels enthält.

Rückgabewerte

Eine Ganzzahl, die die Länge des Werts angibt.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Beispiel

Weitere Informationen finden Sie unter „BOOL GetNote()“ auf Seite 28.

int GetNotesKeyCount()

Beschreibung

Diese Funktion ruft die Anzahl der Schlüssel-Wert-Paare in der angegebenen Design Notes-Datei ab.

Argumente

FileHandle noteHandle

• Das Argument noteHandle ist das von der Funktion OpenNotesFile() zurückgegebene Datei-Handle.

Rückgabewerte

Ein ganzzahliger Wert, der die Anzahl der Schlüssel-Wert-Paare in der Design Notes-Datei angibt.

BOOL GetNotesKeys()

Beschreibung

Diese Funktion ruft eine Liste sämtlicher Schlüssel in einer Design Notes-Datei ab.

Argumente

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

• Das Argument noteHandle ist das von OpenNotesFile() zurückgegebene Datei-Handle.

• Das Argument keyBufArray[64] bezeichnet das Pufferfeld, wo die Schlüssel gespeichert werden.

• Das Argument keyArrayMaxLen ist der von GetNotesKeyCount(noteHandle) zurückgegebene ganzzahlige Wert, der die

maximale Anzahl von Elementen im Schlüsselpuffer-Array angibt.

Rückgabewerte

Ein Boolescher Wert: true bei einem erfolgreichen Vorgang, andernfalls false. Das Argument keyBufArray erhält die Schlüsselnamen.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Beispiel

Mit dem folgenden Code werden die Schlüsselnamen und -werte sämtlicher Schlüssel in der Design Notes-Datei von welcome.html ausgegeben:

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

Beschreibung

Diese Funktion bestimmt den Stammordner für die angegebene Design Notes-Datei.

Argumente

const char* filePath, char* siteRootBuf, int siteRootBufMaxLen, {InfoPrefs* infoPrefs}

• Das Argument filePath im URL-Format „file://“ ist die Datei, deren Stammordner ermittelt werden soll.

• Das Argument siteRootBuf bezeichnet den Puffer, in dem der Stammordner gespeichert ist.

• siteRootBufMaxLen ist die maximale Größe des Puffers, auf den siteRootBuf verweist.

• Das optionale Argument infoPrefs ist ein Verweis auf eine struct, in der die Voreinstellungen für die Site gespeichert

werden.

Rückgabewerte

Ein Boolescher Wert: true bei einem erfolgreichen Vorgang, andernfalls false. Das Argument siteRootBuf erhält die Adresse des Puffers, in dem der Stammordner gespeichert ist. Wenn Sie

infoPrefs angeben, werden auch die

Design Notes-Voreinstellungen für die Site zurückgegeben. Die struct InfoPrefs besitzt zwei Variablen: bUseDesignNotes und

bUploadDesignNotes, beide vom Typ BOOL.

BOOL GetVersionName()

Beschreibung

Diese Funktion ruft den Versionsnamen der gemeinsam genutzten Bibliothek MMNotes ab, der gleichzeitig die implementierende Anwendung angibt.

Argumente

char* versionNameBuf, int versionNameBufMaxLen

• Das Argument versionNameBuf bezeichnet den Puffer, in dem der Versionsname gespeichert wird.

• versionNameBufMaxLen ist die maximale Größe des Puffers, auf den versionNameBuf verweist.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Rückgabewerte

Ein Boolescher Wert: true bei einem erfolgreichen Vorgang, andernfalls false. Dreamweaver speichert "Dreamweaver" im Argument

versionNameBuf.

BOOL GetVersionNum()

Beschreibung

Diese Funktion ruft die Versionsnummer der gemeinsam genutzten Bibliothek MMNotes ab, sodass Sie ermitteln können, ob bestimmte Funktionen verfügbar sind.

Argumente

char* versionNumBuf, int versionNumBufMaxLen

• Das Argument versionNumBuf bezeichnet den Puffer, in dem die Versionsnummer gespeichert wird.

• versionNumBufMaxLen ist die maximale Größe des Puffers, auf den versionNumBuf verweist.

Rückgabewerte

Ein Boolescher Wert: true bei einem erfolgreichen Vorgang, andernfalls false. versionNumBuf speichert die Versionsnummer.

BOOL LocalURLToFilePath()

Beschreibung

Diese Funktion wandelt den angegebenen Pfad im URL-Format „file://“ in einen lokalen Pfad um.

Argumente

const char* localURL, char* drivePathBuf, int drivePathMaxLen

• Das Argument localURL im URL-Format „file://“ ist der Pfad zu einer lokalen Datei.

• Das Argument drivePathBuf bezeichnet den Puffer, in dem die lokale Pfadangabe gespeichert wird.

• drivePathMaxLen ist die maximale Größe des Puffers, auf den drivePathBuf verweist.

Rückgabewerte

Ein Boolescher Wert: true bei einem erfolgreichen Vorgang, andernfalls false. drivePathBuf erhält die lokale Pfadangabe.

FileHandle OpenNotesFile()

Beschreibung

Diese Funktion öffnet die der angegebenen Datei zugeordnete Design Notes-Datei bzw. erstellt eine solche, falls noch keine existiert.

Argumente

const char* localFileURL, {BOOL bForceCreate}

• Das Argument localFileURL im URL-Format „file://“ ist ein String, der den Pfad zur Hauptdatei, mit der die Design

Notes-Datei verknüpft ist, enthält.

• bForceCreate ist ein Boolescher Wert, der angibt, ob die Design Notes-Datei auch dann erstellt werden soll, wenn

Design Notes für die Site deaktiviert sind oder der für

localFileURL angegebene Pfad mit keiner Site verknüpft ist.

FileHandle OpenNotesFilewithOpenFlags()

Beschreibung

Diese Funktion öffnet die der angegebenen Datei zugeordnete Design Notes-Datei bzw. erstellt eine solche, falls noch keine existiert. Die Datei kann im schreibgeschützten Modus geöffnet werden.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Argumente

const char* localFileURL, {BOOL bForceCreate}, {BOOL bReadOnly}

• Das Argument localFileURL im URL-Format „file://“ ist ein String, der den Pfad zur Hauptdatei, mit der die Design

Notes-Datei verknüpft ist, enthält.

• bForceCreate ist ein Boolescher Wert, der angibt, ob die Design Notes-Datei auch dann erstellt werden soll, wenn

Design Notes für die Site deaktiviert sind oder der Pfad mit keiner Site verknüpft ist. Der Standardwert ist Argument ist optional, doch muss es angegeben werden, wenn Sie das dritte Argument angeben.

false. Dieses

• Das optionale Argument bReadOnly ist ein Boolescher Wert, der angibt, ob die Datei im schreibgeschützten Modus

geöffnet werden soll. Der Standardwert ist

false. bReadOnly ist ab Version 2 von MMNotes.dll verfügbar.

BOOL RemoveNote()

Beschreibung

Diese Funktion entfernt den angegebenen Schlüssel (und seinen Wert) aus einer Design Notes-Datei.

Argumente

FileHandle noteHandle, const char keyName[64]

• Das Argument noteHandle ist das von der Funktion OpenNotesFile() zurückgegebene Datei-Handle.

• Das Argument keyName[64] ist ein String, der den Namen des zu entfernenden Schlüssels enthält.

Rückgabewerte

Ein Boolescher Wert: true bei einem erfolgreichen Vorgang, andernfalls false.

BOOL SetNote()

Beschreibung

Diese Funktion erstellt bzw. aktualisiert ein Schlüssel-Wert-Paar in einer Design Notes-Datei.

Argumente

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

• Das Argument noteHandle ist das von der Funktion OpenNotesFile() zurückgegebene Datei-Handle.

• Das Argument keyName[64] ist ein String, der den Namen des Schlüssels enthält.

• Das Argument value ist ein String, der den Wert enthält.

Rückgabewerte

Ein Boolescher Wert: true bei einem erfolgreichen Vorgang, andernfalls false.

Kapitel 5: Integration von Fireworks

FWLaunch ist eine gemeinsam genutzte C-Bibliothek, durch die Autoren von Objekten, Befehlen, Verhalten und Eigenschafteninspektoren mit Adobe® Fireworks® kommunizieren können. Mithilfe von FWLaunch können Sie JavaScript-Code schreiben, um die Fireworks-Benutzeroberfläche zu öffnen und Befehle an Fireworks über dessen eigene JavaScript-API zu senden. Informationen dazu finden Sie im Handbuch Extending Fireworks. Allgemeine Informationen über das Zusammenwirken von C-Bibliotheken mit dem JavaScript-Interpreter in Adobe® Dreamweaver® CS3 finden Sie im Handbuch Dreamweaver erweitern unter „C-Level-Erweiterbarkeit“.

FWLaunch-API

Mit dem FWLaunch-Objekt können Sie Fireworks öffnen, Fireworks-Operationen über die JavaScript-API von Fireworks durchführen und anschließend Werte an Dreamweaver zurückgeben. In diesem Kapitel werden die FWLaunch-Kommunikations-API und deren Verwendung erläutert.

FWLaunch.bringDWToFront()

Ver fügbarkeit

Dreamweaver 3, Fireworks 3.

Beschreibung

Diese Funktion stellt Dreamweaver in den Vordergrund.

Argumente

Keine

Rückgabewerte

Keine

FWLaunch.bringFWToFront()

Ver fügbarkeit

Dreamweaver 3, Fireworks 3.

Beschreibung

Diese Funktion stellt Fireworks in den Vordergrund, falls es ausgeführt wird.

Argumente

Keine

Rückgabewerte

Keine

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

FWLaunch.execJsInFireworks()

Ver fügbarkeit

Dreamweaver 3, Fireworks 3.

Beschreibung

Diese Funktion übergibt das angegebene JavaScript oder einen Verweis auf eine JavaScript-Datei zur Ausführung an Fireworks.

Argumente

javascriptOrFileURL

• Das Argument javascriptOrFileURL im URL-Format „file://“ enthält entweder expliziten JavaScript-Code oder den

Pfad zu einer JavaScript-Datei.

Rückgabewerte

Ein Cookie-Objekt, falls die JavaScript-Daten erfolgreich übergeben wurden, oder ein Fehlercode ungleich Null, falls einer der folgenden Fehler aufgetreten ist:

• Ungültige Verwendung: javascriptOrFileURL wurde als null oder als leerer String definiert, oder der Pfad zu der .JS-

bzw. .JSF-Datei ist ungültig.

• I/O-Dateifehler: Fireworks konnte keine Antwortdatei erstellen, da die Festplatte voll ist.

• Fehlermeldung an Dreamweaver: Benutzer führt keine gültige Version von Dreamweaver (Version 3 oder höher) aus.

• Fehler beim Starten des Fireworks-Prozesses: Die Funktion startet keine gültige Version von Fireworks (Version 3 oder

höher erforderlich).

• Die Aktion wurde vom Benutzer abgebrochen.

FWLaunch.getJsResponse()

Ver fügbarkeit

Dreamweaver 3, Fireworks 3.

Beschreibung

Diese Funktion bestimmt, ob Fireworks noch immer den von FWLaunch.execJsInFireworks() übergebenen JavaScriptCode ausführt, ob das Skript erfolgreich beendet wurde oder ob ein Fehler aufgetreten ist.

Argumente

progressTrackerCookie

• Das Argument progressTrackerCookie ist das von der Funktion FWLaunch.execJsInFireworks() zurückgegebene

Cookie-Objekt.

Rückgabewerte

Ein String mit dem Ergebnis des an FWLaunch.execJsInFireworks() übergebenen Skripts, falls der Vorgang erfolgreich beendet wurde. Der Wert ist Null wird zurückgegeben, wenn einer der folgenden Fehler aufgetreten ist:

• Ungültige Verwendung: Beim Ausführen des Skripts ist ein JavaScript-Fehler aufgetreten.

• I/O-Dateifehler: Fireworks konnte keine Antwortdatei erstellen, da die Festplatte voll ist.

• Fehlermeldung an Dreamweaver: Benutzer führt keine gültige Version von Dreamweaver (Version 3 oder höher) aus.

• Fehler beim Starten des Fireworks-Prozesses: Die Funktion startet keine gültige Version von Fireworks (3 oder höher

erforderlich).

• Die Aktion wurde vom Benutzer abgebrochen.

null, wenn Fireworks noch immer den JavaScript-Code ausführt. Ein Fehlercode ungleich

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Beispiel

Der folgende Code übergibt den String "prompt('Geben Sie Ihren Namen ein:')" an FWLaunch.execJsInFireworks() und prüft dann das Ergebnis:

var progressCookie = FWLaunch.execJsInFireworks("prompt('Please enter your name:')"); var doneFlag = false; while (!doneFlag){

// alle 0,5 Sekunden auf Abschluss prüfen setTimeout('checkForCompletion()',500);

}

function checkForCompletion(){

if (progressCookie != null) {

var response = FWLaunch.getJsResponse(progressCookie);

if (response != null) {

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

// Fehler oder Abbruch durch Benutzer, Fenster schließen // und den Benutzer über Fehler benachrichtigen window.close(); alert("An error occurred.");

} else {

// gültige Antwort! alert("Nice to meet you, " + response); window.close();

}

doneFlag = true;

} }

}

FWLaunch.mayLaunchFireworks()

Ver fügbarkeit

Dreamweaver 2, Fireworks 2.

Beschreibung

Diese Funktion bestimmt, ob der Start einer Fireworks-Optimierungssitzung möglich ist.

Argumente

Keine

Rückgabewerte

Ein Boolescher Wert, der angibt, ob Windows oder Macintosh als Plattform verwendet wird. Bei Macintosh wird angezeigt, ob bereits eine weitere Fireworks-Optimierungssitzung ausgeführt wird.

FWLaunch.optimizeInFireworks()

Ver fügbarkeit

Dreamweaver 2, Fireworks 2.

Beschreibung

Diese Funktion startet für das angegebene Bild eine Fireworks-Optimierungssitzung.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Argumente

docURL, imageURL, {targetWidth}, {targetHeight}

• Das Argument docURL ist der Pfad zum aktiven Dokument im URL-Format „file://“.

• imageURL ist der Pfad zum ausgewählten Bild. Wenn der Pfad relativ ausgedrückt ist, ist er relativ zu dem in docURL

angegebenen Pfad.

• Das optionale Argument targetWidth ist die Breite, auf die das Bild angepasst werden soll.

• Das optionale Argument targetHeight ist die Höhe, auf die das Bild angepasst werden soll.

Rückgabewerte

Null, wenn für das ausgewählte Bild eine Fireworks-Optimierungssitzung erfolgreich gestartet wurde. Ein Fehlercode ungleich Null wird zurückgegeben, falls einer der folgenden Fehler aufgetreten ist:

• Ungültige Verwendung: docURL, imageURL oder beide wurden als null bzw. als leerer String definiert.

• I/O-Dateifehler: Fireworks konnte keine Reaktionsdatei erstellen, da die Festplatte voll ist.

• Fehlermeldung an Dreamweaver: Benutzer arbeitet mit einer ungültigen Version von Dreamweaver (2 oder höher erfor-

derlich).

• Fehler beim Starten des Fireworks-Prozesses: Die Funktion startet keine gültige Version von Fireworks (Version 2 oder

höher erforderlich).

• Die Aktion wurde vom Benutzer abgebrochen.

FWLaunch.validateFireworks()

Ver fügbarkeit

Dreamweaver 2, Fireworks 2.

Beschreibung

Diese Funktion sucht auf der Festplatte des Benutzers nach der angegebenen Version von Fireworks.

Argumente

{versionNumber}

• Das Argument versionNumber ist ein optionaler Gleitkommawert, der mindestens 2 beträgt. Er stellt die erforderliche

Fireworks-Version dar. Bei fehlendem Argument wird der Wert 2 als Standard verwendet.

Rückgabewerte

Ein Boolescher Wert, der angibt, ob die betreffende Version von Fireworks gefunden wurde.

Beispiel

Mit dem folgenden Code wird überprüft, ob Fireworks installiert ist:

if (FWLaunch.validateFireworks(6.0)){

alert("Fireworks 6.0 or later is installed.");

} else {

alert("Fireworks 6.0 is not installed.");

}

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Einfaches FWLaunch-Kommunikationsbeispiel

Mit dem folgenden Befehl wird Fireworks angewiesen, den Benutzer nach seinem Namen zu fragen und diesen Namen an Dreamweaver zu übergeben:

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

}

// Fireworks anweisen, die prompt()-Methode auszuführen. gProgressTrackerCookie = FWLaunch.execJsInFireworks¬ ("prompt('Please enter your name:')");

// Null bedeutet, dass Fireworks nicht gestartet wurde, eine Zahl weist auf einen Fehlercode hin. if (gProgressTrackerCookie == null || ¬ typeof(gProgressTrackerCookie) == "number") {

window.close();

alert("an error occurred");

gProgressTrackerCookie = null; } else {

// Fireworks in den Vordergrund bringen

FWLaunch.bringFWToFront();

// Prüfung starten, um zu sehen, ob Fireworks schon abgeschlossen wurde

checkOneMoreTime(); }

}

function checkOneMoreTime() {

// alle 0,5 Sekunden die Funktion JsResponse() aufrufen, und überprüfen, // ob Fireworks schon abgeschlossen wurde window.setTimeout("checkJsResponse();", 500);

}

function checkJsResponse() {

var response = null;

// Benutzer hat auf 'Abbrechen' geklickt, Fenster schließen if (gCancelClicked) {

window.close();

alert("cancel clicked"); } else {

// wird noch ausgeführt, Status von Fireworks abfragen

if (gProgressTrackerCookie != null)

response = FWLaunch.getJsResponse(gProgressTrackerCookie);

if (response == null) {

// wartet noch auf Antwort, in 0,5 Sekunden noch // einmal anfragen checkOneMoreTime();

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

// Zahl als Antwort bedeutet, dass ein Fehler aufgetreten ist // Aktion wurde vom Benutzer in Fireworks abgebrochen window.close(); alert("an error occurred.");

} else {

// gültige Antwort! Dieser Rückgabewert // ist nicht immer hilfreich, da nicht alle Funktionen in // Fireworks einen String zurückgeben, diese aber doch, // deshalb kann dem Benutzer angezeigt werden, was vorliegt. window.close(); FWLaunch.bringDWToFront();// Dreamweaver in den Vordergrund bringen alert("Nice to meet you, " + response + "!");

} }

}

</script> </head> <body> <formular> <table width="313" nowrap> <tr> <td>This command asks Fireworks to execute the prompt() ¬ aufruft. When you click Prompt, Fireworks comes forward and ¬ asks you to enter a value into a dialog box. That value is then ¬ returned to Dreamweaver and displayed in an alert.</td> </tr> </table> </form> </body> </html>

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Kapitel 6: Flash-Integration

Adobe® Dreamweaver® CS3 unterstützt Flash-Elemente. Außerdem steht eine ständige Unterstützung der API für FlashObjekte zur Verfügung, wodurch die Flash Generator-Vorlagendatei veranlasst wird, neue Flash-Objekte zu erstellen. In diesem Kapitel werden die Verwendung der Flash-Elemente (SWC-Dateien) beschrieben sowie Details zur Erstellung von Flash-Objekten (SWF-Dateien) mithilfe von Flash Generator-Vorlagen (SWT-Dateien) bereitgestellt.

Informationen zum Hinzufügen von Flash-Inhalt zu Dreamweaver-Objekten oder -Befehlen finden Sie im Handbuch Dreamweaver erweitern.

Funktionsweise von Flash-Elementen

Flash-Elemente liegen komprimiert in Form von SWC-Dateien vor. Eine SWC-Datei ist ein von Flash erstellter, kompilierter Komponenten-Clip, der von Adobe-Produkten und Produkten anderer Anbieter verwendet werden kann. Dreamweaver stellt den Benutzern diese Komponenten über die Einfügeleiste, das Menü Einfügen oder die Symbolleiste zur Verfügung. Flash-Elemente werden mit dem Flash-Authoring-Tool erstellt. Dreamweaver kann jedoch die Eigenschaften eines Flash-Elements analysieren und sie über das (dem können dann die Attribute des (Weitere Informationen zum Arbeiten mit Komponenteneigenschaften in Dreamweaver finden Sie im Abschnitt Dream- weaver verwenden.)

param-Tags bearbeiten, um die Eigenschaften des Elements beim Veröffentlichen zu ändern.

object-Tag untergeordnete) param-Tag darstellen. Benutzer

Flash-Elemente einfügen

Flash-Elemente werden über den Extension Manager installiert. Dreamweaver fügt den Dokumenten Flash-Elemente auf die gleiche Weise hinzu wie Objekte, die auf der Einfügeleiste oder im Menü Einfügen verfügbar sind (weitere Informationen zum Arbeiten mit Dreamweaver-Objekten finden Sie unter „Objekte der Einfügeleiste“ im Handbuch Dreamweaver erweitern). Benutzer können Strings in ein Dokument einfügen, indem Sie auf der Einfügeleiste auf Objekte klicken oder Menüoptionen im Menü Einfügen auswählen. Flash-Elemente stehen den Benutzern auf der Einfügeleiste oder im Menü Einfügen zur Verfügung. (Sie können also der Einfügeleiste bzw. dem Menü Einfügen ein gültiges Flash-Element hinzu- fügen, das bereits im Ordner Configuration\Objects\FlashElements oder in den entsprechenden Unterordnern abgelegt ist.) Die Entwickler von Erweiterungen können die JavaScript-Funktion „dom.insertFlashElement()“ auf Seite 124 in der Objektdefinitionsdatei verwenden, um einem Dokument verfügbare Flash-Elemente hinzufügen. Wählt der Benutzer das Flash-Element aus, entpackt Dreamweaver die SWC-Datei mit dem Flash-Inhalt (einer SWF-Datei) sowie eine Datei, die mitteilt, welche Parameter vom Benutzer geändert werden. Dreamweaver fügt die SWF-Datei anschließend in das Benutzerdokument ein.

Flash-Element der Einfügeleiste hinzufügen

Ein Flash-Element wird wie jedes andere Objekt über das button-Tag zur Einfügeleiste hinzugefügt. Ein button-Tag für ein Flash-Element muss jedoch ein hinzugefügt werden kann (weitere Informationen zum button-Tag finden Sie unter „Objekte der Einfügeleiste“ im Handbuch Dreamweaver erweitern). Mithilfe des Elements in Bezug auf den Ordner Objects abgelegt ist. Weisen Sie Dreamweaver anschließend über das an, die Funktion klickt.

Das folgende Beispiel zeigt den Code, der in die Datei insertbar.xml eingefügt wird (als untergeordnetes Objekt des entsprechenden werden soll):

dom.insertFlashElement() zu verwenden, wenn der Benutzer auf eine Schaltfläche der Einfügeleiste

category- oder menubutton-Tags, abhängig davon, wo die Schaltfläche für das Flash-Element angezeigt

file- und command-Attribut enthalten, damit das Element dem Dokument erfolgreich

file-Attributs wird Dreamweaver mitgeteilt, wo die Quelldatei des

command-Attribut

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Hinweis: Das Bild für das Flash-Element auf der Einfügeleiste ist in der SWC-Datei festgelegt. Außerdem muss für das buttonTag eines Flash-Elements ein file-Attribut definiert sein.

Flash-Elemente einem Menü hinzufügen

In Dreamweaver kann sich ein Flash-Element auch auf der Einfügeleiste oder in anderen Menüs befinden. Verwenden Sie die JavaScript-Funktion „dom.insertFlashElement()“ auf Seite 124 in der Datei menus.xml, um die Position des Flash- Elements im Menü anzugeben (siehe „Menüs und Menübefehle“ im Handbuch Dreamweaver erweitern). Mithilfe des folgenden Codes in der Datei menus.xml wird unter Einfügen > Flash-Element das Flash-Element Navigation hinzugefügt.

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

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

id="DWMenu_Insert_FlashElement_Nav" />

API für Flash-Objekte

Mit der API für Flash-Objekte können Objekte zum Erstellen einfacher Flash-Inhalte mithilfe von Flash Generator entwickelt werden. Mit dieser API können Sie Parameter in einer Flash Generator-Vorlage festlegen und eine SWF- bzw. eine Bilddatei erstellen. Des Weiteren können Sie mit ihr neue Flash-Objekte erstellen und vorhandene Flash-Objekte lesen und bearbeiten. Die Flash-Funktionsmerkmale für Schaltflächen und Text werden mit dieser API erstellt.

Die SWT-Datei ist eine Flash Generator-Vorlagendatei, in der sich alle erforderlichen Daten für das Erstellen einer FlashObjektdatei befinden. Mithilfe dieser API-Funktionen können Sie eine neue SWF-Datei (oder Bilddatei) aus einer SWTDatei erstellen, indem Sie die Parameter der SWT-Datei durch echte Werte ersetzen. Weitere Informationen über Flash finden Sie in der Flash-Dokumentation. Die folgenden Funktionen stellen Methoden des

SWFFile.createFile()

Beschreibung

Diese Funktion generiert eine neue Flash-Objektdatei mit der angegebenen Vorlage und einem Parameter-Array. Außerdem erstellt sie GIF-, PNG-, JPEG- und MOV-Versionen des Titels, sofern für diese Formate Dateinamen angegeben wurden.

Wenn Sie einen optionalen Parameter angeben möchten, der auf andere optionale Parameter folgt, die Sie jedoch nicht verwenden möchten, müssen Sie für die nicht zu verwendenden Parameter leere Strings angeben. Wenn Sie beispielsweise eine PNG-Datei, jedoch keine GIF-Datei angeben möchten, müssen Sie vor dem PNG-Dateinamen einen leeren String angeben.

Argumente

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

• Das Argument templateFile ist ein Pfad zu einer Vorlagendatei im URL-Format „file:// “. Hierbei kann es sich um eine

SWT-Datei handeln.

• Das Argument templateParams ist ein Array aus Name-Wert-Paaren. Die Namen stehen hierbei für die Parameter-

namen in der SWT-Datei und die Werte für die gewünschten Werte dieser Parameter. Damit Dreamweaver eine SWFDatei als Flash-Objekt erkennt, muss der erste Parameter Namen des Objekttyps repräsentiert, beispielsweise

"dwType" lauten. Der Wert muss ein String sein, der den

"Flash Text".

SWFFile-Objekts dar.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

• Das Argument swfFileName ist der Name einer SWF-Ausgabedatei im URL-Format „file://“ bzw. ein leerer String, der

ignoriert wird.

• Das Argument gifFileName ist der Name einer GIF-Ausgabedatei im URL-Format „file://“. Dieses Argument ist

optional.

• Das Argument pngFileName ist der Name einer GIF-Ausgabedatei im URL-Format „file://“. Dieses Argument ist

optional.

• Das Argument jpgFileName ist der Name einer GIF-Ausgabedatei im URL-Format „file://“. Dieses Argument ist

optional.

• Das Argument movFileName ist der Name einer QuickTime-Ausgabedatei im URL-Format „file://“. Dieses Argument ist

optional.

• Das Argument generatorParams ist ein String-Array, das optionale Befehlszeilen-Flags für Flash Generator angibt.

Dieses Argument ist optional. Die Datenelemente für jeden Flag müssen hinter diesem Argument folgen. Die folgende Tabelle beschreibt die gängigsten Flags.

Options-Flag Daten Beschreibung Beispiel

-defaultsize Breite, Höhe Stellt die Größe des Ausgabebilds auf die ange- gebene Breite und Höhe ein.

-exactFit Kein Streckt den Inhalt des Ausgabebilds, um es genau an die festgelegte Ausgabegröße anzupassen.

"-defaultsize", "640", "480"

"-exactFit"

Rückgabewerte

Ein String, der einen der folgenden Werte enthält:

• "noError" bedeutet, dass der Aufruf erfolgreich war.

• "invalidTemplateFile" bedeutet, dass die angegebene Vorlagendatei ungültig war oder nicht gefunden wurde.

• "invalidOutputFile" bedeutet, dass mindestens einer der angegebenen Ausgabedateinamen ungültig ist.

• "invalidData" bedeutet, dass mindestens eins der Name-Wert-Paare templateParams ungültig war.

• "initGeneratorFailed" bedeutet, dass Flash Generator nicht initialisiert werden konnte.

• "outOfMemory" bedeutet, dass für den Vorgang nicht genügend Speicher zur Verfügung stand.

• "unknownError" bedeutet, dass ein unbekannter Fehler eintrat.

Beispiel

Mit dem folgenden JavaScript wird eine Flash-Objektdatei vom "myType" erstellt, die jeden "text"-String in der Vorlagendatei durch den String

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

"Hello World" ersetzt. Dabei werden eine GIF- und eine SWF-Datei erstellt.

SWFFile.getNaturalSize()

Beschreibung

Diese Funktion gibt die natürliche Größe eines unkomprimierten Flash-Inhalts zurück.

Argumente

fileName

• Das Argument fileName ist der Pfad zum Flash-Inhalt im URL-Format „file://“.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Rückgabewerte

Ein Array mit zwei Elementen, die die Breite und Höhe einer unkomprimierten SWF-Datei angeben bzw. den Wert null, wenn die Datei keine unkomprimierte SWF-Datei ist.

SWFFile.getObjectType()

Beschreibung

Diese Funktion gibt den Flash-Objekttyp zurück, d. h. den Wert, der im Parameter dwType übergeben wurde, als die Datei durch die Funktion

Argumente

fileName

• Das Argument fileName ist der Pfad zu einer Flash-Objektdatei im URL-Format „file:// “ Hierbei handelt es sich norma-

lerweise um eine SWF-Datei.

Rückgabewerte

Ein String, der den Objekttyp repräsentiert, oder null, wenn die Datei kein Flash-Objekt ist oder nicht gefunden werden konnte.

Beispiel

Mit dem folgenden Code wird geprüft, ob die Datei test.swf ein Flash-Objekt des Typs myType ist:

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

alert ("This is a myType object.");

} else {

alert ("This is not a myType object.");

}

SWFFile.createFile() erstellt wurde.

SWFFile.readFile()

Beschreibung

Mit dieser Funktion wird eine Flash-Objektdatei gelesen.

Argumente

fileName

• Das Argument fileName ist der Pfad zu einer Flash-Objektdatei im URL-Format „file:// “

Rückgabewerte

Ein String-Array, bei dem das erste Array-Element den vollständigen Pfad zur SWT-Vorlagendatei angibt. Die folgenden Strings geben die Parameter (Name-Wert-Paare) für das Objekt an. Im Array befindet sich hinter jedem Namen der entsprechende Wert. Das erste Name-Wert-Paar ist

null zurück, wenn die Datei nicht gefunden werden kann oder wenn sie keine Flash-Objektdatei ist.

Beispiel

Durch Aufrufen von var params = SWFFile.readFile("file:///MyMac/test.swf") werden die folgenden Werte im Parameter-Array zurückgegeben:

"file:///MyMac/test.swt" // Vorlagendatei beim Erstellen dieser .swf-Datei "dwType" // erster Parameter "myType" // erster Parameterwert "text" // zweiter Parameter "Hello World" // zweiter Parameterwert

"dwType" und der entsprechende Wert. Die Funktion gibt den Wert

Kapitel 7: Datenbank-API

Mit den Funktionen der Datenbank-API können Sie Datenbankverbindungen verwalten und auf Informationen zugreifen, die in Datenbanken gespeichert sind. Mit der Datenbank-API werden folgende Aufgaben durchgeführt: Verwalten von und Zugreifen auf Datenbankverbindungen.

Beim Verwalten der Datenbankverbindungen können Sie den Benutzernamen und das Kennwort abfragen, die für den Verbindungsaufbau erforderlich sind, ein Dialogfeld über die Verbindung mit der Datenbank öffnen und ähnliche Aufgaben durchführen.

Beim Zugriff auf Datenbankinformationen können Sie beispielsweise Metadaten abrufen, die das Schema oder die Struktur einer Datenbank beschreiben. Zu diesen Metadaten gehören Informationen über den Namen von Tabellen, Spalten, gespeicherten Prozeduren und Ansichten. Sie können auch die Ergebnisse der Ausführung einer Datenbankabfrage oder gespeicherten Prozedur anzeigen. Für den Zugriff auf eine Datenbank über diese API verwenden Sie SQL-Anweisungen (Structured Query Language).

Datenbank-API-Funktionen werden in der Entwurfsphase ausgeführt, in der die Benutzer ihre Webanwendungen entwerfen, und nicht in der Laufzeit, in der die Webanwendung eingesetzt wird.

Sie können diese Funktionen in einer beliebigen Erweiterung verwenden. Auch die API-Funktionen des Adobe® Dreamweaver® CS3-Serververhaltens, der Datenformate und der Datenquellen nutzen diese Datenbankfunktionen.

Die in diesem Kapitel beschriebenen Funktionen sind in den folgenden Abschnitten zusammengefasst:

• „Datenbankverbindungsfunktionen“ auf Seite 45

• „Datenbankzugriffsfunktionen“ auf Seite 56

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Funktionsweise der Datenbank-API-Funktion

Das folgende Beispiel zeigt, wie die Serververhaltensfunktion getDynamicBindings() für Recordset.js definiert ist. Es wird die Funktion

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;

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

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

MMDB.getColumnAndTypeList() verwendet:

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;

}

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Datenbankverbindungsfunktionen

Mithilfe von Datenbankverbindungsfunktionen können Sie beliebige Verbindungen herstellen und verwalten, z. B. der in Dreamweaver enthaltenen ADO-, ColdFusion- und JDBC-Verbindungen. Diese Funktionen bilden lediglich eine Schnittstelle mit dem Connection Manager; sie werden nicht verwendet, um eine Datenbank direkt aufzurufen. Informationen über Funktionen, die Datenbanken aufrufen, finden Sie unter „Datenbankzugriffsfunktionen“ auf Seite 56.

MMDB.deleteConnection()

Ver fügbarkeit

Dreamweaver MX

Beschreibung

Diese Funktion löscht die benannte Datenbankverbindung.

Argumente

connName

• Das Argument connName ist der Name der Datenbankverbindung gemäß der Angabe im Connection Manager. Dieses

Argument bezeichnet den Namen der zu löschenden Datenbankverbindung.

Rückgabewerte

Keine

Beispiel

Im folgenden Beispiel wird eine Datenbankverbindung gelöscht:

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

Ver fügbarkeit

Dreamweaver UltraDev 4.

Beschreibung

Diese Funktion ruft mithilfe der Funktionen getRDSUserName() und getRDSPassword() die ColdFusion-DSNs (Data Source Names = Datenquellennamen) vom Siteserver ab.

Argumente

Keine

Rückgabewerte

Ein Array mit den ColdFusion-DSNs, die auf dem Server der aktuellen Site gespeichert sind.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

MMDB.getConnection()

Ver fügbarkeit

Dreamweaver UltraDev 4; verbessert in Dreamweaver MX.

Beschreibung

Diese Funktion ruft ein benanntes Verbindungsobjekt ab.

Argumente

name

• Das Argument name ist eine Stringvariable, die den Namen der Verbindung bezeichnet, auf die Sie verweisen möchten.

Rückgabewerte

Ein Bezug auf ein benanntes Verbindungsobjekt. Verbindungsobjekte enthalten folgende Eigenschaften:

Eigenschaft Beschreibung

name Verb indun gsname

type Wenn useHTTP den Wert false hat, zeigt dies an, welche DLL-Datei zur Laufzeit für

string Laufzeit-ADO-Verbindungsstring oder JDBC-URL

dsn ColdFusion DSN

driver Laufzeit-JDBC-Treiber

username Laufzeit-Benutzername

password Laufzeit-Kennwort

useHTTP Ein String, der entweder den Wer t true oder false enthält und dadurch anzeigt, ob

includePattern Ein regulärer Ausd ruck, mit dem die incl ude-Anweisung auf der Seite in den Ansichten

variables Ein Array der Seitenvariablennamen und ihrer Werte, die in den Ansichten Live Data

catalog Wird zur Einschränkung der angezeigten Metadaten verwendet (weitere Informatio-

schema Wird zur Einschränkung der angezeigten Metadaten verwendet (weitere Informatio-

filename Dateiname des Dialogfelds, das zur Erstellung der Verbindung verwendet wurde

den Aufbau der Verbindung mit einer Datenbank verwendet werden soll

in der Entwurfsphase ein entfernter Treiber (HTTP-Verbindung) verwendet werden soll; anderenfalls wird ein lokaler Treiber (DLL) verwendet.

Live Data und Vors chau in B rowser gesucht wird.

und Vorsch au im B rowser verwendet werden.

nen finden Sie unter „MMDB.getProcedures()“ auf Seite 60).

Hinweis: Bei diesen Eigenschaften handelt es sich um die von Dreamweaver implementierten Standardeigenschaften. Entwickler können eigene Verbindungstypen definieren und diese Standardeigenschaften durch neue Eigenschaften ergänzen oder einen völlig anderen Eigenschaftensatz zur Verfügung stellen.

MMDB.getConnectionList()

Ver fügbarkeit

Dreamweaver UltraDev 1.

Beschreibung

Diese Funktion ruft eine Liste aller im Connection Manager definierten Verbindungsstrings ab.

Argumente

Keine

Rückgabewerte

Ein String-Array. Jeder String ist hierbei der Name einer Verbindung laut Anzeige im Connection Manager.

Beispiel

Ein Aufruf von MMDB.getConnectionList() kann die Strings ["EmpDB", "Test", "TestEmp"] zurückgeben.

MMDB.getConnectionName()

Ver fügbarkeit

Dreamweaver UltraDev 1.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Beschreibung

Diese Funktion ruft einen Verbindungsnamen ab, der dem angegebenen Verbindungsstring entspricht. Diese Funktion ist nützlich, wenn Sie aus Daten auf der Seite einen Verbindungsnamen in der Benutzeroberfläche neu auswählen.

Sollte sich ein Verbindungsstring auf zwei verschiedene Treiber beziehen, können Sie sowohl den Verbindungsstring als auch den Treiber, der dem zurückzugebenden Verbindungsnamen entspricht, angeben. Sie können beispielsweise zwei Verbindungen haben:

• Connection 1 hat folgende Eigenschaften:

ConnectionString="jdbc:inetdae:velcro-qa-5:1433?database=pubs"

DriverName="com.inet.tds.TdsDriver"

• Connection 2 hat folgende Eigenschaften:

ConnectionString="jdbc:inetdae:velcro-qa-5:1433?database=pubs"

DriverName="com.inet.tds.TdsDriver2"

Connection 1 und Connection 2 verwenden beide denselben Verbindungsstring. Connection 2 stellt eine Verbindung zu einer neueren Version des Treibers

TdsDriver her. Sie sollten den Treibernamen an diese Funktion weiterleiten, um den

zurückzugebenden Verbindungsnamen vollständig zu bestimmen.

Argumente

connString, {driverName}

• Das Argument connString ist der Verbindungsstring, der den Verbindungsnamen abruft.

• Das Argument driverName ist ein optionales Argument, das connString näher bestimmt.

Rückgabewerte

Ein Verbindungsnamensstring, der dem Verbindungsstring entspricht.

Beispiel

Der folgende Code gibt den String EmpDB zurück:

var connectionName = MMDB.getConnectionName ¬ ("dsn=EmpDB;uid=;pwd=");

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

MMDB.getConnectionString()

Ver fügbarkeit

Dreamweaver UltraDev 1.

Beschreibung

Diese Funktion ruft den Verbindungsstring ab, der mit der benannten Verbindung verknüpft ist.

Argumente

connName

• Das Argument connName ist ein Verbindungsname, der im Connection Manager festgelegt wurde. Er bezeichnet den

Verbindungsstring, den Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data-Quelle verwenden soll.

Rückgabewerte

Ein Verbindungsstring, der der benannten Verbindung entspricht.

Beispiel

Der Code var connectionString = MMDB.getConnectionString ("EmpDB") gibt verschiedene Strings für eine ADO- oder JDBC-Verbindung zurück.

• Bei einer ADO-Verbindung kann folgender String zurückgegeben werden:

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

• Bei einer JDBC-Verbindung kann folgender String zurückgegeben werden:

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

MMDB.getDriverName()

Ver fügbarkeit

Dreamweaver UltraDev 1.

Beschreibung

Diese Funktion ruft den Treibernamen ab, der mit der angegebenen Verbindung verknüpft ist. Nur eine JDBC-Verbindung hat einen Treibernamen.

Argumente

connName

• Das Argument connName ist ein Verbindungsname, der im Connection Manager festgelegt wurde. Er bezeichnet den

Verbindungsstring, den Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data-Quelle verwenden soll.

Rückgabewerte

Ein String, der den Treibernamen enthält.

Beispiel

Die Anweisung MMDB.getDriverName ("EmpDB"); könnte folgenden String zurückgeben:

"jdbc/oracle/driver/JdbcOracle"

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

MMDB.getDriverUrlTemplateList() (veraltet)

Ver fügbarkeit

Dreamweaver UltraDev 4; von der Verwendung in Dreamweaver MX wird abgeraten

Hinweis: Bei Dreamweaver UltraDev 4 wird die Liste der JDBC-Treiber in der Datei connections.xml gespeichert, die sich im Ordner Configuration\Connections befindet. Mit jedem Treiber ist eine URL-Vorlage verknüpft. Diese Funktion gibt die Liste der JDBC-Treiber zurück.

Bei Dreamweaver MX (oder höher) sind diese Treiber und URL-Vorlagen in den JDBC-Dialogfeldern fest kodiert. Darüber hinaus ist diese Funktion eine leere Funktionsdefinition, um Fehler aufgrund einer nicht definierten Definition zu verhindern. Das folgende Beispiel zeigt, in welcher Weise ein JDBC-Treiber und eine URL-Vorlage fest kodiert sind:

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

In Dreamweaver ist ein Dialogfeld für jedes Treiber/URL-Vorlage-Paar vorhanden.

Zusammenfassend kann gesagt werden, dass Entwickler von Dreamweaver UltraDev 4 dem XML-Code einen neuen Eintrag hinzufügen und Entwickler von Dreamweaver MX (oder höher) ein neues Dialogfeld implementieren müssen.

Beschreibung

Diese Funktion ruft JDBC-Treiber und die entsprechenden URL-Vorlagen ab.

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

Argumente

Keine

Rückgabewerte

Ein Array, in dem sich die im System des Benutzers gefundenen JDBC-Treiber und (falls angegeben) die entsprechenden URL-Vorlagen befinden. Das Array enthält eine gerade Anzahl von Elementen, in denen folgende Informationen gespeichert sind:

Driver1, UrlTemplate1, Driver2, UrlTemplate2, usw.

MMDB.getLocalDsnList()

Ver fügbarkeit

Dreamweaver UltraDev 4.

Beschreibung

Diese Funktion ruft ODBC-DSNs ab, die im System des Benutzers definiert sind.

Argumente

Keine

Rückgabewerte

Ein Array, das die im System des Benutzers definierten ODBC-DSNs enthält.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

MMDB.getPassword()

Ver fügbarkeit

Dreamweaver UltraDev 1.

Beschreibung

Diese Funktion ruft das Kennwort für die angegebene Verbindung ab.

Argumente

connName

• Das Argument connName ist ein Verbindungsname, der im Connection Manager festgelegt wurde. Er bezeichnet den

Verbindungsstring, den Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data-Quelle verwenden soll.

Rückgabewerte

Ein mit dem Verbindungsnamen verknüpfter Kennwortstring.

Beispiel

Die Anweisung MMDB.getPassword ("EmpDB"); könnte beispielsweise "joessecret" zurückgeben.

MMDB.getRDSPassword()

Ver fügbarkeit

Dreamweaver UltraDev 4.

Beschreibung

Diese Funktion ruft das RDS-Kennwort (Remote Development Services) ab (zur Verwendung mit ColdFusion-Verbindungen).

Argumente

Keine

Rückgabewerte

Ein String, der das RDS-Kennwort enthält.

MMDB.getRDSUserName()

Ver fügbarkeit

Dreamweaver UltraDev 4.

Beschreibung

Diese Funktion ruft den RDS-Benutzernamen (zur Verwendung mit ColdFusion-Verbindungen) ab.

Argumente

Keine

Rückgabewerte

Ein String, der den RDS-Benutzernamen enthält.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

MMDB.getRemoteDsnList()

Ver fügbarkeit

Dreamweaver UltraDev 4; verbessert in Dreamweaver MX.

Beschreibung

Diese Funktion ruft die ODBC-DSNs vom Siteserver ab. Die Funktionen getRDSUserName() und getRDSPassword() werden verwendet, wenn ColdFusion das Servermodell der aktuellen Site ist. Mit dieser Funktion haben Entwickler die Möglichkeit, einen URL-Parameterstring anzugeben, der an die von Connectivity-URL angefügt wird. Wenn der Entwickler einen Parameterstring zur Verfügung stellt, übergibt ihn diese Funktion an die HTTP-Connectivity-Skripts.

Argumente

{urlParams}

• Das optionale Argument urlParams ist ein String, der eine Liste von Ausdrücken im Format name=value enthält, die

jeweils durch Und-Zeichen (&) voneinander getrennt sind. Die Werte dürfen nicht in Anführungszeichen eingeschlossen werden. Einige Zeichen, wie beispielsweise das Leerzeichen im Wert folgt ein Beispiel für ein gültiges Argument, das an

MMDB.getRemoteDsnList() übergeben werden kann:

a=1&b=Hello%20World

Rückgabewerte

Gibt ein Array mit den ODBC-DSNs zurück, die auf dem Server der aktuellen Site definiert sind.

MMDB.getRemoteDsnList() generierte Remote

Hello World, müssen kodiert werden. Es

MMDB.getRuntimeConnectionType()

Ver fügbarkeit

Dreamweaver UltraDev 1.

Beschreibung

Diese Funktion gibt den Laufzeitverbindungstyp des angegebenen Verbindungsnamens zurück.

Argumente

connName

• Das Argument connName ist ein Verbindungsname, der im Connection Manager festgelegt wurde. Er bezeichnet den

Verbindungsstring, den Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data-Quelle verwenden soll.

Rückgabewerte

Ein Verbindungsstring, der dem Verbindungstyp entspricht. Diese Funktion kann einen der folgenden Werte zurückgeben:

"ADO", "ADODSN", "JDBC" oder "CFDSN".

Beispiel

Der folgende Code würde bei einer ADO-Verbindung den String "ADO" zurückgeben:

var connectionType = MMDB.getRuntimeConnectionType ("EmpDB")

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

MMDB.getUserName()

Ver fügbarkeit

Dreamweaver UltraDev 1.

Beschreibung

Diese Funktion gibt einen Benutzernamen für die angegebene Verbindung zurück.

Argumente

connName

• Das Argument connName ist ein Verbindungsname, der im Connection Manager festgelegt wurde. Er bezeichnet den

Verbindungsstring, den Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data-Quelle verwenden soll.

Rückgabewerte

Ein mit dem Verbindungsnamen verknüpfter Benutzernamenstring.

Beispiel

Die Anweisung MMDB.getUserName ("EmpDB"); könnte beispielsweise "amit" zurückgeben.

MMDB.hasConnectionWithName()

Ver fügbarkeit

Dreamweaver UltraDev 4.

Beschreibung

Diese Funktion stellt fest, ob eine Verbindung mit dem angegebenen Namen vorhanden ist.

Argumente

name

• Das Argument name ist der Verbindungsname.

Rückgabewerte

Gibt einen Booleschen Wert zurück: true, wenn eine Verbindung mit dem angegebenen Namen vorhanden ist, andernfalls

false .

MMDB.needToPromptForRdsInfo()

Ver fügbarkeit

Dreamweaver MX

Beschreibung

Diese Funktion legt fest, ob Dreamweaver das Dialogfeld RDS-Anmeldeinformationen öffnen soll.

Argumente

bForce

• Das Argument bForce ist ein Boolescher Wert; true gibt an, dass der Benutzer, der zuvor das Dialogfeld RDS-Anmeld-

einformationen über die Schaltfläche Abbrechen geschlossen hat, immer noch zur Eingabe der RDS-Anmeldeinforma-

tionen aufgefordert werden muss.

Rückgabewerte

Ein Boolescher Wert: true, wenn der Benutzer zur Eingabe der RDS-Anmeldeinformationen aufgefordert werden muss, anderenfalls

false.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

MMDB.needToRefreshColdFusionDsnList()

Ver fügbarkeit

Dreamweaver MX

Beschreibung

Diese Funktion beauftragt den Connection Manager, den Cache-Speicher zu löschen und die ColdFusion-Datenquellenliste vom Anwendungsserver abzurufen, wenn ein Benutzer die Liste das nächste Mal anfordert.

Argumente

Keine

Rückgabewerte

Keine

MMDB.popupConnection()

Ver fügbarkeit

Dreamweaver MX

Beschreibung

Diese Funktion blendet ein Verbindungsdialogfeld ein. Diese Funktion hat die folgenden drei Signaturen:

• Wenn die Argumentliste nur aus dem Argument dialogFileName besteht (einem String), bewirkt die Funktion popup-

Connection()

können.

, dass Dreamweaver das Verbindungsdialogfeld anzeigt, sodass Sie eine neue Verbindung definieren

• Besteht die Argumentliste nur aus dem Argument connRec (einer Referenz auf die Verbindung), bewirkt die Funktion

opupConnection(), dass Dreamweaver das Verbindungsdialogfeld im Bearbeitungsmodus anzeigt, sodass Sie die

benannte Verbindung bearbeiten können. In diesem Modus wird das Textfeld Name abgeblendet.

• Besteht die Argumentliste aus dem Argument connRec und dem Booleschen Wert bDuplicate, bewirkt die Funktion

popupConnection(), dass Dreamweaver das Verbindungsdialogfeld im Duplizierungsmodus anzeigt. In diesem Modus

wird das Textfeld Name abgeblendet, und die restlichen Eigenschaften werden kopiert, um ein Duplikat der Verbindung zu definieren.

Argumente

dialogFileName

oder

connRec

oder

connrec, bDuplicate

• Das Argument dialogFileName ist ein String, der den Namen einer HTML-Datei enthält, die im Ordner Configu-

ration\Connections\Servermodell gespeichert ist. Mit dieser HTML-Datei wird das Dialogfeld definiert, das zur Erstellung einer Verbindung verwendet wird. In dieser Datei müssen drei JavaScript-API-Funktionen implementiert sein:

findConnection(), inspectConnection() und applyConnection(). In der Regel erstellen Sie eine JavaScript-Datei,

die diese Funktionen implementiert, und anschließend fügen Sie diese Datei in die HTML-Datei ein. (Weitere Informationen zum Herstellen einer Verbindung finden Sie unter „Die Datenbank-Konnektivitäts-API“ auf Seite 69.)

• Das Argument connRec ist eine Referenz auf ein vorhandenes Verbindungsobjekt.

• Das Argument bDuplicate ist ein Boolescher Wert.

Rückgabewerte

Keine Das definierte Verbindungsdialogfeld wird eingeblendet.

MMDB.setRDSPassword()

Ver fügbarkeit

Dreamweaver UltraDev 4.

Beschreibung

Diese Funktion legt das RDS-Kennwort fest.

Argumente

password

• Das Argument password ist ein String, der das RDS-Kennwort enthält.

Rückgabewerte

Keine

MMDB.setRDSUserName()

Ver fügbarkeit

Dreamweaver UltraDev 4.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Beschreibung

Diese Funktion legt den RDS-Benutzernamen fest.

Argumente

username

• Das Argument username ist ein gültiger RDS-Benutzername.

Rückgabewerte

Keine

MMDB.showColdFusionAdmin()

Ver fügbarkeit

Dreamweaver MX

Beschreibung

Diese Funktion zeigt das Dialogfeld ColdFusion-Administrator an.

Argumente

Keine

Rückgabewerte

Keine Das Dialogfeld ColdFusion Administrator wird eingeblendet.

MMDB.showConnectionMgrDialog()

Ver fügbarkeit

Dreamweaver UltraDev 1.

Beschreibung

Diese Funktion zeigt das Dialogfeld Connection Manager an.

Argumente

Keine

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Rückgabewerte

Keine Das Dialogfeld Connection Manager wird angezeigt.

MMDB.showOdbcDialog()

Ver fügbarkeit

Dreamweaver UltraDev 4 (nur Windows).

Beschreibung

Diese Funktion zeigt das Dialogfeld System-ODBC-Administration oder ODBC-Datenquellen-Administrator an.

Argumente

Keine

Rückgabewerte

Keine Das Dialogfeld System-ODBC-Administration oder ODBC-Datenquellen-Administrator wird angezeigt.

MMDB.showRdsUserDialog()

Ver fügbarkeit

Dreamweaver UltraDev 4.

Beschreibung

Diese Funktion zeigt das Dialogfeld zur Eingabe des RDS-Benutzernamens und Kennworts an.

Argumente

username, password

• Das Argument username ist der anfänglich verwendete Benutzername.

• Das Argument password ist das anfänglich verwendete Kennwort.

Rückgabewerte

Ein Objekt, das die neuen Werte in den Eigenschaften username und password enthält. Wird eine der beiden Eigenschaften nicht eingegeben, weist dies darauf hin, dass der Benutzer das Dialogfeld über den Befehl Abbrechen geschlossen hat.

MMDB.showRestrictDialog()

Ver fügbarkeit

Dreamweaver UltraDev 4.

Beschreibung

Diese Funktion zeigt das Dialogfeld Beschränken an.

Argumente

catalog, schema

• Das Argument catalog ist der anfänglich verwendete Katalogwert.

• Das Argument schema ist der anfänglich verwendete Schemawert.

Rückgabewerte

Ein Objekt, das die neuen Werte in den Eigenschaften catalog und schema enthält. Wird eine der beiden Eigenschaften nicht eingegeben, weist dies darauf hin, dass der Benutzer das Dialogfeld über den Befehl Abbrechen geschlossen hat.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

MMDB.testConnection()

Ver fügbarkeit

Dreamweaver UltraDev 4.

Beschreibung

Diese Funktion prüft die Verbindungseinstellungen. Sie zeigt ein modales Dialogfeld ein, in dem die Ergebnisse beschrieben werden.

Argumente

serverPropertiesArray

Diese Funktion erwartet ein einzelnes Argument, ein Array-Objekt, das Werte aus der folgenden Liste enthält, die auf das aktuelle Servermodell zutreffen. Geben Sie für Eigenschaften, die auf die zu prüfende Verbindung nicht zutreffen, einen leeren String (

• Wenn useHTTP den Wert false hat, zeigt das Argument type an, welche DLL-Datei für den Verbindungsaufbau mit einer

Datenbank in der Entwurfsphase zum Prüfen von Verbindungseinstellungen verwendet werden soll.

• Das Argument string ist der ADO-Verbindungsstring oder JDBC-URL.

• Das Argument dsn ist der Data Source Name.

• Das Argument driver ist der JDBC-Treiber.

• Das Argument username ist der Benutzername.

• Das Argument password ist das Kennwort.

• Das Argument useHTTP ist ein Boolescher Wert. Mit dem Wert true wird festgelegt, dass Dreamweaver in der Entwurfs-

phase eine HTTP-Verbindung verwenden soll; andernfalls verwendet Dreamweaver ein DLL-Datei.

"") an.

Rückgabewerte

Ein Boolescher Wert: true, wenn die Prüfung der Verbindung erfolgreich durchgeführt werden konnte, andernfalls false.

Datenbankzugriffsfunktionen

Mithilfe der Datenbankzugriffsfunktionen können Sie eine Datenbank abfragen. Eine Sammlung der Funktionen, die eine Datenbankverbindung verwalten, finden Sie unter „Datenbankverbindungsfunktionen“ auf Seite 45.

Die folgende Liste beschreibt einige der Argumente, die den verfügbaren Funktionen gemeinsam sind:

• Die meisten Datenbankzugriffsfunktionen verwenden einen Verbindungsnamen als Argument. Eine Liste der gültigen

Verbindungsnamen finden Sie im Connection Manager. Sie können aber auch mit der Funktion

tionList()

eine Liste aller Verbindungsnamen abrufen.

• Für gespeicherte Prozeduren sind oft Parameter erforderlich. Die Parameterwerte von Datenbankfunktionen können auf

zwei Arten festgelegt werden. Eine Möglichkeit besteht darin, ein Array von Parameterwerten anzugeben (

paramValuesArray). Falls Sie nur Parameterwerte festlegen, müssen die Werte in der Reihenfolge erscheinen, in der die

gespeicherte Prozedur sie benötigt. Der zweite Schritt besteht darin, Parameterwerte zu definieren, um ein Array von Parameternamen ( die Parameter der gespeicherten Prozedur abrufen. Sollten Sie Parameternamen festlegen, müssen die in

paramValuesArray angegebenen Werte in derselben Reihenfolge angegeben werden, in der die Parameternamen auch in paramNameArray festgelegt wurden.

paramNameArray) bereitzustellen. Mithilfe der Funktion MMDB.getSPParamsAsString() können Sie

MMDB.getConnec-

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

MMDB.getColumnAndTypeList()

Ver fügbarkeit

Dreamweaver UltraDev 1.

Beschreibung

Diese Funktion ruft eine Liste der Spalten und deren Typen aus einer ausgeführten SQL SELECT-Anweisung ab.

Argumente

connName, statement

• Das Argument connName ist ein Verbindungsname, der im Connection Manager festgelegt wurde. Er bezeichnet den

Verbindungsstring, den Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data-Quelle verwenden soll.

• Das Argument statement ist die auszuführende SQL SELECT-Anweisung.

Rückgabewerte

Ein String-Array, das eine Liste der Spalten (und deren Typen) repräsentiert, die der SELECT-Anweisung entsprechen. Ansonsten ein Fehler, wenn die SQL-Anweisung ungültig war oder die Verbindung nicht hergestellt werden konnte.

Beispiel

Der Code var columnArray = MMDB.getColumnAndTypeList("EmpDB","Select * from Employees") gibt das folgende String-Array zurück:

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

MMDB.getColumnList()

Ver fügbarkeit

Dreamweaver UltraDev 1.

Beschreibung

Diese Funktion ruft eine Liste der Spalten aus einer ausgeführten SQL SELECT-Anweisung ab.

Argumente

connName, statement

• Das Argument connName ist ein Verbindungsname, der im Connection Manager festgelegt wurde. Er bezeichnet den

Verbindungsstring, den Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data-Quelle verwenden soll.

• Das Argument statement ist die auszuführende SQL SELECT-Anweisung.

Rückgabewerte

Ein String-Array, das eine Liste der Spalten repräsentiert, die der SELECT-Anweisung entsprechen. Ansonsten ein Fehler, wenn die SQL-Anweisung ungültig war oder die Verbindung nicht hergestellt werden konnte.

Beispiel

Der Code var columnArray = MMDB.getColumnList("EmpDB","Select * from Employees") gibt das folgende StringArray zurück:

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

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

MMDB.getColumns()

Ver fügbarkeit

Dreamweaver MX, Argumente aktualisiert in Dreamweaver MX 2004.

Beschreibung

Diese Funktion gibt ein Array von Objekten zurück, die die in der Tabelle angegebenen Spalten beschreiben.

Argumente

connName, tableName

• Das Argument connName ist der Verbindungsname. Dieser Wert bezeichnet den Verbindungsstring, den Dreamweaver

beim Herstellen einer Datenbankverbindung mit einer Live Data-Quelle verwenden soll.

• Das Argument tableName ist die abzufragende Tabelle.

Rückgabewerte

Ein Array von Objekten, wobei für jede Spalte ein Objekt verwendet wird. Jedes Objekt definiert die folgenden drei Eigenschaften der zugehörigen Spalte.

Name der Eigenschaft Beschreibung

name Name der Spalte (beispielsweise price)

datatype Datentyp der Spalte (beispielsweise small money)

definedsize Definierte Größe der Spalte (beispielsweise 8)

nullable Gibt an, ob die Spalte null-Werte enthalten darf.

Beispiel

Im folgenden Beispiel wird mithilfe von MMDB.getColumns() der QuickInfo-Textwert festgelegt:

var columnNameObjs = MMDB.getColumns(connName,tableName); var databaseType = MMDB.getDatabaseType(connName);

for (i = 0; i < columnNameObjs.length; i++) {

var columnObj = columnNameObjs[i]; var columnName = columnObj.name; var typename = columnObj.datatype; if (dwscripts.isNumber(typename)) {

// ist bereits eine Zahl

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

var tooltiptext = typename;

}

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

MMDB.getColumnsOfTable()

Ver fügbarkeit

Dreamweaver UltraDev 1.

Beschreibung

Diese Funktion erstellt eine Liste aller in der angegebenen Tabelle enthaltenen Spalten.

Argumente

connName, tableName

• Das Argument connName ist ein Verbindungsname, der im Connection Manager festgelegt wurde. Er bezeichnet den

Verbindungsstring, den Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data-Quelle verwenden soll.

• Das Argument tableName ist der Name einer Tabelle in der Datenbank, die über connName angegeben wurde.

Rückgabewerte

Ein String-Array. Jeder String ist hierbei der Name einer Spalte in der Tabelle.

Beispiel

Die Anweisung MMDB.getColumnsOfTable ("EmpDB","Employees"); gibt die folgenden Strings zurück:

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

MMDB.getPrimaryKeys()

Ver fügbarkeit

Dreamweaver MX

Beschreibung

Diese Funktion gibt die Namen der Spalten zurück, die gemeinsam den Primärschlüssel der benannten Tabelle bilden. Ein Primärschlüssel ist der eindeutige Bezeichner einer Datenbankzeile; er besteht aus mindestens einer Spalte.

Argumente

connName, tableName

• Das Argument connName ist ein Verbindungsname, der im Connection Manager festgelegt wurde. Er bezeichnet den

Verbindungsstring, den Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data-Quelle verwenden soll.

• Das Argument tableName ist der Name der Tabelle, aus der Sie die Spalten abrufen möchten, die den Primärschlüssel

der Tabelle bilden.

Rückgabewerte

Ein String-Array. Das Array besteht aus einem String für jede Spalte, aus der sich der Primärschlüssel zusammensetzt.

Beispiel

Im folgenden Beispiel wird der Primärschlüssel für die angegebene Tabelle zurückgegeben.

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

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

MMDB.getProcedures()

Ver fügbarkeit

Dreamweaver MX

Beschreibung

Diese Funktion gibt ein Array der Prozedurobjekte zurück, die mit einer benannten Verbindung verknüpft sind.

Argumente

connName

• Das Argument connName ist ein Verbindungsname, der im Connection Manager festgelegt wurde. Er bezeichnet den

Verbindungsstring, den Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data-Quelle verwenden soll.

Rückgabewerte

Ein Array der Prozedurobjekte, wobei jedes Prozedurobjekt die folgenden drei Eigenschaften aufweist:

Name der Eigenschaft Beschreibung

schema

catalog Name des mit dem Objekt verknüpften Katalogs (Eigentümerqualifizierer).

procedure Name der Prozedur.

a. Sobald Sie eine Datensatzgruppe modifizieren, stellt Dreamweaver eine Verbindung zur Datenbank her und ruft alle Tabellen aus der Datenbank ab. Wenn die Datenbank viele Tabellen enthält, benötigt Dreamweaver auf bestimmten Systemen u. U. viel Zeit, um diese abzurufen. Enthält die Datenbank ein Schema oder einen Katalog, können Sie mit dessen Hilfe die Anzahl der Datenbankelemente beschränken, die Dreamweaver während der Entwurfsphase abruft. Zunächst müssen Sie in Ihrer Datenbankanwendung ein Schema oder einen Katalog erstellen, bevor Sie das Schema oder den Katalog in Dreamweaver zuweisen können. Weitere Informationen können Sie der Dokumentation Ihrer Datenbank entnehmen oder von Ihrem Systemadministrator erfragen.

Name des mit dem Objekt verknüpften Schemas.

Diese Eigenschaft bezeichnet den Benutzer, der mit der gespeicherten Prozedur in der SQLDatenbank verknüpft ist, die von der Funktion getProcedures() aufgerufen wird. Die von dieser Funktion aufgerufene Datenbank hängt vom Typ der Verbindung ab.

• Bei ODBC-Verbindungen wird die Datenbank durch die ODBC-Datenquelle definiert. Der

DSN wird durch die Eigenschaft dsn im Verbindungsobjekt (connName) angegeben, das Sie an die Funktion getProcedures() übergeben.

• Bei OLE-Datenbankverbindungen wird die Datenbank durch den Verbindungsstring defi-

niert.

Der Wert der Eigenschaft catalog wird durch ein Attribut des OLE-DBTreibers definiert. Mit diesem Treiberattribut wird eine standardmäßige Eigenscha ft user.database definiert, die verwendet wird, wenn im OLE-DB-Verbindungsstring keine Datenbank festgelegt wird.

Beispiel

Mit folgendem Code wird eine Liste der Prozeduren abgerufen:

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

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Ver fügbarkeit

Dreamweaver UltraDev 1.

Beschreibung

Diese Funktion ruft eine Liste der Ergebnissatzspalten ab, die durch einen Aufruf der angegebenen gespeicherten Prozedur erzeugt wurden.

Argumente

connName, statement, paramValuesArray

• Das Argument connName ist ein Verbindungsname, der im Connection Manager festgelegt wurde. Er bezeichnet den

Verbindungsstring, den Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data-Quelle verwenden soll.

• Das Argument statement ist der Name der gespeicherten Prozedur, die den Ergebnissatz zurückgibt, wenn sie ausge-

führt wird.

• Das Argument paramValuesArray ist ein Array, das eine Liste von Testwerten der Entwurfsphasenparameter enthält.

Geben Sie die Parameterwerte in der Reihenfolge ein, in der sie die Prozedur erwartet. Mithilfe der Funktion

MMDB.getSPParamsAsString() können Sie die Parameter der gespeicherten Prozedur abrufen.

Rückgabewerte

Ein String-Array, das die Liste der Spalten repräsentiert. Diese Funktion gibt einen Fehler zurück, wenn die SQLAnweisung oder der Verbindungsstring ungültig ist.

Beispiel

Der folgende Code kann eine Liste der Ergebnissatzspalten zurückgeben, die von der ausgeführten gespeicherten Prozedur

getNewEmployeesMakingAtLeast generiert wurden:

var paramValueArray = new Array("2/1/2000", "50000") var columnArray = MMDB.getSPColumnList("EmpDB", ¬ "getNewEmployeesMakingAtLeast", paramValueArray) Die folgenden Werte werden zurückgegeben: columnArray[0] = "EmpID", columnArray[1] = "LastName", ¬ columnArray[2] ="startDate", columnArray[3] = "salary"

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

MMDB.getSPColumnListNamedParams()

Ver fügbarkeit

Dreamweaver UltraDev 1.

Beschreibung

Diese Funktion ruft eine Liste der Ergebnissatzspalten ab, die durch einen Aufruf der angegebenen gespeicherten Prozedur erzeugt wurden.

Argumente

connName, statement, paramNameArray, paramValuesArray

• Das Argument connName ist ein Verbindungsname, der im Connection Manager festgelegt wurde. Er bezeichnet den

Verbindungsstring, den Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data-Quelle verwenden soll.

• Das Argument statement ist der Name der gespeicherten Prozedur, die den Ergebnissatz zurückgibt, wenn sie ausge-

führt wird.

• Das Argument paramNameArray ist ein Array, das eine Liste von Parameternamen enthält. Mithilfe der Funktion

MMDB.getSPParamsAsString() können Sie die Parameter der gespeicherten Prozedur abrufen.

• Das Argument paramValuesArray ist ein Array, das eine Liste von Testwerten der Entwurfsphasenparameter enthält. Sie

können festlegen, ob die Prozedur für ihre Ausführung Parameter erfordert. Sollten Sie in namen angegeben haben, müssen Sie die Parameternamen in derselben Reihenfolge festgelegen, wie sie in

Array

aufgeführt sind. Falls Sie paramNameArray nicht festgelegt haben, legen Sie die Werte in der Reihenfolge fest, in der

sie die gespeicherte Prozedur erwartet.

paramNameArray Parameter-

paramName-

Rückgabewerte

Ein String-Array, das die Liste der Spalten repräsentiert. Diese Funktion gibt einen Fehler zurück, wenn die SQLAnweisung oder der Verbindungsstring ungültig ist.

Beispiel

Der folgende Code kann eine Liste der Ergebnissatzspalten zurückgeben, die von der ausgeführten gespeicherten Prozedur

getNewEmployeesMakingAtLeast generiert wurden:

var paramNameArray = new Array("startDate", "salary") var paramValueArray = new Array("2/1/2000", "50000") var columnArray = MMDB.getSPColumnListNamedParams("EmpDB", ¬ "getNewEmployeesMakingAtLeast", paramNameArray, paramValueArray)

Die folgenden Werte werden zurückgegeben:

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

MMDB.getSPParameters()

Ver fügbarkeit

Dreamweaver MX

Beschreibung

Diese Funktion gibt ein Array der Parameterobjekte einer benannten Prozedur zurück.

Argumente

connName, procName

• Das Argument connName ist ein Verbindungsname, der im Connection Manager festgelegt wurde. Er bezeichnet den

Verbindungsstring, den Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data-Quelle verwenden soll.

• Das Argument procName ist der Name der Prozedur.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Rückgabewerte

Ein Array von Parameterobjekten, die jeweils die folgende Gruppe von Eigenschaften bezeichnen:

Name der Eigenschaft Beschreibung

name Name des Parameters (beispielsweise @@lolimit)

datatype Datentyp des Parameters (beispielsweise smallmoney)

direction Richtung des Parameters:

1– Der Parameter wird nur für Eingaben verwendet.

2– Der Parameter wird nur für Ausgaben verwendet. In diesem Fall wird der Parameter

durch Bezugnahme übergeben, und die Methode schreibt einen Wert in ihn. Sie können den Wert verwenden, nachdem die Methode einen Rückgabewert geliefert hat.

3– Der Parameter wird für Ein- und Ausgaben verwendet.

4– Der Parameter enthält einen Rückgabewert.

Beispiel

Im folgenden Beispiel werden die Parameterobjekte für die angegebene Prozedur abgerufen und eine QuickInfo für jedes Objekt basierend auf der entsprechenden Eigenschaft erstellt.

var paramNameObjs = MMDB.getSPParameters(connName,procName); for (i = 0; i < paramNameObjs.length; i++) {

var paramObj = paramNameObjs[i]; var tooltiptext = paramObj.datatype; tooltiptext+=" "; tooltiptext+=GetDirString(paramObj.directiontype);

}

MMDB.getSPParamsAsString()

Ver fügbarkeit

Dreamweaver UltraDev 1.

Beschreibung

Diese Funktion ruft einen String ab, der Kommas als Trennzeichen verwendet und in dem die Liste der Parameter enthalten ist, die die gespeicherte Prozedur annimmt.

Argumente

connName, procName

• Das Argument connName ist ein Verbindungsname, der im Connection Manager festgelegt wurde. Er bezeichnet den

Verbindungsstring, den Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data-Quelle verwenden soll.

• Das Argument procName ist der Name der gespeicherten Prozedur.

Rückgabewerte

Ein String, der Kommas als Trennzeichen verwendet und in dem die Liste der Parameter gespeichert ist, die die gespeicherte Prozedur annimmt. Der Name, die Richtung und der Datentyp der Parameter sind enthalten und durch einen Strichpunkt (;) voneinander getrennt.

Beispiel

Der Code MMDB.getSPParamsAsString ("EmpDB","getNewEmployeesMakingAtLeast") kann einen String des Formularnamens

startDate;direction:in;datatype:date, salary;direction:in;datatype:integer zurückgeben.

In diesem Beispiel hat die gespeicherte Prozedur getNewEmployeesMakingAtLeast zwei Parameter: startDate und Salary. Bei

startDate ist die Richtung in und der Datentyp date. Bei salary ist die Richtung in und der Datentyp date.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

MMDB.getTables()

Ver fügbarkeit

Dreamweaver UltraDev 1.

Beschreibung

Diese Funktion ruft eine Liste aller Tabellen ab, die für die angegebene Datenbank definiert wurden. Jedes Tabellenobjekt weist drei Eigenschaften auf:

Argumente

connName

• Das Argument connName ist ein Verbindungsname, der im Connection Manager festgelegt wurde. Er bezeichnet den

Verbindungsstring, den Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data-Quelle verwenden soll.

Rückgabewerte

Ein Array von Objekten, wobei jedes Objekt drei Eigenschaften ausweist: table, schema und catalog. Table ist der Name der Tabelle.

Schema ist der Name des Schemas, das die Tabelle enthält. Catalog ist der Katalog, der die Tabelle enthält.

Beispiel

Die Anweisung MMDB.getTables ("EmpDB"); könnte beispielsweise ein Array mit zwei Objekten erzeugen. Die Eigenschaften des ersten Objekts sehen möglicherweise wie im folgenden Beispiel aus:

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

table, schema und catalog.

Die Eigenschaften des zweiten Objekts sehen möglicherweise wie im folgenden Beispiel aus:

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

MMDB.getViews()

Ver fügbarkeit

Dreamweaver UltraDev 4.

Beschreibung

Diese Funktion ruft eine Liste aller Ansichten ab, die für die angegebene Datenbank definiert wurden. Jedes Ansichtsobjekt hat die Eigenschaften

Argumente

connName

• Das Argument connName ist ein Verbindungsname, der im Connection Manager festgelegt wurde. Er bezeichnet den

Verbindungsstring, den Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data-Quelle verwenden soll.

Rückgabewerte

Ein Array von Ansichtsobjekten, wobei jedes Objekt drei Eigenschaften ausweist: catalog, schema und view. catalog bzw.

schema dient zum Einschränken oder Filtern der Anzahl der Ansichten, die sich auf einen bestimmten Schemen- oder

Katalognamen beziehen, der im Rahmen der Verbindungsinformationen definiert wurde.

catalog, schema und view.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Beispiel

Das folgende Beispiel gibt die Ansichten für einen bestimmten Verbindungswert, CONN_LIST.getValue(), zurück:

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

Ver fügbarkeit

Dreamweaver UltraDev 1.

Beschreibung

Diese Funktion zeigt ein Dialogfeld mit den Ergebnissen aus der Ausführung der angegebenen SQL-Anweisung an. Das Dialogfeld zeigt ein tabellarisches Raster an, wobei die Überschrift die Spalteninformationen zum Ergebnissatz wiedergibt. Sollte der Verbindungsstring oder die SQL-Anweisung ungültig sein, wird ein Fehler angezeigt. Diese Funktion überprüft die SQL-Anweisung.

Argumente

connName, SQLstatement

• Das Argument connName ist ein Verbindungsname, der im Connection Manager festgelegt wurde. Er bezeichnet den

Verbindungsstring, den Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data-Quelle verwenden soll.

• Das Argument SQLstatement ist die SQL SELECT-Anweisung.

Rückgabewerte

Keine Diese Funktion gibt einen Fehler zurück, wenn die SQL-Anweisung oder der Verbindungsstring ungültig ist.

Beispiel

Der folgende Code zeigt die Ergebnisse der ausgeführten SQL-Anweisung an:

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

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

MMDB.showSPResultset()

Ver fügbarkeit

Dreamweaver UltraDev 1.

Beschreibung

Diese Funktion zeigt ein Dialogfeld mit den Ergebnissen aus der Ausführung der angegebenen gespeicherten Prozedur an. Das Dialogfeld zeigt ein tabellarisches Raster an, wobei die Überschrift die Spalteninformationen zum Ergebnissatz wiedergibt. Sollte der Verbindungsstring oder die gespeicherte Prozedur ungültig sein, wird ein Fehler angezeigt. Diese Funktion überprüft die gespeicherte Prozedur.

Argumente

connName, procName, paramValuesArray

• Das Argument connName ist ein Verbindungsname, der im Connection Manager festgelegt wurde. Er bezeichnet den

Verbindungsstring, den Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data-Quelle verwenden soll.

• Das Argument procName ist der Name der auszuführenden gespeicherten Prozedur.

• Das Argument paramValuesArray ist ein Array, das eine Liste von Testwerten der Entwurfsphasenparameter enthält.

Geben Sie die Parameterwerte in der Reihenfolge ein, in der sie die Prozedur erwartet. Mithilfe der Funktion

MMDB.getSPParamsAsString() können Sie die Parameter der gespeicherten Prozedur abrufen.

Rückgabewerte

Diese Funktion gibt einen Fehler zurück, wenn die SQL-Anweisung oder der Verbindungsstring ungültig ist, andernfalls gibt es keinen Rückgabewert.

Beispiel

Der folgende Code zeigt die Ergebnisse der ausgeführten gespeicherten Prozedur an:

var paramValueArray = new Array("2/1/2000", "50000") MMDB.showSPResultset("EmpDB", "getNewEmployeesMakingAtLeast", ¬ paramValueArray)

MMDB.showSPResultsetNamedParams()

Ver fügbarkeit

Dreamweaver UltraDev 1.

Beschreibung

Diese Funktion zeigt ein Dialogfeld mit den Ergebnissen der angegebenen gespeicherten Prozedur an. Das Dialogfeld zeigt ein tabellarisches Raster an, wobei die Überschrift die Spalteninformationen zum Ergebnissatz wiedergibt. Sollte der Verbindungsstring oder die gespeicherte Prozedur ungültig sein, wird ein Fehler angezeigt. Diese Funktion überprüft die gespeicherte Prozedur. Diese Funktion unterscheidet sich von dem Namen festlegen können und nicht nach der Reihenfolge, in der die gespeicherte Prozedur sie erwartet.

MMDB.showSPResultset(), da Sie hier Parameterwerte nach

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Argumente

connName, procName, paramNameArray, paramValuesArray

• Das Argument connName ist ein Verbindungsname, der im Connection Manager festgelegt wurde. Er bezeichnet den

Verbindungsstring, den Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data-Quelle verwenden soll.

• Das Argument procName ist der Name der gespeicherten Prozedur, die den Ergebnissatz zurückgibt, wenn sie ausgeführt

wird.

• Das Argument paramNameArray ist ein Array, das eine Liste von Parameternamen enthält. Mithilfe der Funktion

MMDB.getSPParamsAsString() können Sie die Parameter der gespeicherten Prozedur abrufen.

• Das Argument paramValuesArray ist ein Array, das eine Liste von Testwerten der Entwurfsphasenparameter enthält.

Rückgabewerte

Diese Funktion gibt einen Fehler zurück, wenn die SQL-Anweisung oder der Verbindungsstring ungültig ist, andernfalls gibt es keinen Rückgabewert.

Beispiel

Der folgende Code zeigt die Ergebnisse der ausgeführten gespeicherten Prozedur an:

var paramNameArray = new Array("startDate", "salary") var paramValueArray = new Array("2/1/2000", "50000") MMDB.showSPResultsetNamedParams("EmpDB","getNewEmployees¬ MakingAtLeast", paramNameArray, paramValueArray)

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Kapitel 8: Die Datenbank-KonnektivitätsAPI

Als Entwickler können Sie neue Verbindungstypen und die entsprechenden Dialogfelder für neue bzw. vorhandene Servermodelle für Adobe® Dreamweaver® CS3 erstellen. Anschließend kann ein Benutzer, der eine Site zum Erstellen von Seiten einrichtet, ein neues Verbindungsobjekt nach Auswahl einer bestimmten Verbindung erstellen.

Der Benutzer kann dabei eine der folgenden Möglichkeiten wählen:

• Er klickt im Bedienfeld Anwendung auf die Schaltfläche mit dem Pluszeichen (+) und wählt die Option Datensatz-

gruppe. Er blendet im Dialogfeld Datensatzgruppe die Einträge des Listenfelds Ver b in d un g ein.

• Er klickt im Bedienfeld Datenbanken auf der Registerkarte Datenbank auf die Schaltfläche mit dem Pluszeichen (+)

und wählt Data Source Name.

Neue Verbindungstypen entwickeln

Die folgenden Schritte erläutern den Prozess der Erstellung eines neuen Verbindungstyps:

1 Erstellen Sie das Layout für das Verbindungsdialogfeld.

Erstellen Sie eine HTML-Datei, die die Benutzeroberfläche (UI) für das Verbindungsdialogfeld festlegt. Speichern Sie die Datei unter einem ähnlichen Namen wie die Verbindung selbst (z. B. „myConnection.htm“). Informationen zum Erstellen eines Dialogfelds finden Sie im Handbuch Erste Schritte mit Dreamweaver.

Vergewissern Sie sich, dass diese HTML-Datei die JavaScript-Implementierungsdatei enthält, die Sie in Schritt 2, „Erstellen Sie eine JavaScript-Datei, die mindestens die nachfolgenden Elemente implementiert:“ auf Seite 70, definieren, wie im folgenden Beispiel dargestellt:

<head>

</head>

Speichern Sie diese HTML-Datei, die das Verbindungsdialogfeld definiert, im Ordner Configuration/Connections/servermodel/Plattform (dabei steht Plattform entweder für Windows oder für Macintosh handelt).

Beispielsweise wird das Standard-ADO-Verbindungsdialogfeld für ein ASP-JavaScript-Dokument auf einer WindowsPlattform im Ordner ASP_Js/Win abgelegt und unter dem Namen Connection_ado_conn_string.htm gespeichert.

Hinweis: Zur Laufzeit erstellt Dreamweaver dynamisch eine Liste von Verbindungstypen, die dem Benutzer aus der Auswahl der Dialogfelder im Ordner ASP_Js\Win zur Verfügung stehen.

Im Ordner Configuration\ServerModels sind HTML-Dateien abgelegt, die jedes Servermodell definieren. Jede dieser HTML-Dateien enthält die Funktion jeweiligen Ser vermodell verknüpft ist. Nachfolgendes Beispiel erläutert die Funktion für den ASP JavaScript-Dokumenttyp:

function getServerModelFolderName() {

return "ASP

}

_JS";

getServerModelFolderName(), die den Namen des Ordners zurückgibt, der mit dem

Anhand der Datei MMDocumentTypes.xml im Ordner Configuration/DocumentTypes können Sie die Zuordnung der Servermodelle zu den Dokumenttypen ermitteln.

2 Erstellen Sie eine JavaScript-Datei, die mindestens die nachfolgenden Elemente implementiert:

Element Beschreibung Beispiele

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Eine Gruppe von Variablen Jede Variable definiert eine bestimmte Ver-

bindungseigenschaft.

Eine Gruppe von Schaltflächen Jede Schaltfläche wird im Verbindungsdia-

logfeld angezeigt.

Konnektivitätsfunktionen Alle diese Funktionen definieren die Konnek-

tivitäts-API.

Verbindungs typ, DSN usw.

Tes t en , Hilfe usw. (OK und Abbrechen gehören standardmäßig dazu.)

findConnection()

applyConnection()

inspectConnection()

Sie können einen beliebigen Namen für diese Implementierungsdatei vergeben, sie muss jedoch die Erweiterung „.js“ haben (z. B. „myConnectionImpl.js“). Sie können die Datei lokal oder auf einem Remote-Computer speichern. Sie können auch einen Unterordner im Ordner Configuration/Connections anlegen und die Implementierungsdatei dort speichern.

Hinweis: Die in Schritt 1, „Erstellen Sie das Layout für das Verbindungsdialogfeld.“ auf Seite 69, definierte HTML-Datei muss diese Implementierungsdatei zum Verbindungstyp enthalten.

Wenn Sie die in der Standarddatei connection_includefile.edml festgelegten Verbindungsparameter nicht anpassen müssen, genügen zum Erstellen eines neuen Verbindungsdialogfelds diese beiden Schritte.

Hinweis: Der Titel des Dialogfelds auf der Benutzeroberfläche steht im Tag

title, das im HTML-Dokument festgelegt wird.

Mithilfe der im nächsten Abschnitt aufgeführten Funktionen können Sie ein Verbindungsdialogfeld erstellen. Zusammen mit dem Aufruf zum Generieren von Include-Dateien für den Benutzer müssen Sie möglicherweise auch Ihren Verbindungstyp beim Servermodell-Abschnitt der Verbindungs-XML-Datei anmelden.

Weitere Informationen zur Datenbank-Konnektivitäts-API im Zusammenhang mit dem Erstellen einer neuen Verbindung finden Sie unter „Datenbankverbindungsfunktionen“ auf Seite 45.

Die Verbindungs-API

Um einen neuen Verbindungstyp zu erstellen, einschließlich des Dialogfelds für die Benutzeroberfläche, müssen Sie die folgenden drei Funktionen implementieren: schreiben die drei Funktionen und nehmen Sie in die JavaScript-Implementierungsdatei auf, die mit Ihrem neuen Verbindungstyp verknüpft wird (siehe Schritt 2, „Erstellen Sie eine JavaScript-Datei, die mindestens die nachfolgenden Elemente implementiert:“ auf Seite 70).

Die Funktion

applyConnection() gibt eine HTML-Quelle innerhalb einer Include-Datei zurück. Beispiele für eine HTML-

Quelle finden Sie unter „Die generierte Include-Datei“ auf Seite 73. Die Funktion schaften der HTML-Quelle. Sie können die Funktion XML-Dateien Informationen zu extrahieren, die von JavaScript-Dateien erläutern eine solche Implementierung:

• connection_ado_conn_string.js befindet sich im Ordner Configuration/Connections/ASP_Js.

• connection_common.js befindet sich im Ordner Configuration/Connections/Shared.

Wenn ein Benutzer eine Site aufruft, öffnet Dreamweaver jede Datei im Ordner Connections und gibt deren Inhalt an die Funktion Funktion Bedienfeld Database Explorer angezeigt.

Wenn ein Benutzer ein Verbindungsdialogfeld öffnet, um eine neue Verbindung zu erstellen oder eine bestehende zu kopieren bzw. zu bearbeiten, ruft Dreamweaver die Funktion objekt zurück, das von tionen angezeigt werden.

findConnection() weiter. Entspricht der Inhalt einer Datei den Kriterien für eine gültige Verbindung, gibt die findConnection() ein Verbindungsobjekt zurück. Alle Verbindungsobjekte werden in Dreamweaver im

findConnection() erstellt wurde. Auf diese Weise können im Dialogfeld die Verbindungsinforma-

findConnection(), inspectConnection() und applyConnection(). Sie

findConnection() extrahiert die Eigen-

findConnection() implementieren, um mithilfe der Suchmuster in

applyConnection() zurückgegeben werden. Die nachfolgenden zwei

inspectConnection() auf und gibt das gleiche Verbindungs-

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Wenn ein Benutzer im Verbindungsdialogfeld auf die Schaltfläche OK klickt, schickt Dreamweaver einen Aufruf an die Funktion ration/Connections aufgenommen wird. Die Funktion

applyConnection(), um die HTML-Datei zu erstellen, die dann in die Include-Datei im Ordner Configu-

applyConnection() gibt einen leeren String zurück, der anzeigt,

dass eines der Felder einen Fehler enthält und das Dialogfeld noch nicht geschlossen werden sollte. Die Dateinamenerweiterung der Include-Datei entspricht dem aktuellen Servermodell.

Wenn ein Benutzer in eine Seite ein Serververhalten aufnimmt, das die Verbindung verwendet, z. B. eine Datensatzgruppe oder eine gespeicherte Prozedur, nimmt Dreamweaver eine Anweisung in die Seite auf, die die Include-Datei der Verbin d u ng ent h ält.

findConnection()

Ver fügbarkeit

Dreamweaver UltraDev 4.

Beschreibung

Dreamweaver ruft diese Funktion auf, um eine Verbindung in der ausgewählten HTML-Quelle zu finden und die Verbindungsparameter zu analysieren. Stimmt der Inhalt dieser Quelldatei mit den Kriterien für eine gültige Verbindung überein, gibt

findConnection() ein Verbindungsobjekt zurück. Andernfalls gibt diese Funktion den Wert null zurück.

Argument

htmlSource

Das Argument htmlSource ist die HTML-Quelle für eine Verbindung.

Rückgabewerte

Ein Verbindungsobjekt, das Werte für eine bestimmte Kombination der nachfolgend aufgeführten Eigenschaften liefert. Die Eigenschaften, für die diese Funktion einen Wert zurückgibt, sind vom Dokumenttyp abhängig.

Eigenschaft Beschreibung

name Der Name der Verbindung

type Wenn useHTTP auf false gesetzt ist, wird angezeigt, welche DLL für die Verbindung

string Verbindungsstring während der Ausführung Für ADO ist es ein String von Verbin-

dsn Data Source Name, der für ODBC- oder Cold Fusion-Verbindungen (Laufzeit) verwen-

driver Name eines JDBC-Treibers (Laufzeit)

username Name des Benutzers für die Laufzeitverbindung

password Kennwort für die Laufzeitverbindung

designtimeString Entwurfsphasen-Verbindungsstring (siehe string)

designtimeDsn Entwurfsphasen-Data Source Name (siehe dsn)

designtimeDriver Name eines JDBC-Treibers (Entwurfsphase)

designtimeUsername Name des Benutzers für die Entwurfsphasenverbindung

designtimePassword Kennwort für die Entwurfsphasenverbindung

designtimeType Entwurfsphasen-Verbindungstyp

usesDesigntimeInfo Wenn false, benutzt Dreamweaver Laufzeiteigenschaften in der Entwurfsphase;

mit der Datenbank während der Laufzeit verwendet werden soll.

dungsparametern, für JDBC eine Verbindungs-URL.

det wird.

wenn nicht, Entwurfsphaseneigenschaften.

useHTTP Ein String. der true oder false enthält: true gibt an, dass die HTTP-Verbindung bei

der Entwurfsphase verwendet werden soll; false gibt an, dass DLL verwendet werden soll.

Eigenschaft Beschreibung

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

includePattern Ein regulärer Ausdruck, mit dem die include -Anweisung auf der Seite in den Ansichten

variables Objekt mit einer Eigenschaft für jede Seitenvariable, die auf deren entsprechenden

catalog String mit einer Datenbank kennung, die den Umfang der angezeigten Metadaten ein-

schema String mit einer Datenbank kennung, die den Umfang der angezeigten Metadaten ein-

filename Name des Dialogfelds, über das die Verbindung erstellt wird.

Live Data und Vors chau in B rowser gesucht wird.

Wert gesetzt wird. Dieses Objekt wird in den Ansichten Live Data und Vors chau i n Browser verwendet.

schränkt.

Wird keine Verbindung in htmlSource gefunden, wird der Wert null zurückgegeben.

Hinweis: Entwickler können benutzerdefinierte Eigenschaften , z. B. Metadaten, in die HTML-Quelle aufnehmen, die von

applyConnection() zusammen mit den Standardeigenschaften zurückgeben werden.

inspectConnection()

Ver fügbarkeit

Dreamweaver UltraDev 4.

Beschreibung

Dreamweaver ruft diese Funktion auf, um die Dialogfelddaten zum Definieren der Verbindung zu initialisieren, wenn der Benutzer eine bestehende Verbindung bearbeitet. Auf diese Weise können im Dialogfeld die richtigen Verbindungsinformationen angezeigt werden.

Argument

parameters

Beim Argument parameters handelt es sich um das gleiche Objekt, das die Funktion findConnection() zurückgibt.

Rückgabewerte

Keine

applyConnection()

Ver fügbarkeit

Dreamweaver UltraDev 4.

Beschreibung

Dreamweaver ruft diese Funktion auf, wenn der Benutzer im Verbindungsdialogfeld auf OK klickt. Die Funktion apply-

Connection()

Datei Configuration\Connections\Ve r bi n d u n g s n am e . e r w , wobei Ver b in d un g sn am e der Name Ihrer Verbindung (siehe „Erstellen Sie das Layout für das Verbindungsdialogfeld.“ auf Seite 69) und .erw die Standarderweiterung für das Servermodell ist.

Argumente

Keine

Rückgabewerte

Die HTML-Quelle für eine Verbindung. Dreamweaver schließt auch das Verbindungsdialogfeld. Wenn eine Feldüberprüfung einen Fehler ergibt, zeigt anzuzeigen, dass das Dialogfeld nicht geschlossen werden soll.

generiert die HTML-Quelle für eine Verbindung. Dreamweaver schreibt den HTML-Code in die Include-

applyConnection() eine Fehlermeldung an und gibt einen leeren String zurück, um

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Die generierte Include-Datei

In der von applyConnection() generierten Include-Datei werden alle Eigenschaften einer Verbindung deklariert. Der Dateiname der Include-Datei ist der Verbindungsname und weist die Erweiterung auf, die für das mit der aktuellen Site verknüpfte Servermodell definiert ist.

Hinweis: Verbindungen werden zur gemeinsamen Verwendung zentral abgelegt; setzen Sie daher den Wert für auf

false. Dadurch wird gewährleistet, dass die Verbindungsdatei nur einmal in das Dokument aufgenommen wird und dass

allowMultiple

das Serverskript auf der Seite bleibt, auch dann, wenn andere Serververhalten es verwenden.

In den nachfolgenden Abschnitten finden Sie Beispiele für Include-Dateien, die von

applyConnection() für diverse

Standard-Servermodelle generiert werden.

Hinweis: Um ein neues Dateiformat für eine Include-Datei zu erstellen, müssen Sie eine neue EDML-Zuordnungsdatei definieren, die der Datei connection_includefile.edm ähnlich sein sollte (siehe dazu „Definitionsdateien für Ihren Verbindungstyp“ auf Seite 74).

ASP JavaScript

Die ASP- und JavaScript-Include-Datei sollte den Namen myConnection1.asp haben, wobei myConnection1 der Name der Verbindung ist. Das nachfolgende Beispiel ist eine Include-Datei für den ADO-Verbindungsstring:

// Dateiname="Connection // Type="ADO" // HTTP="true" // Catalog="" // Schema=""

_MyConnection1_STRING = "dsn=pubs";

var MM

Die Serververhaltensdatei schließt diese Verbindung mit ein, indem sie die relative Include-Anweisung verwendet (siehe nachfolgendes Beispiel):

_ado_conn_string.htm"

ColdFusion

Wenn Sie mit UltraDev 4 ColdFusion arbeiten, ruft Dreamweaver mithilfe einer ColdFusion Include-Datei eine Liste von Datenquellen ab.

Hinweis: Bei Dreamweaver-ColdFusion ignoriert Dreamweaver normalerweise alle Include-Dateien und ruft die Liste der Datenquellen stattdessen über RDS von ColdFusion ab.

Die Include-Datei für UltraDev 4 ColdFusion sollte den Namen myConnection1.cfm haben, wobei myConnection1 der Name Ihrer Verbindung ist. Nachfolgendes Beispiel zeigt die Include-Datei für eine ColdFusion-Verbindung mit einer Produkttabelle.

<CFSET MM_MyConnection1_DSN = "products"> <CFSET MM_MyConnection1_USERNAME = ""> <CFSET MM_Product_USERNAME = ""> <CFSET MM_MyConnection1_PASSWORD = "">

Die Serververhaltensdatei schließt diese Verbindung mit ein, indem sie die Anweisung cfinclude verwendet (siehe nachfolgendes Beispiel):

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

JSP

Die JSP Include-Datei sollte den Namen MyConnection1.jsp haben, wobei MyConnection1 der Name Ihrer Verbindung ist. Nachfolgend ist ein Beispiel für eine Include-Datei für eine JDBC-Verbindung mit einer Datenbank aufgeführt:

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

Die Serververhaltensdatei schließt diese Verbindung mit ein, indem sie die relative Include-Anweisung verwendet (siehe nachfolgendes Beispiel):

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

Definitionsdateien für Ihren Verbindungstyp

Für jedes Servermodell gibt es eine eigene Datei connection_includefile.edml, die den Verbindungstyp definiert und die die in der Include-Datei definierten Eigenschaften den entsprechenden Elementen der Dreamweaver-Schnittstelle zuordnet.

Dreamweaver bietet standardmäßig sieben Definitionsdateien, d. h. eine für jedes der vordefinierten Servermodelle, die in der nachfolgenden Tabelle aufgeführt sind.

Servermodell Unterordner im Ordner 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 ermittelt Verbindungsblöcke mit den Parametern dungsblöcke mit dem Parameter

insertText. Weitere Informationen über EDML-Tags und -Attribute sowie Suchmuster

quickSearch und searchPattern und erstellt Verbin-

für reguläre Ausdrücke finden Sie unter „Serververhalten“ im Handbuch Dreamweaver erweitern.

Hinweis: Wenn Sie das Format Ihrer Include-Datei ändern oder eine Include-Datei für ein neues Servermodell definieren, müssen Sie die Verbindungsparameter der Dreamweaver Benutzeroberfläche sowie den Ansichten Live Data und Vo rs chau in Browser zuordnen. In nachfolgendem Beispiel für eine EDML-Datei, die mit dem Standard-ASP-JS-Servermodell verknüpft ist, wurden alle Variablen der Verbindungsseite den entsprechenden Werten zugeordnet, bevor die Seite an den Server gesendet wurde. Weitere Informationen über EDML und Suchmuster für reguläre Ausdrücke finden Sie unter „Serververhalten“ im Handbuch Dreamweaver erweitern.

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

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

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

var MM %> ]]>

</insertText>

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

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

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

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

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

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

<![CDATA[/var\s+MM

</searchPatterns> </participant>

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

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Tokens in einer EDML-Datei, wie @@filename@@ in diesem Beispiel, ordnen Werte in der Include-Datei den jeweiligen Eigenschaften eines Verbindungsobjekts zu. Die Eigenschaften von Verbindungsobjekten legen Sie in der JavaScript-Implementierungsdatei fest.

Alle standardmäßig im Lieferumfang von Dreamweaver enthaltenen Dialogfelder verwenden die Zuordnungsdatei connection_includefile.edml. Damit Dreamweaver diese Datei finden kann, wird der Dateiname, wie im folgenden Beispiel gezeigt, in der JavaScript-Implementierungsdatei festgelegt:

var PARTICIPANT_FILE = "connection_includefile";

Beim Erstellen eines benutzerdefinierten Verbindungstyps können Sie in Ihren Dialogfeldern eine beliebige Zuordnungsdatei angeben. Wenn Sie eine Zuordnungsdatei erstellen, können Sie für Ihre EDML-Datei einen beliebigen Namen neben connection_includefile verwenden. Wenn Sie einen anderen Namen verwenden, müssen Sie diesen auch in der JavaScriptImplementierungsdatei verwenden, wenn Sie den Wert für die Variable

PARTICIPANT_FILE angeben, wie im folgenden

Beispiel dargestellt.

var PARTICIPANT_FILE = "myConnection_mappingfile";

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Kapitel 9: Die JavaBeans-API

In diesem Kapitel sind die APIs für JavaBeans beschrieben. Die MMJB*()-Funktionen sind JavaScript-Hooks, die Java-Introspektionsaufrufe für JavaBeans-Unterstützung aufrufen. Diese Funktionen rufen die Klassennamen, Methoden, Eigenschaften und Ereignisse aus JavaBeans ab, die in der Dreamweaver-Benutzeroberfläche angezeigt werden können. Damit diese JavaScript-Funktionen verwendet werden können und Adobe® Dreamweaver® CS3 der Zugriff auf JavaBeans ermöglicht wird, muss sich JavaBeans im Ordner Configuration\Classes befinden.

Hinweis: Die in diesem Kapitel beschriebenen Funktionsargumente verfügen möglicherweise über das Argument

packageName.className, das einen einzelnen Wert repräsentiert.

Die JavaBeans-API

Die folgenden Funktionen stellen Methoden des MMJB-Objekts dar.

MMJB.getClasses()

Ver fügbarkeit

Dreamweaver UltraDev 4.

Beschreibung

Diese Funktion ruft alle JavaBeans-Klassennamen ab, die sich im Ordner Configuration\Classes befinden.

Argumente

Keine

Rückgabewerte

Ein String-Array von Klassennamen im Ordner Configuration\Classes. Bei einem Fehler wird ein leeres Array zurückgegeben.

MMJB.getClassesFromPackage()

Ver fügbarkeit

Dreamweaver UltraDev 4.

Beschreibung

Diese Funktion ruft alle JavaBeans-Klassen aus dem Paket ab.

Argumente

packageName.pathName

• Das Argument packageName.pathName ist der Pfad zu dem Paket. Es muss sich dabei um ein Java-Archiv (JAR oder ZIP)

handeln, z. B.

C:\jdbcdrivers\Una2000_Enterprise.zip.

Rückgabewerte

Ein String-Array von Klassennamen in einem bestimmten JAR- oder ZIP-Java-Archiv. Bei einem Fehler wird ein leeres Array zurückgegeben.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

MMJB.getErrorMessage()

Ver fügbarkeit

Dreamweaver UltraDev 4.

Beschreibung

Diese Funktion ruft die letzte Dreamweaver-Fehlermeldung ab, die während der Verwendung der MMJB-Schnittstelle ausgegeben wurde.

Argumente

Keine

Rückgabewerte

Ein String aus der letzten Dreamweaver-Fehlermeldung.

MMJB.getEvents()

Ver fügbarkeit

Dreamweaver UltraDev 4; verbessert in Dreamweaver MX.

Beschreibung

Überprüft die JavaBeans-Klasse und gibt deren Ereignisse zurück.

Argumente

packageName.className, {packagePath}

• Das Argument packageName.className ist der Name der Klasse. Die Klasse muss sich in einem JAR- oder ZIP-Java-

Archiv befinden. Wenn eine Klassendatei sein, die im Ordner Configuration\Classes gespeichert ist.

packagePath weggelassen wird, muss sich das Archiv im classpath Ihres Systems befinden oder

• Das Argument packagePath ist ein optionaler String, der auf den Speicherort des JAR- oder ZIP-Java-Archivs verweist,

das

className enthält.

Rückgabewerte

Ein String-Array von Ereignissen, die className zugeordnet sind. Bei einem Fehler wird ein leeres Array zurückgegeben.

MMJB.getIndexedProperties()

Ver fügbarkeit

Dreamweaver UltraDev 4; verbessert in Dreamweaver MX.

Beschreibung

Überprüft die JavaBeans-Klasse und gibt deren indizierte Eigenschaften zurück, d. h. Entwurfsmuster mit dem gleichen Verhalten wie Sammlungen.

Argumente

packageName.className, {packagePath}

• Das Argument packageName.className ist der Name der Klasse. Die Klasse muss sich in einem JAR- oder ZIP-Java-

Archiv befinden. Wenn eine Klassendatei sein, die im Ordner Configuration\Classes gespeichert ist.

• Das Argument packagePath ist ein optionaler String, der auf den Speicherort des JAR- oder ZIP-Java-Archivs verweist,

das

className enthält.

packagePath weggelassen wird, muss sich das Archiv im classpath Ihres Systems befinden oder

Rückgabewerte

Ein String-Array der indizierten Eigenschaften, die className zugeordnet sind. Bei einem Fehler wird ein leeres Array zurückgegeben.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

MMJB.getMethods()

Ver fügbarkeit

Dreamweaver UltraDev 4; verbessert in Dreamweaver MX.

Beschreibung

Überprüft die JavaBeans-Klasse und gibt deren Methoden zurück.

Argumente

packageName.className, {packagePath}

• Das Argument packageName.className ist der Name der Klasse. Die Klasse muss sich in einem JAR- oder ZIP-Java-

Archiv befinden. Wenn eine Klassendatei sein, die im Ordner Configuration\Classes gespeichert ist.

packagePath weggelassen wird, muss sich das Archiv im classpath Ihres Systems befinden oder

• Das Argument packagePath ist ein optionaler String, der auf den Speicherort des JAR- oder ZIP-Java-Archivs verweist,

das

className enthält.

Rückgabewerte

Ein String-Array von Methoden, die className zugeordnet sind. Bei einem Fehler wird ein leeres Array zurückgegeben.

MMJB.getProperties()

Ver fügbarkeit

Dreamweaver UltraDev 4; verbessert in Dreamweaver MX.

Beschreibung

Überprüft die JavaBeans-Klasse und gibt deren Eigenschaften zurück.

Argumente

packageName.className, {packagePath}

• Das Argument packageName.className ist der Name der Klasse. Die Klasse muss sich in einem JAR- oder ZIP-Java-

Archiv befinden. Wenn eine Klassendatei sein, die im Ordner Configuration\Classes gespeichert ist.

packagePath weggelassen wird, muss sich das Archiv im classpath Ihres Systems befinden oder

• Das Argument packagePath ist ein optionaler String, der auf den Speicherort des JAR- oder ZIP-Java-Archivs verweist,

das

className enthält.

Rückgabewerte

Ein String-Array von Eigenschaften, die className zugeordnet sind. Bei einem Fehler wird ein leeres Array zurückgegeben.

MMJB.getReadProperties()

Ver fügbarkeit

Dreamweaver MX

Beschreibung

Ruft Nur-Lesen-Eigenschaften für JavaBeans ab, die get accessor-Aufrufe unterstützen.

Argumente

packageName.className, {packagePath}

• Das Argument packageName.className ist der Name der Klasse. Die Klasse muss sich in einem JAR- oder ZIP-Java-

Archiv befinden. Wenn eine Klassendatei sein, die im Ordner Configuration\Classes gespeichert ist.

packagePath weggelassen wird, muss sich das Archiv im classpath Ihres Systems befinden oder

• Das Argument packagePath ist ein optionaler String, der auf den Speicherort des JAR- oder ZIP-Java-Archivs verweist,

das

className enthält.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Rückgabewerte

Ein String-Array von Nur-Lesen-Eigenschaften, die className zugeordnet sind. Bei einem Fehler wird ein leeres Array zurückgegeben.

MMJB.getWriteProperties()

Ver fügbarkeit

Dreamweaver MX

Beschreibung

Ruft Nur-Schreiben-Eigenschaften für JavaBeans auf, die set method-Aufrufe unterstützen.

Argumente

packageName.className, {packagePath}

• Das Argument packageName.className ist der Name der Klasse. Die Klasse muss sich in einem JAR- oder ZIP-Java-

Archiv befinden. Wenn eine Klassendatei sein, die im Ordner Configuration\Classes gespeichert ist.

• Das Argument packagePath ist ein optionaler String, der auf den Speicherort des JAR- oder ZIP-Java-Archivs verweist,

das

className enthält.

packagePath weggelassen wird, muss sich das Archiv im classpath Ihres Systems befinden oder

Rückgabewerte

Ein String-Array von Nur-Lesen-Eigenschaften, die className zugeordnet sind. Bei einem Fehler wird ein leeres Array zurückgegeben.

Kapitel 10: API zur Integration der Quellcodeverwaltung

Mit der API zur Integration der Quellcodeverwaltung können Sie gemeinsam genutzte Bibliotheken schreiben, um das Einund Auschecken in Adobe® Dreamweaver® CS3 unter Verwendung von Quellcode-Verwaltungssystemen (wie Sourcesafe oder CVS) zu erweitern.

Ihre Bibliotheken müssen eine Mindestanzahl erforderlicher API-Funktionen unterstützen, damit Dreamweaver in ein Quellcode-Verwaltungssystem integriert werden kann. Außerdem müssen sich Ihre Bibliotheken im Ordner Programme/Adobe/Adobe Dreamweaver CS3/Configuration/SourceControl befinden.

Beim Start von Dreamweaver werden die einzelnen Bibliotheken geladen. Dreamweaver ruft API-Funktion auf, um zu ermitteln, welche Funktionen die Bibliothek unterstützt. Wenn keine Adresse vorhanden ist, nimmt Dreamweaver an, dass die API nicht von der Bibliothek unterstützt wird. Wenn die Adresse vorhanden ist, verwendet Dreamweaver die Bibliothek-Version der Funktion, um die Funktionalität zu unterstützen. Wenn ein Dreamweaver-Benutzer eine Site definiert oder bearbeitet und anschließend die Registerkarte We b S er ve r S CS auswählt, werden zusätzlich zu den Standardelementen die Auswahlmöglichkeiten angezeigt, die den aus dem Ordner Programme/Adobe/Adobe Dreamweaver CS3/Configuration/SourceControl geladenen DLLs entsprechen.

Um ein Menü des Typs Site > Quellcodeverwaltung zu erstellen, dem Sie benutzerdefinierte Elemente hinzufügen können, fügen Sie den folgenden Code in das Menü Site in der Datei menus.xml ein:

Die in diesem Kapitel beschriebenen Funktionen sind in den folgenden Abschnitten zusammengefasst:

GetProcAddress() für jede

• „Erforderliche Funktionen für die API zur Integration der Quellcodeverwaltung“ auf Seite 82

• „Optionale Funktionen für die API zur Integration der Quellcodeverwaltung“ auf Seite 87

• „Enabler“ auf Seite 95

So funktioniert die Integration der Quellcodeverwaltung in Dreamweaver

Wenn ein Dreamweaver-Benutzer eine Serververbindung, eine Dateiübertragung oder Funktionen im Zusammenhang mit Design Notes auswählt, ruft Dreamweaver die DLL-Version der entsprechenden API-Funktion auf (

Disconnect(), Get(), Put(), Checkin(), Checkout(), Undocheckout() und Synchronize()). Die DLL handhabt die Anfor-

derung und das Anzeigen von Dialogfeldern, in denen Informationen erfasst werden oder über die Benutzer mit der DLL interagieren. Die DLL zeigt außerdem Informationen und Fehlermeldungen an.

Das Quellcodeverwaltungsystem kann optional Design Notes und das Ein- und Auschecken unterstützen. In Dreamweaver aktivieren Sie Design Notes für das Quellcode-Verwaltungssystem, indem Sie im Dialogfeld Sites bearbeiten die Register- karte Design Notes auswählen und dann das entsprechende Kontrollkästchen aktivieren. So werden Design Notes auch über FTP und LANs aktiviert. Wenn Design Notes vom Quellcode-Verwaltungssystem nicht unterstützt werden und der Benutzer diese Funktion verwenden möchte, werden Design Notes-Dateien (MNO-Dateien) von Dreamweaver transportiert, um die Design Notes zu verwalten (wie auch über FTP und LANs).

Das Ein- und Auschecken wird anders behandelt als die Funktion der Design Notes: Wenn das Quellcode-Verwaltungssystem dies unterstützt, kann der Benutzer die Verwendung nicht vom Dialogfeld Design Notes aus außer Kraft setzen. Wenn der Benutzer versucht, das Quellcode-Verwaltungssystem außer Kraft zu setzen, wird eine Fehlermeldung angezeigt.

Connect(),

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Quellcode-Verwaltungssystemfunktionen hinzufügen

Sie können zu Dreamweaver Quellcode-Verwaltungssystemfunktionen hinzufügen, indem Sie einen GetNewFeaturesHandler schreiben, der eine Gruppe von Menüobjekten und entsprechenden C-Funktionen zurückgibt. Wenn Sie beispielsweise eine Sourcesafe-Bibliothek schreiben und es Dreamweaver-Benutzern ermöglichen möchten, den Verlauf einer Datei anzuzeigen, können Sie einen Handler namen

history zurückgibt. Wenn der Benutzer anschließend in Windows mit der rechten Maustaste auf eine Datei klickt,

ist das Menüobjekt Ve rl a uf eine der Optionen im Kontextmenü. Wenn ein Benutzer das Menüobjekt Ver l au f auswählt, ruft Dreamweaver die entsprechende Funktion auf, und die ausgewählten Dateien werden an die DLL weitergegeben. Die DLL zeigt das Dialogfeld Ve r la u f an, sodass der Benutzer damit genauso interagieren kann wie bei Sourcesafe.

GetNewFeatures schreiben, der das Menüobjekt Ver l a u f und den C-Funktions-

Erforderliche Funktionen für die API zur Integration der Quellcodeverwaltung

Die API zur Integration der Quellcodeverwaltung verfügt über erforderliche und optionale Funktionen. Bei den hier aufgeführten Funktionen handelt es sich um erforderliche Funktionen.

bool SCS_GetAgentInfo()

Beschreibung

Diese Funktion fordert die DLL auf, ihren Namen und eine Beschreibung zurückzugeben. Diese Informationen werden im Dialogfeld Sites bearbeiten angezeigt. Der Name wird im Popupmenü Server-Zugriff angezeigt (z. B. sourcesafe, webdav, perforce) und die Beschreibung direkt unter dem Popupmenü.

Argumente

char name[32], char version[32], char description[256], const char *dwAppVersion

• Das Argument name ist der Name des Quellcode-Verwaltungssystems. Der Name wird im Dialogfeld Sites bearbeiten

auf der Registerkarte Quellcodeverwaltung im Kombinationsfeld zum Auswählen eines Quellcode-Verwaltungssystems angezeigt. Der Name kann aus maximal 32 Zeichen bestehen.

• Das Argument version ist ein String, der die Version der DLL anzeigt. Die Version wird im Dialogfeld Sites bearbeiten

auf der Registerkarte Quellcodeverwaltung angezeigt. Die Version kann aus maximal 32 Zeichen bestehen.

• Das Argument description ist ein String, der die Beschreibung des Quellcode-Verwaltungssystems enthält. Die

Beschreibung wird im Dialogfeld Sites bearbeiten auf der Registerkarte Quellcodeverwaltung angezeigt. Die Beschreibung kann aus maximal 256 Zeichen bestehen.

• Das Argument dwAppVersion ist ein String, der die Dreamweaver-Version angibt, die die DLL aufruft. Die DLL kann

anhand dieses Strings die Version und Sprache von Dreamweaver bestimmen.

Rückgabewerte

Ein Boolescher Wert: true, wenn erfolgreich, andernfalls false.

bool SCS_Connect()

Beschreibung

Diese Funktion verbindet den Benutzer mit dem Quellcode-Verwaltungssystem. Wenn die DLL nicht über Anmeldungsinformationen verfügt, muss die DLL ein Dialogfeld anzeigen, in dem der Benutzer aufgefordert wird, die Informationen einzugeben. Sie muss außerdem die Daten für die spätere Verwendung speichern.

Argumente

void **connectionData, const char siteName[64]

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

• Das Argument connectionData ist ein Handle zu den Daten, die beim Aufrufen anderer API-Funktionen von Dream-

weaver an den Agenten weitergegeben werden sollen.

• Das Argument siteName ist ein String, der auf den Namen der Site verweist. Der Sitename kann aus maximal 64 Zeichen

bestehen.

Rückgabewerte

Ein Boolescher Wert: true, wenn erfolgreich, andernfalls false.

bool SCS_Disconnect()

Beschreibung

Diese Funktion trennt die Verbindung des Benutzers zum Quellcode-Verwaltungssystem.

Argumente

void *connectionData

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect() an

Dreamweaver weitergegeben wurden.

Rückgabewerte

Ein Boolescher Wert: true, wenn erfolgreich, andernfalls false.

bool SCS_IsConnected()

Beschreibung

Diese Funktion bestimmt den Status der Verbindung.

Argumente

void *connectionData

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect() an

Dreamweaver weitergegeben wurden.

Rückgabewerte

Ein Boolescher Wert: true, wenn erfolgreich, andernfalls false.

int SCS_GetRootFolderLength()

Beschreibung

Diese Funktion gibt die Länge des Stammordnernamens zurück.

Argumente

void *connectionData

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect() an

Dreamweaver weitergegeben wurden.

Rückgabewerte

Eine Ganzzahl, die die Länge des Stammordnernamens angibt. Ist der Rückgabewert der Funktion < 0, wird dies von Dreamweaver als Fehler interpretiert, und das Programm versucht, die Fehlermeldung von der DLL abzurufen, sofern dies unterstützt wird.

bool SCS_GetRootFolder()

Beschreibung

Diese Funktion gibt den Namen des Stammordners zurück.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Argumente

void *connectionData, char remotePath[], const int folderLen

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect() an

Dreamweaver weitergegeben wurden.

• remotePath ist ein Puffer, in dem der Remote-Pfad des Stammordners gespeichert wird.

• Das Argument folderLen ist eine Ganzzahl, mit der die Länge von remotePath angezeigt wird. Dies ist der von GetRoot-

FolderLength

zurückgegebene Wert.

Rückgabewerte

Ein Boolescher Wert: true, wenn erfolgreich, andernfalls false.

int SCS_GetFolderListLength()

Beschreibung

Diese Funktion gibt die Anzahl der Elemente im eingereichten Ordner zurück.

Argumente

void *connectionData, const char *remotePath

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect() an

Dreamweaver weitergegeben wurden.

• Das Argument remotePath ist der vollständige Pfad und Name des Remote-Ordners, den die DLL auf die Anzahl der

Elemente prüft.

Rückgabewerte

Eine Ganzzahl, die die Anzahl der Elemente im aktuellen Ordner angibt. Ist der Rückgabewert der Funktion < 0, wird dies von Dreamweaver als Fehler interpretiert, und das Programm versucht, die Fehlermeldung von der DLL abzurufen, sofern dies unterstützt wird.

bool SCS_GetFolderList()

Beschreibung

Diese Funktion gibt eine Liste der Dateien und Ordner im eingereichten Ordner zurück, einschließlich zugehöriger Informationen wie Größe, Datum der letzten Änderung und der Angabe, ob es sich um einen Ordner oder eine Datei handelt.

Argumente

void *connectionData, const char *remotePath, itemInfo itemList[ ], const int numItems

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect() an

Dreamweaver weitergegeben wurden.

• Das Argument remotePath ist der Pfadname des Remote-Ordners, den die DLL auf die Anzahl der Elemente prüft.

• Das Argument itemList ist eine bereits zugewiesene Liste mit itemInfo-Strukturen:

name char[256] Name der Datei oder des Ordners

isFolder bool true, wenn Ordner; false, wenn Datei

month int Komponente Monat von Änderungsdatum 1–12

day int Komponente Tag von Änderungsdatum 1–31

year int Komponente Jahr von Änderungsdatum 1900+

hour int Komponente Stunde von Änderungsdatum 0–23

minutes int Komponente Minute von Änderungsdatum 0–59

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

name char[256] Name der Datei oder des Ordners

Sekunden int Komponente Sekunde von Änderungsdatum 0–59

type char[256] Dateityp (falls nicht durch die DLL festgelegt, bestimmt Dreamweaver

Größe int in Byte

den Typ wie bisher anhand der Dateierweiterung)

• Das Argument numItems ist die Anzahl der für itemList zugewiesenen Elemente (zurückgegeben von GetFolderList-

Length

Rückgabewerte

Ein Boolescher Wert: true, wenn erfolgreich, andernfalls false.

bool SCS_Get()

Beschreibung

Diese Funktion ruft eine Liste mit Dateien oder Ordnern ab und speichert sie lokal.

Argumente

void *connectionData, const char *remotePathList[], const char *localPathList[], const int numItems

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect() an

Dreamweaver weitergegeben wurden.

• Das Argument remotePathList ist eine Liste der abzurufenden Remote-Dateien oder Remote-Ordner. Die Liste enthält

die vollständigen Pfade und Namen.

• Das Argument localPathList ist eine gespiegelte Liste der Namen lokaler Dateien oder Ordnerpfade.

• Das Argument numItems ist die Anzahl der Elemente in jeder Liste.

Rückgabewerte

Ein Boolescher Wert: true, wenn erfolgreich, andernfalls false.

bool SCS_Put()

Beschreibung

Diese Funktion stellt eine Liste mit lokalen Dateien oder Ordnern im Quellcode-Verwaltungssystem bereit.

Argumente

void *connectionData, const char *localPathList[], const char *remotePathList[], const int numItems

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect() an

Dreamweaver weitergegeben wurden.

• Das Argument localPathList ist die Liste mit Namen der lokalen Dateien oder Pfaden zu lokalen Ordnern, die im

Quellcode-Verwaltungssystem bereitgestellt werden sollen.

• Das Argument remotePathList ist eine gespiegelte Liste mit Namen von Remote-Dateien oder Pfaden zu Remote-

Ordnern.

• Das Argument numItems ist die Anzahl der Elemente in jeder Liste.

Rückgabewerte

Ein Boolescher Wert: true, wenn erfolgreich, andernfalls false.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

bool SCS_NewFolder()

Beschreibung

Mit dieser Funktion wird ein neuer Ordner erstellt.

Argumente

void *connectionData, const char *remotePath

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect() an

Dreamweaver weitergegeben wurden.

• Das Argument remotePath ist der vollständige Pfadname des Remote-Ordners, der von der DLL erstellt wird.

Rückgabewerte

Ein Boolescher Wert: true, wenn erfolgreich, andernfalls false.

bool SCS_Delete()

Beschreibung

Diese Funktion löscht eine Liste mit Dateien oder Ordnern aus dem Quellcode-Verwaltungssystem.

Argumente

void *connectionData, const char *remotePathList[], const int numItems

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect() an

Dreamweaver weitergegeben wurden.

• Das Argument remotePathList ist eine Liste der Namen zu löschender Remote-Dateien bzw. der Pfade zu löschender

Remote-Ordner.

• Das Argument numItems ist die Anzahl der Elemente in remotePathList.

Rückgabewerte

Ein Boolescher Wert: true, wenn erfolgreich, andernfalls false.

bool SCS_Rename()

Beschreibung

Diese Funktion bewirkt, dass eine Datei oder ein Ordner umbenannt oder verschoben wird, je nach den für oldRemotePath und

newRemotePath angegebenen Werten. Ist beispielsweise oldRemotePath gleich "$/folder1/file1" und newRemotePath

gleich

"$/folder1/renamefile1", wird file1 in renamefile1 umbenannt und befindet sich in folder1.

Ist oldRemotePath gleich "$/folder1/file1" und newRemotePath gleich "$/folder1/subfolder1/file1", wird file1 in den Ordner subfolder1 verschoben.

Um herauszufinden, ob es sich bei dem Aufruf dieser Funktion um eine Verschiebung oder um ein Umbenennen handelt, überprüfen Sie die übergeordneten Pfade der beiden Eingabewerte. Wenn sie identisch sind, handelt es sich bei dem Vorgang um eine Umbenennung.

Argumente

void *connectionData, const char *oldRemotePath, const char *newRemotePath

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect() an

Dreamweaver weitergegeben wurden.

• Das Argument oldRemotePath ist der Pfad des umzubenennenden Remote-Ordners bzw. der umzubenennenden

Remote-Datei.

• Das Argument newRemotePath ist der Remote-Pfad des neuen Namens für die Datei oder den Ordner.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Rückgabewerte

Ein Boolescher Wert: true, wenn erfolgreich, andernfalls false.

bool SCS_ItemExists()

Beschreibung

Diese Funktion bestimmt, ob eine Datei bzw. ein Ordner auf dem Server vorhanden ist.

Argumente

void *connectionData, const char *remotePath

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect() an

Dreamweaver weitergegeben wurden.

• Das Argument remotePath ist der Pfad zu einer Remote-Datei bzw. einem Remote-Ordner.

Rückgabewerte

Ein Boolescher Wert: true, wenn erfolgreich, andernfalls false.

Optionale Funktionen für die API zur Integration der

Quellcodeverwaltung

Die API zur Integration der Quellcodeverwaltung verfügt über erforderliche und optionale Funktionen. Bei den hier aufgeführten Funktionen handelt es sich um optionale Funktionen.

bool SCS_GetConnectionInfo()

Beschreibung

Diese Funktion zeigt ein Dialogfeld an, in dem der Benutzer die Verbindungsinformationen für diese Site ändern oder festlegen kann. Eine Verbindung wird nicht hergestellt. Diese Funktion wird aufgerufen, wenn der Benutzer im Dialogfeld Sites bearbeiten im Abschnitt Remote-Informationen auf die Schaltfläche Einstellungen... klickt.

Argumente

void **connectionData, const char siteName[64]

• Das Argument connectionData ist ein Handle zu den Daten, die beim Aufrufen anderer API-Funktionen von Dream-

weaver an den Agenten weitergegeben werden sollen.

• Das Argument siteName ist ein String, der auf den Namen der Site verweist. Der Name darf höchstens 64 Zeichen

enthalten.

Rückgabewerte

Ein Boolescher Wert: true, wenn erfolgreich, andernfalls false.

bool SCS_SiteDeleted()

Beschreibung

Diese Funktion teilt der DLL mit, dass die Site gelöscht wurde oder nicht mehr mit diesem Quellcode-Verwaltungssystem verbunden ist. Dies bedeutet, dass das Quellcodeverwaltungssystem die persistenten Daten für diese Site löschen kann.

Argumente

const char siteName[64]

• Das Argument siteName ist ein String, der auf den Namen der Site verweist. Der Name darf höchstens 64 Zeichen

enthalten.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Rückgabewerte

Ein Boolescher Wert: true, wenn erfolgreich, andernfalls false.

bool SCS_SiteRenamed()

Beschreibung

Diese Funktion teilt der DLL mit, wenn der Benutzer die Site umbenannt hat, sodass die permanenten Informationen zu der Site in der DLL aktualisiert werden können.

Argumente

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

• Das Argument oldSiteName ist ein String, der auf den ursprünglichen Namen der Site verweist. Dies ist der Name der

Site vor der Umbenennung. Der Name darf höchstens 64 Zeichen enthalten.

• Das Argument newSiteName ist ein String, der auf den neuen Namen der Site verweist. Dies ist der Name der Site nach

der Umbenennung. Der Name darf höchstens 64 Zeichen enthalten.

Rückgabewerte

Ein Boolescher Wert: true, wenn erfolgreich, andernfalls false.

int SCS_GetNumNewFeatures()

Beschreibung

Diese Funktion gibt die Zahl der neuen Funktionen zurück, die Dreamweaver hinzugefügt werden (z. B. Dateiverlauf, Unterschiede usw.).

Argumente

Keine

Rückgabewerte

Eine Ganzzahl, die die Anzahl der neuen Funktionen angibt, die Dreamweaver hinzugefügt werden. Ist der Rückgabewert der Funktion der DLL abzurufen, sofern dies unterstützt wird.

< 0, wird dies von Dreamweaver als Fehler interpretiert, und das Programm versucht, die Fehlermeldung von

bool SCS_GetNewFeatures()

Beschreibung

Diese Funktion gibt eine Liste mit Menüelementen zurück, die in das Hauptmenü und in die Kontextmenüs von Dreamweaver eingefügt werden sollen. Beispielsweise können mit der Sourcesafe-DLL Verlauf und Dateiunterschiede in das Hauptmenü eingefügt werden.

Argumente

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

• Das Argument menuItemList ist eine Liste mit Strings, die von der DLL ausgefüllt wird. Sie gibt die Menüelemente an,

die dem Hauptmenü und den Kontextmenüs hinzugefügt werden sollen. Jeder String kann höchstens 32 Zeichen enthalten.

• Das Argument functionList wird von der DLL gefüllt. Es legt fest, welche Routinen in der DLL aufgerufen werden,

wenn der Benutzer das entsprechende Menüelement auswählt.

• Das Argument enablerList wird von der DLL gefüllt. Es legt fest, welche Routinen in der DLL aufgerufen werden, wenn

Dreamweaver bestimmen muss, ob das entsprechende Menüelement aktiviert ist.

• Das Argument numNewFeatures ist die Anzahl der Elemente, die von der DLL hinzugefügt werden. Dieser Wert wird

vom Aufruf

GetNumNewFeatures() abgerufen.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Die folgende Funktionssignatur definiert die Funktionen und Enabler, die mit den Argumenten functionlist und

enablerList

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

an den Aufruf von SCS_GetNewFeatures() übergeben werden.

const char *localPathList[], const int numItems)

Rückgabewerte

Ein Boolescher Wert: true, wenn erfolgreich, andernfalls false.

bool SCS_GetCheckoutName()

Beschreibung

Diese Funktion gibt den Auschecknamen des aktuellen Benutzers zurück. Falls diese Funktion vom Quellcode-Verwaltungssystem nicht unterstützt wird, aber vom Benutzer aktiviert wurde, wird die interne Dreamweaver-Funktion Einchecken/Auschecken verwendet, mit der LCK-Dateien in das Quellcode-Verwaltungssystem und aus dem QuellcodeVerwaltungssystem transportiert werden.

Argumente

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

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect() an

Dreamweaver weitergegeben wurden.

• Das Argument checkOutName ist der Name des aktuellen Benutzers.

• Das Argument emailAddress ist die E-Mail-Adresse des aktuellen Benutzers.

Rückgabewerte

Ein Boolescher Wert: true, wenn erfolgreich, andernfalls false.

bool SCS_Checkin()

Beschreibung

Diese Funktion checkt eine Liste mit lokalen Dateien oder Ordnern in das Quellcode-Verwaltungssystem ein. Die DLL ist verantwortlich für das Einstellen des Schreibschutzes für die Datei. Falls diese Funktion vom Quellcode-Verwaltungssystem nicht unterstützt wird, aber vom Benutzer aktiviert wurde, wird die interne Dreamweaver-Funktion Einchecken/Auschecken verwendet, mit der LCK-Dateien in das Quellcode-Verwaltungssystem und aus dem QuellcodeVerwaltungssystem transportiert werden.

Argumente

void *connectionData, const char *localPathList[], const char *remotePathList[], bool successList[], const int numItems

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect() an

Dreamweaver weitergegeben wurden.

• Das Argument localPathList ist eine Liste der Namen einzucheckender lokaler Dateien oder Ordnerpfade.

• Das Argument remotePathList ist eine gespiegelte Liste mit Namen von Remote-Dateien oder Pfaden zu Remote-

Ordnern.

• Das Argument successList ist eine Liste mit Booleschen Werten, die von der DLL angegeben werden, um Dreamweaver

mitzuteilen, welche der zugehörigen Dateien erfolgreich eingecheckt wurden.

• Das Argument numItems ist die Anzahl der Elemente in jeder Liste.

Rückgabewerte

Ein Boolescher Wert: true, wenn erfolgreich, andernfalls false.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

bool SCS_Checkout()

Beschreibung

Diese Funktion checkt eine Liste lokaler Dateien oder Ordner aus dem Quellcode-Verwaltungssystem aus. Die DLL ist verantwortlich dafür, die Schreibberechtigungen für die Datei zu gewähren. Falls diese Funktion vom Quellcode-Verwaltungssystem nicht unterstützt wird, aber vom Benutzer aktiviert wurde, wird die interne Dreamweaver-Funktion Einchecken/Auschecken verwendet, mit der LCK-Dateien in das Quellcode-Verwaltungssystem und aus dem QuellcodeVerwaltungssystem transportiert werden.

Argumente

void *connectionData, const char *remotePathList[], const char *localPathList[], bool successList[], const int numItems

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect() an

Dreamweaver weitergegeben wurden.

• Das Argument remotePathList ist eine Liste der Namen auszucheckender Remote-Dateien bzw. der Pfade auszuchek-

kender Remote-Ordner.

• Das Argument localPathList ist eine gespiegelte Liste der Namen lokaler Dateien oder Ordnerpfade.

• Das Argument successList ist eine Liste mit Booleschen Werten, die von der DLL angegeben werden, um Dreamweaver

mitzuteilen, welche der zugehörigen Dateien erfolgreich ausgecheckt wurden.

• Das Argument numItems ist die Anzahl der Elemente in jeder Liste.

Rückgabewerte

Ein Boolescher Wert: true, wenn erfolgreich, andernfalls false.

bool SCS_UndoCheckout()

Beschreibung

Diese Funktion macht den Auscheck-Status einer Liste mit Dateien oder Ordnern rückgängig. Die DLL ist verantwortlich für das Einstellen des Schreibschutzes für die Datei. Falls diese Funktion vom Quellcode-Verwaltungssystem nicht unterstützt wird, aber vom Benutzer aktiviert wurde, wird die interne Dreamweaver-Funktion Einchecken/Auschecken verwendet, mit der LCK-Dateien in das Quellcode-Verwaltungssystem und aus dem Quellcode-Verwaltungssystem transportiert werden.

Argumente

void *connectionData, const char *remotePathList[], const char *localPathList[], bool successList[], const int numItems

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect() an

Dreamweaver weitergegeben wurden.

• Das Argument remotePathList ist eine Liste der Namen von Remote-Dateien oder Pfadnamen von Remote-Ordnern,

für die das Auschecken rückgängig gemacht werden soll.

• Das Argument localPathList ist eine gespiegelte Liste der Namen lokaler Dateien oder Ordnerpfade.

• Das Argument successList ist eine Liste mit Booleschen Werten, die von der DLL angegeben werden, um Dreamweaver

mitzuteilen, für welche der zugehörigen Dateien das Auschecken erfolgreich rückgängig gemacht wurde.

• Das Argument numItems ist die Anzahl der Elemente in jeder Liste.

Rückgabewerte

Ein Boolescher Wert: true, wenn erfolgreich, andernfalls false.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

int SCS_GetNumCheckedOut()

Beschreibung

Diese Funktion gibt die Anzahl der Benutzer zurück, die eine Datei ausgecheckt haben.

Argumente

void *connectionData, const char *remotePath

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect() an

Dreamweaver weitergegeben wurden.

• Das Argument remotePath ist der Name der Remote-Datei oder der Pfad zum Remote-Ordner, der daraufhin überprüft

werden soll, wie viele Benutzer die Datei bzw. den Ordner ausgecheckt haben.

Rückgabewerte

Eine Ganzzahl, die angibt, wie viele Personen die Datei ausgecheckt haben. Ist der Rückgabewert der Funktion < 0, wird dies von Dreamweaver als Fehler interpretiert, und das Programm versucht, die Fehlermeldung von der DLL abzurufen, sofern dies unterstützt wird.

bool SCS_GetFileCheckoutList()

Beschreibung

Diese Funktion gibt eine Liste der Benutzer zurück, die eine Datei ausgecheckt haben. Wenn die Liste leer ist, hat niemand die Datei ausgecheckt.

Argumente

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

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect() an

Dreamweaver weitergegeben wurden.

• Das Argument remotePath ist der Pfadname der Remote-Datei oder des Remote-Ordners, der daraufhin überprüft

werden soll, wie viele Benutzer die Datei bzw. den Ordner ausgecheckt haben.

• Das Argument checkOutList ist eine Liste mit Strings, die den Benutzern entsprechen, die die Datei ausgecheckt haben.

Die Benutzerstrings können jeweils maximal 64 Zeichen lang sein.

• Das Argument emailAddressList ist eine Liste mit Strings, die den E-Mail-Adressen der Benutzer entsprechen. Die

Strings für die E-Mail-Adressen können jeweils maximal 64 Zeichen lang sein.

• Das Argument numCheckedOut ist die Anzahl der Personen, die die Datei ausgecheckt haben. Diese Zahl wird von

GetNumCheckedOut() zurückgegeben.

Rückgabewerte

Ein Boolescher Wert: true, wenn erfolgreich, andernfalls false.

int SCS_GetErrorMessageLength()

Beschreibung

Diese Funktion gibt die Länge der aktuellen internen Fehlermeldung der DLL zurück. Dies weist den Puffer zu, der an die Funktion Funktion

GetErrorMessage() übergeben wird. Diese Funktion sollte nur dann aufgerufen werden, wenn eine API- false oder <0 zurückgibt, wodurch ein Fehler dieser API-Funktion angezeigt wird.

Argumente

void *connectionData

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect() an

Dreamweaver weitergegeben wurden.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

Rückgabewerte

Eine Ganzzahl, die die Länge der Fehlermeldung angibt.

bool SCS_GetErrorMessage()

Beschreibung

Diese Funktion gibt die letzte Fehlermeldung zurück. Wenn Sie getErrorMessage() implementieren, ruft Dreamweaver die Funktion jedes Mal auf, wenn eine Ihrer API-Funktionen den Wert

Wenn eine Routine –1 oder false zurückgibt, wird dadurch angezeigt, dass eine Fehlermeldung verfügbar sein sollte.

Argumente

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

Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect() an Dreamweaver weitergegeben wurden.

• Das Argument errorMsg ist ein bereits zugewiesener String, der von der DLL mit der Fehlermeldung gefüllt wird.

• Das Argument msgLength ist die Länge des Puffers, der durch das errorMsg[]-Argument dargestellt wird.

Rückgabewerte

Ein Boolescher Wert: true, wenn erfolgreich, andernfalls false.

false zurückgibt.

int SCS_GetNoteCount()

Beschreibung

Diese Funktion gibt die Anzahl der Design Note-Schlüssel für den angegebenen Pfad der Remote-Datei bzw. des RemoteOrdners zurück. Wenn dies vom Quellcode-Verwaltungssystem nicht unterstützt wird, ruft Dreamweaver diese Informationen aus der zugehörigen MNO-Datei ab.

Argumente

void *connectionData, const char *remotePath

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect() an

Dreamweaver weitergegeben wurden.

• Das Argument remotePath ist der Pfadname der Remote-Datei oder des Remote-Ordners, den die DLL auf die Anzahl

der angefügten Design Notes überprüft.

Rückgabewerte

Eine Ganzzahl, die die Anzahl der Design Notes angibt, die zu dieser Datei gehören. Ist der Rückgabewert der Funktion <

, wird dies von Dreamweaver als Fehler interpretiert, und das Programm versucht, die Fehlermeldung von der DLL

abzurufen, sofern dies unterstützt wird.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

int SCS_GetMaxNoteLength()

Beschreibung

Diese Funktion gibt die Länge der größten Design Note für die angegebene Datei bzw. den angegebenen Ordner zurück. Wenn dies vom Quellcode-Verwaltungssystem nicht unterstützt wird, ruft Dreamweaver diese Informationen aus der zugehörigen MNO-Datei ab.

Argumente

void *connectionData, const char *remotePath

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect() an

Dreamweaver weitergegeben wurden.

• Das Argument remotePath ist der Pfadname der Remote-Datei oder des Remote-Ordners, den die DLL auf die maximale

Design Note-Länge überprüft.

Rückgabewerte

Eine Ganzzahl, die die Größe der längsten Design Note angibt, die zu dieser Datei gehört. Ist der Rückgabewert der Funktion

< 0, wird dies von Dreamweaver als Fehler interpretiert, und das Programm versucht, die Fehlermeldung von der

DLL abzurufen, sofern dies unterstützt wird.

bool SCS_GetDesignNotes()

Beschreibung

Diese Funktion ruft Schlüssel-Wertpaare aus den Meta-Informationen für die angegebene Datei bzw. den angegebenen Ordner ab. Wenn dies vom Quellcode-Verwaltungssystem nicht unterstützt wird, ruft Dreamweaver diese Informationen aus der zugehörigen MNO-Datei ab.

Argumente

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

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect() an

Dreamweaver weitergegeben wurden.

• Das Argument remotePath ist der Pfadname der Remote-Datei oder des Remote-Ordners, den die DLL auf die Anzahl

der Elemente überprüft.

• Das Argument keyList ist eine Liste der Design Note-Schlüssel, z. B. "Status".

• Das Argument valueList ist eine Liste der Design Note-Werte, die den Design Note-Schlüsseln entsprechen, z. B.

"Awaiting Signoff".

• Das Argument showColumnList ist eine Liste der Booleschen Werte, die den Design Note-Schlüsseln entsprechen. Damit

wird angegeben, ob Dreamweaver den Schlüssel als Spalte im Bedienfeld Site anzeigen kann.

• Das Argument noteCount ist die Anzahl der Design Notes, die an eine Datei oder einen Ordner angefügt sind. Dieser

Wert w ird v o m Aufr u f

GetNoteCount() zurückgegeben.

• Das Argument noteLength ist die maximale Länge einer Design Note. Dies ist der vom Aufruf GetMaxNoteLength()

zurückgegebene Wert.

Rückgabewerte

Ein Boolescher Wert: true, wenn erfolgreich, andernfalls false.

ADOBE DREAMWEAVER 9.0

API-Referenzhandbuch

bool SCS_SetDesignNotes()

Beschreibung

Diese Funktion speichert die Schlüssel-Wertpaare in den Meta-Informationen für die angegebene Datei bzw. für den angegebenen Ordner. Hierdurch wird das Set von Meta-Informationen für die Datei ersetzt. Wenn dies vom QuellcodeVerwaltungssystem nicht unterstützt wird, speichert Dreamweaver Design Notes in MNO-Dateien.

Argumente

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

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect() an

Dreamweaver weitergegeben wurden.

• Das Argument remotePath ist der Pfadname der Remote-Datei oder des Remote-Ordners, den die DLL auf die Anzahl

der Elemente überprüft.

• Das Argument keyList ist eine Liste der Design Note-Schlüssel, z. B. "Status".

• Das Argument valueList ist eine Liste der Design Note-Werte, die den Design Note-Schlüsseln entsprechen, z. B.

"Awaiting Signoff".

• Das Argument showColumnList ist eine Liste der Booleschen Werte, die den Design Note-Schlüsseln entsprechen. Damit

wird angegeben, ob Dreamweaver den Schlüssel als Spalte im Bedienfeld Site anzeigen kann.

• Das Argument noteCount ist die Anzahl der Design Notes, die an eine Datei oder einen Ordner angefügt sind. Anhand

dieser Zahl kann die DLL die Größe der angegebenen Listen ermitteln. Wenn Notes aus der Datei entfernt.

• Das Argument noteLength ist die Länge der größten Design Note für die angegebene Datei bzw. den angegebenen

Ordner.

noteCount gleich 0 ist, werden alle Design

Rückgabewerte

Ein Boolescher Wert: true, wenn erfolgreich, andernfalls false.

bool SCS_IsRemoteNewer()

Beschreibung

Diese Funktion prüft jeden angegebenen Remote-Pfad, um festzustellen, ob die Remote-Version neuer ist. Wenn dies vom Quellcode-Verwaltungssystem nicht unterstützt wird, verwendet Dreamweaver seinen internen Algorithmus.

Argumente

void *connectionData, const char *remotePathList[], const char *localPathList[], int remoteIsNewerList[], const int numItems

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect() an

Dreamweaver weitergegeben wurden.

• Das Argument remotePathList ist eine Liste der Namen von Remote-Dateien oder Pfadnamen von Remote-Ordnern,

die auf einen neueren Status überprüft werden sollen.

• Das Argument localPathList ist eine gespiegelte Liste der Namen lokaler Dateien oder Ordnerpfade.

• Das Argument remoteIsNewerList ist eine Liste mit Ganzzahlen, die von der DLL ausgefüllt wird und Dreamweaver

mitteilt, welche der entsprechenden Dateien auf der Remote-Seite neuer sind. Folgende Werte sind gültig: 1 gibt an, dass die Remote-Version neuer ist. –1 gibt an, dass die lokale Version neuer ist. 0 gibt an, dass die beiden Versionen identisch sind.

• Das Argument numItems ist die Anzahl der Elemente in jeder Liste.

isRemoteNewer-

Rückgabewerte

Ein Boolescher Wert: true, wenn erfolgreich, andernfalls false.

ADOBE Dreamweaver API CS3 User Manual [de]

Specifications and Main Features

Frequently Asked Questions

User Manual

Inhaltsverzeichnis

Kapitel 1: Einführung

Hintergrund

Dreamweaver erweitern

Weitere Ressourcen für das Schreiben von Erweiterungen

Neue Funktionen in Dreamweaver CS3

Anwendung

Funktionen für externe Anwendungen

Globale Anwendungsfunktionen

Bridge-Kommunikation

Arbeitsbereich

Aktive Inhalte

Codeansicht

Site

Dokumente

Seiteninhalt

Spry-Widgets bearbeiten

Spry-Widgets einfügen

Probleme bei der Browserkompatibilitätsprüfung

Dynamische Dokumente

Design

CSS-Layout

Entfernte Funktionen

Errata

In diesem Handbuch verwendete Konventionen

Typografische Konventionen

Namengebungskonventionen

Kapitel 2: Die API für Datei-E/A

Auf Konfigurationsordner zugreifen

Die API für Datei-E/A

DWfile.copy()

DWfile.createFolder()

DWfile.exists()

DWfile.getAttributes()

DWfile.getModificationDate()

DWfile.getCreationDate()

DWfile.getCreationDateObj()

DWfile.getModificationDateObj()

DWfile.getSize()

DWfile.listFolder()

DWfile.read()

DWfile.remove()

DWfile.setAttributes()

DWfile.write()

Kapitel 3: Die HTTP-API

Funktionsweise der HTTP-API

Die HTTP-API

MMHttp.clearServerScriptsFolder()

MMHttp.clearTemp()

MMHttp.getFile()

MMHttp.getFileCallback()

MMHttp.getText()

MMHttp.getTextCallback()

MMHttp.postText()

MMHttp.postTextCallback()

Kapitel 4: API für Design Notes

Funktionsweise von Design Notes

JavaScript -API für Design Notes

MMNotes.close()

MMNotes.filePathToLocalURL()

MMNotes.get()

MMNotes.getKeyCount()

MMNotes.getKeys()

MMNotes.getSiteRootForFile()

MMNotes.getVersionName()

MMNotes.getVersionNum()

MMNotes.localURLToFilePath()

MMNotes.open()

MMNotes.remove()

MMNotes.set()

C-API für Design Notes

void CloseNotesFile()

BOOL FilePathToLocalURL()

BOOL GetNote()

int GetNoteLength()

int GetNotesKeyCount()