AFComponents.com

Flow List V. 1.1 API Docs



Properties

Name Type Description
content Collection Property defines image properties.
  1. description:String – Image description
  2. path:String – Path to the image file
  3. data:Mixed
contentXML String Property indicates a path to the XML File.

Sample XML file:
http://www.afcomponents.com/components/flow_list/content.xml

Sample Flickr feed:
http://api.flickr.com/services/feeds/photos_public.gne
flowAnimationEasingType Void Property determines flow animation easing type.
  1. easeIn:String
  2. easeOut:String
  3. easeNone:String
flowAnimationSpeed Number Property (0-10) determines flow animation speed.
flowAnimationTweenType String Property defines flow animation tween type.
  1. none:String
  2. regular:String
  3. strong:String
  4. elastic:String
  5. bounce:String
  6. back:String
flowFadeSpace Number Property indicates the space for the both sides, in which the items start or end fading. Default this is 150 pixels.
imagePadding Number Property defines horizontal padding.
imagePerspective Object Property defines image perspective.
  1. vertical:Number – Vertical perspective
  2. angle:Number – Angle at which images are viewed.
imageSize Object Property defines image size. Please note that these properties override scaleContent and maintainAspectRatio parameters.
  1. width:Number
  2. height:Number
maintainAspectRatio Boolean Property determines whether to maintain image aspect ratio during scaling.
previewClip String Property defines a linkage identifier of a placeholder movie clip. Please note that the movie clip has to be exported for ActionScript.
reflection Boolean Property defines whether image reflection is displayed.
reflectionSettings Object Property defines image reflection.
  1. alpha:Number
  2. clipAlpha:Number
  3. distance:Number
  4. matrixRatio:Number
  5. matrixDropOff:Number
scaleContent Boolean Property defines whether to scale image (true) or not (false). If set to true, images will be resized to fit the height of the component.
slideShow Boolean Property defines whether images are displayed in a slide show mode.
slideShowLoop Boolean Property determines whether slides how is looped. If set to true, flow is scrolled all the way to the first image.
slideShowTime Number Property indicates the amount of time (seconds) slide show is paused on each image.
startItem Number Property defines initially selected item.
transition Boolean Property determines whether to display image transition (true) or not (false).
transitionEasingType String Property determines transition easing type.
  1. easeIn:String
  2. easeOut:String
  3. easeNone:String
transitionSpeed Number Property (0-10) determines transition speed.
UIScrollBar String Defines a path to UIScrollBar component instance.

Methods

Name Return Type Description
getItemNum( item:Number ) Object Returns content item object specified by Number attribute.

Example

var item:Object = myFlow.getItemNum(2);
//trace(item.description);
//trace(item.path);
//trace(item.data);
getTotalItems( void ) Number Returns total number of items in the content object.

Example

var items:Number = myFlow.getTotalItems();
getSelectedItem( void ) Object Returns selected item object.

Example

var item:Object = myFlow.getSelectedItem();
//trace(item.description);
//trace(item.path);
//trace(item.data);
selectItem( item:Object ) Void Selects item specified by attribute.

Example

var item:Object = myFlow.getItemNum(2);
myFlow.seletItem(item);
selectItemNum( item:Number ) Void Selects item specified by Number attribute.

Example

myFlow.selectItemNum(2);
selectNextItem( void ) Void Selects next item.

Example

myFlow.selectNextItem();
selectPreviousItem( void ) Void Selects previous item.

Example

myFlow.selectPreviousItem();
addItem( item:Object ) Void Adds new item to the content list.

Example

myFlow.addItem({description:"Item", path:"image.jpg",data:"url.html"});
removeItem( item:Object ) Void Removes item from the content object.

Example

var item:Object = myFlow.getItemNum(3);
myFlow.removeItem(item);
displayNextPage( void ) Void Displays the next page.

Example

myFlow.displayNextPage();
displayPreviousPage( void ) Void Displays the previous page.

Example

myFlow.displayPreviousPage();

Events

Name Return Value Description
INITIALIZE type
target		 Triggered after component initializes.

Example

var eventListener = new Object();
eventListener.INITIALIZE = function(evnt:Object){
trace(evnt.type);
}
myFlow.addEventListener("INITIALIZE", eventListener);
ERROR type
target
message		 Triggered once error occurs. If there is an error loading an image this event fired. If a wrong parameter is passed to a function this event is fired.

Example

var eventListener = new Object();
eventListener.ERROR = function(evnt){
trace(evnt.type);
trace(evnt.message);
}
myFlow.addEventListener("ERROR", eventListener);
CONTENT_LOAD_START type
target		 Triggered whenever content (images) start loading. This event helps user track general loading progress.

Example

