com.dwuser.ss4.ui.FlashSlideshow

Public Properties

	Property		Defined by
		activeEffects : Array The list of effects that are currently playing on the component, as an Array of EffectInstance instances.	UIComponent
		autoLayout : Boolean If `true`, measurement and layout are done when the position or size of a child is changed.	Container
		automationDelegate : Object The delegate object that handles the automation-related functionality.	UIComponent
		automationName : String Name that can be used as an identifier for this object.	UIComponent
		automationTabularData : Object An implementation of the `IAutomationTabularData` interface, which can be used to retrieve the data.	UIComponent
		automationValue : Array This value generally corresponds to the rendered appearance of the object and should be usable for correlating the identifier with the object as it appears visually within the application.	UIComponent
		autoplayEnabled : Boolean = false This utility flag specifies if the slideshow is currently in autoplay mode (toggled through the PlayPauseButton or AutoplayToggleButton elements) or not.	FlashSlideshow
		autoplayManager : AutoplayManager Provides a reference to the main `AutoplayManager` instance, which manages the autoplay and provide current status information.	FlashSlideshow
		autoplayNotEnabled : Boolean = true This utility flag specifies if the slideshow is currently NOT in autoplay mode (toggled through the PlayPauseButton or AutoplayToggleButton elements).	FlashSlideshow
		baselinePosition : Number The y-coordinate of the baseline of the first line of text of the component.	UIComponent
		borderMetrics : EdgeMetrics Returns an EdgeMetrics object that has four properties: `left`, `top`, `right`, and `bottom`.	Container
		cacheHeuristic : Boolean Used by Flex to suggest bitmap caching for the object.	UIComponent
		cachePolicy : String Specifies the bitmap caching policy for this object.	UIComponent
		childDescriptors : Array Array of UIComponentDescriptor objects produced by the MXML compiler.	Container
		className : String The name of this instance's class, such as `"Button"`.	UIComponent
		clipContent : Boolean Whether to apply a clip mask if the positions and/or sizes of this container's children extend outside the borders of this container.	Container
		configurationParameters : FlashSlideshowConfigurationParameters When creating a component-based slideshow implementation, the `configurationParameters` object specifies all of the initial configuration information.	FlashSlideshow
		constraintColumns : Array An Array of ConstraintColumn instances that partition this container.	Canvas
		constraintRows : Array An Array of ConstraintRow instances that partition this container.	Canvas
		contentMouseX : Number Returns the x position of the mouse, in the content coordinate system.	Container
		contentMouseY : Number Returns the y position of the mouse, in the content coordinate system.	Container
		creatingContentPane : Boolean Containers use an internal content pane to control scrolling.	Container
		creationIndex : int Specifies the order to instantiate and draw the children of the container.	Container
		creationPolicy : String The child creation policy for this Container.	Container
		currentDelayedSyncSlide : IndividualSlide A reference to the currently displayed slide; this reference updates after a delay following the transition to the slide starting.	FlashSlideshow
		currentDelayedSyncSlideExists : Boolean = false This utility flag specifies if a `currentDelayedSyncSlide` value currently exists or not.	FlashSlideshow
		currentDelayedSyncSlideNotExists : Boolean = true This utility flag specifies if a `currentDelayedSyncSlide` value currently does NOT exist.	FlashSlideshow
		currentLooperData : Object When using this component as the child of a DataLooper element, this holds the current element's corresponding looping data.	UIComponent
		currentPostSyncSlide : IndividualSlide A reference to the currently displayed slide; this reference updates once the transition to the slide has completed.	FlashSlideshow
		currentPostSyncSlideExists : Boolean = false This utility flag specifies if a `currentPostSyncSlide` value currently exists or not.	FlashSlideshow
		currentPostSyncSlideNotExists : Boolean = true This utility flag specifies if a `currentPostSyncSlide` value currently does NOT exist.	FlashSlideshow
		currentPreSyncSlide : IndividualSlide A reference to the currently displayed slide; this reference updates as soon as the transition to the slide starts.	FlashSlideshow
		currentPreSyncSlideExists : Boolean = false This utility flag specifies if a `currentPreSyncSlide` value currently exists or not.	FlashSlideshow
		currentPreSyncSlideNotExists : Boolean = true This utility flag specifies if a `currentPreSyncSlide` value currently does NOT exist.	FlashSlideshow
		currentState : String The current view state of the component.	UIComponent
		cursorManager : ICursorManager Gets the CursorManager that controls the cursor for this component and its peers.	UIComponent
		data : Object The `data` property lets you pass a value to the component when you use it in an item renderer or item editor.	Container
		defaultButton : IFlexDisplayObject The Button control designated as the default button for the container.	Container
		descriptor : UIComponentDescriptor Reference to the UIComponentDescriptor, if any, that was used by the `createComponentFromDescriptor()` method to create this UIComponent instance.	UIComponent
		document : Object A reference to the document object associated with this UIComponent.	UIComponent
		doubleClickEnabled : Boolean Specifies whether the UIComponent object receives `doubleClick` events.	UIComponent
		effectLibrary : EffectLibrary Provides a reference to the main `EffectLibrary` instance, which is a repository for effects.	FlashSlideshow
		enabled : Boolean Whether the component can accept user interaction.	UIComponent
		errorManager : ErrorManager Provides a reference to the main `ErrorManager` instance.	FlashSlideshow
		errorString : String The text that will be displayed by a component's error tip when a component is monitored by a Validator and validation fails.	UIComponent
		explicitHeight : Number Number that specifies the explicit height of the component, in pixels, in the component's coordinates.	UIComponent
		explicitMaxHeight : Number Number that specifies the maximum height of the component, in pixels, in the component's coordinates.	UIComponent
		explicitMaxWidth : Number Number that specifies the maximum width of the component, in pixels, in the component's coordinates.	UIComponent
		explicitMinHeight : Number Number that specifies the minimum height of the component, in pixels, in the component's coordinates.	UIComponent
		explicitMinWidth : Number Number that specifies the minimum width of the component, in pixels, in the component's coordinates.	UIComponent
		explicitWidth : Number Number that specifies the explicit width of the component, in pixels, in the component's coordinates.	UIComponent
		flexContextMenu : IFlexContextMenu The context menu for this UIComponent.	UIComponent
		focusEnabled : Boolean Indicates whether the component can receive focus when tabbed to.	UIComponent
		focusManager : IFocusManager Gets the FocusManager that controls focus for this component and its peers.	UIComponent
		focusPane : Sprite The focus pane associated with this object.	UIComponent
		fullScreenEnabled : Boolean = false This utility flag specifies if the slideshow is currently in full-screen mode (activated through the FullScreenButton element) or not.	FlashSlideshow
		fullScreenNotEnabled : Boolean = true This utility flag specifies if the slideshow is currently NOT in full-screen mode (activated through the FullScreenButton element).	FlashSlideshow
		globalX : Number	UIComponent
		globalY : Number	UIComponent
		height : Number Number that specifies the height of the component, in pixels, in the parent's coordinates.	UIComponent
		horizontalLineScrollSize : Number Number of pixels to move when the left- or right-arrow button in the horizontal scroll bar is pressed.	Container
		horizontalPageScrollSize : Number Number of pixels to move when the track in the horizontal scroll bar is pressed.	Container
		horizontalScrollBar : ScrollBar The horizontal scrollbar used in this container.	Container
		horizontalScrollPolicy : String Specifies whether the horizontal scroll bar is always present, always absent, or automatically added when needed.	Container
		horizontalScrollPosition : Number The current position of the horizontal scroll bar.	Container
		icon : Class The Class of the icon displayed by some navigator containers to represent this Container.	Container
		id : String ID of the component.	UIComponent
		includeInLayout : Boolean Specifies whether this component is included in the layout of the parent container.	UIComponent
		inheritingStyles : Object The beginning of this component's chain of inheriting styles.	UIComponent
		initialized : Boolean A flag that determines if an object has been through all three phases of layout: commitment, measurement, and layout (provided that any were required).	UIComponent
		instanceIndex : int The index of a repeated component.	UIComponent
		instanceIndices : Array An Array containing the indices required to reference this UIComponent object from its parent document.	UIComponent
		isDocument : Boolean Determines whether this UIComponent instance is a document object, that is, whether it is at the top of the hierarchy of a Flex application, MXML component, or ActionScript component.	UIComponent
		isPopUp : Boolean Set to `true` by the PopUpManager to indicate that component has been popped up.	UIComponent
		kbManager : KBManager Provides a reference to the main `KBManager` instance, which is a repository for all KB effects.	FlashSlideshow
		label : String The text displayed by some navigator containers to represent this Container.	Container
		layoutManager : LayoutManager Provides a reference to the main `LayoutManager` instance, which manages the slideshow's user interface.	FlashSlideshow
		loadedAssetDomain : ApplicationDomain Allows access to the ApplicationDomain used to load the external skin file.	FlashSlideshow
		maxHeight : Number Number that specifies the maximum height of the component, in pixels, in the component's coordinates.	UIComponent
		maxHorizontalScrollPosition : Number The largest possible value for the `horizontalScrollPosition` property.	Container
		maxVerticalScrollPosition : Number The largest possible value for the `verticalScrollPosition` property.	Container
		maxWidth : Number Number that specifies the maximum width of the component, in pixels, in the component's coordinates.	UIComponent
		measuredHeight : Number The default height of the component, in pixels.	UIComponent
		measuredMinHeight : Number The default minimum height of the component, in pixels.	UIComponent
		measuredMinWidth : Number The default minimum width of the component, in pixels.	UIComponent
		measuredWidth : Number The default width of the component, in pixels.	UIComponent
		minHeight : Number Number that specifies the minimum height of the component, in pixels, in the component's coordinates.	UIComponent
		minWidth : Number Number that specifies the minimum width of the component, in pixels, in the component's coordinates.	UIComponent
		miscHolder : Object A utility holder for any various properties	UIComponent
		moduleFactory : IFlexModuleFactory The moduleFactory that is used to create TextFields in the correct SWF context.	UIComponent
		mouseFocusEnabled : Boolean Whether you can receive focus when clicked on.	UIComponent
		move_enableProtection : Boolean = false	UIComponent
		nestLevel : int Depth of this object in the containment hierarchy.	UIComponent
		nonInheritingStyles : Object The beginning of this component's chain of non-inheriting styles.	UIComponent
		numAutomationChildren : int The number of automation children this container has.	UIComponent
		numChildren : int Number of child components in this container.	Container
		owner : DisplayObjectContainer The owner of this UIComponent.	UIComponent
		parent : DisplayObjectContainer The parent container or component for this component.	UIComponent
		parentApplication : Object A reference to the Application object that contains this UIComponent instance.	UIComponent
		parentDocument : Object A reference to the parent document object for this UIComponent.	UIComponent
		percentHeight : Number Number that specifies the height of a component as a percentage of its parent's size.	UIComponent
		percentWidth : Number Number that specifies the width of a component as a percentage of its parent's size.	UIComponent
		processedDescriptors : Boolean Set to `true` after immediate or deferred child creation, depending on which one happens.	UIComponent
		rawChildren : IChildList A container typically contains child components, which can be enumerated using the `Container.getChildAt()` method and `Container.numChildren` property.	Container
		repeater : IRepeater A reference to the Repeater object in the parent document that produced this UIComponent.	UIComponent
		repeaterIndex : int The index of the item in the data provider of the Repeater that produced this UIComponent.	UIComponent
		repeaterIndices : Array An Array containing the indices of the items in the data provider of the Repeaters in the parent document that produced this UIComponent.	UIComponent
		repeaters : Array An Array containing references to the Repeater objects in the parent document that produced this UIComponent.	UIComponent
		scaleX : Number Number that specifies the horizontal scaling factor.	UIComponent
		scaleY : Number Number that specifies the vertical scaling factor.	UIComponent
		screen : Rectangle Returns an object that contains the size and position of the base drawing surface for this object.	UIComponent
		setActualSize_enableProtection : Boolean = false	UIComponent
		setVisible_enableProtection : Boolean = true	UIComponent
		showInAutomationHierarchy : Boolean A flag that determines if an automation object shows in the automation hierarchy.	UIComponent
		states : Array The view states that are defined for this component.	UIComponent
		styleClassOverridesInline : Boolean = true Specifies if class-specific styles (as defined by the `styleName` property) override inline styles.	UIComponent
		styleDeclaration : CSSStyleDeclaration Storage for the inline inheriting styles on this object.	UIComponent
		styleName : Object The class style used by this component.	UIComponent
		systemManager : ISystemManager Returns the SystemManager object used by this component.	UIComponent
		toolTip : String Text to display in the ToolTip.	UIComponent
		tooltipAppearanceManager : ToolTipAppearanceManager Provides a reference to the main `ToolTipAppearanceManager` instance, which manages the appearance of all tooltips.	FlashSlideshow
		transitions : Array An Array of Transition objects, where each Transition object defines a set of effects to play when a view state change occurs.	UIComponent
		tweeningProperties : Array Array of properties that are currently being tweened on this object.	UIComponent
		uid : String A unique identifier for the object.	UIComponent
		updateCompletePendingFlag : Boolean A flag that determines if an object has been through all three phases of layout validation (provided that any were required).	UIComponent
		utilityHolder : Object This holder can be used to hold any persistent values that are needed (e.g.	FlashSlideshow
		validationSubField : String Used by a validator to associate a subfield with this component.	UIComponent
		verticalLineScrollSize : Number Number of pixels to scroll when the up- or down-arrow button in the vertical scroll bar is pressed, or when you scroll by using the mouse wheel.	Container
		verticalPageScrollSize : Number Number of pixels to scroll when the track in the vertical scroll bar is pressed.	Container
		verticalScrollBar : ScrollBar The vertical scrollbar used in this container.	Container
		verticalScrollPolicy : String Specifies whether the vertical scroll bar is always present, always absent, or automatically added when needed.	Container
		verticalScrollPosition : Number The current position of the vertical scroll bar.	Container
		viewMetrics : EdgeMetrics Returns an object that has four properties: `left`, `top`, `right`, and `bottom`.	Container
		viewMetricsAndPadding : EdgeMetrics Returns an object that has four properties: `left`, `top`, `right`, and `bottom`.	Container
		visible : Boolean Controls the visibility of this UIComponent.	UIComponent
		visible_unprotected : Boolean If setVisible_enableProtection is enabled, this allows access to determine what the pseudo-state is -- that is, what's been requested, regardless of any prevention of default behavior.	UIComponent
		width : Number Number that specifies the width of the component, in pixels, in the parent's coordinates.	UIComponent
		x : Number Number that specifies the component's horizontal position, in pixels, within its parent container.	UIComponent
		xmlDescriptor : XML For certain dynamically created elements, this represents the XML node used to create that element.	UIComponent
		xmlManager : XMLManager Provides a reference to the main `XMLManager` instance, which manages all XML loading and can be queried later on to retrieve XML information.	FlashSlideshow
		xmlManagerClass : Class Specifies the class to use when creating the XML manager.	FlashSlideshow
		y : Number Number that specifies the component's vertical position, in pixels, within its parent container.	UIComponent

	Property	Defined by
		actualCreationPolicy : String The creation policy of this container.	Container
		unscaledHeight : Number A convenience method for determining the unscaled height of the component.	UIComponent
		unscaledWidth : Number A convenience method for determining the unscaled width of the component All of a component's drawing and child layout should be done within a bounding rectangle of this width, which is also passed as an argument to `updateDisplayList()`.	UIComponent

	Method	Defined by
		FlashSlideshow(createDummyShellOnly:Boolean = false) Constructor	FlashSlideshow
		addChild(child:DisplayObject):DisplayObject Adds a child DisplayObject to this Container.	Container
		addChildAt(child:DisplayObject, index:int):DisplayObject Adds a child DisplayObject to this Container.	Container
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = true):void	FlashSlideshow
		callLater(method:Function, args:Array = null):void Queues a function to be called later.	UIComponent
		clearStyle(styleProp:String):void Deletes a style property from this component instance.	UIComponent
		contentToGlobal(point:Point):Point Converts a `Point` object from content coordinates to global coordinates.	Container
		contentToLocal(point:Point):Point Converts a `Point` object from content to local coordinates.	Container
		createAutomationIDPart(child:IAutomationObject):Object Returns a set of properties that identify the child within this container.	UIComponent
		createComponentFromDescriptor(descriptor:ComponentDescriptor, recurse:Boolean):IFlexDisplayObject Given a single UIComponentDescriptor, create the corresponding component and add the component as a child of this Container.	Container
		createComponentsFromDescriptors(recurse:Boolean = true):void Iterate through the Array of `childDescriptors`, and call the `createComponentFromDescriptor()` method for each one.	Container
		createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void Creates an `id` reference to this IUIComponent object on its parent document object.	UIComponent
		deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void Deletes the `id` reference to this IUIComponent object on its parent document object.	UIComponent
		destroy():void Destroys the slideshow instance and does some necessary cleanup.	FlashSlideshow
		determineTextFormatFromStyles():UITextFormat Returns a UITextFormat object corresponding to the text styles for this UIComponent.	UIComponent
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	UIComponent
		dispatchSlideshowEvent(type:String, extraInfo:Object = null):void A utility function designed for easy access; dispatches a slideshow control event based on the passed parameters.	FlashSlideshow
		drawFocus(isFocused:Boolean):void Shows or hides the focus indicator around this component.	UIComponent
		drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void Programatically draws a rectangle into this skin's Graphics object.	UIComponent
		effectFinished(effectInst:IEffectInstance):void Called by the effect instance when it stops playing on the component.	UIComponent
		effectStarted(effectInst:IEffectInstance):void Called by the effect instance when it starts playing on the component.	UIComponent
		endEffectsStarted():void Ends all currently playing effects on the component.	UIComponent
		executeBindings(recurse:Boolean = false):void Executes all the data bindings on this Container.	Container
		executeChildBindings(recurse:Boolean):void Executes the bindings into this Container's child UIComponent objects.	Container
		finishPrint(obj:Object, target:IFlexDisplayObject):void Called after printing is complete.	UIComponent
		getAutomationChildAt(index:int):IAutomationObject Provides the automation object at the specified index.	UIComponent
		getChildAt(index:int):DisplayObject Gets the nth child component object.	Container
		getChildByName(name:String):DisplayObject Returns the child whose `name` property is the specified String.	Container
		getChildIndex(child:DisplayObject):int Gets the zero-based index of a specific child.	Container
		getChildren():Array Returns an Array of DisplayObject objects consisting of the content children of the container.	Container
		getClassStyleDeclarations():Array Finds the type selectors for this UIComponent instance.	UIComponent
		getConstraintValue(constraintName:String):* Returns a layout constraint value, which is the same as getting the constraint style for this component.	UIComponent
		getDescendantByName(name:String):DisplayObject Searches all children for the first child named with the passed value; returns that child, or null if not found.	UIComponent
		getDescendantsByName(name:String):Array Searches all children for all children named with the passed value; returns an array with those children, or an empty array if none found.	UIComponent
		getExplicitOrMeasuredHeight():Number A convenience method for determining whether to use the explicit or measured height	UIComponent
		getExplicitOrMeasuredWidth():Number A convenience method for determining whether to use the explicit or measured width	UIComponent
		getFocus():InteractiveObject Gets the object that currently has focus.	UIComponent
		getRepeaterItem(whichRepeater:int = -1):Object Returns the item in the `dataProvider` that was used by the specified Repeater to produce this Repeater, or `null` if this Repeater isn't repeated.	UIComponent
		getStyle(styleProp:String):* Gets a style property that has been set anywhere in this component's style lookup chain.	UIComponent
		getVisibleRect(targetParent:DisplayObject = null):Rectangle MOVED OVER FROM SDK 3.2 UIComponent - Allows for popped-up alerts to be displayed correctly - NGR MOVED 11-20-08	UIComponent
		globalToContent(point:Point):Point Converts a `Point` object from global to content coordinates.	Container
		horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix Returns a box Matrix which can be passed to the `drawRoundRect()` method as the `rot` parameter when drawing a horizontal gradient.	UIComponent
		initialize():void Initializes the internal structure of this component.	UIComponent
		initializeRepeaterArrays(parent:IRepeaterClient):void Initializes various properties which keep track of repeated instances of this component.	UIComponent
		invalidateDisplayList():void Marks a component so that its `updateDisplayList()` method gets called during a later screen update.	UIComponent
		invalidateProperties():void Marks a component so that its `commitProperties()` method gets called during a later screen update.	UIComponent
		invalidateSize():void Marks a component so that its `measure()` method gets called during a later screen update.	UIComponent
		localToContent(point:Point):Point Converts a `Point` object from local to content coordinates.	Container
		measureHTMLText(htmlText:String):TextLineMetrics Measures the specified HTML text, which may contain HTML tags such as `<font>` and `<b>`, assuming that it is displayed in a single-line UITextField using a UITextFormat determined by the styles of this UIComponent.	UIComponent
		measureText(text:String):TextLineMetrics Measures the specified text, assuming that it is displayed in a single-line UITextField using a UITextFormat determined by the styles of this UIComponent.	UIComponent
		move(x:Number, y:Number):void Moves the component to a specified position within its parent.	UIComponent
		move_unprotected(x:Number, y:Number):void Same as move, but cannot be prevented via the protection_move event.	UIComponent
		notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void Propagates style changes to the children.	UIComponent
		owns(child:DisplayObject):Boolean Returns `true` if the chain of `owner` properties points from `child` to this UIComponent.	UIComponent
		parentChanged(p:DisplayObjectContainer):void Called by Flex when a UIComponent object is added to or removed from a parent.	UIComponent
		prepareToPrint(target:IFlexDisplayObject):Object Prepares an IFlexDisplayObject for printing.	UIComponent
		regenerateStyleCache(recursive:Boolean):void Builds or rebuilds the CSS style cache for this component and, if the `recursive` parameter is `true`, for all descendants of this component as well.	UIComponent
		registerEffects(effects:Array):void For each effect event, registers the EffectManager as one of the event listeners.	UIComponent
		removeAllChildren():void Removes all children from the child list of this container.	Container
		removeChild(child:DisplayObject):DisplayObject Removes a child DisplayObject from the child list of this Container.	Container
		removeChildAt(index:int):DisplayObject Removes a child DisplayObject from the child list of this Container at the specified index.	Container
		replayAutomatableEvent(event:Event):Boolean Replays the specified event.	UIComponent
		resolveAutomationIDPart(criteria:Object):Array Resolves a child by using the id provided.	UIComponent
		resumeBackgroundProcessing():void [static] Resumes the background processing of methods queued by `callLater()`, after a call to `suspendBackgroundProcessing()`.	UIComponent
		setActualSize(w:Number, h:Number):void Sizes the object.	UIComponent
		setActualSize_unprotected(w:Number, h:Number):void Same as setActualSize, but is not cancelable via the protection_size event.	UIComponent
		setChildIndex(child:DisplayObject, newIndex:int):void Sets the index of a particular child.	Container
		setConstraintValue(constraintName:String, value:*):void Sets a layout constraint value, which is the same as setting the constraint style for this component.	UIComponent
		setCurrentState(stateName:String, playTransition:Boolean = true):void Set the current state.	UIComponent
		setFocus():void Sets the focus to this component.	UIComponent
		setGlobalStyles(selector:String, values:Object, applyImmediately:Boolean = true):void A utility function designed for easy access; allows a global style property to be set.	FlashSlideshow
		setStyle(styleProp:String, newValue:*):void Sets a style property on this component instance.	UIComponent
		setView(id:String):void A utility function designed for easy access; opens the requested layout view.	FlashSlideshow
		setViewDelayed(id:String, delay:Number):void A utility function designed for easy access; opens the requested layout view after the specified delay has elapsed.	FlashSlideshow
		setVisible(value:Boolean, noEvent:Boolean = false):void Called when the `visible` property changes.	UIComponent
		setVisible_unprotected(value:Boolean, noEvent:Boolean = false):void Same as setVisible, but cannot be prevented.	UIComponent
		startAudio(level:String = ""):void A utility function designed for easy access; starts/plays the audio on the specified level or levels.	FlashSlideshow
		startAutoplay():void A utility function designed for easy access; starts/plays autoplay if it is disabled.	FlashSlideshow
		stopAudio(level:String = ""):void A utility function designed for easy access; stops/pauses the audio on the specified level or levels.	FlashSlideshow
		stopAutoplay():void A utility function designed for easy access; stops/pauses autoplay if it is enabled.	FlashSlideshow
		styleChanged(styleProp:String):void Detects changes to style properties.	UIComponent
		stylesInitialized():void Flex calls the `stylesInitialized()` method when the styles for a component are first initialized.	UIComponent
		suspendBackgroundProcessing():void [static] Blocks the background processing of methods queued by `callLater()`, until `resumeBackgroundProcessing()` is called.	UIComponent
		toString():String Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application.	FlexSprite
		validateDisplayList():void Validates the position and size of children and draws other visuals.	UIComponent
		validateNow():void Validate and update the properties and layout of this object and redraw it, if necessary.	UIComponent
		validateProperties():void Used by layout logic to validate the properties of a component by calling the `commitProperties()` method.	UIComponent
		validateSize(recursive:Boolean = false):void Validates the measured size of the component If the `LayoutManager.invalidateSize()` method is called with this ILayoutManagerClient, then the `validateSize()` method is called when it's time to do measurements.	UIComponent
		validationResultHandler(event:ValidationResultEvent):void Handles both the `valid` and `invalid` events from a validator assigned to this component.	UIComponent
		verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix Returns a box Matrix which can be passed to `drawRoundRect()` as the `rot` parameter when drawing a vertical gradient.	UIComponent

	Method	Defined by
		adjustFocusRect(obj:DisplayObject = null):void Adjust the focus rectangle.	UIComponent
		attachOverlay():void Used internally by the Dissolve Effect to add the overlay to the chrome of a container.	Container
		childrenCreated():void Performs any final processing after child objects are created.	UIComponent
		commitProperties():void Processes the properties set on the component.	UIComponent
		createBorder():void Creates the container's border skin if it is needed and does not already exist.	Container
		createChildren():void	FlashSlideshow
		createInFontContext(classObj:Class):Object Creates a new object using a context based on the embedded font being used.	UIComponent
		createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object Creates the object using a given moduleFactory.	UIComponent
		focusInHandler(event:FocusEvent):void The event handler called when a UIComponent object gets focus.	UIComponent
		focusOutHandler(event:FocusEvent):void The event handler called when a UIComponent object loses focus.	UIComponent
		initializationComplete():void Finalizes the initialization of this component.	UIComponent
		initializeAccessibility():void Initializes this component's accessibility code.	UIComponent
		isOurFocus(target:DisplayObject):Boolean Typically overridden by components containing UITextField objects, where the UITextField object gets focus.	UIComponent
		keyDownHandler(event:KeyboardEvent):void The event handler called for a `keyDown` event.	UIComponent
		keyUpHandler(event:KeyboardEvent):void The event handler called for a `keyUp` event.	UIComponent
		layoutChrome(unscaledWidth:Number, unscaledHeight:Number):void Respond to size changes by setting the positions and sizes of this container's borders.	Container
		measure():void	FlashSlideshow
		resourcesChanged():void This method is called when a UIComponent is constructed, and again whenever the ResourceManager dispatches a `"change"` Event to indicate that the localized resources have changed in some way.	UIComponent
		scrollChildren():void Positions the container's content area relative to the viewable area based on the horizontalScrollPosition and verticalScrollPosition properties.	Container
		updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void Sets the size of each child of the container.	Canvas

