Packagecom.dwuser.ss4.core
Classpublic class SlideshowParams

In standalone implementations, the SlideshowParams class allows access to all slideshow configuration parameters which were passed in the HTML page. As a utility class, it has no visual representation. Instead, it must be called within your own scripts or event handlers, etc. This class rarely has any relevant applicability.

The options stored in this class control options which appear at the very start of the slideshow, before even the XML configuration file has been loaded. For more information about the parameters available, see the FlashSlideshowConfigurationParameters class.

See also

FlashSlideshowConfigurationParameters
com.dwuser.ss4.ui.FlashSlideshow


Public Methods
 MethodDefined by
  
SlideshowParams
  
applyParams(obj:Object):void
[static] Main public methods
SlideshowParams
  
getParam(param:String):*
[static] Returns a formatted copy of the requested parameter as defined in the slideshow HTML, or null if the parameter is not defined.
SlideshowParams
Constructor detail
SlideshowParams()constructor
public function SlideshowParams()
Method detail
applyParams()method
public static function applyParams(obj:Object):void

Main public methods

Parameters
obj:Object
getParam()method 
public static function getParam(param:String):*

Returns a formatted copy of the requested parameter as defined in the slideshow HTML, or null if the parameter is not defined.

Parameters
param:String — The name of the parameter being requested.

Returns
* — The formatted parameter value requested, or null if the parameter is not defined.