Packagecom.dwuser.ss4.events
Classpublic class SlideshowEvent
InheritanceSlideshowEvent Inheritance flash.events.Event

The SlideshowEvent class defines the event constants for the events dispatched by a FlashSlideshow instance. Most of these events are dispatched automatically by various internal slideshow elements. However, some events can be dispatched directly by creating a new FlashSlideshowEvent instance, then calling the FlashSlideshow.dispatchEvent() or FlashSlideshow.dispatchSlideshowEvent() method to dispatch it.

Thus, there are two types of events:

Control events can be dispatched in the following manner, using the dispatchSlideshowEvent() method. This example requests the second gallery to be opened:

  // The dispatchSlideshowEvent method has two parameters - the type string, and the extraInfo object
  slideshow.dispatchSlideshowEvent('images_requestGallery', {id:1});
   

See also

com.dwuser.ss4.ui.FlashSlideshow.dispatchEvent
com.dwuser.ss4.ui.FlashSlideshow.dispatchSlideshowEvent
com.dwuser.ss4.ui.FlashSlideshow


Public Properties
 PropertyDefined by
  extraInfo : Object
The holder for all extra detailed information.
SlideshowEvent
  slideshow : FlashSlideshow
The effect instance object for the event.
SlideshowEvent
Public Methods
 MethodDefined by
  
SlideshowEvent(eventType:String, bubbles:Boolean = false, cancelable:Boolean = false, slideshowInstance:FlashSlideshow = null, extraInfo:Object = null)
Constructor.
SlideshowEvent
Public Constants
 ConstantDefined by
  AUDIO_IMAGESOUNDCOMPLETE : String = "audio_imageSoundComplete"
[static] The SlideshowEvent.AUDIO_IMAGESOUNDCOMPLETE constant defines the value of the type property of the event object for a audio_imageSoundComplete event.
SlideshowEvent
  AUDIO_IMAGESOUNDSTART : String = "audio_imageSoundStart"
[static] The SlideshowEvent.AUDIO_IMAGESOUNDSTART constant defines the value of the type property of the event object for a audio_imageSoundStart event.
SlideshowEvent
  AUDIO_LOADPROGRESS : String = "audio_loadProgress"
[static] The SlideshowEvent.AUDIO_LOADPROGRESS constant defines the value of the type property of the event object for a audio_loadProgress event.
SlideshowEvent
  AUDIO_POSITIONUPDATE : String = "audio_positionUpdate"
[static] The SlideshowEvent.AUDIO_POSITIONUPDATE constant defines the value of the type property of the event object for a audio_positionUpdate event.
SlideshowEvent
  AUDIO_SETCONTROLLABEL : String = "audio_setControlLabel"
[static] The SlideshowEvent.AUDIO_SETCONTROLLABEL constant defines the value of the type property of the event object for a audio_setControlLabel event.
SlideshowEvent
  AUDIO_SETPOSITION : String = "audio_setPosition"
[static] The SlideshowEvent.AUDIO_SETPOSITION constant defines the value of the type property of the event object for a audio_setPosition event.
SlideshowEvent
  AUDIO_SETSTATUSPLAYING : String = "audio_setStatusPlaying"
[static] The SlideshowEvent.AUDIO_SETSTATUSPLAYING constant defines the value of the type property of the event object for a audio_setStatusPlaying event.
SlideshowEvent
  AUDIO_SETVOLUME : String = "audio_setVolume"
[static] The SlideshowEvent.AUDIO_SETVOLUME constant defines the value of the type property of the event object for a audio_setVolume event.
SlideshowEvent
  AUDIO_SHOWHIDECONTROLS : String = "audio_showHideControls"
[static] The SlideshowEvent.AUDIO_SHOWHIDECONTROLS constant defines the value of the type property of the event object for a audio_showHideControls event.
SlideshowEvent
  AUDIO_SILENTSTOP : String = "audio_silentStop"
[static] The SlideshowEvent.AUDIO_SILENTSTOP constant defines the value of the type property of the event object for a audio_silentStop event.
SlideshowEvent
  AUDIO_STATUSPLAYINGUPDATE : String = "audio_statusPlayingUpdate"
[static] The SlideshowEvent.AUDIO_STATUSPLAYINGUPDATE constant defines the value of the type property of the event object for a audio_statusPlayingUpdate event.
SlideshowEvent
  AUTOPLAY_ENABLEDISABLE : String = "autoplay_enableDisable"
[static] The SlideshowEvent.AUTOPLAY_ENABLEDISABLE constant defines the value of the type property of the event object for a autoplay_enableDisable event.
SlideshowEvent
  AUTOPLAY_ENABLEDISABLELOOP : String = "autoplay_enableDisableLoop"
[static] The SlideshowEvent.AUTOPLAY_ENABLEDISABLELOOP constant defines the value of the type property of the event object for a autoplay_enableDisableLoop event.
SlideshowEvent
  AUTOPLAY_REMOVECURRENT : String = "autoplay_removeCurrent"
[static] The SlideshowEvent.AUTOPLAY_REMOVECURRENT constant defines the value of the type property of the event object for a autoplay_removeCurrent event.
SlideshowEvent
  AUTOPLAY_TIMEOUTCLEARED : String = "autoplay_timeoutCleared"
[static] The SlideshowEvent.AUTOPLAY_TIMEOUTCLEARED constant defines the value of the type property of the event object for a autoplay_timeoutStarted event.
SlideshowEvent
  AUTOPLAY_TIMEOUTSTARTED : String = "autoplay_timeoutStarted"
[static] The SlideshowEvent.AUTOPLAY_TIMEOUTSTARTED constant defines the value of the type property of the event object for a autoplay_timeoutStarted event.
SlideshowEvent
  DATA_XMLLOADED : String = "data_xmlLoaded"