Events

Hide Inherited Events

Show Inherited Events

	Summary	Defined by
add	Dispatched when the component is added to a container as a content child by using the `addChild()` or `addChildAt()` method.	UIComponent
audio_imageSoundComplete	The `SlideshowEvent.AUDIO_IMAGESOUNDCOMPLETE` constant defines the value of the `type` property of the event object for a `audio_imageSoundComplete` event.	FlashSlideshow
audio_imageSoundStart	The `SlideshowEvent.AUDIO_IMAGESOUNDSTART` constant defines the value of the `type` property of the event object for a `audio_imageSoundStart` event.	FlashSlideshow
audio_loadProgress	The `SlideshowEvent.AUDIO_LOADPROGRESS` constant defines the value of the `type` property of the event object for a `audio_loadProgress` event.	FlashSlideshow
audio_positionUpdate	The `SlideshowEvent.AUDIO_POSITIONUPDATE` constant defines the value of the `type` property of the event object for a `audio_positionUpdate` event.	FlashSlideshow
audio_setControlLabel	The `SlideshowEvent.AUDIO_SETCONTROLLABEL` constant defines the value of the `type` property of the event object for a `audio_setControlLabel` event.	FlashSlideshow
audio_setPosition	The `SlideshowEvent.AUDIO_SETPOSITION` constant defines the value of the `type` property of the event object for a `audio_setPosition` event.	FlashSlideshow
audio_setStatusPlaying	The `SlideshowEvent.AUDIO_SETSTATUSPLAYING` constant defines the value of the `type` property of the event object for a `audio_setStatusPlaying` event.	FlashSlideshow
audio_setVolume	The `SlideshowEvent.AUDIO_SETVOLUME` constant defines the value of the `type` property of the event object for a `audio_setVolume` event.	FlashSlideshow
audio_showHideControls	The `SlideshowEvent.AUDIO_SHOWHIDECONTROLS` constant defines the value of the `type` property of the event object for a `audio_showHideControls` event.	FlashSlideshow
audio_silentStop	The `SlideshowEvent.AUDIO_SILENTSTOP` constant defines the value of the `type` property of the event object for a `audio_silentStop` event.	FlashSlideshow
audio_statusPlayingUpdate	The `SlideshowEvent.AUDIO_STATUSPLAYINGUPDATE` constant defines the value of the `type` property of the event object for a `audio_statusPlayingUpdate` event.	FlashSlideshow
autoplay_enableDisable	The `SlideshowEvent.AUTOPLAY_ENABLEDISABLE` constant defines the value of the `type` property of the event object for a `autoplay_enableDisable` event.	FlashSlideshow
autoplay_enableDisableLoop	The `SlideshowEvent.AUTOPLAY_ENABLEDISABLELOOP` constant defines the value of the `type` property of the event object for a `autoplay_enableDisableLoop` event.	FlashSlideshow
autoplay_removeCurrent	The `SlideshowEvent.AUTOPLAY_REMOVECURRENT` constant defines the value of the `type` property of the event object for a `autoplay_removeCurrent` event.	FlashSlideshow
autoplay_timeoutCleared	The `SlideshowEvent.AUTOPLAY_TIMEOUTCLEARED` constant defines the value of the `type` property of the event object for a `autoplay_timeoutStarted` event.	FlashSlideshow
autoplay_timeoutStarted	The `SlideshowEvent.AUTOPLAY_TIMEOUTSTARTED` constant defines the value of the `type` property of the event object for a `autoplay_timeoutStarted` event.	FlashSlideshow
childAdd	Dispatched after a child has been added to a container.	Container
childIndexChange	Dispatched after the index (among the container children) of a container child changes.	Container
childRemove	Dispatched before a child of a container is removed.	Container
creationComplete	Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing.	UIComponent
currentStateChange	Dispatched after the view state has changed.	UIComponent
currentStateChanging	Dispatched after the `currentState` property changes, but before the view state changes.	UIComponent
data_xmlLoaded	The `SlideshowEvent.DATA_XMLLOADED` constant defines the value of the `type` property of the event object for a `data_xmlLoaded` event.	FlashSlideshow
dataChange	Dispatched when the `data` property changes.	Container
dragComplete	Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop.	UIComponent
dragDrop	Dispatched by the drop target when the user releases the mouse over it.	UIComponent
dragEnter	Dispatched by a component when the user moves the mouse over the component during a drag operation.	UIComponent
dragExit	Dispatched by the component when the user drags outside the component, but does not drop the data onto the target.	UIComponent
dragOver	Dispatched by a component when the user moves the mouse while over the component during a drag operation.	UIComponent
dragStart	Dispatched by the drag initiator when starting a drag operation.	UIComponent
effectEnd	Dispatched after an effect ends.	UIComponent
effectStart	Dispatched just before an effect starts.	UIComponent
enterState	Dispatched after the component has returned to the root view state.	UIComponent
exitState	Dispatched before the component exits from the root view state.	UIComponent
hide	Dispatched when an object's state changes from visible to invisible.	UIComponent
image_setDominantColor	The `SlideshowEvent.IMAGE_SETDOMINANTCOLOR` constant defines the value of the `type` property of the event object for a `image_setDominantColor` event.	FlashSlideshow
imageLibrary_assetDestroyed	The `SlideshowEvent.IMAGELIBRARY_ASSETDESTROYED` constant defines the value of the `type` property of the event object for a `imageLibrary_assetDestroyed` event.	FlashSlideshow
imageLibrary_checkedIn	The `SlideshowEvent.IMAGELIBRARY_CHECKEDIN` constant defines the value of the `type` property of the event object for a `imageLibrary_checkedIn` event.	FlashSlideshow
images_closeGallery	The `SlideshowEvent.IMAGES_CLOSEGALLERY` constant defines the value of the `type` property of the event object for a `images_closeGallery` event.	FlashSlideshow
images_displayImage		FlashSlideshow
images_galleryPreloadComplete	The `SlideshowEvent.IMAGES_GALLERYPRELOADCOMPLETE` constant defines the value of the `type` property of the event object for a `images_galleryPreloadComplete` event.	FlashSlideshow
images_jumpToGalleryUniqueID	The `SlideshowEvent.IMAGES_JUMPTOGALLERYUNIQID` constant defines the value of the `type` property of the event object for a `images_jumpToGalleryUniqueID` event.	FlashSlideshow
images_jumpToUniqueID	The `SlideshowEvent.IMAGES_JUMPTOUNIQID` constant defines the value of the `type` property of the event object for a `images_jumpToUniqueID` event.	FlashSlideshow
images_requestGallery	The `SlideshowEvent.IMAGES_REQUESTGALLERY` constant defines the value of the `type` property of the event object for a `images_requestGallery` event.	FlashSlideshow
images_setGallery	The `SlideshowEvent.IMAGES_SETGALLERY` constant defines the value of the `type` property of the event object for a `images_setGallery` event.	FlashSlideshow
images_setGalleryComplete	The `SlideshowEvent.IMAGES_SETGALLERYCOMPLETE` constant defines the value of the `type` property of the event object for a `images_setGalleryComplete` event.	FlashSlideshow
images_setImage	The `SlideshowEvent.IMAGES_SETIMAGE` constant defines the value of the `type` property of the event object for a `images_setImage` event.	FlashSlideshow
images_setImageChangeable	The `SlideshowEvent.IMAGES_SETIMAGECHANGEABLE` constant defines the value of the `type` property of the event object for a `images_setImageChangeable` event.	FlashSlideshow
images_syncImages	The `SlideshowEvent.IMAGES_SYNCIMAGES` constant defines the value of the `type` property of the event object for a `images_syncImages` event.	FlashSlideshow
images_syncImagesStart	The `SlideshowEvent.IMAGES_SYNCIMAGESSTART` constant defines the value of the `type` property of the event object for a `images_syncImagesStart` event.	FlashSlideshow
initialize	Dispatched when the component has finished its construction and has all initialization properties set.	UIComponent
invalid	Dispatched when a component is monitored by a Validator and the validation failed.	UIComponent
kenBurns_imageEffectEnd	The `SlideshowEvent.KB_IMAGEEND` constant defines the value of the `type` property of the event object for a `kenBurns_imageEffectEnd` event.	FlashSlideshow
kenBurns_imageEffectStart	The `SlideshowEvent.KB_IMAGESTART` constant defines the value of the `type` property of the event object for a `kenBurns_imageEffectStart` event.	FlashSlideshow
layout_changeRequested	The `SlideshowEvent.LAYOUT_REQUESTCHANGE` constant defines the value of the `type` property of the event object for a `layout_changeRequested` event.	FlashSlideshow
layout_managerReady	The `SlideshowEvent.LAYOUT_MANAGERREADY` constant defines the value of the `type` property of the event object for a `layout_managerReady` event.	FlashSlideshow
layout_setCurrentViewID		FlashSlideshow
layout_setWritable	The `SlideshowEvent.LAYOUT_SETWRITABLE` constant defines the value of the `type` property of the event object for a `layout_setWritable` event.	FlashSlideshow
layout_viewReady	The `SlideshowEvent.LAYOUT_VIEWREADY` constant defines the value of the `type` property of the event object for a `layout_viewReady` event.	FlashSlideshow
loader_setGroupProgress	The `SlideshowEvent.LOADER_SETGROUPPROGRESS` constant defines the value of the `type` property of the event object for a `loader_setGroupProgress` event.	FlashSlideshow
loader_setSingleProgress	The `SlideshowEvent.LOADER_SETSINGLEPROGRESS` constant defines the value of the `type` property of the event object for a `loader_setSingleProgress` event.	FlashSlideshow
loader_showGroupLoader	The `SlideshowEvent.LOADER_SHOWGROUP` constant defines the value of the `type` property of the event object for a `loader_showGroupLoader` event.	FlashSlideshow
loader_showSingleLoader	The `SlideshowEvent.LOADER_SHOWSINGLE` constant defines the value of the `type` property of the event object for a `loader_showSingleLoader` event.	FlashSlideshow
mouseDownOutside	Dispatched from a component opened using the PopUpManager when the user clicks outside it.	UIComponent
mouseWheelOutside	Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it.	UIComponent
move	Dispatched when the object has moved.	UIComponent
preinitialize	Dispatched at the beginning of the component initialization sequence.	UIComponent
protection_hide	Dispatched when the component is about to be hidden (visible = false); calling event.preventDefault() will stop the action from occuring.	UIComponent
protection_move	Dispatched when the component is about to be moved via move(); calling event.preventDefault() will stop the action from occuring.	UIComponent
protection_show	Dispatched when the component is about to be shown (visible = true); calling event.preventDefault() will stop the action from occuring.	UIComponent
protection_size	Dispatched when the component is about to be sized via setActualSize(); calling event.preventDefault() will stop the action from occuring.	UIComponent
remove	Dispatched when the component is removed from a container as a content child by using the `removeChild()` or `removeChildAt()` method.	UIComponent
resize	Dispatched when the component is resized.	UIComponent
scroll	Dispatched when the user manually scrolls the container.	Container
show	Dispatched when an object's state changes from invisible to visible.	UIComponent
toolTipCreate	Dispatched by the component when it is time to create a ToolTip.	UIComponent
toolTipEnd	Dispatched by the component when its ToolTip has been hidden and will be discarded soon.	UIComponent
toolTipHide	Dispatched by the component when its ToolTip is about to be hidden.	UIComponent
toolTipShow	Dispatched by the component when its ToolTip is about to be shown.	UIComponent
toolTipShown	Dispatched by the component when its ToolTip has been shown.	UIComponent
toolTipStart	Dispatched by a component whose `toolTip` property is set, as soon as the user moves the mouse over it.	UIComponent
updateComplete	Dispatched when an object has had its `commitProperties()`, `measure()`, and `updateDisplayList()` methods called (if needed).	UIComponent
valid	Dispatched when a component is monitored by a Validator and the validation succeeded.	UIComponent
valueCommit	Dispatched when values are changed programmatically or by user interaction.	UIComponent
video_imageVideoComplete	The `SlideshowEvent.VIDEO_IMAGEVIDEOCOMPLETE` constant defines the value of the `type` property of the event object for a `video_imageVideoComplete` event.	FlashSlideshow
video_imageVideoStart	The `SlideshowEvent.VIDEO_IMAGEVIDEOSTART` constant defines the value of the `type` property of the event object for a `video_imageVideoStart` event.	FlashSlideshow
video_stopAll	The `SlideshowEvent.VIDEO_STOPALL` constant defines the value of the `type` property of the event object for a `video_stopAll` event.	FlashSlideshow

