Photoshop CS4 JavaScript Ref

bbc
ADOBE PHOTOSHOP CS4
JAVASCRIPT SCRIPTING REFERENCE
Revision 1
© 2008 Adobe Systems Incorporated. All rights reserved.
Adobe® Creative Suite® 4 Photoshop®
JavaScript Scripting Reference 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®
, GoLive®
,InDesign®
, Illustrator®
, Photoshop®
are either registered trademarks or trademarks of Adobe
Systems Incorporated in the United States and/or other countries.
Apple®
, Mac OS®
, and Macintosh®
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. JavaScriptTM
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.
3
Contents
1 Introduction ...............................................................................................................................33
JavaScript support in Adobe Photoshop CS4....................................................................................................................33
Executing scripts ....................................................................................................................................................................34
Installing scripts ...............................................................................................................................................................34
Executing other scripts..................................................................................................................................................34
Startup scripts .........................................................................................................................................................................34
Object model usage and naming...........................................................................................................................................35
Changes since earlier versions - CS4 changes ...................................................................................................................35
.............................................................................................................................................................................................................36
2 JavaScript Object Reference.....................................................................................................37
Object descriptions......................................................................................................................................................................37
Properties notation ...............................................................................................................................................................37
displayDialogs.................................................................................................................................................................37
Methods notation..................................................................................................................................................................37
crop.....................................................................................................................................................................................38
ActionDescriptor ..........................................................................................................................................................................39
Properties..................................................................................................................................................................................39
count ..................................................................................................................................................................................39
typename .........................................................................................................................................................................39
Methods ....................................................................................................................................................................................39
clear ....................................................................................................................................................................................39
erase ...................................................................................................................................................................................39
fromStream......................................................................................................................................................................39
getBoolean.......................................................................................................................................................................39
getClass.............................................................................................................................................................................39
getData..............................................................................................................................................................................39
getDouble ........................................................................................................................................................................39
getEnumerationType ...................................................................................................................................................39
getEnumerationValue..................................................................................................................................................39
getInteger.........................................................................................................................................................................39
getKey................................................................................................................................................................................39
getList ................................................................................................................................................................................40
getObjectType................................................................................................................................................................40
getObjectValue...............................................................................................................................................................40
getPath..............................................................................................................................................................................40
getReference...................................................................................................................................................................40
getString...........................................................................................................................................................................40
getType .............................................................................................................................................................................40
getUnitDoubleType......................................................................................................................................................40
getUnitDoubleValue.....................................................................................................................................................40
hasKey................................................................................................................................................................................40
isEqual................................................................................................................................................................................40
putBoolean ......................................................................................................................................................................40
putClass.............................................................................................................................................................................40
putData .............................................................................................................................................................................40
Adobe Photoshop CS4
JavaScript Scripting Reference 4
putDouble........................................................................................................................................................................40
putEnumerated..............................................................................................................................................................40
putInteger ........................................................................................................................................................................40
putList................................................................................................................................................................................41
putObject..........................................................................................................................................................................41
putPath..............................................................................................................................................................................41
putReference...................................................................................................................................................................41
putString...........................................................................................................................................................................41
putUnitDouble................................................................................................................................................................41
toStream ...........................................................................................................................................................................41
ActionList.........................................................................................................................................................................................42
Properties..................................................................................................................................................................................42
count ..................................................................................................................................................................................42
typename .........................................................................................................................................................................42
Methods ....................................................................................................................................................................................42
clear ....................................................................................................................................................................................42
getBoolean.......................................................................................................................................................................42
getClass.............................................................................................................................................................................42
getData..............................................................................................................................................................................42
getDouble ........................................................................................................................................................................42
getEnumerationType ...................................................................................................................................................42
getEnumerationValue..................................................................................................................................................42
getInteger.........................................................................................................................................................................42
getList ................................................................................................................................................................................43
getObjectType................................................................................................................................................................43
getObjectValue...............................................................................................................................................................43
getPath..............................................................................................................................................................................43
getReference...................................................................................................................................................................43
getString...........................................................................................................................................................................43
getType .............................................................................................................................................................................43
getUnitDoubleType......................................................................................................................................................43
getUnitDoubleValue.....................................................................................................................................................43
putBoolean ......................................................................................................................................................................43
putClass.............................................................................................................................................................................43
putData .............................................................................................................................................................................43
putDouble........................................................................................................................................................................43
putEnumerated..............................................................................................................................................................43
putInteger ........................................................................................................................................................................43
putList................................................................................................................................................................................43
putObject..........................................................................................................................................................................43
putPath..............................................................................................................................................................................43
putReference...................................................................................................................................................................43
putString...........................................................................................................................................................................44
putUnitDouble................................................................................................................................................................44
ActionReference ...........................................................................................................................................................................45
Properties..................................................................................................................................................................................45
typename .........................................................................................................................................................................45
Methods ........................................................................................................