[static] The SlideshowEvent.DATA_XMLLOADED constant defines the value of the type property of the event object for a data_xmlLoaded event.
SlideshowEvent
  GALLERYITEM_CLICK : String = "galleryItemClick"
[static] The SlideshowEvent.GALLERYITEM_CLICK constant defines the value of the type property of the event object for a galleryItemClick event.
SlideshowEvent
  GALLERYITEM_GALLERYDESELECTED : String = "galleryDeselected"
[static] The SlideshowEvent.GALLERYITEM_GALLERYDESELECTED constant defines the value of the type property of the event object for a galleryDeselected event.
SlideshowEvent
  GALLERYITEM_GALLERYSELECTED : String = "gallerySelected"
[static] The SlideshowEvent.GALLERYITEM_GALLERYSELECTED constant defines the value of the type property of the event object for a gallerySelected event.
SlideshowEvent
  IMAGELIBRARY_ASSETDESTROYED : String = "imageLibrary_assetDestroyed"
[static] The SlideshowEvent.IMAGELIBRARY_ASSETDESTROYED constant defines the value of the type property of the event object for a imageLibrary_assetDestroyed event.
SlideshowEvent
  IMAGELIBRARY_CHECKEDIN : String = "imageLibrary_checkedIn"
[static] The SlideshowEvent.IMAGELIBRARY_CHECKEDIN constant defines the value of the type property of the event object for a imageLibrary_checkedIn event.
SlideshowEvent
  IMAGES_CLOSEGALLERY : String = "images_closeGallery"
[static] The SlideshowEvent.IMAGES_CLOSEGALLERY constant defines the value of the type property of the event object for a images_closeGallery event.
SlideshowEvent
  IMAGE_SETDOMINANTCOLOR : String = "image_setDominantColor"
[static] The SlideshowEvent.IMAGE_SETDOMINANTCOLOR constant defines the value of the type property of the event object for a image_setDominantColor event.
SlideshowEvent
  IMAGES_GALLERYPRELOADCOMPLETE : String = "images_galleryPreloadComplete"
[static] The SlideshowEvent.IMAGES_GALLERYPRELOADCOMPLETE constant defines the value of the type property of the event object for a images_galleryPreloadComplete event.
SlideshowEvent
  IMAGES_JUMPTOGALLERYUNIQID : String = "images_jumpToGalleryUniqueID"
[static] The SlideshowEvent.IMAGES_JUMPTOGALLERYUNIQID constant defines the value of the type property of the event object for a images_jumpToGalleryUniqueID event.
SlideshowEvent
  IMAGES_JUMPTOUNIQID : String = "images_jumpToUniqueID"
[static] The SlideshowEvent.IMAGES_JUMPTOUNIQID constant defines the value of the type property of the event object for a images_jumpToUniqueID event.
SlideshowEvent
  IMAGES_REQUESTGALLERY : String = "images_requestGallery"
[static] The SlideshowEvent.IMAGES_REQUESTGALLERY constant defines the value of the type property of the event object for a images_requestGallery event.
SlideshowEvent
  IMAGES_SETGALLERY : String = "images_setGallery"
[static] The SlideshowEvent.IMAGES_SETGALLERY constant defines the value of the type property of the event object for a images_setGallery event.
SlideshowEvent
  IMAGES_SETGALLERYCOMPLETE : String = "images_setGalleryComplete"
[static] The SlideshowEvent.IMAGES_SETGALLERYCOMPLETE constant defines the value of the type property of the event object for a images_setGalleryComplete event.
SlideshowEvent
  IMAGES_SETIMAGE : String = "images_setImage"
[static] The SlideshowEvent.IMAGES_SETIMAGE constant defines the value of the type property of the event object for a images_setImage event.
SlideshowEvent
  IMAGES_SETIMAGECHANGEABLE : String = "images_setImageChangeable"
[static] The SlideshowEvent.IMAGES_SETIMAGECHANGEABLE constant defines the value of the type property of the event object for a images_setImageChangeable event.
SlideshowEvent
  IMAGES_SYNCIMAGES : String = "images_syncImages"
[static] The SlideshowEvent.IMAGES_SYNCIMAGES constant defines the value of the type property of the event object for a images_syncImages event.
SlideshowEvent
  IMAGES_SYNCIMAGESSTART : String = "images_syncImagesStart"
[static] The SlideshowEvent.IMAGES_SYNCIMAGESSTART constant defines the value of the type property of the event object for a images_syncImagesStart event.
SlideshowEvent
  KB_IMAGEEND : String = "kenBurns_imageEffectEnd"
[static] The SlideshowEvent.KB_IMAGEEND constant defines the value of the type property of the event object for a kenBurns_imageEffectEnd event.
SlideshowEvent
  KB_IMAGESTART : String = "kenBurns_imageEffectStart"
[static] The SlideshowEvent.KB_IMAGESTART constant defines the value of the type property of the event object for a kenBurns_imageEffectStart event.
SlideshowEvent
  LAYOUT_MANAGERREADY : String = "layout_managerReady"
[static] The SlideshowEvent.LAYOUT_MANAGERREADY constant defines the value of the type property of the event object for a layout_managerReady event.
SlideshowEvent
  LAYOUT_REQUESTCHANGE : String = "layout_changeRequested"
[static] The SlideshowEvent.LAYOUT_REQUESTCHANGE constant defines the value of the type property of the event object for a layout_changeRequested event.
SlideshowEvent
  LAYOUT_SETWRITABLE : String = "layout_setWritable"
