Slideshow > API

Properties

Property Type Default Description
xmlPath String "" (Empty String) The location of the XML file.

Example:
mySlideshow.xmlPath = "files/xml/images.xml";
items Array [] An array of objects, each object containing the source of the content and other additional data.

Example:
mySlideshow.items = [{source:"images/img0.jpg"}, {source:"images/img1.jpg"}, {source:"images/img2.jpg"}];
itemsArray Array [] An array of strings, each string containing the source of the content.

Example:
mySlideshow.itemsArray = ["images/img0.jpg", "files/img1.jpg", "images/img2.jpg"];
scaleMode String "exactFit" The scaling of each item. "exactFit" will resize all items to the maximum width and height. "maintainAspectRatio" will resize the items to the maximum width or height, maintaining the aspect ratio. "noScale" will ignore the maximum width and height, maintaining the items at the original dimensions.

Example:
mySlideshow.scaleMode = "maintainAspectRatio";
alignType String "middleCenter" The alignment of the items. Values: "topLeft", "topCenter", "topRight", "middleLeft", "middleCenter", "middleRight", "bottomLeft", "bottomCenter", "bottomRight".

Example:
mySlideshow.alignType = "topLeft";
autoLoad Boolean true Indicates whether the first item will load automatically.

Example:
mySlideshow.autoLoad = false;
handCursor Boolean false Indicates whether a hand cursor will be displayed when the mouse rolls over an item.

Example:
mySlideshow.handCursor = true;
interactiveItems Boolean false Indicates whether the items will be interactive. Set this property to true if the items contain objects that need to respond to mouse interaction.

Example:
mySlideshow.interactiveItems = true;
border Boolean false Indicates whether a border will be added for each item.

Example:
mySlideshow.border = true;
borderColor uint 0xFFFFFF The color of the border.

Example:
mySlideshow.borderColor = 0xFF00FF;
borderAlpha Number 1.0 The alpha of the border.

Example:
mySlideshow.borderAlpha = 0.5;
borderThickness Number 5 The thickness of the border.

Example:
mySlideshow.borderThickness = 0xFF00FF;
preloaderType String "bar" The type of preloader. Values: "bar", "pie", "circular1", "circular2", "circular3" and "none".

Example:
mySlideshow.preloaderType = "circular2";
preloaderSize Number 100 The width of the preloader if preloaderType is set to "bar" and the radius of the preloader if preloaderType is set to "pie", "circular1", "circular2" or "circular3".

Example:
mySlideshow.preloaderSize =15;
preloaderFillAlpha Number 0.5 The alpha of the preloader's fill portion.

Example:
mySlideshow.preloaderFillAlpha = 0.7;
preloaderLineAlpha Number 1.0 The alpha of the preloader's line portion.

Example:
mySlideshow.preloaderLineAlpha = 0.2;
preloaderFillColor uint 0xFFFFFF The color of the preloader's fill portion.

Example:
mySlideshow.preloaderFillColor = 0x0000FF;
preloaderLineColor uint 0xFFFFFF The color of the preloader's line portion.

Example:
mySlideshow.preloaderLineColor = 0xFF0000;
useCacheAsBitmap Boolean false Indicates the value of the cacheAsBitmap property for each item. Setting this property to true might result in better performance but it could also be a problem if the component has too many items.

Example:
mySlideshow.useCacheAsBitmap = true;
temporaryClipReference Object null The name of a Class associated to a library symbol that will be displayed for each item until the content of the item is loaded. If no value is specified, automatically a rectangle will be used with a specified alpha and color. If you don't want a temporary clip to be displayed at all, simply set the temporaryClipAlpha property to 0.

Example:
mySlideshow.temporaryClipReference = "TempClip";
temporaryClipAlpha Number 0.5 The alpha of the temporary clip. This property will be ignored if a reference to a temporary clip is set.

Example:
mySlideshow.temporaryClipAlpha = 1.0;
temporaryClipColor uint 0xCCCCCC The color of the temporary clip. This property will be ignored if a reference to a temporary clip is set.

Example:
mySlideshow.temporaryClipColor = 0x000000;
continueAfterError Boolean false Indicates whether the component will ignore invalid sources when external content is loaded.