Description	Defined by
backgroundAlpha	Type: Number CSS Inheritance: no Alpha level of the color defined by the `backgroundColor` property, of the image or SWF file defined by the `backgroundImage` style.	Container
backgroundAttachment	Type: String CSS Inheritance: no If a background image is specified, this style specifies whether it is fixed with regard to the viewport (`"fixed"`) or scrolls along with the content (`"scroll"`).	Container
backgroundColor	Type: uint Format: Color CSS Inheritance: no Background color of a component.	Container
backgroundDisabledColor	Type: uint Format: Color CSS Inheritance: yes Background color of the component when it is disabled.	Container
backgroundImage	Type: Object Format: File CSS Inheritance: no Background image of a component.	Container
backgroundSize	Type: String CSS Inheritance: no Scales the image specified by `backgroundImage` to different percentage sizes.	Container
barColor	Type: uint Format: Color CSS Inheritance: yes Determines the color of a ProgressBar.	Container
baseline	Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position.	UIComponent
borderColor	Type: uint Format: Color CSS Inheritance: no Color of the border.	Container
borderSides	Type: String CSS Inheritance: no Bounding box sides.	Container
borderSkin	Type: Class CSS Inheritance: no The border skin class of the component.	Container
borderStyle	Type: String CSS Inheritance: no Bounding box style.	Container
borderThickness	Type: Number Format: Length CSS Inheritance: no Bounding box thickness.	Container
bottom	Type: String CSS Inheritance: no The vertical distance in pixels from the lower edge of the component to the lower edge of its content area.	UIComponent
brightness	Type: Number CSS Inheritance: no The color brightness of the component.	UIComponent
color	Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label.	Container
contrast	Type: Number CSS Inheritance: no The color contrast of the component.	UIComponent
cornerRadius	Type: Number Format: Length CSS Inheritance: no Radius of component corners.	Container
disabledColor	Type: uint Format: Color CSS Inheritance: yes Color of text in the component if it is disabled.	Container
disabledOverlayAlpha	Type: Number CSS Inheritance: no The alpha value for the overlay that is placed on top of the container when it is disabled.	Container
dropShadowColor	Type: uint Format: Color CSS Inheritance: yes Color of the drop shadow.	Container
dropShadowEnabled	Type: Boolean CSS Inheritance: no Boolean property that specifies whether the component has a visible drop shadow.	Container
errorColor	Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails.	UIComponent
fontAntiAliasType	Type: String CSS Inheritance: yes Sets the `antiAliasType` property of internal TextFields.	Container
fontFamily	Type: String CSS Inheritance: yes Name of the font to use.	Container
fontGridFitType	Type: String CSS Inheritance: yes Sets the `gridFitType` property of internal TextFields that represent text in Flex controls.	Container
fontSharpness	Type: Number CSS Inheritance: yes Sets the `sharpness` property of internal TextFields that represent text in Flex controls.	Container
fontSize	Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels.	Container
fontStyle	Type: String CSS Inheritance: yes Determines whether the text is italic font.	Container
fontThickness	Type: Number CSS Inheritance: yes Sets the `thickness` property of internal TextFields that represent text in Flex controls.	Container
fontWeight	Type: String CSS Inheritance: yes Determines whether the text is boldface.	Container
horizontalCenter	Type: String CSS Inheritance: no The horizontal distance in pixels from the center of the component's content area to the center of the component.	UIComponent
horizontalScrollBarStyleName	Type: String CSS Inheritance: no The name of the horizontal scrollbar style.	Container
hue	Type: Number CSS Inheritance: no The color hue of the component.	UIComponent
kerning	Type: Boolean CSS Inheritance: yes A Boolean value that indicates whether kerning is enabled (`true`) or disabled (`false`).	Container
left	Type: String CSS Inheritance: no The horizontal distance in pixels from the left edge of the component's content area to the left edge of the component.	UIComponent
letterSpacing	Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character.	Container
opacity	Type: Number CSS Inheritance: no The opacity of the component.	UIComponent
right	Type: String CSS Inheritance: no The horizontal distance in pixels from the right edge of the component to the right edge of its content area.	UIComponent
saturation	Type: Number CSS Inheritance: no The color saturation of the component.	UIComponent
shadowDirection	Type: String CSS Inheritance: no Direction of the drop shadow.	Container
shadowDistance	Type: Number Format: Length CSS Inheritance: no Distance of the drop shadow.	Container
textAlign	Type: String CSS Inheritance: yes Alignment of text within a container.	Container
textDecoration	Type: String CSS Inheritance: yes Determines whether the text is underlined.	Container
textIndent	Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container, in pixels.	Container
themeColor	Type: uint Format: Color CSS Inheritance: yes Theme color of a component.	UIComponent
top	Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the control's content area to the top edge of the component.	UIComponent
verticalCenter	Type: String CSS Inheritance: no The vertical distance in pixels from the center of the component's content area to the center of the component.	UIComponent
verticalScrollBarStyleName	Type: String CSS Inheritance: no The name of the vertical scrollbar style.	Container