[static] The SlideshowEvent.LAYOUT_SETWRITABLE constant defines the value of the type property of the event object for a layout_setWritable event.
SlideshowEvent
  LAYOUT_VIEWREADY : String = "layout_viewReady"
[static] The SlideshowEvent.LAYOUT_VIEWREADY constant defines the value of the type property of the event object for a layout_viewReady event.
SlideshowEvent
  LOADER_SETGROUPPROGRESS : String = "loader_setGroupProgress"
[static] The SlideshowEvent.LOADER_SETGROUPPROGRESS constant defines the value of the type property of the event object for a loader_setGroupProgress event.
SlideshowEvent
  LOADER_SETSINGLEPROGRESS : String = "loader_setSingleProgress"
[static] The SlideshowEvent.LOADER_SETSINGLEPROGRESS constant defines the value of the type property of the event object for a loader_setSingleProgress event.
SlideshowEvent
  LOADER_SHOWGROUP : String = "loader_showGroupLoader"
[static] The SlideshowEvent.LOADER_SHOWGROUP constant defines the value of the type property of the event object for a loader_showGroupLoader event.
SlideshowEvent
  LOADER_SHOWSINGLE : String = "loader_showSingleLoader"
[static] The SlideshowEvent.LOADER_SHOWSINGLE constant defines the value of the type property of the event object for a loader_showSingleLoader event.
SlideshowEvent
  VIDEO_IMAGEVIDEOCOMPLETE : String = "video_imageVideoComplete"
[static] The SlideshowEvent.VIDEO_IMAGEVIDEOCOMPLETE constant defines the value of the type property of the event object for a video_imageVideoComplete event.
SlideshowEvent
  VIDEO_IMAGEVIDEOSTART : String = "video_imageVideoStart"
[static] The SlideshowEvent.VIDEO_IMAGEVIDEOSTART constant defines the value of the type property of the event object for a video_imageVideoStart event.
SlideshowEvent
  VIDEO_STOPALL : String = "video_stopAll"
[static] The SlideshowEvent.VIDEO_STOPALL constant defines the value of the type property of the event object for a video_stopAll event.
SlideshowEvent
Property detail
extraInfoproperty
public var extraInfo:Object

The holder for all extra detailed information. Most dispatched SlideshowEvent instances define extra values in the extraInfo property, including the sub-element which actually dispatched the event. This property will also contain all event-specific parameters, such as image information on a IMAGES_SYNCIMAGES event.

slideshowproperty 
public var slideshow:FlashSlideshow

The effect instance object for the event. You can use this property to access the properties of the slideshow instance object from within your event listener.

Constructor detail
SlideshowEvent()constructor
public function SlideshowEvent(eventType:String, bubbles:Boolean = false, cancelable:Boolean = false, slideshowInstance:FlashSlideshow = null, extraInfo:Object = null)

Constructor.

Parameters
eventType:String — The event type; indicates the action that caused the event.
 
bubbles:Boolean (default = false) — Specifies whether the event can bubble up the display list hierarchy.
 
cancelable:Boolean (default = false) — Specifies whether the behavior associated with the event can be prevented.
 
slideshowInstance:FlashSlideshow (default = null) — The effect instance that triggered the event.
 
extraInfo:Object (default = null)
Constant detail
AUDIO_IMAGESOUNDCOMPLETEconstant
public static const AUDIO_IMAGESOUNDCOMPLETE:String = "audio_imageSoundComplete"

The SlideshowEvent.AUDIO_IMAGESOUNDCOMPLETE constant defines the value of the type property of the event object for a audio_imageSoundComplete event.

Dispatched automatically by the FlashSlideshow instance whenever the audio associated with an image finishes playing.