var eventListener = new Object();
eventListener.CONTENT_LOAD_START = function(evnt){
trace(evnt.type);
}
myFlow.addEventListener("CONTENT_LOAD_START", eventListener);
CONTENT_LOAD_PROGRESS type
target
itemsLoaded
itemsTotal		 Triggered during content (images) loading. Returns total and loaded number of content elements.

Example

var eventListener = new Object();
eventListener.CONTENT_LOAD_PROGRESS = function(evnt){
trace(evnt.type);
trace(evnt.itemsLoaded); //Total Items
trace(evnt.itemsTotal);  //Loaded Items
}
myFlow.addEventListener("CONTENT_LOAD_PROGRESS", eventListener);
CONTENT_LOAD_COMPLETE type
target		 Triggered after the content finishes loading.

Example

var eventListener = new Object();
eventListener.CONTENT_LOAD_COMPLETE = function(evnt){
trace(evnt.type);
}
myFlow.addEventListener("CONTENT_LOAD_COMPLETE", eventListener);
XML_LOAD_START type
target		 Triggered when XML starts loading.

Example

var eventListener = new Object();
eventListener.XML_LOAD_START = function(evnt){
trace(evnt.type);
}
myFlow.addEventListener("XML_LOAD_START", eventListener);
XML_LOAD_PROGRESS type
target
bytesLoaded
bytesTotal		 Triggered while XML file is being loaded.

Example

var eventListener = new Object();
eventListener.XML_LOAD_PROGRESS = function(evnt){
trace(evnt.type);
trace(evnt.bytesLoaded);
trace(evnt.bytesTotal);
}
myFlow.addEventListener("XML_LOAD_PROGRESS", eventListener);
XML_LOAD_COMPLETE type
target		 Triggered after XML file finishes loading.

Example

var eventListener = new Object();
eventListener.XML_LOAD_COMPLETE = function(evnt){
trace(evnt.type);
}
myFlow.addEventListener("XML_LOAD_COMPLETE", eventListener);
ITEM_LOAD_START type
target		 Triggered when item image starts loading.

Example

var eventListener = new Object();
eventListener.ITEM_LOAD_START = function(evnt){
trace(evnt.type);
}
myFlow.addEventListener("ITEM_LOAD_START", eventListener);
ITEM_LOAD_PROGRESS type
target
bytesLoaded
bytesTotal		 Triggered while item image is being loaded.

Example

var eventListener = new Object();
eventListener.ITEM_LOAD_PROGRESS = function(evnt){
trace(evnt.type);
trace(evnt.bytesLoaded);
trace(evnt.bytesTotal);
}
myFlow.addEventListener("ITEM_LOAD_PROGRESS", eventListener);
ITEM_LOAD_COMPLETE type
target		 Triggered after item image finishes loading.

Example

var eventListener = new Object();
eventListener.ITEM_LOAD_COMPLETE = function(evnt){
trace(evnt.type);
}
myFlow.addEventListener("ITEM_LOAD_COMPLETE", eventListener);
ITEM_ON_ROLL_OVER type
target		 Trigged onRollOver button event.

Example

var eventListener = new Object();
eventListener.ITEM_ON_ROLL_OVER = function(evnt){
trace(evnt.type);
}
myFlow.addEventListener("ITEM_ON_ROLL_OVER", eventListener);
ITEM_ON_ROLL_OUT type
target		 Triggered onRollOut button event.

Example

var eventListener = new Object();
eventListener.ITEM_ON_ROLL_OUT = function(evnt){
trace(evnt.type);
}
myFlow.addEventListener("ITEM_ON_ROLL_OUT", eventListener);
ITEM_ON_RELEASE type
target		 Triggered onRelease button event.

Example

var eventListener = new Object();
eventListener.ITEM_ON_RELEASE = function(evnt){
trace(evnt.type);
}
myFlow.addEventListener("ITEM_ON_RELEASE", eventListener);
ITEM_ON_PRESS type
target		 Triggered onPress mouse event.

Example

var eventListener = new Object();
eventListener.ITEM_ON_PRESS = function(evnt){
trace(evnt.type);
}
myFlow.addEventListener("ITEM_ON_PRESS", eventListener);
ITEM_ON_RELEASE_OUTSIDE type
target		 Triggered onReleaseOutside button event.

Example

var eventListener = new Object();
eventListener.ITEM_ON_RELEASE_OUTSIDE = function(evnt){
trace(evnt.type);
}
myFlow.addEventListener("ITEM_ON_RELEASE_OUTSIDE", eventListener);
ITEM_ON_DOUBLE_CLICK type
target		 Triggered on mouse double click.

Example

var eventListener = new Object();
eventListener.ITEM_ON_DOUBLE_CLICK = function(evnt){
trace(evnt.type);
}
myFlow.addEventListener("ITEM_ON_DOUBLE_CLICK", eventListener);



© 2005-2007 advanced flash components