Description	Defined by
addedEffect	Triggering event: added Played when the component is added as a child to a Container.	UIComponent
creationCompleteEffect	Triggering event: creationComplete Played when the component is created.	UIComponent
hideEffect	Triggering event: hide Played when the component becomes invisible.	UIComponent
mouseDownEffect	Triggering event: mouseDown Played when the user presses the mouse button while over the component.	UIComponent
mouseUpEffect	Triggering event: mouseUp Played when the user releases the mouse button while over the component.	UIComponent
moveEffect	Triggering event: move Played when the component is moved.	UIComponent
removedEffect	Triggering event: removed Played when the component is removed from a Container.	UIComponent
resizeEffect	Triggering event: resize Played when the component is resized.	UIComponent
rollOutEffect	Triggering event: rollOut Played when the user rolls the mouse so it is no longer over the component.	UIComponent
rollOverEffect	Triggering event: rollOver Played when the user rolls the mouse over the component.	UIComponent
showEffect	Triggering event: show Played when the component becomes visible.	UIComponent

	Constant	Defined by
		DEFAULT_MAX_HEIGHT : Number = 10000 [static] The default value for the `maxHeight` property.	UIComponent
		DEFAULT_MAX_WIDTH : Number = 10000 [static] The default value for the `maxWidth` property.	UIComponent
		DEFAULT_MEASURED_HEIGHT : Number = 22 [static] The default value for the `measuredHeight` property.	UIComponent
		DEFAULT_MEASURED_MIN_HEIGHT : Number = 22 [static] The default value for the `measuredMinHeight` property.	UIComponent
		DEFAULT_MEASURED_MIN_WIDTH : Number = 40 [static] The default value for the `measuredMinWidth` property.	UIComponent
		DEFAULT_MEASURED_WIDTH : Number = 160 [static] The default value for the `measuredWidth` property.	UIComponent

