SDK Programmer's Guide bc Adobe GoLive cs2 ® ® © 2005 Adobe Systems Incorporated. All rights reserved. AdobeÆ Creative Suite 2 GoLive® CS2 SDK Programmer's Guide for Windows® and Macintosh®. NOTICE: All information contained herein is the property of Adobe Systems Incorporated. No part of this publication (whether in hardcopy or electronic form) may be reproduced or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written consent of Adobe Systems Incorporated. The software described in this document is furnished under license and may only be used or copied in accordance with the terms of such license. This publication and the information herein is furnished AS IS, is subject to change without notice, and should not be construed as a commitment by Adobe Systems Incorporated. Adobe Systems Incorporated assumes no responsibility or liability for any errors or inaccuracies, makes no warranty of any kind (express, implied, or statutory) with respect to this publication, and expressly disclaims any and all warranties of merchantability, fitness for particular purposes, and noninfringement of third party rights. Any references to company names in sample templates are for demonstration purposes only and are not intended to refer to any actual organization. Adobe, the Adobe logo, Acrobat, and GoLive are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. Apple, Mac, Macintosh, and Mac OS are trademarks of Apple Computer, Inc., registered in the United States and other countries. Microsoft and Windows are either registered trademarks or trademarks of Microsoft Corporation in the United States and other countries. JavaScript and all Java-related marks are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries. UNIX is a registered trademark of The Open Group. All other trademarks are the property of their respective owners. If this guide is distributed with software that includes an end user agreement, this guide, as well as the software described in it, is furnished under license and may be used or copied only in accordance with the terms of such license. Except as permitted by any such license, no part of this guide may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, recording, or otherwise, without the prior written permission of Adobe Systems Incorporated. Please note that the content in this guide is protected under copyright law even if it is not distributed with software that includes an end user license agreement. The content of this guide is furnished for informational use only, is subject to change without notice, and should not be construed as a commitment by Adobe Systems Incorporated. Adobe Systems Incorporated assumes no responsibility or liability for any errors or inaccuracies that may appear in the informational content contained in this guide. Adobe Systems Incorporated, 345 Park Avenue, San Jose, California 95110, USA. Contents Preface ........................................................................................................................................ 10 About Adobe GoLive CS2 SDK ................................................................................................................................................10 About This Book............................................................................................................................................................................11 Who should read this book ................................................................................................................................................11 What is in this book ...............................................................................................................................................................11 Document conventions .......................................................................................................................................................12 Typographical conventions .........................................................................................................................................12 JavaScript common properties...................................................................................................................................12 Where to Go for More Information ........................................................................................................................................13 1 Installing and Configuring the GoLive SDK............................................................................. 14 Installing the GoLive CS2 SDK..................................................................................................................................................14 Installing the core set of tools and sample extensions ............................................................................................14 Installing the core extensions .....................................................................................................................................14 Uninstalling an extension .............................................................................................................................................15 Configuring GoLive for Extension Development..............................................................................................................15 Enabling the Extend Script module ................................................................................................................................15 Enabling and disabling modules......................................................................................................................................16 Debugging Your Scripts.............................................................................................................................................................17 Error logs ...................................................................................................................................................................................17 2 How to Create an Extension...................................................................................................... 18 About Adobe GoLive CS2 Extensions ...................................................................................................................................18 What can extensions do? ....................................................................................................................................................18 Anatomy of an Extension ..........................................................................................................................................................19 Extension-building tools .....................................................................................................................................................20 Example Main.html File..............................................................................................................................................................21 Creating An Extension Module................................................................................................................................................21 Creating the Main.html file.................................................................................................................................................22 Adding SDK Tags and JavaScript Functions to the Module..........................................................................................23 Adding the module tag .......................................................................................................................................................24 Adding event-handling functions ...................................................................................................................................24 Summary ...................................................................................................................................................................................26 3 The JavaScript Environment..................................................................................................... 27 JavaScript Objects in the GoLive Environment .................................................................................................................27 Objects, elements, and properties...................................................................................................................................27 Accessing attribute values..................................................................................................................................................27 Naming objects and attributes .........................................................................................................................................28 JavaScript object collections..............................................................................................................................................29 Using the global object arrays ....................................................................................................................................29 Comparing objects..........................................................................................................................................................30 Updating references to objects ........................................................................................................................................30 Scope of Variables and Functions ..........................................................................................................................................31 Releasing Memory .................................................................................................................................................................32 Handling Events............................................................................................................................................................................32 Defining and Registering Event Handlers.....................................................................................................................33 3 Adobe GoLive CS2 SDK SDK Programmer's Guide Contents 4 Nesting Event Handlers .......................................................................................................................................................34 Sharing Data...................................................................................................................................................................................34 Persistent shared data..........................................................................................................................................................35 Non-persistent shared data................................................................................................................................................35 Communicating with other extensions .........................................................................................................................35 Sending messages to other extension modules ..................................................................................................36 Responding to a broadcast ..........................................................................................................................................36 Delays and Timeouts...................................................................................................................................................................36 Timed tasks...............................................................................................................................................................................37 Setting the JavaScript timeout..........................................................................................................................................37 Progress bars ...........................................................................................................................................................................37 Starting a progress or busy bar...................................................................................................................................38 Updating a progress or busy bar................................................................................................................................38 Progress bar example...................................................................... ...