Packagecom.dwuser.ss4.managers
Classpublic class KBManager

The KBManager class functions as a central repository for all Ken Burns (KB) effects. A single instance of the class is created for the slideshow and is accessible by referencing the FlashSlideshow_instance.kbManager property.

All effects stored in this repository are KBEffect class instances. See that class for more information about how KB effects are constructed and their structure. See the applyXML method below to see how the definitions in the XML configuration file are converted to actual KB effects.

For more detailed XML integration information, see the KBEffect class.

See also

com.dwuser.ss4.utils.KBEffect
applyXML
com.dwuser.ss4.ui.FlashSlideshow


Public Methods
 MethodDefined by
  
KBManager
  
applyXML(node:XML):void
Processes an XML node which defines kb effects and adds them to the manager.
KBManager
  
getEffect(id:String):KBEffect
This method returns the actual KBEffect instance associated with the requested id value.
KBManager
Constructor detail
KBManager()constructor
public function KBManager()
Method detail
applyXML()method
public function applyXML(node:XML):void

Processes an XML node which defines kb effects and adds them to the manager. This method normally doesn't need to be called directly; it is all handled automatically.

The node parameter should be in the format listed below. This XML format is the format used for the <kenburns> node in the XML configuration file, which is a subnode of the main <slideshow> node.

    <kenburns>
     <kbEffect id="sampleEffectID" startX="-106" startY="85" startZoom="1.2" endX="82" endY="-91" endZoom="1" delay="500" duration="5000" easing="Easing(Quadratic.easeInOut)"/>
        ... More kbEffect nodes...
    </kenburns>
    

For more detailed information, see the KBEffect class.

Parameters
node:XML

See also

getEffect()method 
public function getEffect(id:String):KBEffect

This method returns the actual KBEffect instance associated with the requested id value. If no KB effect was defined for the requested id value, an empty default effect is returned.

If one or more effects has been defined and Random is specified as the ID value, a random effect will be returned from all created effects.

If one or more effects has been defined and Cycle is specified as the ID value, all created effects will be cycled through as effects are needed.

Parameters
id:String

Returns
KBEffect — The KBEffect instance associated with the requested id

See also