Property detail

autoplayEnabled

property

public var autoplayEnabled:Boolean = false

This utility flag specifies if the slideshow is currently in autoplay mode (toggled through the PlayPauseButton or AutoplayToggleButton elements) or not.

It can be used as the source for binding expressions which show/hide elements based on autoplay being enabled. If you want to bind to whether autoplay is not enabled, use the autoplayNotEnabled property instead.

This property can be used as the source for data binding.

autoplayManager

property

public var autoplayManager:AutoplayManager

Provides a reference to the main AutoplayManager instance, which manages the autoplay and provide current status information. See the AutoplayManager class for more information.

See also

com.dwuser.ss4.managers.AutoplayManager

autoplayNotEnabled

property

public var autoplayNotEnabled:Boolean = true

This utility flag specifies if the slideshow is currently NOT in autoplay mode (toggled through the PlayPauseButton or AutoplayToggleButton elements).

It can be used as the source for binding expressions which show/hide elements based on autoplay being enabled. If you want to bind to whether autoplay is enabled, use the autoplayEnabled property instead.

This property can be used as the source for data binding.

configurationParameters

property

public var configurationParameters:FlashSlideshowConfigurationParameters

When creating a component-based slideshow implementation, the configurationParameters object specifies all of the initial configuration information. A new instance of the FlashSlideshowConfigurationParameters class should be created, all desired/required parameters applied (see the FlashSlideshowConfigurationParameters class documentation for more information), then the object applied to the configurationParameters property.