Example:
mySlideshow.continueAfterError = true;
autoSlideshow Boolean false Indicates whether the component will be in auto slideshow mode.

Example:
mySlideshow.autoSlideshow = true;
autoSlideshowDelay Number 3 Indicates the delay of the auto scrollslideshow, in seconds.

Example:
mySlideshow.autoSlideshowDelay = 4;
autoSlideshowDirection String "next" Indicates the direction in which the items will be selected.

Example:
mySlideshow.autoSlideshowDirection = "previous";
selectOver uint 1 Indicates over how many items the scrolling will be executed when selectNext() and selectPrevious() methods are used.

Example:
mySlideshow.selectOver = 3;
selectedIndex uint 0 Sets the index of the item that will be opened first.

Example:
mySlideshow.selectedIndex= 3;
transitionEffect Object null An instance of a TransitionEffect component.

Example:
var fadeTransition:FadeTransition = new FadeTransition();
mySlideshow.transitionEffect = fadeTransition;
or mySlideshow.transitionEffect = "fadeTransition";
videoPlayer Object null An instance of a SlideshowVideoPlayer component.

Example:
var vp:SlideshowVideoPlayer = new SlideshowVideoPlayer();
mySlideshow.videoPlayer = vp;

Read-only Properties

Property Type Description
numItems uint Returns the total number of slides.

Example:
trace(mySlideshow.numItems);
slide DisplayObject Returns the instance of the current slide.

Example:
trace(mySlideshow.slide);
inTransitionPhase Boolean Indicates whether the component is in the transition phase.

Example:
trace(mySlideshow.inTransitionPhase);

Methods

Method Implementation Description
addItem() addItem(data:Object):void Adds a new item at the end of the component.

Example:
mySlideshow.addItem({source:"images/image1.jpg", title:"Flower", description:"Image description"});
addItemAt() addItemAt(data:Object, index:uint):void Adds a new item at the specified index.

Example:
mySlideshow.addItemAt({source:"images/image1.jpg", title:"Flower", description:"Image description"}, 3);
addItems() addItems(items:Array):void Adds an array of items to the end of the component.

Example:
var myItems:Array = [{source:"images/image0.jpg"}, {source:"images/image1.jpg",title:"Bird"}, {source:"images/image2.jpg",title:"Sky"}, {source:"images/image3.jpg"}]; mySlideshow.addItems(myItems);
addItemsAt() addItems(items:Array, index:uint):void Adds an array of items at the specified index.

Example:
var myItems:Array = [{source:"images/image0.jpg"}, {source:"images/image1.jpg",title:"Bird"}, {source:"images/image2.jpg",title:"Sky"}, {source:"images/image3.jpg"}]; mySlideshow.addItems(myItems, 5);
removeItemAt() removeItemAt(index:uint):void Removes the item at the specified index.

Example:
mySlideshow.removeItemAt(1);
removeItemsAt() removeItemsAt(startIndex:uint, removeCount:uint) Removes a specified number of items starting at a specified index.

Example:
mySlideshow.removeItemsAt(0, 3);
removeAllItems() removeAllItems():void Removes all items.

Example:
mySlideshow.removeAllItems();
replaceItemAt() replaceItemAt(data:Object, index:uint) Replace an existing item at a specified index with a new item.

Example:
var data:Object = {source:"images/image1.jpg", desc:"Bird"}; mySlideshow.replaceItem(data, 2);
spliceItems() spliceItems(startIndex:uint, removeCount:uint, items:Array = null):void Removes a specified number of items, starting at a specified index and adds an array of items at the specified index.

Example:
var newItems:Array = [{source:"images/image0.jpg"}, {source:"images/image1.jpg",title:"Bird"}, {source:"images/image2.jpg",title:"Sky"}, {source:"images/image3.jpg"}]; mySlideshow.spliceItems(0, 3, newItems);
getItemDataAt() getItemDataAt(index:uint):Object Returns the item data at the specified index.

Example:
trace(mySlideshow.getItemDataAt(2).index);// output 2
nextSlide() nextSlide():void Opens the next slide.

Example:
mySlideshow.nextSlide();
previousSlide() previousSlide():void Opens the previous slide.

Example:
mySlideshow.previousSlide();
setSize() setSize(width:Number, height:Number):void Sets the component's size at the specified width and height.

