Actionscript 3 reference

 

Properties

autoFlip
autoFlipDelay
autoFlipPause
defaultIndex
distance
flipSoundClass
inited
motionSpeed
nameBold
nameColor
nameDistance
nameEmbed
nameFont
nameItalic
namePosition
nameSize
photoAngle
photoHeight
photoWidth
playFlipSound
preloadHolderAlpha
preloadHolderBorder
preloadHolderBorderColor
preloadHolderColor
preloadSet
reflectionAlpha
reflectionDepth
reflectionExtend
resizeImage
selectedReflectionAlpha
selectedReflectionDepth
selectedScale
selectedY
showName
showReflection
spacing
totalPhoto
useKeyboard
useMouseWheel
view
zoomScale
zoomType

 

Methods

addPhoto
loadXML
next

previous
removePhoto
setSelection

 

Events

ADD
CLICK_SELECTED
INIT
PHOTO_LOAD_PROGRESS
PHOTO_LOADED
PHOTOS_LOADED
PHOTO_MOUSE_OUT
PHOTO_MOUSE_OVER
REMOVE
SELECT
UPDATE

 

Properties

 

autoFlip

Availability
Flash Player 9

Usage
photoFlow.autoFlip

Description
Property. Specifies whether to flip the photos automatically.

Example

myPhotoFlow.autoFlip = true;

 

autoFlipDelay

Availability
Flash Player 9

Usage
photoFlow.autoFlipDelay

Description
Property. The delay before the autoFlip takes place

Example

myPhotoFlow.autoFlipDelay = 0;

 

autoFlipPause

Availability
Flash Player 9

Usage
photoFlow.autoFlipPause

Description
Property. The pause when autoFlipping is in effect.

Example

myPhotoFlow.autoFlipPause = 0;

 

defaultIndex

Availability
Flash Player 9

Usage
photoFlow.defaultIndex

Description
Property. The index of the default image.

Example

myPhotoFlow.defaultIndex = 4;

 

distance

Availability
Flash Player 9

Usage
photoFlow.distance

Description
Property. The horizontal distance in pixels between the selected image and the other images.

Example

myPhotoFlow.distance = 0;

 

flipSoundClass

Availability
Flash Player 9

Usage
photoFlow.flipSoundClass

Description
Property. The class name of the sound to play when flipping between images.

Example

myPhotoFlow.flipSoundClass = "MySoundClass";

 

inited

Availability
Flash Player 9

Usage
photoFlow.inited

Description
Property. Specifies whether the component has inited.

Example

trace(myPhotoFlow.inited);

 

motionSpeed

Availability
Flash Player 9

Usage
photoFlow.motionSpeed

Description
Property. The speed at which to animate.

Example

myPhotoFlow.motionSpeed = 1;

 

nameBold

Availability
Flash Player 9

Usage
photoFlow.nameBold

Description
Property. Specifies whether the name should be bold.

Example

myPhotoFlow.nameBold = true;

 

nameColor

Availability
Flash Player 9

Usage
photoFlow.nameColor

Description
Property. The color of the name text.

Example

myPhotoFlow.nameColor = 0x000000;

 

nameDistance

Availability
Flash Player 9

Usage
photoFlow.nameDistance

Description
Property. The distance of the name from the image.

Example

myPhotoFlow.nameDistance = 1;

 

nameEmbed

Availability
Flash Player 9

Usage
photoFlow.nameEmbed

Description
Property. Specifies whether the name text should use an embedded font.

Example

myPhotoFlow.nameEmbed = true;

 

nameFont

Availability
Flash Player 9

Usage
photoFlow.nameFont

Description
Property. The font to use for the name.

Example

myPhotoFlow.nameFont = "Arial";

 

nameItalic

Availability
Flash Player 9

Usage
photoFlow.nameItalic

Description
Property. Specifies whether the name should be displayed italic.

Example

myPhotoFlow.nameItalic = true;

 

namePosition

Availability
Flash Player 9

Usage
photoFlow.namePosition

Description
Property. The position of the image name

Example

myPhotoFlow.namePosition = "bottom center";

 

nameSize

Availability
Flash Player 9

Usage
photoFlow.nameSize

Description
Property. The size of the name text.

Example

myPhotoFlow.nameSize = "8";

 

photoAngle

Availability
Flash Player 9

Usage
photoFlow.photoAngle

Description
Property. Angle at which to view the photoFlow.

Example

myPhotoFlow.photoAngle = 45;

 

photoHeight

Availability
Flash Player 9

Usage
photoFlow.photoHeight

Description
Property. The height of images.

Example

myPhotoFlow.photoHeight = 250;

 

photoWidth

Availability
Flash Player 9

Usage
photoFlow.photoWidth

Description
Property. The width of images.

Example

myPhotoFlow.photoWidth = 250;

 

playFlipSound

Availability
Flash Player 9

Usage
photoFlow.playFlipSound

Description
Property. Specifies whether to play the flipSoundClass when flipping between images or not.

Example

myPhotoFlow.playFlipSound = true;

 

preloadHolderAlpha

Availability
Flash Player 9