For example, you might use the following Actionscript (assuming you've already added the FlashSlideshow SWC file to your project):

    import com.dwuser.ss4.core.FlashSlideshowConfigurationParameters;
    import com.dwuser.ss4.ui.FlashSlideshow;
   
    // Create the config object
    var config:FlashSlideshowConfigurationParameters = new FlashSlideshowConfigurationParameters();
    config.xml = "path/to/configuration_file.xml";
    // optionally apply some more parameters here...
   
    // Create the slideshow instance and add it to the display list
    var ss:FlashSlideshow = new FlashSlideshow();
    ss.configurationParameters = config;
    ss.width = 400;
    ss.height = 300;
    addChild(ss);

In a standalone implementation, the configurationParameters object is passed through the slideshow HTML. See the class description above for more information.

currentDelayedSyncSlide

property

public var currentDelayedSyncSlide:IndividualSlide

A reference to the currently displayed slide; this reference updates after a delay following the transition to the slide starting. This value can be used as the source for binding expressions which need to reference properties of the currently displayed slide.

It differs from currentPreSyncSlide and currentPostSyncSlide in when chronologically it is updated. The currentPreSyncSlide slide reference is updated as soon as the transition to the slide begins. The currentDelayedSyncSlide slide reference is updated after a certain delay passes following the transition to the slide beginning. The duration of this delay is specified in the ImageManager.delayedSyncDelay style property. The currentPostSyncSlide slide reference is updated when the transition to the slide has completed. All of the different slide references can have applicability depending on the application.

If you need to determine if this property currently has a value, reference the currentDelayedSyncSlideExists property.

By default, all slide references are not reset while a gallery is loading; the current slide references are left intact. You can change this behavior by modifying the ImageManager.resetGlobalSlideRefsOnSetGallery style property.

This property can be used as the source for data binding.

currentDelayedSyncSlideExists

property

public var currentDelayedSyncSlideExists:Boolean = false

This utility flag specifies if a currentDelayedSyncSlide value currently exists or not. If the currentDelayedSyncSlide value doesn't exist or is null, this value is false.

It can be used as the source for binding expressions which show/hide elements based on the existence of a delayed-sync slide reference.

This property can be used as the source for data binding.

currentDelayedSyncSlideNotExists

property

public var currentDelayedSyncSlideNotExists:Boolean = true

This utility flag specifies if a currentDelayedSyncSlide value currently does NOT exist. If the currentDelayedSyncSlide value doesn't exist or is null, this value is true. This is the opposite of the currentDelayedSyncSlideExists value.

It can be used as the source for binding expressions which show/hide elements based on the NON-existence of a delayed-sync slide reference.

This property can be used as the source for data binding.

currentPostSyncSlide

property

public var currentPostSyncSlide:IndividualSlide

A reference to the currently displayed slide; this reference updates once the transition to the slide has completed. This value can be used as the source for binding expressions which need to reference properties of the currently displayed slide.

It differs from currentPreSyncSlide and currentDelayedSyncSlide in when chronologically it is updated. The currentPreSyncSlide slide reference is updated as soon as the transition to the slide begins. The currentDelayedSyncSlide slide reference is updated after a certain delay passes following the transition to the slide beginning. The duration of this delay is specified in the ImageManager.delayedSyncDelay style property. The currentPostSyncSlide slide reference is updated when the transition to the slide has completed. All of the different slide references can have applicability depending on the application.

If you need to determine if this property currently has a value, reference the currentPostSyncSlideExists property.

This property can be used as the source for data binding.

See also

currentPostSyncSlideExists

property

public var currentPostSyncSlideExists:Boolean = false

This utility flag specifies if a currentPostSyncSlide value currently exists or not. If the currentPostSyncSlide value doesn't exist or is null, this value is false.

It can be used as the source for binding expressions which show/hide elements based on the existence of a post-sync slide reference.

This property can be used as the source for data binding.

currentPostSyncSlideNotExists

property

public var currentPostSyncSlideNotExists:Boolean = true

This utility flag specifies if a currentPostSyncSlide value currently does NOT exist. If the currentPostSyncSlide value doesn't exist or is null, this value is true. This is the opposite of the currentPostSyncSlideExists value.

It can be used as the source for binding expressions which show/hide elements based on the NON-existence of a post-sync slide reference.

This property can be used as the source for data binding.

currentPreSyncSlide

property

public var currentPreSyncSlide:IndividualSlide

A reference to the currently displayed slide; this reference updates as soon as the transition to the slide starts. This value can be used as the source for binding expressions which need to reference properties of the currently displayed slide.

It differs from currentDelayedSyncSlide and currentPostSyncSlide in when chronologically it is updated. The currentPreSyncSlide slide reference is updated as soon as the transition to the slide begins. The currentDelayedSyncSlide slide reference is updated after a certain delay passes following the transition to the slide beginning. The duration of this delay is specified in the ImageManager.delayedSyncDelay style property. The currentPostSyncSlide slide reference is updated when the transition to the slide has completed. All of the different slide references can have applicability depending on the application.

If you need to determine if this property currently has a value, reference the currentPreSyncSlideExists property.

This property can be used as the source for data binding.

See also

currentPreSyncSlideExists

property

public var currentPreSyncSlideExists:Boolean = false

This utility flag specifies if a currentPreSyncSlide value currently exists or not. If the currentPreSyncSlide value doesn't exist or is null, this value is false.

It can be used as the source for binding expressions which show/hide elements based on the existence of a pre-sync slide reference.

This property can be used as the source for data binding.

currentPreSyncSlideNotExists

property

public var currentPreSyncSlideNotExists:Boolean = true

This utility flag specifies if a currentPreSyncSlide value currently does NOT exist. If the currentPreSyncSlide value doesn't exist or is null, this value is true. This is the opposite of the currentPreSyncSlideExists value.

It can be used as the source for binding expressions which show/hide elements based on the NON-existence of a pre-sync slide reference.

This property can be used as the source for data binding.

effectLibrary

property

public var effectLibrary:EffectLibrary

Provides a reference to the main EffectLibrary instance, which is a repository for effects. See the EffectLibrary class for more information.

See also

com.dwuser.ss4.managers.EffectLibrary

errorManager

property

public var errorManager:ErrorManager

Provides a reference to the main ErrorManager instance. See the ErrorManager class for more information.

See also

com.dwuser.ss4.managers.ErrorManager

fullScreenEnabled

property

public var fullScreenEnabled:Boolean = false

This utility flag specifies if the slideshow is currently in full-screen mode (activated through the FullScreenButton element) or not.

It can be used as the source for binding expressions which show/hide elements based on the display mode (full-screen or normal). If you want to bind to whether full-screen is not enabled, use the fullScreenNotEnabled property instead.

This property can be used as the source for data binding.

fullScreenNotEnabled

property

public var fullScreenNotEnabled:Boolean = true

This utility flag specifies if the slideshow is currently NOT in full-screen mode (activated through the FullScreenButton element).

It can be used as the source for binding expressions which show/hide elements based on the display mode (full-screen or normal). If you want to bind to whether full-screen is enabled, use the fullScreenEnabled property instead.

This property can be used as the source for data binding.

kbManager

property

public var kbManager:KBManager

Provides a reference to the main KBManager instance, which is a repository for all KB effects. See the KBManager class for more information.

See also

com.dwuser.ss4.managers.KBManager

layoutManager

property

public var layoutManager:LayoutManager

Provides a reference to the main LayoutManager instance, which manages the slideshow's user interface. See the LayoutManager class for more information.

In a component implementation, this reference cannot safely be accessed until the FlashSlideshow instance dispatches the SlideshowEvent.LAYOUT_MANAGERREADY notification event. See the documentation on the SlideshowEvent.LAYOUT_MANAGERREADY constant for more information.

loadedAssetDomain

property

public var loadedAssetDomain:ApplicationDomain

Allows access to the ApplicationDomain used to load the external skin file. This allows for access to loaded skins, etc. Generally, this should NOT be accessed by any of your scripts. Instead, use the ClassReference('...') XML attribute format, as documented on the XMLAttributeFormats.CLASS_REFERENCE constant.

tooltipAppearanceManager

property

public var tooltipAppearanceManager:ToolTipAppearanceManager

Provides a reference to the main ToolTipAppearanceManager instance, which manages the appearance of all tooltips. See the ToolTipAppearanceManager class for more information.

utilityHolder

property

public var utilityHolder:Object

This holder can be used to hold any persistent values that are needed (e.g. within event handlers); it is an empty object.

xmlManager

property

public var xmlManager:XMLManager

Provides a reference to the main XMLManager instance, which manages all XML loading and can be queried later on to retrieve XML information. See the XMLManager class for more information.

See also

com.dwuser.ss4.managers.XMLManager

xmlManagerClass

property

public var xmlManagerClass:Class

Specifies the class to use when creating the XML manager. By default, this is the com.dwuser.ss4.managers.XMLManager class. However, the XMLManager class can be subclassed and the custom subclass specified here. When the main xmlManager instance is created, it will use the class specified on this variable.

See the XMLManager class for more information about extending the class.

The class specified for this value must always be the XMLManager class or subclass the XMLManager class.

The default value is com.dwuser.ss4.managers.XMLManager.

See also

xmlManager
com.dwuser.ss4.managers.XMLManager;

Constructor detail

FlashSlideshow

()

constructor

public function FlashSlideshow(createDummyShellOnly:Boolean = false)

Constructor

Parameters

createDummyShellOnly:Boolean (default = false)

Method detail

addEventListener

()

method

public override function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = true):void

