Packagecom.adobe.photoshop.events
Classpublic class SubscriptionEvent
InheritanceSubscriptionEvent Inheritance flash.events.Event

A SubscriptionEvent is dispatched by classes such as the SubscriptionManager, and will contain useful information regarding the user events in Photoshop.



Public Properties
 PropertyDefined By
  data : *
Data associated with this event.
SubscriptionEvent
Public Methods
 MethodDefined By
  
SubscriptionEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)
Creates a new SubscriptionEvent.
SubscriptionEvent
Public Constants
 ConstantDefined By
  ACTIVEVIEW_CHANGED_EVENT : String = SubscriptionEventActiveviewChanged
[static] The "Activeview" changed in Photoshop
SubscriptionEvent
  ALREADY_SUBSCRIBED : String = SubscriptionEventAlreadySubscribed
[static] Dispatched when a subscription was requested, but the API is already subscribed to that type.
SubscriptionEvent
  BACKGROUND_COLOR_CHANGED_EVENT : String = SubscriptionEventBackgroundColorChanged
[static] The background color was changed in Photoshop
SubscriptionEvent
  COLOR_SETTINGS_CHANGED_EVENT : String = SubscriptionEventColorSettingsChanged
[static] Photoshop's color settings were changed.
SubscriptionEvent
  CURRENTDOCUMENT_CHANGED_EVENT : String = SubscriptionEventCurrentdocumentChanged
[static] The current document was changed in Photoshop
SubscriptionEvent
  DOCUMENT_CHANGED_EVENT : String = SubscriptionEventDocumentChanged
[static] A document was changed in Photoshop
SubscriptionEvent
  DOCUMENT_CLOSED_EVENT : String = SubscriptionEventDocumentClosed
[static] A document was closed in Photoshop
SubscriptionEvent
  DOCUMENTVIEW_CREATED_EVENT : String = SubscriptionEventDocumentviewCreated
[static] A "documentview" was created in Photoshop
SubscriptionEvent
  FOREGROUND_COLOR_CHANGED_EVENT : String = SubscriptionEventForegroundColorChanged
[static] The foreground color was changed in Photoshop
SubscriptionEvent
  KEYBOARD_SHORTCUTS_CHANGED_EVENT : String = SubscriptionEventKeyboardShortcutsChanged
[static] Photoshop's keyboard shortcuts were changed.
SubscriptionEvent
  NOT_SUBSCRIBED : String = SubscriptionEventNotSubscribed
[static] A subscription event was attempted (or a check made for subscription status), and the API isn't subscribed to that type.
SubscriptionEvent
  PREFERENCES_CHANGED_EVENT : String = SubscriptionEventPreferencesChanged
[static] Photoshop's preferences were changed
SubscriptionEvent
  QUICK_MASK_STATE_CHANGED_EVENT : String = SubscriptionEventQuickMaskStateChanged
[static] The user entered or exited Photoshop's quick mask
SubscriptionEvent
  SCREEN_MODE_CHANGED_EVENT : String = SubscriptionEventScreenModeChanged
[static] Photoshop's screen mode (full screen, normal, etc.) was changed.
SubscriptionEvent
  SUBSCRIBED : String = SubscriptionEventSubscribed
[static] Used when a Subcription has been successfully registered.
SubscriptionEvent
  TOOL_CHANGED_EVENT : String = SubscriptionEventToolChanged
[static] The user changed the currently selected tool in Photoshop
SubscriptionEvent
  UNSUBSCRIBED : String = SubscriptionEventUnsubscribed
[static] An unsubscription request was successful.
SubscriptionEvent
Property Detail
dataproperty
public var data:*

Data associated with this event. This will contain any information returned from Photoshop. In some cases this information may contain the document id, a returned color, etc. In other cases, it will simply contain a string returned from Photoshop, reiterating the type of change the occured.

Constructor Detail
SubscriptionEvent()Constructor
public function SubscriptionEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false)

Language Version : ActionScript 3.0
Runtime Versions : AIR 1.0, Flash Player 10

Creates a new SubscriptionEvent.

Parameters
type:String — The Type of SubscriptionEvent
 
bubbles:Boolean (default = false)
 
cancelable:Boolean (default = false)
Constant Detail
ACTIVEVIEW_CHANGED_EVENTConstant
public static const ACTIVEVIEW_CHANGED_EVENT:String = SubscriptionEventActiveviewChanged

Language Version : ActionScript 3.0
Runtime Versions : AIR 1.0, Flash Player 10

The "Activeview" changed in Photoshop

ALREADY_SUBSCRIBEDConstant 
public static const ALREADY_SUBSCRIBED:String = SubscriptionEventAlreadySubscribed

Language Version : ActionScript 3.0
Runtime Versions : AIR 1.0, Flash Player 10