Example:
mySlideshow.setSize(700, 500);
move() move(x:Number, y:Number):void Moves the component at the specified position.

Example:
mySlideshow.move(100, 100);

Events

Event type Description
ITEMS_LOAD_START Dispatched when the loading of a group of items begins.

Example:

import com.flashotaku.events.SlideshowEvent;

mySlideshow.addEventListener(SlideshowEvent.ITEMS_LOAD_START, eventHandler)

function eventHandler(event:SlideshowEvent):void
{
trace("loading begins");
}
ITEMS_LOAD_PROGRESS Dispatched every time an items was loaded, during the loading of a group of items.

Example:

import com.flashotaku.events.SlideshowEvent;

mySlideshow.addEventListener(SlideshowEvent.ITEMS_LOAD_PROGRESS,eventHandler)

function eventHandler(event:SlideshowEvent):void
{
trace("Loaded " + event.itemsLoaded + " out of " + event.itemsTotal);
}
ITEMS_LOAD_COMPLETE Dispatched when the loading of a group of items is complete.

Example:

import com.flashotaku.events.SlideshowEvent;

mySlideshow.addEventListener(SlideshowEvent.ITEMS_LOAD_COMPLETE,eventHandler)

function eventHandler(event:SlideshowEvent):void
{
trace("loading complete");
}
XML_LOAD_START Dispatched when the loading of the XML file begins.

Example:

import com.flashotaku.events.SlideshowEvent;

mySlideshow.addEventListener(SlideshowEvent.XML_LOAD_START, eventHandler);

function eventHandler(event:SlideshowEvent):void
{
trace("XML loading begins");
}
XML_LOAD_PROGRESS Dispatched during the loading of the XML file.

Example:

import com.flashotaku.events.SlideshowEvent;

mySlideshow.addEventListener(SlideshowEvent.XML_LOAD_PROGRESS, eventHandler);
function eventHandler(event:SlideshowEvent):void
{
trace("Loaded " + event.bytesLoaded + " out of " + event.bytesTotal);
}
XML_LOAD_COMPLETE Dispatched when the loading of an XML file is complete.

Example:

import com.flashotaku.events.SlideshowEvent;

mySlideshow.addEventListener(SlideshowEvent.XML_LOAD_COMPLETE,eventHandler)
function eventHandler(event:SlideshowEvent):void
{
trace("XML file loaded");
}
ITEM_ADD Dispatched when a new item was added.

Example:

import com.flashotaku.events.SlideshowEvent;

mySlideshow.addEventListener(SlideshowEvent.ITEM_ADD, eventHandler);

function eventHandler(event:SlideshowEvent):void
{
trace(event.index); // output 3
trace(event.data); // output ,source:"images/image1.jpg", title:"Flower", desc:"Sun flower"
trace(event.data.title); // output "Flower"
}

mySlideshow.addItemAt({source:"images/image1.jpg", title:"Flower", desc:"Sun flower"}, 3);
ITEM_REMOVE Dispatched when an item was removed.

Example:

import com.flashotaku.events.SlideshowEvent;

mySlideshow.addEventListener(SlideshowEvent.ITEM_REMOVE, eventHandler);

function eventHandler(event:SlideshowEvent):void
{
trace(event.index); // output 1
}

mySlideshow.removeItemAt(1);
ITEM_CLICK Dispatched when an item was clicked.

Example:

import com.flashotaku.events.SlideshowEvent;

mySlideshow.addEventListener(SlideshowEvent.ITEM_CLICK, eventHandler);

function eventHandler(event:SlideshowEvent):void
{
trace(event.index);
}
ITEM_DOUBLE_CLICK Dispatched when an item was double-clicked.

Example:

import com.flashotaku.events.SlideshowEvent;

mySlideshow.addEventListener(SlideshowEvent.ITEM_DOUBLE_CLICK, eventHandler);

function eventHandler(event:SlideshowEvent):void
{
trace(event.data);
}
ITEM_MOUSE_UP Dispatched when the mouse is released over an item.

Example:

import com.flashotaku.events.SlideshowEvent;

mySlideshow.addEventListener(SlideshowEvent.ITEM_MOUSE_UP, eventHandler);

function eventHandler(event:SlideshowEvent):void
{
trace(event.index);
}
ITEM_MOUSE_DOWN Dispatched when the mouse is pressed over an item.