Parameters

	`type:String`

	`listener:Function`

	`useCapture:Boolean` (default = `false`)

	`priority:int` (default = `0`)

	`useWeakReference:Boolean` (default = `true`)

createChildren

()

method

protected override function createChildren():void

destroy

()

method

public function destroy():void

Destroys the slideshow instance and does some necessary cleanup. This method would only need to be called if using a component implementation, and even in such a case it should only be called prior to a removeChild() call and destruction of the slideshow instance.

dispatchSlideshowEvent

()

method

public function dispatchSlideshowEvent(type:String, extraInfo:Object = null):void

A utility function designed for easy access; dispatches a slideshow control event based on the passed parameters. See the SlideshowEvent class for more information about control events.

Parameters

	`type:String` — The type of the event, as described by the string value of one of the control-event type constants in SlideshowEvent; see SlideshowEvent for more information.

	`extraInfo:Object` (default = `null`) — Optional; if specified, specifies the `extraInfo` parameters to be passed on the control event.

See also

com.dwuser.ss4.events.SlideshowEvent

measure

()

method

protected override function measure():void

setGlobalStyles

()

method

public function setGlobalStyles(selector:String, values:Object, applyImmediately:Boolean = true):void

A utility function designed for easy access; allows a global style property to be set. The values are passed in as key/value pair object.