Dispatched when a subscription was requested, but the API is already subscribed to that type.

BACKGROUND_COLOR_CHANGED_EVENTConstant 
public static const BACKGROUND_COLOR_CHANGED_EVENT:String = SubscriptionEventBackgroundColorChanged

Language Version : ActionScript 3.0
Runtime Versions : AIR 1.0, Flash Player 10

The background color was changed in Photoshop

COLOR_SETTINGS_CHANGED_EVENTConstant 
public static const COLOR_SETTINGS_CHANGED_EVENT:String = SubscriptionEventColorSettingsChanged

Language Version : ActionScript 3.0
Runtime Versions : AIR 1.0, Flash Player 10

Photoshop's color settings were changed.

CURRENTDOCUMENT_CHANGED_EVENTConstant 
public static const CURRENTDOCUMENT_CHANGED_EVENT:String = SubscriptionEventCurrentdocumentChanged

Language Version : ActionScript 3.0
Runtime Versions : AIR 1.0, Flash Player 10

The current document was changed in Photoshop

DOCUMENT_CHANGED_EVENTConstant 
public static const DOCUMENT_CHANGED_EVENT:String = SubscriptionEventDocumentChanged

Language Version : ActionScript 3.0
Runtime Versions : AIR 1.0, Flash Player 10

A document was changed in Photoshop

DOCUMENT_CLOSED_EVENTConstant 
public static const DOCUMENT_CLOSED_EVENT:String = SubscriptionEventDocumentClosed

Language Version : ActionScript 3.0
Runtime Versions : AIR 1.0, Flash Player 10

A document was closed in Photoshop

DOCUMENTVIEW_CREATED_EVENTConstant 
public static const DOCUMENTVIEW_CREATED_EVENT:String = SubscriptionEventDocumentviewCreated

Language Version : ActionScript 3.0
Runtime Versions : AIR 1.0, Flash Player 10

A "documentview" was created in Photoshop

FOREGROUND_COLOR_CHANGED_EVENTConstant 
public static const FOREGROUND_COLOR_CHANGED_EVENT:String = SubscriptionEventForegroundColorChanged

Language Version : ActionScript 3.0
Runtime Versions : AIR 1.0, Flash Player 10

The foreground color was changed in Photoshop

KEYBOARD_SHORTCUTS_CHANGED_EVENTConstant 
public static const KEYBOARD_SHORTCUTS_CHANGED_EVENT:String = SubscriptionEventKeyboardShortcutsChanged

Language Version : ActionScript 3.0
Runtime Versions : AIR 1.0, Flash Player 10

Photoshop's keyboard shortcuts were changed.

NOT_SUBSCRIBEDConstant 
public static const NOT_SUBSCRIBED:String = SubscriptionEventNotSubscribed

Language Version : ActionScript 3.0
Runtime Versions : AIR 1.0, Flash Player 10

A subscription event was attempted (or a check made for subscription status), and the API isn't subscribed to that type.

PREFERENCES_CHANGED_EVENTConstant 
public static const PREFERENCES_CHANGED_EVENT:String = SubscriptionEventPreferencesChanged

Language Version : ActionScript 3.0
Runtime Versions : AIR 1.0, Flash Player 10

Photoshop's preferences were changed

QUICK_MASK_STATE_CHANGED_EVENTConstant 
public static const QUICK_MASK_STATE_CHANGED_EVENT:String = SubscriptionEventQuickMaskStateChanged

Language Version : ActionScript 3.0
Runtime Versions : AIR 1.0, Flash Player 10

The user entered or exited Photoshop's quick mask

SCREEN_MODE_CHANGED_EVENTConstant 
public static const SCREEN_MODE_CHANGED_EVENT:String = SubscriptionEventScreenModeChanged

Language Version : ActionScript 3.0
Runtime Versions : AIR 1.0, Flash Player 10

Photoshop's screen mode (full screen, normal, etc.) was changed.

SUBSCRIBEDConstant 
public static const SUBSCRIBED:String = SubscriptionEventSubscribed

Language Version : ActionScript 3.0
Runtime Versions : AIR 1.0, Flash Player 10

Used when a Subcription has been successfully registered.

TOOL_CHANGED_EVENTConstant 
public static const TOOL_CHANGED_EVENT:String = SubscriptionEventToolChanged

Language Version : ActionScript 3.0
Runtime Versions : AIR 1.0, Flash Player 10

The user changed the currently selected tool in Photoshop

UNSUBSCRIBEDConstant 
public static const UNSUBSCRIBED:String = SubscriptionEventUnsubscribed

Language Version : ActionScript 3.0
Runtime Versions : AIR 1.0, Flash Player 10

An unsubscription request was successful.