Usage
photoFlow.preloadHolderAlpha

Description
Property. The opacity of the preloader clip.

Example

myPhotoFlow.preloadHolderAlpha = 50;

 

preloadHolderBorder

Availability
Flash Player 9

Usage
photoFlow.preloadHolderBorder

Description
Property. The thickness of the preloader clip border.

Example

myPhotoFlow.preloadHolderBorder = 1;

 

preloadHolderBorderColor

Availability
Flash Player 9

Usage
photoFlow.preloadHolderBorderColor

Description
Property. The color of the preloader clip border.

Example

myPhotoFlow.preloadHolderBorderColor = 0x000000;

 

preloadHolderColor

Availability
Flash Player 9

Usage
photoFlow.preloadHolderColor

Description
Property. The color of the preloader clip.

Example

myPhotoFlow.preloadHolderColor = 0xffffff;

 

preloadSet

Availability
Flash Player 9

Usage
photoFlow.preloadSet

Description
Property. The number of images to preload before displaying any of the images.

Example

myPhotoFlow.preloadSet = 12;

 

reflectionAlpha

Availability
Flash Player 9

Usage
photoFlow.reflectionAlpha

Description
Property. Refection Opacity.

Example

myPhotoFlow.reflectionAlpha = 50;

 

reflectionDepth

Availability
Flash Player 9

Usage
photoFlow.reflectionDepth

Description
Property. Depth of reflection.

Example

myPhotoFlow.reflectionDepth = 255;

 

reflectionExtend

Availability
Flash Player 9

Usage
photoFlow.reflectionExtend

Description
Property. The number of pixels that each reflection should extend.

Example

myPhotoFlow.reflectionExtend = 50;

 

resizeImage

Availability
Flash Player 9

Usage
photoFlow.resizeImage

Description
Property. Determines how the images should be resized to fit the specified width and height.

Example

myPhotoFlow.resizeImage = "showAll";

 

selectedReflectionAlpha

Availability
Flash Player 9

Usage
photoFlow.selectedReflectionAlpha

Description
Property. Opacity of the selected image's reflection.

Example

myPhotoFlow.selectedReflectionAlpha = 25;

 

selectedReflectionDepth

Availability
Flash Player 9

Usage
photoFlow.selectedReflectionDepth

Description
Property. Depth of the selected images's reflection.

Example

myPhotoFlow.selectedReflectionDepth = 25;

 

selectedScale

Availability
Flash Player 9

Usage
photoFlow.selectedScale

Description
Property. The scale of the selected image.

Example

myPhotoFlow.selectedScale = 1.1;

 

selectedY

Availability
Flash Player 9

Usage
photoFlow.selectedY

Description
Property. The y position of the currently selected image.

Example

myPhotoFlow.selectedY = 50;

 

showName

Availability
Flash Player 9

Usage
photoFlow.showName

Description
Property. Specifies whether to show the name or not.

Example

myPhotoFlow.showName = true;

 

showReflection

Availability
Flash Player 9

Usage
photoFlow.showReflection

Description
Property. Specifies whether to show a reflection or not.

Example

myPhotoFlow.showReflection = true;

 

spacing

Availability
Flash Player 9

Usage
photoFlow.spacing

Description
Property. Determines the spacing between images.

Example

myPhotoFlow.spacing = 47;

 

totalPhoto

Availability
Flash Player 9

Usage
photoFlow.totalPhoto

Description
Property. The total number of images.

Example

trace(myPhotoFlow.totalPhoto);

 

useKeyboard

Availability
Flash Player 9

Usage
photoFlow.useKeyboard

Description
Property. Specifies whether the keyboard can be used to navigate the images.

Example

myPhotoFlow.useKeyboard = true;

 

useMouseWheel

Availability
Flash Player 9

Usage
photoFlow.useMouseWheel

Description
Property. Specifies whether the mouse wheel can be used for scrolling or not.

Example

myPhotoFlow.useMouseWheel = true;

 

view

Availability
Flash Player 9

Usage
photoFlow.view

Description
Property. Angle at which to view the photoFlow.

Example

myPhotoFlow.view = 45;

 

zoomScale

Availability
Flash Player 9

Usage
photoFlow.zoomScale

Description
Property. The degree of scaling when zoomed.

Example

myPhotoFlow.zoomScale = 1.1;

 

zoomType

Availability
Flash Player 9

Usage
photoFlow.zoomType

Description
Property. The type of scaling when zoomed.

Example

myPhotoFlow.zoomType = "none";

 

Methods

 

addPhoto

Availability
Flash Player 9

Usage
photoFlow.addPhoto()

Description
Method. Adds a photo to the component.

Example

myPhotoFlow.addPhoto({name:"image", desc:"an image", url:"image.jpg"}, 1);

 

loadXML

Availability

Flash Player 9

Description

Method; loads the specified XML file.

Example

myPhotoFlow.loadXML("source.xml");

 

 

next

Availability
Flash Player 9

Usage
photoFlow.next()

Description
Method. Move forward one photo in the series.

Example

myPhotoFlow.next();

 

previous

Availability
Flash Player 9

Usage
photoFlow.previous()