Event type: Notification-only (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Always Present
level A string value of 'image' Yes
id The associated image's ID number Yes
image The associated image's XML descriptor node Yes

See also

AUDIO_IMAGESOUNDSTARTconstant 
public static const AUDIO_IMAGESOUNDSTART:String = "audio_imageSoundStart"

The SlideshowEvent.AUDIO_IMAGESOUNDSTART constant defines the value of the type property of the event object for a audio_imageSoundStart event.

Dispatched automatically by the FlashSlideshow instance whenever the audio associated with an image automatically starts to play.

Event type: Notification-only (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Always Present
id The associated image's ID number Yes
image The associated image's XML descriptor node Yes

See also

AUDIO_LOADPROGRESSconstant 
public static const AUDIO_LOADPROGRESS:String = "audio_loadProgress"

The SlideshowEvent.AUDIO_LOADPROGRESS constant defines the value of the type property of the event object for a audio_loadProgress event.

Dispatched automatically by the FlashSlideshow instance whenever audio loading progress occurs.

Event type: Notification-only (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Always Present
level A string value specifying which audio level this event is associated with - "intro", "gallery", or "image". Yes
value The percentage loaded, as a value between 0 and 1. Yes

See also

AUDIO_POSITIONUPDATEconstant 
public static const AUDIO_POSITIONUPDATE:String = "audio_positionUpdate"

The SlideshowEvent.AUDIO_POSITIONUPDATE constant defines the value of the type property of the event object for a audio_positionUpdate event.

Dispatched automatically by the FlashSlideshow instance whenever the 'playhead' position changes for an audio file. This event is dispatched frequently, so use handlers judiciously.

Event type: Notification-only (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Always Present
level A string value specifying which audio level this event is associated with - "intro", "gallery", or "image". Yes
position The position, in milliseconds, of the playhead in the audio file. Yes
duration The calculated duration of the sound file in milliseconds. Until the file finishes loading, this value won't be totally accurate. Yes
loaded The loaded duration of the audio file in milliseconds; once the file has fully loaded, this will be the actual full length. Yes

See also

AUDIO_SETCONTROLLABELconstant 
public static const AUDIO_SETCONTROLLABEL:String = "audio_setControlLabel"

The SlideshowEvent.AUDIO_SETCONTROLLABEL constant defines the value of the type property of the event object for a audio_setControlLabel event.

Dispatched automatically by the FlashSlideshow instance whenever a new audio file is opened for a certain level. It includes the Audio Label associated with the audio file, allowing status text to be updated.

Event type: Notification-only (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Always Present
level A string value specifying which audio level this event is associated with - "intro", "gallery", or "image". Yes
value String; the new Audio Label for the audio file (or an empty string if none exists). Yes

See also

AUDIO_SETPOSITIONconstant 
public static const AUDIO_SETPOSITION:String = "audio_setPosition"

The SlideshowEvent.AUDIO_SETPOSITION constant defines the value of the type property of the event object for a audio_setPosition event.

Dispatching this event sets the playhead position on any audio on the specified level.

Event type: Control event (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Required when dispatching
level A string value specifying which audio level this event is associated with - "intro", "gallery", or "image". Yes
value Number; a value, in milliseconds, of where the playhead should be moved to. Yes

See also

AUDIO_SETSTATUSPLAYINGconstant 
public static const AUDIO_SETSTATUSPLAYING:String = "audio_setStatusPlaying"

The SlideshowEvent.AUDIO_SETSTATUSPLAYING constant defines the value of the type property of the event object for a audio_setStatusPlaying event.

Dispatching this event plays or pauses any audio on the specified level.

Event type: Control event (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Required when dispatching
level A string value specifying which audio level this event is associated with - "intro", "gallery", or "image". Yes
value Boolean; specifies whether the audio file should be playing (set to false to pause the audio, true to play it). Yes

See also

AUDIO_SETVOLUMEconstant 
public static const AUDIO_SETVOLUME:String = "audio_setVolume"

The SlideshowEvent.AUDIO_SETVOLUME constant defines the value of the type property of the event object for a audio_setVolume event.

Dispatching this event changes the volume of all audio on the slideshow.

Event type: Control event (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Required when dispatching
value Number. Determines the new volume; valid values range from 0 (muted) to 100 (full volume). Yes

See also

AUDIO_SHOWHIDECONTROLSconstant 
public static const AUDIO_SHOWHIDECONTROLS:String = "audio_showHideControls"

The SlideshowEvent.AUDIO_SHOWHIDECONTROLS constant defines the value of the type property of the event object for a audio_showHideControls event.

Dispatched automatically by the FlashSlideshow instance whenever audio controls for a certain level should be revealed or hidden. This allows handlers to show the controls when there is an audio file to control, and hide them when there is no audio to control.

Event type: Notification-only (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Always Present
level A string value specifying which audio level this event is associated with - "intro", "gallery", or "image". Yes
value Boolean; whether or not the controls should be visible. Yes

See also

AUDIO_SILENTSTOPconstant 
public static const AUDIO_SILENTSTOP:String = "audio_silentStop"

The SlideshowEvent.AUDIO_SILENTSTOP constant defines the value of the type property of the event object for a audio_silentStop event.

Dispatching this event temporarily pauses any audio on the specified level. This is dispatched during scrub operations, to temporarily pause the audio while the scrubbing takes place. Once the scrub completes and an audio_setPosition event is dispatched, the audio will resume playing.

Event type: Control event (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Required when dispatching
level A string value specifying which audio level this event is associated with - "intro", "gallery", or "image". Yes

See also

AUDIO_STATUSPLAYINGUPDATEconstant 
public static const AUDIO_STATUSPLAYINGUPDATE:String = "audio_statusPlayingUpdate"

The SlideshowEvent.AUDIO_STATUSPLAYINGUPDATE constant defines the value of the type property of the event object for a audio_statusPlayingUpdate event.

Dispatched automatically by the FlashSlideshow instance whenever an audio file is played or paused (when its "playing" status changes).

Event type: Notification-only (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Always Present
level A string value specifying which audio level this event is associated with - "intro", "gallery", or "image". Yes
value Boolean; whether or not the audio is playing. Yes

See also

AUTOPLAY_ENABLEDISABLEconstant 
public static const AUTOPLAY_ENABLEDISABLE:String = "autoplay_enableDisable"

The SlideshowEvent.AUTOPLAY_ENABLEDISABLE constant defines the value of the type property of the event object for a autoplay_enableDisable event.

Dispatching this event enables or disables autoplay for the slideshow based on the value parameter.

Event type: Control event (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Required when dispatching
value Boolean; specifies if the autoplay should be enabled. A value of true indicates that autoplay should be enabled/playing; false indicates it should be disabled/paused. Yes

See also

AUTOPLAY_ENABLEDISABLELOOPconstant 
public static const AUTOPLAY_ENABLEDISABLELOOP:String = "autoplay_enableDisableLoop"

The SlideshowEvent.AUTOPLAY_ENABLEDISABLELOOP constant defines the value of the type property of the event object for a autoplay_enableDisableLoop event.

Dispatching this event enables or disables autoplay looping for the slideshow based on the value parameter.

Event type: Control event (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Required when dispatching
value Boolean; specifies if the autoplay looping should be enabled. A value of true indicates that looping should be enabled; false indicates it should be disabled. Yes

See also

AUTOPLAY_REMOVECURRENTconstant 
public static const AUTOPLAY_REMOVECURRENT:String = "autoplay_removeCurrent"

The SlideshowEvent.AUTOPLAY_REMOVECURRENT constant defines the value of the type property of the event object for a autoplay_removeCurrent event.

Dispatching this event removes any current autoplay timer which is counting down. It does not actually pause the autoplay, but effectively pauses it until a new IMAGES_SYNCIMAGES takes place.

Event type: Control event (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Required when dispatching
(None)

See also

AUTOPLAY_TIMEOUTCLEAREDconstant 
public static const AUTOPLAY_TIMEOUTCLEARED:String = "autoplay_timeoutCleared"

The SlideshowEvent.AUTOPLAY_TIMEOUTCLEARED constant defines the value of the type property of the event object for a autoplay_timeoutStarted event.

Dispatched automatically by the FlashSlideshow instance whenever the autoplay timer is stopped or reset for some reason.

Event type: Notification-only (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Always Present
target A reference to the main AutoplayManager instance which is sending the event. Yes

See also

AUTOPLAY_TIMEOUTSTARTEDconstant 
public static const AUTOPLAY_TIMEOUTSTARTED:String = "autoplay_timeoutStarted"

The SlideshowEvent.AUTOPLAY_TIMEOUTSTARTED constant defines the value of the type property of the event object for a autoplay_timeoutStarted event.

Dispatched automatically by the FlashSlideshow instance when a new autoplay timer begins to count down. For example, this event is used by the AutoplayProgressDisplay element to display the countdown progress circle.

Event type: Notification-only (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Always Present
target A reference to the main AutoplayManager instance which is sending the event. Yes
value Number; the length, in milliseconds, of the timer which was just started. Yes

See also

DATA_XMLLOADEDconstant 
public static const DATA_XMLLOADED:String = "data_xmlLoaded"

The SlideshowEvent.DATA_XMLLOADED constant defines the value of the type property of the event object for a data_xmlLoaded event.

Dispatched automatically by the FlashSlideshow instance when all external XML data has been loaded. It is a notification-only event; the slideshow has no default handler for this event.

Event type: Notification-only (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Always Present
(None)

See also

GALLERYITEM_CLICKconstant 
public static const GALLERYITEM_CLICK:String = "galleryItemClick"

The SlideshowEvent.GALLERYITEM_CLICK constant defines the value of the type property of the event object for a galleryItemClick event.

Dispatched automatically by a GallerySelector element instance when an item in it is clicked. To create a custom handler for this event, add a listener for the event on the actual GallerySelector element; see the GallerySelector class for more information.

By default, the built-in handler on the GallerySelector handles the event, opening the corresponding gallery and, if the hideOnSelection style parameter is set to true, hiding the GallerySelector element. If you wish to prevent the default handler from processing the event, add a custom listener and call the preventDefault() method on the event. For example:

      // Normally, a custom action would follow the preventDefault() call:
      <GallerySelector ... event_galleryItemClick="event.preventDefault();" />
      

Event type: on-globalNotification-only (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Always Present
id The associated gallery's ID index number. This can be used to dispatch a IMAGES_REQUESTGALLERY control event to open the corresponding gallery. Yes

See also

GALLERYITEM_GALLERYDESELECTEDconstant 
public static const GALLERYITEM_GALLERYDESELECTED:String = "galleryDeselected"

The SlideshowEvent.GALLERYITEM_GALLERYDESELECTED constant defines the value of the type property of the event object for a galleryDeselected event.

Dispatched automatically by an item in a GallerySelector instance whenever it becomes one of the deselected galleries. The event must be handled on the actual gallery selector item instance. See the GallerySelector class for more information.

Event type: on-globalNotification-only (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Always Present
(None)

See also

GALLERYITEM_GALLERYSELECTEDconstant 
public static const GALLERYITEM_GALLERYSELECTED:String = "gallerySelected"

The SlideshowEvent.GALLERYITEM_GALLERYSELECTED constant defines the value of the type property of the event object for a gallerySelected event.

Dispatched automatically by an item in a GallerySelector instance whenever it becomes the selected gallery.

Event type: on-globalNotification-only (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Always Present
(None)

See also

IMAGELIBRARY_ASSETDESTROYEDconstant 
public static const IMAGELIBRARY_ASSETDESTROYED:String = "imageLibrary_assetDestroyed"

The SlideshowEvent.IMAGELIBRARY_ASSETDESTROYED constant defines the value of the type property of the event object for a imageLibrary_assetDestroyed event.

Dispatched automatically by the FlashSlideshow instance whenever an asset is removed from the ImageLibrary asset repository and destroyed. This means that it is no longer available for being checked out.

Event type: Notification-only (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Always Present
url String; the URL of the just-destroyed asset. Yes

See also

SlideshowEvent
com.dwuser.ss4.managers.ImageLibrary
IMAGELIBRARY_CHECKEDINconstant 
public static const IMAGELIBRARY_CHECKEDIN:String = "imageLibrary_checkedIn"

The SlideshowEvent.IMAGELIBRARY_CHECKEDIN constant defines the value of the type property of the event object for a imageLibrary_checkedIn event.

Dispatched automatically by the FlashSlideshow instance whenever an asset is checked into the ImageLibrary asset repository (usually because it was just loaded). This means that it is then available for being checked out.

Event type: Notification-only (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Always Present
url String; the URL of the just-checked-in asset which has been loaded. Yes

See also

SlideshowEvent
com.dwuser.ss4.managers.ImageLibrary
IMAGES_CLOSEGALLERYconstant 
public static const IMAGES_CLOSEGALLERY:String = "images_closeGallery"

The SlideshowEvent.IMAGES_CLOSEGALLERY constant defines the value of the type property of the event object for a images_closeGallery event.

Dispatching this event causes any currently-open gallery to be explicitly closed. If you wish to open a new gallery, it is unnecessary to dispatch this control event; instead, the IMAGES_REQUESTGALLERY control event can be dispatched directly and it will close any current gallery before opening the new one.

Event type: Control event (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Required when dispatching
(None)

See also

IMAGE_SETDOMINANTCOLORconstant 
public static const IMAGE_SETDOMINANTCOLOR:String = "image_setDominantColor"

The SlideshowEvent.IMAGE_SETDOMINANTCOLOR constant defines the value of the type property of the event object for a image_setDominantColor event.

Dispatched automatically by the FlashSlideshow instance when a new slide is created, notifying of the new image's dominant color. This can be used to update other elements based on the current image's dominant color. This event only works properly when using a layout with a single-image-at-one-time display such as the ImagesStandard display element. Instead of using this notification element, you can also use the following property (which is also bindable, and a better all-around choice):

slideshow.currentDelayedSyncSlide.dominantColor       ...OR...

slideshow.currentDelayedSyncSlide.dominantColorDark

For more information about the dominantColor and dominantColorDark properties, see the IndividualSlide class reference.

Event type: Notification-only (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Always Present
slide A reference to the new slide (an IndividualSlide instance) associated with the event. Can be used, for example, to retrieve the IndividualSlide.dominantColorDark property. Yes
id The associated image's ID number Yes
image The associated image's XML descriptor node Yes
value Numerical color value; specifies the dominant color of the new slide reference. Yes

See also

IMAGES_GALLERYPRELOADCOMPLETEconstant 
public static const IMAGES_GALLERYPRELOADCOMPLETE:String = "images_galleryPreloadComplete"

The SlideshowEvent.IMAGES_GALLERYPRELOADCOMPLETE constant defines the value of the type property of the event object for a images_galleryPreloadComplete event.

Dispatched automatically by the FlashSlideshow instance when a group preload completes. Group preloads are preloading operations which, based on the ImageManager.preloadMode used, may occur when a gallery is opened. This is usually the preload of all images or thumbnails in a gallery.

Event type: Notification-only (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Always Present
target A reference to the ImageManager instance dispatching the event. Yes

See also

IMAGES_JUMPTOGALLERYUNIQIDconstant 
public static const IMAGES_JUMPTOGALLERYUNIQID:String = "images_jumpToGalleryUniqueID"

The SlideshowEvent.IMAGES_JUMPTOGALLERYUNIQID constant defines the value of the type property of the event object for a images_jumpToGalleryUniqueID event.

Dispatching this event requests a new specific gallery to be opened, based on the passed id Gallery UniqueID parameter. This id parameter should be in the following format: gallery_0 where the number is the 0-base index of the gallery. Thus the above example would open the first gallery.

Event type: Control event (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Required when dispatching
id String Gallery UniqueID value, e.g. gallery_0 . See above for more information. Yes

See also

IMAGES_JUMPTOUNIQIDconstant 
public static const IMAGES_JUMPTOUNIQID:String = "images_jumpToUniqueID"

The SlideshowEvent.IMAGES_JUMPTOUNIQID constant defines the value of the type property of the event object for a images_jumpToUniqueID event.

Dispatching this event requests a new specific image to be opened (and its corresponding gallery if not already open), based on the passed id Image UniqueID parameter. This id parameter should be in the following format: img_0_5 where the first number is the 0-base index of the gallery and the second number is the 0-base index of the image within the gallery. Thus the above example would open the sixth image in the first gallery.

Event type: Control event (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Required when dispatching
id String Image UniqueID value, e.g. img_0_5 . See above for more information. Yes

See also

IMAGES_REQUESTGALLERYconstant 
public static const IMAGES_REQUESTGALLERY:String = "images_requestGallery"

The SlideshowEvent.IMAGES_REQUESTGALLERY constant defines the value of the type property of the event object for a images_requestGallery event.

Dispatching this event requests a new specific gallery to be opened, based on the passed id gallery-index parameter. If a gallery requested via this event has a password, a password prompt will be displayed. It differs from IMAGES_SETGALLERY in that IMAGES_SETGALLERY immediately opens a gallery without any further validation or authentication.

Event type: Control event (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Required when dispatching
id The 0-base index value of the new gallery which is being requested. Yes
gallery Optional; a reference to the actual associated <gallery> XML node. If not specified, the slideshow automatically retrieves this value based on the id value. No

See also

IMAGES_SETGALLERYconstant 
public static const IMAGES_SETGALLERY:String = "images_setGallery"

The SlideshowEvent.IMAGES_SETGALLERY constant defines the value of the type property of the event object for a images_setGallery event.

Dispatching this event requests a new specific gallery to be opened, based on the passed id gallery-index parameter. It differs from IMAGES_REQUESTGALLERY in that IMAGES_SETGALLERY immediately opens a gallery without any further validation or authentication, even if a gallery password exists. It is strongly recommended that IMAGES_REQUESTGALLERY is used instead.

Event type: Control event (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Required when dispatching
id The 0-base index value of the new gallery which is being requested. Yes
gallery Optional; a reference to the actual associated gallery XML node. If not specified, the slideshow automatically retrieves this value based on the id value. No

See also

IMAGES_SETGALLERYCOMPLETEconstant 
public static const IMAGES_SETGALLERYCOMPLETE:String = "images_setGalleryComplete"

The SlideshowEvent.IMAGES_SETGALLERYCOMPLETE constant defines the value of the type property of the event object for a images_setGalleryComplete event.

Dispatched automatically by the FlashSlideshow instance when a new gallery has successfully been opened.

Event type: Notification-only (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Always Present
target A reference to the ImageManager instance dispatching the event. Yes

See also

IMAGES_SETIMAGEconstant 
public static const IMAGES_SETIMAGE:String = "images_setImage"

The SlideshowEvent.IMAGES_SETIMAGE constant defines the value of the type property of the event object for a images_setImage event.

Dispatching this event requests a new specific image to be opened, based on the passed id image-index and image XML node referece parameters. It is the image equivalent of IMAGES_REQUESTGALLERY. It is generally much easier to use the IMAGES_JUMPTOUNIQID control event instead.

Event type: Control event (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Required when dispatching
checkForNewImage Boolean; default is true. Specifies whether the ImageManager should make sure that this is a new image, or (re)open it regardless of whether it is already the currently-synced image. No
id The 0-base index value of the new image which is being requested. Yes
image A reference to the actual associated <img ... /> image XML node. Yes

See also

IMAGES_SETIMAGECHANGEABLEconstant 
public static const IMAGES_SETIMAGECHANGEABLE:String = "images_setImageChangeable"

The SlideshowEvent.IMAGES_SETIMAGECHANGEABLE constant defines the value of the type property of the event object for a images_setImageChangeable event.

Dispatched automatically by the FlashSlideshow instance whenever an image "lock" is applied or removed. An image lock means that the image cannot currently be changed (by a IMAGES_SETIMAGE control event, for example), because some task is currently taking place. These tasks could include a group preload (which means that the preload must finish before an image is opened), or, if ImagesStandardTransition.lockImages is enabled, an image/slide transition.

Event type: Notification-only (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Always Present
value Boolean; specifies if the images are changeable. If true, the images are changeable/unlocked. If false, the images are unchangeable/locked. Yes

See also

IMAGES_SYNCIMAGESconstant 
public static const IMAGES_SYNCIMAGES:String = "images_syncImages"

The SlideshowEvent.IMAGES_SYNCIMAGES constant defines the value of the type property of the event object for a images_syncImages event.

Dispatched automatically by the FlashSlideshow instance when a new slide has opened. This event differs from IMAGES_SYNCIMAGESSTART in that it is dispatched at the end of the slide transition instead of the beginning.

Event type: Notification-only (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Always Present
target A reference to the image display instance (such as an ImagesStandard instance) dispatching the event. Yes
slideRef A reference to the new slide (an IndividualSlide instance) associated with the event. Yes
id The associated image's ID number Yes
image The associated image's XML descriptor node Yes

See also

IMAGES_SYNCIMAGESSTARTconstant 
public static const IMAGES_SYNCIMAGESSTART:String = "images_syncImagesStart"

The SlideshowEvent.IMAGES_SYNCIMAGESSTART constant defines the value of the type property of the event object for a images_syncImagesStart event.

Dispatched automatically by the FlashSlideshow instance when a new slide starts to open. This event differs from IMAGES_SYNCIMAGES in that it is dispatched at the beginning of the slide transition instead of the end.

Event type: Notification-only (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Always Present
target A reference to the image display instance (such as an ImagesStandard instance) dispatching the event. Yes
slideRef A reference to the new slide (an IndividualSlide instance) associated with the event. Yes
id The associated image's ID number Yes
image The associated image's XML descriptor node Yes

See also

KB_IMAGEENDconstant 
public static const KB_IMAGEEND:String = "kenBurns_imageEffectEnd"

The SlideshowEvent.KB_IMAGEEND constant defines the value of the type property of the event object for a kenBurns_imageEffectEnd event.

Dispatched automatically by the FlashSlideshow instance whenever the Ken Burns (kb) effect associated with an image finishes playing. For example, this event is used to trigger autoplay progress which is linked with a delay value of kbComplete.

Event type: Notification-only (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Always Present
target A reference to the IndividualSlide instance dispatching the event. Yes
id The associated image's ID index number Yes
image The associated image's XML descriptor node Yes

See also

KB_IMAGESTARTconstant 
public static const KB_IMAGESTART:String = "kenBurns_imageEffectStart"

The SlideshowEvent.KB_IMAGESTART constant defines the value of the type property of the event object for a kenBurns_imageEffectStart event.

Dispatched automatically by the FlashSlideshow instance whenever the Ken Burns (kb) effect associated with an image starts playing. Note - based on the IndividualSlide.startKBEffectEarly parameter, this event may be dispatched twice for each slide.

Event type: Notification-only (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Always Present
target A reference to the IndividualSlide instance dispatching the event. Yes
id The associated image's ID index number Yes
image The associated image's XML descriptor node Yes

See also

LAYOUT_MANAGERREADYconstant 
public static const LAYOUT_MANAGERREADY:String = "layout_managerReady"

The SlideshowEvent.LAYOUT_MANAGERREADY constant defines the value of the type property of the event object for a layout_managerReady event.

Dispatched automatically by the FlashSlideshow instance when the LayoutManager finishes initializing and the the initial view has been opened. This event essentially notifies that the user interface is ready to use.

Event type: Notification-only (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Always Present
target A reference to the main LayoutManager instance which is dispatching the event. Yes

See also

LAYOUT_REQUESTCHANGEconstant 
public static const LAYOUT_REQUESTCHANGE:String = "layout_changeRequested"

The SlideshowEvent.LAYOUT_REQUESTCHANGE constant defines the value of the type property of the event object for a layout_changeRequested event.

Dispatching this event requests a new specific layout view to be opened, based on the passed id parameter. The id value should map to a <view id="someIdValue" ... > tag in the Layout XML in the configuration XML file.

Event type: Control event (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Required when dispatching
id The ID value of the new view which is being requested. This must map to a <view id="someIdValue" ... > tag in the Layout XML in the configuration XML file. Yes

See also

LAYOUT_SETWRITABLEconstant 
public static const LAYOUT_SETWRITABLE:String = "layout_setWritable"

The SlideshowEvent.LAYOUT_SETWRITABLE constant defines the value of the type property of the event object for a layout_setWritable event.

If LayoutTransition.lockLayout is enabled, dispatched automatically by the FlashSlideshow instance when the LayoutManager locks or unlocks the layout. A layout "lock" means that the layout cannot be changed to a different view, usually because a view transition is currently in progress.

Event type: Notification-only (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Always Present
value Boolean; specifies if the layout is writable. If true, the layout is writable/unlocked. If false, the layout is unwritable/locked. Yes

See also

LAYOUT_VIEWREADYconstant 
public static const LAYOUT_VIEWREADY:String = "layout_viewReady"

The SlideshowEvent.LAYOUT_VIEWREADY constant defines the value of the type property of the event object for a layout_viewReady event.

Dispatched automatically by the FlashSlideshow instance when a new layout view has been opened.

Event type: Notification-only (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Always Present
target A reference to the main LayoutManager instance which is dispatching the event. Yes
view A reference to the new view's associated Canvas. Yes
currentViewID String; the ID value of the new layout view. Yes

See also

LOADER_SETGROUPPROGRESSconstant 
public static const LOADER_SETGROUPPROGRESS:String = "loader_setGroupProgress"

The SlideshowEvent.LOADER_SETGROUPPROGRESS constant defines the value of the type property of the event object for a loader_setGroupProgress event.

Dispatched automatically by the FlashSlideshow instance whenever group load progress takes place and the progress needs to be updated. Group preloads include loads such as the loading of all images or thumbnails in a gallery. This event, for example, controls the progress displayed on the GroupLoader element.

Event type: Notification-only (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Always Present
target A reference to the main ImageManager instance which is sending the event. Yes
progressPercent Number; specifies the loading progress percentage, as a value between 0 and 100. Yes

See also

LOADER_SETSINGLEPROGRESSconstant 
public static const LOADER_SETSINGLEPROGRESS:String = "loader_setSingleProgress"

The SlideshowEvent.LOADER_SETSINGLEPROGRESS constant defines the value of the type property of the event object for a loader_setSingleProgress event.

Dispatched automatically by the FlashSlideshow instance whenever single load progress takes place and the progress needs to be updated. Single loads are the loads which take place when a single image is loaded. This event, for example, controls the progress displayed on the SingleLoader element.

Event type: Notification-only (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Always Present
target A reference to the main ImageManager instance which is sending the event. Yes
progressPercent Number; specifies the loading progress percentage, as a value between 0 and 100. Yes

See also

LOADER_SHOWGROUPconstant 
public static const LOADER_SHOWGROUP:String = "loader_showGroupLoader"

The SlideshowEvent.LOADER_SHOWGROUP constant defines the value of the type property of the event object for a loader_showGroupLoader event.

Dispatched automatically by the FlashSlideshow instance whenever the group loader should be shown or hidden (based on the value parameter). The group loader is the loader shown while group preloads take place, such as the loading of all images or thumbnails in a gallery. This event, for example, controls the visibility of the GroupLoader element.

Event type: Notification-only (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Always Present
target A reference to the main ImageManager instance which is sending the event. Yes
value Boolean; specifies if the loader should be shown (true), or hidden (false). Yes

See also

LOADER_SHOWSINGLEconstant 
public static const LOADER_SHOWSINGLE:String = "loader_showSingleLoader"

The SlideshowEvent.LOADER_SHOWSINGLE constant defines the value of the type property of the event object for a loader_showSingleLoader event.

Dispatched automatically by the FlashSlideshow instance whenever the single loader should be shown or hidden (based on the value parameter). The single loader is the loader shown while a single image load takes place. This event, for example, controls the visibility of the SingleLoader element.

Event type: Notification-only (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Always Present
target A reference to the main ImageManager instance which is sending the event. Yes
value Boolean; specifies if the loader should be shown (true), or hidden (false). Yes

See also

VIDEO_IMAGEVIDEOCOMPLETEconstant 
public static const VIDEO_IMAGEVIDEOCOMPLETE:String = "video_imageVideoComplete"

The SlideshowEvent.VIDEO_IMAGEVIDEOCOMPLETE constant defines the value of the type property of the event object for a video_imageVideoComplete event.

Dispatched automatically by the FlashSlideshow instance whenever the video associated with an image finishes playing.

Event type: Notification-only (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Always Present
slide A reference to the IndividualSlide instance dispatching the event. Yes
value Boolean value of true. Yes
id The associated image's ID number Yes
image The associated image's XML descriptor node Yes

See also

VIDEO_IMAGEVIDEOSTARTconstant 
public static const VIDEO_IMAGEVIDEOSTART:String = "video_imageVideoStart"

The SlideshowEvent.VIDEO_IMAGEVIDEOSTART constant defines the value of the type property of the event object for a video_imageVideoStart event.

Dispatched automatically by the FlashSlideshow instance whenever the video associated with an image starts to buffer or play. This event may be dispatched multiple times; it is designed to provide a notification that video exists and is being played.

Event type: Notification-only (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Always Present
slide A reference to the IndividualSlide instance dispatching the event. Yes
value Boolean value of true. Yes
id The associated image's ID number Yes
image The associated image's XML descriptor node Yes

See also

VIDEO_STOPALLconstant 
public static const VIDEO_STOPALL:String = "video_stopAll"

The SlideshowEvent.VIDEO_STOPALL constant defines the value of the type property of the event object for a video_stopAll event.

Dispatching this event stops any image-associated video which is currently playing.

Event type: Control event (see SlideshowEvent class description for more information)

The extraInfo parameter on the event has the following parameters:

Property Description Required when dispatching
(None)

See also