Example:

import com.flashotaku.events.SlideshowEvent;

mySlideshow.addEventListener(SlideshowEvent.ITEM_MOUSE_DOWN, eventHandler);
function eventHandler(event:SlideshowEvent):void
{
trace(event.index);
}
ITEM_MOUSE_OVER Dispatched when the mouse pointer is moved over an item.

Example:

import com.flashotaku.events.SlideshowEvent;

mySlideshow.addEventListener(SlideshowEvent.ITEM_MOUSE_OVER, eventHandler);
function eventHandler(event:SlideshowEvent):void
{
trace(event.index);
}
ITEM_MOUSE_OUT Dispatched when the mouse pointer is moved away from an item.

Example:

import com.flashotaku.events.SlideshowEvent;

mySlideshow.addEventListener(SlideshowEvent.ITEM_MOUSE_OUT, eventHandler);
function eventHandler(event:SlideshowEvent):void
{
trace(event.index);
}
ITEM_START Dispatched when the content of an item begins to load.

Example:

import com.flashotaku.events.SlideshowEvent;

mySlideshow.addEventListener(SlideshowEvent.ITEM_START, eventHandler);

function eventHandler(event:SlideshowEvent):void
{
trace("Item at index: " + event.index + " has started loading");
}
ITEM_PROGRESS Dispatched during the loading of an item's content.

Example:

import com.flashotaku.events.SlideshowEvent;

mySlideshow.addEventListener(SlideshowEvent.ITEM_PROGRESS, eventHandler);

function eventHandler(event:SlideshowEvent):void
{
trace("Loaded " + event.bytesLoaded + " out of " +event.bytesTotal);
}
ITEM_COMPLETE Dispatched when the content of an item is completely loaded.

Example:

import com.flashotaku.events.SlideshowEvent;

mySlideshow.addEventListener(SlideshowEvent.ITEM_COMPLETE, eventHandler);

function eventHandler(event:SlideshowEvent):void
{
trace("Item at index: " + event.index + " has finished loading");
}
ITEM_ERROR Dispatched when an error has occurred during the loading process.

Example:

import com.flashotaku.events.SlideshowEvent;

mySlideshow.addEventListener(SlideshowEvent.ITEM_ERROR, eventHandler);

function eventHandler(event:SlideshowEvent):void
{
trace("Item at index: " + event.index + " could not be loaded");
}
SLIDE_REQUEST Dispatched when a slide is requested.

Example:

import com.flashotaku.events.SlideshowEvent;

mySlideshow.addEventListener(SlideshowEvent.SLIDE_REQUEST, slideRequestHandler);

function slideRequestHandler(event:SlideshowEvent):void
{
trace("The slide at index: " + event.index + " was requested");
}
UPDATE Dispatched after the component was updated because a property changed or an item was added or removed.

Example:

import com.flashotaku.events.SlideshowEvent;

mySlideshow.addEventListener(SlideshowEvent.UPDATE, eventHandler);

function eventHandler(event:SlideshowEvent):void
{
trace("Something changed!");
}
TRANSITION_START Dispatched when a transition starts.

Example:

import com.flashotaku.events.SlideshowEvent;

mySlideshow.addEventListener(SlideshowEvent.TRANSITION_START, transitionStartHandler);

function transitionStartHandler(event:SlideshowEvent):void
{
trace("Index of the selected item: " + event.index);
}
TRANSITION_COMPLETE Dispatched when a transition is complete.

Example:

import com.flashotaku.events.SlideshowEvent;

mySlideshow.addEventListener(SlideshowEvent.TRANSITION_COMPLETE, transitionCompleteHandler);

function transitionCompleteHandler(event:SlideshowEvent):void
{
trace("Index of the selected item: " + event.index);
}

Slideshow Video Player

Properties

Property Type Default Description
videoWidth Number 400 The width of the video.

Example:
mySlideshowVideoPlayer.videoWidth = 200;
videoHeight Number 250 The height of the video.

Example:
mySlideshowVideoPlayer.videoHeight = 150;
scaleMode String "exactFit" The scaling of the video. "exactFit" will resize the video to the maximum width and height. "maintainAspectRatio" will resize the video to the maximum width or height, maintaining the aspect ratio. "noScale" will ignore the maximum width and height, maintaining the video at the original dimensions.