Parameters

	`selector:String`

	`values:Object`

	`applyImmediately:Boolean` (default = `true`)

setView

()

method

public function setView(id:String):void

A utility function designed for easy access; opens the requested layout view. The layout view corresponding to the passed id value is opened.

Parameters

id:String

See also

LayoutManager

setViewDelayed

()

method

public function setViewDelayed(id:String, delay:Number):void

A utility function designed for easy access; opens the requested layout view after the specified delay has elapsed. The layout view corresponding to the passed id value is opened after the delay.

Parameters

	`id:String`

	`delay:Number`

See also

LayoutManager

startAudio

()

method

public function startAudio(level:String = ""):void

A utility function designed for easy access; starts/plays the audio on the specified level or levels. The level parameter can be a comma-separated list of values which include the following:

intro, gallery, and image

Here are some valid example values:

    intro,gallery,image
    gallery
    image
    gallery,image

Parameters

level:String (default = "")

startAutoplay

()

method

public function startAutoplay():void

A utility function designed for easy access; starts/plays autoplay if it is disabled.

stopAudio

()

method

public function stopAudio(level:String = ""):void

A utility function designed for easy access; stops/pauses the audio on the specified level or levels. The level parameter can be a comma-separated list of values which include the following:

intro, gallery, and image

Here are some valid example values:

    intro,gallery,image
    gallery
    image
    gallery,image

Parameters

level:String (default = "")

stopAutoplay

()

method

public function stopAutoplay():void

A utility function designed for easy access; stops/pauses autoplay if it is enabled.

Event detail

audio_imageSoundComplete

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

audio_imageSoundStart

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

audio_loadProgress

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

audio_positionUpdate

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

audio_setControlLabel

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

audio_setPosition

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

audio_setStatusPlaying

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

audio_setVolume

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

audio_showHideControls

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

audio_silentStop

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

audio_statusPlayingUpdate

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

autoplay_enableDisable

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

autoplay_enableDisableLoop

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

autoplay_removeCurrent

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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)

autoplay_timeoutCleared

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

autoplay_timeoutStarted

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

data_xmlLoaded

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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)

image_setDominantColor

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

imageLibrary_assetDestroyed

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

imageLibrary_checkedIn

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

images_closeGallery

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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)

images_displayImage

event

Event object type: com.dwuser.ss4.events.SlideshowEvent

images_galleryPreloadComplete

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

images_jumpToGalleryUniqueID

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.IMAGES_JUMPTOGALLERYUNIQID

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

images_jumpToUniqueID

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.IMAGES_JUMPTOUNIQID

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

images_requestGallery

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

images_setGallery

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

images_setGalleryComplete

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

images_setImage

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

images_setImageChangeable

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

images_syncImages

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

images_syncImagesStart

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

kenBurns_imageEffectEnd

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.KB_IMAGEEND

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

kenBurns_imageEffectStart

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.KB_IMAGESTART

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

layout_changeRequested

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.LAYOUT_REQUESTCHANGE

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

layout_managerReady

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

layout_setCurrentViewID

event

Event object type: com.dwuser.ss4.events.SlideshowEvent

layout_setWritable

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

layout_viewReady

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

loader_setGroupProgress

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

loader_setSingleProgress

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

loader_showGroupLoader

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.LOADER_SHOWGROUP

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

loader_showSingleLoader

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.LOADER_SHOWSINGLE

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

video_imageVideoComplete

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

video_imageVideoStart

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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

video_stopAll

event

Event object type: com.dwuser.ss4.events.SlideshowEvent
SlideshowEvent.type property = com.dwuser.ss4.events.SlideshowEvent.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)

XML Flash Slideshow v4 - Class Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class FlashSlideshow	Properties \| Methods \| Events \| Styles \| Effects \| Constants

Package	com.dwuser.ss4.ui
Class	public class FlashSlideshow
Inheritance	FlashSlideshow Canvas Container UIComponent FlexSprite flash.display.Sprite