Packagecom.dwuser.ss4.core
Classpublic dynamic class FlashSlideshowConfigurationParameters

When using a component implementation of the FlashSlideshow, this class holds all of the initialization parameters.

In a component implementation, you will create an instance of this class and pass it to the slideshow's configurationParameters property immediately after creating the FlashSlideshow instance.

In a standard standalone configuration (as implemented through the default SWF's installed by the Dreamweaver extension), the properties on this class are passed to the slideshow through the slideshow HTML's initialization parameter object.

The parameters on this class control the most basic settings on the slideshow -- specifically, those which are set prior to the main XML configuration file being loaded. This includes such parameters as:

All of the parameters are formatted as strings. This is because the slideshow automatically converts/casts them to the correct data type. In the case of parameters such as backgroundColor, this means that you will pass an HTML-style color value such as #FFFFFF instead of a hex-formatted number such as 0xFFFFFF.

Note that the all of the properties have defaults, and so most settings can be omitted. When properties are omitted, their default values are automatically used. The only truly required parameter is the xml parameter, which specifies the XML configuration file to be loaded.

See also

com.dwuser.ss4.ui.FlashSlideshow
com.dwuser.ss4.ui.FlashSlideshow.configurationParameters


Public Properties
 PropertyDefined by
  backgroundAlpha : String = "1"
Specifies the opacity of the slideshow background.
FlashSlideshowConfigurationParameters
  backgroundColor : String = "#000000"
Specifies the background color of the slideshow.
FlashSlideshowConfigurationParameters
  backgroundImage : String = ""
Specifies the url to the background image for the slideshow.
FlashSlideshowConfigurationParameters
  colorCorrection : String = "match"
Specifies the color correction mode to be used.
FlashSlideshowConfigurationParameters
  controlButtonsEnabled : String = "true"
Specifies if the control buttons should function normally/properly when clicked.
FlashSlideshowConfigurationParameters
  customizeVScrollBar : String = "true"
Specifies if the scrollbars in the slideshow application should be customized with the default customized version.
FlashSlideshowConfigurationParameters
  dataLoaderHideDelay : String = "700"
Specifies the duration, in milliseconds, of the fade-out effect used on the data preloader before the slideshow actually initializes.
FlashSlideshowConfigurationParameters
  dataLoaderLabel : String = "Loading Data... {N}%"
Specifies the label displayed on the data preloader while external XML data are being loaded.
FlashSlideshowConfigurationParameters
  destroyOldBitmaps : String = "true"
Specifies if loaded bitmaps (images) should be removed from memory after they have been displayed.
FlashSlideshowConfigurationParameters
  disableMultipleXML : String = "false"
Specifies if commas should be ignored in the xml parameter.
FlashSlideshowConfigurationParameters
  externalSkinURL : String = ""
Optionally specifies the URL to an external skin SWF file which holds skin resources.
FlashSlideshowConfigurationParameters
  initViewID : String = ""
Allows the initially visible layout view to be explicitly specified.
FlashSlideshowConfigurationParameters
  initXML : String = ""
Allows for a direct injection of starter XML data through an XML string value.
FlashSlideshowConfigurationParameters
  layoutXML : String = ""
Allows for the layout XML (<ui>...</ui>) to be explicitly passed in an XML string value.
FlashSlideshowConfigurationParameters
  preloaderAlpha : String = "0.4"
Specifies the opacity (alpha) of the label text and progress bar graphic on the preloader.
FlashSlideshowConfigurationParameters
  preloaderBarHeight : String = "2"
Specifies the height (thickness), in pixels, of the progress bar graphic on the preloader.
FlashSlideshowConfigurationParameters
  preloaderBarPadding : String = "10"
Specifies the padding, in pixels, between the bottom of the progress bar graphic and the bottom edge of the slideshow.
FlashSlideshowConfigurationParameters
  preloaderColor : String = "#FFFFFF"
Specifies the color of the preloader's progress bar graphic.
FlashSlideshowConfigurationParameters
  preloaderLabel : String = "Loading... {N}%"
Specifies the label displayed on the preloader while the slideshow SWF loads.
FlashSlideshowConfigurationParameters
  preloaderLibraryLabel : String = "Loaded Library {N} of {T}..."
Specifies the label displayed on the preloader while any shared libraries are loaded.
FlashSlideshowConfigurationParameters
  preloaderTextColor : String = "#FFFFFF"
Specifies the color of the label text on the preloader.
FlashSlideshowConfigurationParameters
  preloaderTextFont : String = "Verdana"
Specifies the font used for the label text on the preloader.
FlashSlideshowConfigurationParameters
  preloaderTextPadding : String = "0"
Specifies the padding, in pixels, between the bottom of the text and the progress bar graphic.
FlashSlideshowConfigurationParameters
  preloaderTextSize : String = "10"
Specifies the size, in pixels, of the label text on the preloader
FlashSlideshowConfigurationParameters
  preventCache : String = "true"
Specifies if a cache-busting querystring should be appended to all XML files' URLs when loading to prevent data caching.
FlashSlideshowConfigurationParameters
  rawXML : String = ""
Allows for a direct injection of XML data through an XML string value.
FlashSlideshowConfigurationParameters
  redirect : String = ""
Optionally specifies the URL of a page to redirect to if the appropriate Flash Player version is unavailable.
FlashSlideshowConfigurationParameters
  rightClickLabel : String = ""
Specifies the label displayed in the right-click context menu when the user right-clicks on the slideshow.
FlashSlideshowConfigurationParameters
  rightClickLinkTarget : String = ""
Specifies the window in which the rightClickURL link should be opened, if one is specified.
FlashSlideshowConfigurationParameters
  rightClickURL : String = ""
Specifies the URL to redirect to when the user clicks on the custom right-click menu option specified by rightClickLabel.
FlashSlideshowConfigurationParameters
  showErrorBar : String = "true"
Specifies whether the 'Asset Loading Error' notification bar should be shown if an image or video fails to load.
FlashSlideshowConfigurationParameters
  useDataLoader : String = "true"
Specifies if the data preloader should be displayed while the external XML data are being loaded.
FlashSlideshowConfigurationParameters
  useKeyboardShortcuts : String = "true"
Specifies if the standard keyboard shortcuts should be enabled.
FlashSlideshowConfigurationParameters
  usePreloader : String = "true"
Specifies if the preloader is displayed while the slideshow SWF loads.
FlashSlideshowConfigurationParameters
  xml : String = ""
Specifies the URL to all external XML configuration and data file(s).
FlashSlideshowConfigurationParameters
Public Methods
 MethodDefined by
  
FlashSlideshowConfigurationParameters
Property detail
backgroundAlphaproperty
public var backgroundAlpha:String = "1"

Specifies the opacity of the slideshow background. Valid values range from 0.0 (fully transparent) to 1.0 (fully opaque). Setting the value to 0 makes the slideshow background transparent.

The default value is "1".

backgroundColorproperty 
public var backgroundColor:String = "#000000"

Specifies the background color of the slideshow. Must be passed in as a hex color string, e.g. #000000 (black).

The default value is "#000000".

backgroundImageproperty 
public var backgroundImage:String = ""

Specifies the url to the background image for the slideshow. This must be the URL of a JPEG, PNG, GIF or SWF image. It is loaded and displayed at runtime, both during preloading and after the main slideshow begins. The URL must be relative to the HTML page which the slideshow is displayed in. An empty string (the default value) means that no image is being specified.

The default value is "".

colorCorrectionproperty 
public var colorCorrection:String = "match"

Specifies the color correction mode to be used.

Note: This was accurate as of 6-19-09. As Adobe addresses bugs and/or changes functionality, the information on this feature may change.

This is an advanced setting. First, to enable color correction, you must be using the Professional version SWF (only available in the Pro version of the software). This setting is in the Global Configuration and Playback Settings section of the wizard. Next, you must add a special parameter to your Slideshow HTML code in the initialization object:

_param_wmode:'window'

This will enable a wmode value of window, which is required for color correction to take place.

By default, the Flash Player will attempt to use color correction only if the host browser is using color correction (a small minority of users, mostly Safari). At the time of writing, Flash Player color correction detection was buggy at best. In Mac-based testing, color correction was NEVER enabled by default.

It is possible to force color correction to be enabled at all times. However, enabling slideshow color correction in a browser which does not support color correction may result in the slidehow not matching the HTML page. The following values are supported for the colorCorrection parameter

Enabling color correction in a browser which does not support color correction may result in the slidehow not matching the HTML page.

The default value is "match".

controlButtonsEnabledproperty 
public var controlButtonsEnabled:String = "true"

Specifies if the control buttons should function normally/properly when clicked. If set to false, then the control buttons will not do anything when clicked. This parameter should never be changed from its default value of true.

The default value is "true".

customizeVScrollBarproperty 
public var customizeVScrollBar:String = "true"

Specifies if the scrollbars in the slideshow application should be customized with the default customized version. If disabled, the standard scrollbars will be left intact. This applies to all scrollbars displayed in the slideshow, including any scrollbars on the caption text.

The default value is "true".

dataLoaderHideDelayproperty 
public var dataLoaderHideDelay:String = "700"

Specifies the duration, in milliseconds, of the fade-out effect used on the data preloader before the slideshow actually initializes. Using a value of slightly less than a second allows for a more "polished" and "gentle" transition from the preloading phase to the actual slideshow display phase.

The default value is "700".

dataLoaderLabelproperty 
public var dataLoaderLabel:String = "Loading Data... {N}%"

Specifies the label displayed on the data preloader while external XML data are being loaded. To display the current percentage which has loaded, include {N} in the label value.

The default value is "Loading Data... {N}%".

destroyOldBitmapsproperty 
public var destroyOldBitmaps:String = "true"

Specifies if loaded bitmaps (images) should be removed from memory after they have been displayed. Enabling this option can result in better performance, but can cause a slight delay when the user re-requests an already-viewed image, while the image is re-loaded from cache. On balance, it is usually best to leave this option at its default value of true.

The default value is "true".

disableMultipleXMLproperty 
public var disableMultipleXML:String = "false"

Specifies if commas should be ignored in the xml parameter. This parameter should almost always be left at its default value of false. The only time it would be necessary is if your single XML file URL contained commas. If this is the case, however, it is strongly recommended that you instead modify the URL to not contain commas, as this parameter could cause unexpected results.

The default value is "false".

externalSkinURLproperty 
public var externalSkinURL:String = ""

Optionally specifies the URL to an external skin SWF file which holds skin resources. To not load an external skin file, leave this parameter at its default value (an empty string).

This URL must be relative to the HTML page holding the slideshow.

The default value is "".

See also

initViewIDproperty 
public var initViewID:String = ""

Allows the initially visible layout view to be explicitly specified. If provided, this value should match the id attribute on a <view id="bla" ... > node in the Layout XML. If this parameter is omitted, the default view will be initially opened.

The default value is "".

initXMLproperty 
public var initXML:String = ""

Allows for a direct injection of starter XML data through an XML string value. If specified, this XML (in <slideshow>...</slideshow> format) will be applied prior to the external XML file(s) being loaded. To omit this parameter, leave it at the default value (an empty string).

The default value is "".

layoutXMLproperty 
public var layoutXML:String = ""

Allows for the layout XML (<ui>...</ui>) to be explicitly passed in an XML string value. This value should generally NOT be specified, but rather left at its default, an empty string. If this value is specified, it will override any loaded layout XML which came from the XML configuration file.

The default value is "".

preloaderAlphaproperty 
public var preloaderAlpha:String = "0.4"

Specifies the opacity (alpha) of the label text and progress bar graphic on the preloader. Valid values range from 0.0 (fully transparent) to 1.0 (fully opaque).

The default value is "0.4".

preloaderBarHeightproperty 
public var preloaderBarHeight:String = "2"

Specifies the height (thickness), in pixels, of the progress bar graphic on the preloader.

The default value is "2".

preloaderBarPaddingproperty 
public var preloaderBarPadding:String = "10"

Specifies the padding, in pixels, between the bottom of the progress bar graphic and the bottom edge of the slideshow.

The default value is "10".

preloaderColorproperty 
public var preloaderColor:String = "#FFFFFF"

Specifies the color of the preloader's progress bar graphic. Must be passed in as a hex color string, e.g. #FFFFFF (white).

The default value is "#FFFFFF".

preloaderLabelproperty 
public var preloaderLabel:String = "Loading... {N}%"

Specifies the label displayed on the preloader while the slideshow SWF loads. Only applicable for standalone implementations. To display the currently-loaded percentage, include {N} in the label.

The default value is "Loading... {N}%".

preloaderLibraryLabelproperty 
public var preloaderLibraryLabel:String = "Loaded Library {N} of {T}..."

Specifies the label displayed on the preloader while any shared libraries are loaded. Not applicable in any default configuration. This parameter is only be used if shared libraries are used in the slideshow SWF. No such libraries are used by default, so this parameter is generally irrelevant. To display the number of libraries which have loaded, include {N} in the label. To display the number of total libraries to be loaded, include {T} in the label.

The default value is "Loaded Library {N} of {T}...".

preloaderTextColorproperty 
public var preloaderTextColor:String = "#FFFFFF"

Specifies the color of the label text on the preloader. Must be passed in as a hex color string, e.g. #FFFFFF (white).

The default value is "#FFFFFF".

preloaderTextFontproperty 
public var preloaderTextFont:String = "Verdana"

Specifies the font used for the label text on the preloader. This font must be a standard system font (one that is installed on all systems, e.g. Arial or Verdana) or it will degrade.

The default value is "Verdana".

preloaderTextPaddingproperty 
public var preloaderTextPadding:String = "0"

Specifies the padding, in pixels, between the bottom of the text and the progress bar graphic.

The default value is "0".

preloaderTextSizeproperty 
public var preloaderTextSize:String = "10"

Specifies the size, in pixels, of the label text on the preloader

The default value is "10".

preventCacheproperty 
public var preventCache:String = "true"

Specifies if a cache-busting querystring should be appended to all XML files' URLs when loading to prevent data caching. When set to true, all external XML data files which are loaded will have a value similar to somefile.xml?nocache=4565456484 appended to their URLs before loading. This ensures that the very latest version of the XML file is loaded, and the most up-to-date image data is displayed. Only set to false if your server doesn't support querystrings or the data is being loaded exclusively from a local file system (as opposed to a real server).

The default value is "true".

rawXMLproperty 
public var rawXML:String = ""

Allows for a direct injection of XML data through an XML string value. If specified, this XML (in <slideshow>...</slideshow> format) will be used as the configuration data instead of the loaded XML. To omit this parameter, leave it at the default value (an empty string).

The default value is "".

redirectproperty 
public var redirect:String = ""

Optionally specifies the URL of a page to redirect to if the appropriate Flash Player version is unavailable.

If specified and the appropriate Flash Player version is unavailable, the user will be redirected to the specified URL. If a redirection page is not specified, the user will be prompted to upgrade or the alternate content including in the page will be shown. See the manual for more information about the Flash Player detection which is used.

The default value is "".

rightClickLabelproperty 
public var rightClickLabel:String = ""

Specifies the label displayed in the right-click context menu when the user right-clicks on the slideshow. Leave as an empty string to disable this option.

The default value is "".

rightClickLinkTargetproperty 
public var rightClickLinkTarget:String = ""

Specifies the window in which the rightClickURL link should be opened, if one is specified. If not specified, defaults to _blank (a new window). Other supported values include _self (the same window), and _parent (the parent frame if using frames).

The default value is "".

See also

rightClickURLproperty 
public var rightClickURL:String = ""

Specifies the URL to redirect to when the user clicks on the custom right-click menu option specified by rightClickLabel. Leave as an empty string to not redirect to any URL when the item is selected.

The default value is "".

showErrorBarproperty 
public var showErrorBar:String = "true"

Specifies whether the 'Asset Loading Error' notification bar should be shown if an image or video fails to load. If the default value - true - is used, then the bar will be shown if any loading errors occur. If set to false, then the notification bar will never be shown. It is generally best to leave the default value to help with determining problems; disabling the bar makes it difficult to know what which asset URL's are failing to load.

The default value is "true".

useDataLoaderproperty 
public var useDataLoader:String = "true"

Specifies if the data preloader should be displayed while the external XML data are being loaded.

The default value is "true".

useKeyboardShortcutsproperty 
public var useKeyboardShortcuts:String = "true"

Specifies if the standard keyboard shortcuts should be enabled. For some configurations, you may want to automatically disable all keyboard shortcuts. This parameter allows for disabling all shortcuts with a single setting change.

The default value is "true".

usePreloaderproperty 
public var usePreloader:String = "true"

Specifies if the preloader is displayed while the slideshow SWF loads. Only applicable for standalone implementations.

The default value is "true".

xmlproperty 
public var xml:String = ""

Specifies the URL to all external XML configuration and data file(s).

This is the most important configuration parameter for the slideshow. It tells the slideshow where all of the external data should be loaded from.

The value should be a list of one or more URLs, separated by commas. Each URL must be relative to the HTML page holding the slideshow. Example of the comma separation:

   Only one XML file:
   path/to/main_configuration.xml
   
   Two XML files:
   path/to/main_configuration.xml,path/to/supplementary_data.xml
   

If you want to link an external XML data source to a specific gallery which has already been defined and given a linkage id (e.g. <gallery ... id="someGalleryID">), then use the following format for that URL:

{gallery:someGalleryID}http://www.someserver.com/some/path_to/dynamic_data.php

If you omit the {gallery:id} part, the external data source will be added to a newly-created gallery automatically. For example, here's an xml parameter value which has the following characteristics: The main XML configuration file is slideshow_data0.xml; dynamic data is being loaded from data/dynamic_data.php and added to a new gallery; dynamic data is being loaded from http://api.flickr.com/some/path/to/photos.rss and being added to the already-defined flickrImages gallery:

slideshow_data0.xml,data/dynamic_data.php,{gallery:flickrImages}http://api.flickr.com/some/path/to/photos.rss

Any relative URLs must be relative to the HTML page holding the slideshow.

The default value is "".

Constructor detail
FlashSlideshowConfigurationParameters()constructor
public function FlashSlideshowConfigurationParameters()