Example:
mySlideshowVideoPlayer.scaleMode = "maintainAspectRatio";
alignType String "middleCenter" The alignment of the video. Available values: "topLeft", "topCenter', "topRight", "middleLeft", "middleCenter", "middleRight", "bottomLeft", "bottomCenter", "bottomRight".

Example:
mySlideshowVideoPlayer.alignType = "topLeft";
autoPlay Boolean false Indicates whether the video will play imediatelly after the transition of the slide is complete.

Example:
mySlideshowVideoPlayer.autoPlay = true;
autoReplay Boolean false Indicates whether the video will be replayed after reaching the end.

Example:
mySlideshowVideoPlayer.autoReplay = true;
fadeControls Boolean true Indicates whether the player controls will fade out.

Example:
mySlideshowVideoPlayer.fadeControls = true;
fadeInDuration Number 0.5 The duration of the fade in.

Example:
mySlideshowVideoPlayer.fadeInDuration = 1;
fadeOutDuration Number 1 The duration of the fade out.

Example:
mySlideshowVideoPlayer.fadeOutDuration = 2;
fadeOutDelay Number 1 The delay of the fade out.

Example:
mySlideshowVideoPlayer.fadeOutDelay = 2;
initialFadeOutDelay Number 3 The delay of the initial fade out.

Example:
mySlideshowVideoPlayer.initialFadeOutDelay = 2;
playButtonAlpha Number 0.8 The alpha of the initial play button.

Example:
mySlideshowVideoPlayer.playButtonAlpha = 0.3;
smoothing Boolean false Indicates whether the videos will be smoothened.

Example:
mySlideshowVideoPlayer.smoothing = true;
marginBottom Number 10 The bottom margin of the player controls.

Example:
mySlideshowVideoPlayer.marginBottom = 20;
marginLeft Number 10 The left margin of the player controls.

Example:
mySlideshowVideoPlayer.marginLeft = 20;
marginBottom Number 10 The right margin of the player controls.

Example:
mySlideshowVideoPlayer.marginRight = 20;
volume Number 0.5 A number between 0 and 1 representing the volume of the video.

Example:
mySlideshowVideoPlayer.volume = 0.4;

Read-only Properties

Property Type Description
duration Number Returns the duration of the video, in seconds.

Example:
trace(mySlideshowVideoPlayer.duration);
time Number Returns the current time of the video, in seconds.

Example:
trace(mySlideshowVideoPlayer.time);

Methods

Method Implementation Description
resume() resume():void Resumes the currently playing video.

Example:
mySlideshowVideoPlayer.resume();
stop() stop():void Stops the currently playing video.

Example:
mySlideshowVideoPlayer.stop();
pause() pause():void Pauses the currently playing video.

Example:
mySlideshowVideoPlayer.pause();
seek() seek(value:Number):void Seeks the currently playing video to the specified time value.

Example:
mySlideshowVideoPlayer.seek(100);
close() close():void Closes the currently playing video.

Example:
mySlideshowVideoPlayer.close();

Events

Event type Description
VIDEO_CLICK Dispatched when a video was clicked.

Example:

import com.flashotaku.events.SlideshowVideoPlayerEvent;

mySlideshowVideoPlayer.addEventListener(SlideshowVideoPlayerEvent.VIDEO_CLICK, eventHandler);

function eventHandler(event:SlideshowVideoPlayerEvent):void
{
trace(event.type);
}
VIDEO_DOUBLE_CLICK Dispatched when a video was double-clicked.

Example:

import com.flashotaku.events.SlideshowVideoPlayerEvent;

mySlideshowVideoPlayer.addEventListener(SlideshowVideoPlayerEvent.VIDEO_DOUBLE_CLICK, eventHandler);

function eventHandler(event:SlideshowVideoPlayerEvent):void
{
trace(event.type);
}
VIDEO_MOUSE_UP Dispatched when the mouse is released over a video.

Example:

import com.flashotaku.events.SlideshowVideoPlayerEvent;

mySlideshowVideoPlayer.addEventListener(SlideshowVideoPlayerEvent.VIDEO_MOUSE_UP, eventHandler);

