Adobe 65014293 Scripting Guide - Page 81

C

HAPTER

4: Action Manager

Using ScriptListener to find event IDs and class IDs

81

Using ScriptListener to find event IDs and class IDs

The section demonstrates how to use ScriptListener to determine event IDs and class IDs for actions taken

by Photoshop. These event and class IDs are used to set up notification using the

Notifier class

.

You can determine the event ID for any recordable action by using ScriptListener. Simply install the

ScriptListener plug in, as described in

“Installing ScriptListener” on page 73

. Then execute the action you

want to find the event ID for. The event is logged in the Script Listener log file. (See

“The ScriptListener

Plug-In” on page 73

) If the event applies to several different classes of objects, the class ID is also logged in

the log file.

The following examples show how to find the event ID for the “Open Document” event, and the event and

class IDs for the “New” event, which applies to several different classes.

Finding the event ID for the “Open Document” event

1.

Make sure that the ScriptListener plug in is installed.

2.

Open Photoshop, then open a document.

3.

Find the ScriptListener log file and open it. You can use either the VBScript log file or the JavaScript log

file. In the JavaScript version of the file, you will see code that looks something like this at the end of

the file, everything below the row of equal signs the log of the last action taken:

// =======================================================

var id14 = charIDToTypeID( "Opn " );

var desc5 = new ActionDescriptor();

var id15 = charIDToTypeID( "null" );

desc5.putPath( id15, new File( "C:\\Program Files\\Adobe\\Adobe Photoshop CS4\\

Samples\\Fish.psd" ) );

executeAction( id14, desc5, DialogModes.NO );

4.

The

executeAction

method runs the action from a script, and it needs the event ID to identify which

action to take. The first argument, in this case

id14

, provides the event ID to the method. You can see

the variable

id14

defined several lines earlier, and it shows that the event ID for the Open Document

action is

"Opn ".

5.

You can now use this event ID to set up event notification on Open Document from your scripts. In

JavaScript, for example:

var eventFile = new File(app.path +

"/Presets/Scripts/Event Scripts Only/Welcome.jsx")

app.notifiers.add(

"Opn ", eventFile)

Finding the event ID and class ID for the “New” event

1.

Make sure that the ScriptListener plug in is installed.

2.

Open Photoshop, then create a new document using File > New.

3.

Next, create a new channel, using the Create New Channel icon on the Channels palette.

4.

Find the ScriptListener log file and open it. You can use either the VBScript log file or the JavaScript log

file. We have recorded two actions, so we are interested in looking at the last two sections in the file

that are delimited by the rows of equal signs. In the JavaScript log file, you will see code that looks

something like this:

Section	Page
Adobe® Creative Suite® 4 Photoshop® Scripting Guide	2
Introduction	6
About this Manual	6
Conventions in this Guide	6
Photoshop Scripting Basics	8
Scripting Overview	8
Why use scripts instead of actions?	8
Scripting Support in Photoshop	9
JavaScript support	9
Executing other scripts	10
Startup scripts	10
Executing JavaScripts from AS or VBS	10
Photoshop Object Model	11
Containment hierarchy	11
Application and document classes	12
Layer classes	12
Layer Comp class	13
Channel class	13
Selection class	13
History State class	13
Document Info class	13
Path Item, Sub Path Item, and Path Point classes	14
Preferences class	14
Notifier class	14
Count Item class	14
Color Sampler class	14
Measurement Scale class	14
The containment hierarchy and the Photoshop user interface	14
Additional objects	16
Constants	16
Creating a sample Hello World script	17
Creating and running an AppleScript	18
Creating and running a VBScript	19
Creating and running a JavaScript	19
Scripting Photoshop	21
Viewing Photoshop Objects, Commands, and Methods	21
Viewing Photoshop’s AppleScript dictionary	21
Viewing Photoshop’s type library (VBS)	22
Targeting and Referencing the Application Object	22
Creating New Objects in a Script	23
Setting the Active Object	25
Setting the active document	26
Setting the active layer	27
Setting the active channels	28
Opening a Document	28
Opening a file with default file format	28
Specifying file formats to open	29
Saving a Document	31
Setting Application Preferences	32
Allowing or Preventing Dialogs	33
Working with the Photoshop Object Model	33
Using the Application object	34
Using the Document object	34
Manipulating a document object	35
Working with layer objects	36
Creating an ArtLayer object	37
Creating a Layer Set object	38
Referencing ArtLayer objects	38
Working with Layer Set objects	39
Linking layer objects	40
Applying styles to layers	40
Using the Text Item object	41
Determining a layer’s kind	41
Adding and manipulating text in a Text Item object	42
Working with Selection objects	42
Creating and defining a selection	43
Stroking the selection border	44
Inverting selections	44
Expanding, contracting, and feathering selections	44
Filling a selection	45
Loading and storing selections	45
Working with Channel objects	46
Changing channel types	46
Using the Document Info object	47
Using history state objects	47
Using Notifier objects	48
Using the PathItem object	49
Working with color objects	51
Solid color classes	52
Using hex values for RGB color	52
Getting and converting colors	52
Comparing colors	53
Getting a Web-safe color	53
Working with Filters	53
Other filters	54
Understanding Clipboard Interaction	54
Using the copy and paste commands	54
Using the copy merged command/method	55
Working with Units	56
Unit values	56
Special unit value types	56
AppleScript unit considerations	56
Using unit values in calculations	57
Unit value usage	57
Setting ruler and type units in a script	59
Sample Workflow Automation JavaScripts	60
Advanced Scripting	60
Working with document preferences	61
Applying color to a text item	64
Applying a wave filter	66
Defining the area of a selection object	67
Applying a MotionBlur filter	71
Action Manager	73
The ScriptListener Plug-In	73
Installing ScriptListener	73
Action Manager Scripting Objects	74
Recording a Script using ScriptListener	74
Using the Action Manager from JavaScript	75
Using the Action Manager from a VBS Script	76
Running JavaScript-based Action Manager code from VBScript	79
Running JavaScript-based Action Manager code from AppleScript	80
Using ScriptListener to find event IDs and class IDs	81

Adobe 65014293 Scripting Guide - Page 81

Using ScriptListener to find event IDs and class IDs

Page 81 highlights