Packagecom.dwuser.ss4.managers
Classpublic class ImageManager

Holds the style parameters which control global image management, including loading and other settings. This class is not implemented by a visual element; instead, it only provides control over settings which have no visual representation. It is used to document the available ImageManager style values which can be applied in the <styles> section of the XML configuration file.

To learn how to customize the gallery password prompt, see the GalleryPasswordPanel and GalleryPasswordAlert classes.

Style XML Implementation Example:

The following example code goes in the <styles> section of the main <slideshow> holder node in a slideshow XML configuration file. 

   <styles>
   ...
      <ImageManager
         openDefaultGallery="true"
         openDefaultImage="true"
         preloadMode="smart"
         smartLoadDelay="50"
         destroyOldBitmaps="true"
         delayedSyncDelay="1000"
         resetGlobalSlideRefsOnSetGallery="false"
      />
   ...
   </styles>

See also

com.dwuser.ss4.ui.GalleryPasswordPanel
com.dwuser.ss4.ui.GalleryPasswordAlert

Public Properties
 PropertyDefined by
  currentGallery : Object
[static] Specifies the current gallery object (if any exists), in format of {id:Gallery index, gallery:Gallery XML Node Reference} .
ImageManager
  currentImage : Object
[static] Specifies the current image object (if any exists), in format of {id:Image index, image:Image XML Node Reference} .
ImageManager
  imagesLocked : Boolean = false
[static] Specifies if the images can be changed or if they are locked (usually due to a transition taking place).
ImageManager
  multipleGalleriesExist : Boolean = false
[static] Specifies if more than one gallery exists.
ImageManager
Public Methods
 MethodDefined by
  
ImageManager()
ImageManager
  
init():void
ImageManager
Styles
 StyleDescriptionDefined by
  
delayedSyncDelay
Type: Number   Format: Time   CSS Inheritance: no
Specifies the delay between when the SlideshowEvent.IMAGES_SYNCIMAGESSTART event is dispatched and when the currentDelayedSyncSlide property is updated on the main FlashSlideshow instance. The currentDelayedSyncSlide property is designed to allow image-property bindings which execute at a specific point relative to the image transition. This allows finer control over, for example, a caption box which dynamically moves to always be at the bottom of the images. The default value is 1000.		ImageManager
  
destroyOldBitmaps
Type: Boolean   CSS Inheritance: no
Specifies if old images should be removed from memory when the user selects a new image. This can in some cases boost over performance. However, it can also cause delays when a user re-requests an image they've already viewed. The default value is true.		ImageManager
  
openDefaultGallery
Type: Boolean   CSS Inheritance: no
Specifies whether the slideshow should automatically open the initial gallery or wait for an explicit user selection. If set to false, the user will have to manually select a gallery to begin the slideshow. The default value is true.		ImageManager
  
openDefaultImage
Type: Boolean   CSS Inheritance: no
Specifies whether the slideshow should automatically open the initial image in a gallery when a gallery is opened, or wait for an explicit user selection. If set to false, the user will have to manually select an image for the gallery to start. This setting should generally always be left at its default value of true. The default value is true.		ImageManager
  
preloadMode
Type: String   Format: Enumerated   CSS Inheritance: no
Specifies the loading mode used to preload images.

Explanation of image preloading modes:

  • smart - Smart Loading - This is usually the best option. As soon as the first image is loaded, it is displayed. However, in the background, loading of subsequent images continues. If the user chooses to skip to an unloaded image, that image is loaded and the loading manager then starts loading the images subsequent to it.
  • onDemand - On-demand - This loading mode only loads each image when it is specifically requested. This option minimizes bandwidth usage, but can require your users to wait each time they request an image if they have a slow connection or the images are very large.
  • preloadAll - Preload Entire Gallery - Preloads all images in the gallery before the gallery begins to play. This loading mode is NOT recommended for most configurations, as it can cause lengthy up-front loading times. It is useful for certain timed presentations, however, where there must be an exact delay between every image.
  • 3d - 3D Display Preload - This preloading method should only be used for certain 3D display elements in the professional version. Oftentimes, the preloadThumbs mode is a better choice. It preloads all of the thumbnail/low-res images before the gallery opens. When a specific image is requested, the low-res image is blown up to full size until the full-size high-res image can load.
  • preloadThumbs - Preload Thumbs, then Smart Loading - This preloading mode preloads all thumbnail images before the gallery opens, then subsequently uses the Smart Loading method for all full-size images. This option should be used if it's important that the user have access to all thumbnails for navigation.

The default value is smart.		ImageManager
  
resetGlobalSlideRefsOnSetGallery
Type: Boolean   CSS Inheritance: no
Specifies if the global slide references (on the main FlashSlideshow instance) should be reset when a new gallery is opened via the SlideshowEvent.IMAGES_SETGALLERY control event. By default, the value is false, which means that the global slide references will be left intact until the first image in the new gallery opens. However, by changing the value to true, the references will all be reset as soon as the IMAGES_SETGALLERY control event is dispatched; the slideshow.currentPreSyncSlideExists, slideshow.currentDelayedSyncSlideExists, and slideshow.currentPostSyncSlideExists properties will all be reset to false.

Yes, this is an agregiously long style property name. Sorry if you don't like it.

The default value is false.		ImageManager
  
smartLoadDelay
Type: Number   Format: Time   CSS Inheritance: no
Specifies the delay, in milliseconds, between each image load when performing smart loading. This setting usually only makes a difference when a user re-visits a page and the slideshow images are already in the user's cache. In this case, it prevents the slideshow from bogging down as all of the images are loaded from the cache. PLEASE NOTE - This setting is completely unrelated to the autoplay delay betwen images during playback. The default value is 50.		ImageManager
  
smartLoadMax
Type: Number   CSS Inheritance: no
Specifies the maximum number of images ahead from the current image to load when performing smart loading. This setting essentially allows control over the "buffering" that takes place on the slideshow when smart loading is enabled as the preloadMode.

Use of a lower value ensures that less unnecessary bandwidth will be consumed: only the images near where the user is viewing will be preloaded. This is especially important when working with galleries that have a large number of photos, and when loading from a third-party site such as Flickr.

A higher value (or -1 to indicate ALL images in the gallery) can be used to ensure that the user can skip around from place to place in the gallery with everything already being preloaded behind the scenes. However, for most connection speeds this will not make any noticeable difference and, in the process, consume a large quantity of unnecessary bandwidth.

The default value is 10.		ImageManager
Property detail
currentGalleryproperty
public static var currentGallery:Object

Specifies the current gallery object (if any exists), in format of {id:Gallery index, gallery:Gallery XML Node Reference} .

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

currentImageproperty 
public static var currentImage:Object

Specifies the current image object (if any exists), in format of {id:Image index, image:Image XML Node Reference} .

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

imagesLockedproperty 
public static var imagesLocked:Boolean = false

Specifies if the images can be changed or if they are locked (usually due to a transition taking place).

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

multipleGalleriesExistproperty 
public static var multipleGalleriesExist:Boolean = false

Specifies if more than one gallery exists. This bindable property can be used to determine if a gallery selector needs to be shown (if there's only one gallery, no selector would be needed).

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

Constructor detail
ImageManager()constructor
public function ImageManager()
Method detail
init()method
public function init():void



(c) Copyright 2010 DWUser.com - http://www.dwuser.com/flashslideshow/