function eventHandler(event:SlideshowVideoPlayerEvent):void
{
trace(event.type);
}
VIDEO_MOUSE_DOWN Dispatched when the mouse is pressed over a video.

Example:

import com.flashotaku.events.SlideshowVideoPlayerEvent;

mySlideshowVideoPlayer.addEventListener(SlideshowVideoPlayerEvent.VIDEO_MOUSE_DOWN, eventHandler);

function eventHandler(event:SlideshowVideoPlayerEvent):void
{
trace(event.type);
}
VIDEO_MOUSE_UP Dispatched when the mouse is released over a video.

Example:

import com.flashotaku.events.SlideshowVideoPlayerEvent;

mySlideshowVideoPlayer.addEventListener(SlideshowVideoPlayerEvent.VIDEO_MOUSE_DOWN, eventHandler);

function eventHandler(event:SlideshowVideoPlayerEvent):void
{
trace(event.type);
}
VIDEO_MOUSE_OVER Dispatched when the mouse pointer is moved over a video.

Example:

import com.flashotaku.events.SlideshowVideoPlayerEvent;

mySlideshowVideoPlayer.addEventListener(SlideshowVideoPlayerEvent.VIDEO_MOUSE_OVER, eventHandler);

function eventHandler(event:SlideshowVideoPlayerEvent):void
{
trace(event.type);
}
VIDEO_MOUSE_OUT Dispatched when the mouse pointer is moved away from a video.

Example:

import com.flashotaku.events.SlideshowVideoPlayerEvent;

mySlideshowVideoPlayer.addEventListener(SlideshowVideoPlayerEvent.VIDEO_MOUSE_OUT, eventHandler);

function eventHandler(event:SlideshowVideoPlayerEvent):void
{
trace(event.type);
}
BEGIN Dispatched when the initial play button was clicked.

Example:

import com.flashotaku.events.SlideshowVideoPlayerEvent;

mySlideshowVideoPlayer.addEventListener(SlideshowVideoPlayerEvent.BEGIN, eventHandler);

function eventHandler(event:SlideshowVideoPlayerEvent):void
{
trace(event.type);
}
CLOSE Dispatched when the video player is closed, after the user moved to a new slide or after the close() method was called.

Example:

import com.flashotaku.events.SlideshowVideoPlayerEvent;

mySlideshowVideoPlayer.addEventListener(SlideshowVideoPlayerEvent.CLOSE, eventHandler);

function eventHandler(event:SlideshowVideoPlayerEvent):void
{
trace(event.type);
}
START Dispatched when the playback initially starts to play.

Example:

import com.flashotaku.events.SlideshowVideoPlayerEvent;

mySlideshowVideoPlayer.addEventListener(SlideshowVideoPlayerEvent.START, eventHandler);

function eventHandler(event:SlideshowVideoPlayerEvent):void
{
trace(event.type);
}
STOP Dispatched when the stop button is pressed or when the playback is complete.

Example:

import com.flashotaku.events.SlideshowVideoPlayerEvent;

mySlideshowVideoPlayer.addEventListener(SlideshowVideoPlayerEvent.STOP, eventHandler);

function eventHandler(event:SlideshowVideoPlayerEvent):void
{
trace(event.type);
}
PAUSE Dispatched when the video is paused.

Example:

import com.flashotaku.events.SlideshowVideoPlayerEvent;

mySlideshowVideoPlayer.addEventListener(SlideshowVideoPlayerEvent.PAUSE, eventHandler);

function eventHandler(event:SlideshowVideoPlayerEvent):void
{
trace(event.type);
}
RESUME Dispatched when the playback is resumed.

Example:

import com.flashotaku.events.SlideshowVideoPlayerEvent;

mySlideshowVideoPlayer.addEventListener(SlideshowVideoPlayerEvent.RESUME, eventHandler);

function eventHandler(event:SlideshowVideoPlayerEvent):void
{
trace(event.type);
}
COMPLETE Dispatched when the playback is complete.

Example:

import com.flashotaku.events.SlideshowVideoPlayerEvent;

mySlideshowVideoPlayer.addEventListener(SlideshowVideoPlayerEvent.COMPLETE, eventHandler);

function eventHandler(event:SlideshowVideoPlayerEvent):void
{
trace(event.type);
}