Description
Method. Moves back one photo in the series.

Example

myPhotoFlow.previous();

 

removePhoto

Availability
Flash Player 9

Usage
photoFlow.removePhoto()

Description
Method. Removes the specified photo from the series.

Example

myPhotoFlow.removePhoto(0);

 

setSelection

Availability
Flash Player 9

Usage
photoFlow.setSelection()

Description
Method. Selects the specified photo.

Example

myPhotoFlow.setSelection(1);

 

Events

 

ADD

Availability
Flash Player 9

Usage
PhotoFlowEvent.ADD

Description
Event. Triggered when a photo is added to the component.

Example

myPhotoFlow.addEventListener(PhotoFlowEvent.ADD, eventHandler);
function eventHandler(eo:PhotoFlowEvent):void

{

    // trace id, data and index of photo
    trace(eo.id  + ", " + eo.data + ", " + eo.index);
}

 

CLICK_SELECTED

Availability
Flash Player 9

Usage
PhotoFlowEvent.CLICK_SELECTED

Description
Event. Triggered when the selected photo is clicked.

Example

myPhotoFlow.addEventListener(PhotoFlowEvent.CLICK_SELECTED, eventHandler);
function eventHandler(eo:PhotoFlowEvent):void

{

    // trace id, data and index of photo
    trace(eo.id  + ", " + eo.data + ", " + eo.index);
}

 

INIT

Availability
Flash Player 9

Usage
PhotoFlowEvent.INIT

Description
Event. Triggered on initialization.

Example

myPhotoFlow.addEventListener(PhotoFlowEvent.INIT, eventHandler);
function eventHandler(eo:PhotoFlowEvent):void

{

    //do something
}

 

PHOTO_LOAD_PROGRESS

Availability
Flash Player 9

Usage
PhotoFlowEvent.PHOTO_LOAD_PROGRESS

Description
Event. Triggered each time a portion of a photo is loaded.

Example

myPhotoFlow.addEventListener(PhotoFlowEvent.PHOTO_LOAD_PROGRESS, eventHandler);
function eventHandler(eo:PhotoFlowEvent):void

{

    //do something
}

 

PHOTO_LOADED

Availability
Flash Player 9

Usage
PhotoFlowEvent.PHOTO_LOADED

Description
Event. Triggered when an individual photo is loaded.

Example

myPhotoFlow.addEventListener(PhotoFlowEvent.PHOTO_LOADED, eventHandler);
function eventHandler(eo:PhotoFlowEvent):void

{

    // trace id, data and index of photo
    trace(eo.id  + ", " + eo.data + ", " + eo.index);
}

 

PHOTOS_LOADED

Availability
Flash Player 9

Usage
PhotoFlowEvent.PHOTOS_LOADED

Description
Event. Triggered when all photos have loaded.

Example

myPhotoFlow.addEventListener(PhotoFlowEvent.PHOTOS_LOADED, eventHandler);
function eventHandler(eo:PhotoFlowEvent):void

{

    //do something
}

 

PHOTO_MOUSE_OUT

Availability
Flash Player 9

Usage
PhotoFlowEvent.PHOTO_MOUSE_OUT

Description
Event. Triggered when the cursor mouses off a photo.

Example

myPhotoFlow.addEventListener(PhotoFlowEvent.PHOTO_MOUSE_OUT, eventHandler);
function eventHandler(eo:PhotoFlowEvent):void

{

    // trace id, data and index of photo
    trace(eo.id  + ", " + eo.data + ", " + eo.index);
}

 

PHOTO_MOUSE_OVER

Availability
Flash Player 9

Usage
PhotoFlowEvent.PHOTO_MOUSE_OVER

Description
Event. Triggered when a photo is moused over.

Example

myPhotoFlow.addEventListener(PhotoFlowEvent.PHOTO_MOUSE_OVER, eventHandler);
function eventHandler(eo:PhotoFlowEvent):void

{

    // trace id, data and index of photo
    trace(eo.id  + ", " + eo.data + ", " + eo.index);
}

 

REMOVE

Availability
Flash Player 9

Usage
PhotoFlowEvent.REMOVE

Description
Event. Triggered when a photo is removed.

Example

myPhotoFlow.addEventListener(PhotoFlowEvent.REMOVE, eventHandler);
function eventHandler(eo:PhotoFlowEvent):void

{

    //do something
}

 

SELECT

Availability
Flash Player 9

Usage
PhotoFlowEvent.SELECT

Description
Event. Triggered when a photograph is selected.

Example

myPhotoFlow.addEventListener(PhotoFlowEvent.SELECT, eventHandler);
function eventHandler(eo:PhotoFlowEvent):void

{

    // trace id, data and index of photo
    trace(eo.id  + ", " + eo.data + ", " + eo.index);
}

 

UPDATE

Availability
Flash Player 9

Usage
PhotoFlowEvent.UPDATE

Description
Event. Triggered when the component is updated.

Example

myPhotoFlow.addEventListener(PhotoFlowEvent.UPDATE, eventHandler);
function eventHandler(eo:PhotoFlowEvent):void

{

    //do something
}