WipeTransition class

Inheritance Movie Clip > UIObject class > UIComponent class > WipeTransition (see flash help for documentation on parent classes).

ActionScript Class Name flextnet.components.WipeTransition

Each component class has a version property, which is a class property. Class properties are available only on the class itself. The version property returns a string that indicates the version of the component. To access this property, use the following code:

trace(flextnet.components.WipeTransition.version);

Note: The code trace(myItInstance.version); returns undefined.

Method summary for the WipeTransition class

Besides methods in parent classes, you can call the following methods on an WipeTransition component:

Method	Description
`clearScreen()`	Removes all images from display and clears the image list.
`parseImageXml()`	Recreates image list based on the imageXml property.
`pauseTransition()`	Pauses transition and image show.
`playTransition()`	Resumes or restarts the image show.
`showImage()`	Immediately shows an image you specify and pauses the slide show.

Property summary for the WipeTransition class

These are the properties of the WipeTransition class:

Property	Description
`appendMode`	If set to true, combines all lists of images and mc's specified in mcList, loadImageList and dataFile into one combined list.
`autoStart`	If true, the images & transitions begin displaying automatically.
`bgColor`	A solid color behind all images.
`border`	If true, show a border around the component instance.
`borderMc`	Specifies the linkage id of a movie clip to be used as the border.
`currentIndex`	A 0-based index of the current image being displayed.
`dataFile`	An url of a file (xml or plain text) with a detailed list of images, transitions, and properties for each.
`flipVertical`	If true, flip the transition effects vertically.
`flipHorizontal`	If true, flip the transition effects horizontally.
`imageBytesLoaded`	Read-only; number of bytes already loaded for the image currently being loaded.
`imageBytesTotal`	Read-only; number of total bytes for the image currently being loaded.
`imagesLeftToLoad`	Read-only; number of images that have not yet been fully loaded.
`imageXml`	Read-only; an XML object with image list and corresponding properties.
`isPaused`	Read-only; specfies whether the running transition has been paused.
`loadImageList`	A list of image files (urls) to be loaded into the component.
`masterList`	A list of Objects containing MovieClip's that are shown during the slide show.
`mcList`	A list of linkage ids for movie clips to be used as images in the slide show.
`nextIndex`	A 0-based index of the next image to show in the list.
`preloader`	Specifies a movie clip to be used as a preloder for images/swf's.
`retainAspectRatio`	Keeps original aspect ratio when displaying each image or mc.
`secondsDelay`	Number of seconds to elapse before showing the next image on the list.
`sizeToFit`	Automatically size the component to fit the image being displayed. NOT CURRENTLY SUPPORTED.
`stockTransition`	A linkage id of the 'one' transition to use during the slide show.
`transitionOrder`	Can be 'sequential' or 'random'.
`transitionList`	A list of transitions to be used during the slide show.

Event summary for the WipeTransition class

These are the events of the WipeTransition class:

Events	Description
`allImagesLoaded`	Triggered when all image data that needed to be loaded has completed loading.
`transitionEnded`	Triggered when the current transition has finished playing.
`transitionStarted`	Triggered when the next transition is about to begin.