Packageat.display
Classpublic class ImageStackNavigator
InheritanceImageStackNavigator Inheritance mx.core.UIComponent
ImplementsINavigationUI

The ImageStackNavigator is a navigation component to view content as visual panes in a 3D space.

The component's dataProvider requires an imageStackThumbnailFilename as the image to display (which can be a swf or image file).

Default MXML PropertydataProvider



Public Properties
 PropertyDefined by
  clipContent : Boolean
Whether to apply a clip mask if the positions and/or sizes of this container's children extend outside the borders of this container.
ImageStackNavigator
  dataProvider : Object
The data that is used to created the visual panes.
ImageStackNavigator
  debugMode : Boolean = false
Outputs useful information for debugging this component for developers when true.
ImageStackNavigator
  depth : Number
The distance away from the selected item in the stack along the z-axis.
ImageStackNavigator
  easingFunction : String = "easeOutExpo"
Tweening function to use for moving through the component.
ImageStackNavigator
  hasScrollBar : Boolean
Determines whether or not the ImageStackNavigator has a ScrollBar.
ImageStackNavigator
  imageHeight : Number = 300
The height of all of the items in the stack.
ImageStackNavigator
  imageWidth : Number = 400
The width of all of the items in the stack.
ImageStackNavigator
  layoutMode : String
Determines how the visuals are displayed.
ImageStackNavigator
  navigationManager : INavigationManager
This is a navigation manager that is required if useDefaultNavigationBehavior is set to true.
ImageStackNavigator
  numStackChildren : int
[read-only] The number of children in the container in the component.
ImageStackNavigator
  offset : Number
The distance in pixels to the left and right from the center point of the selected item in the stack.
ImageStackNavigator
  reflectionAlpha : Number
The alpha of the reflection in the image loader.
ImageStackNavigator
  reflectionEnabled : Boolean
Draws a reflection on the items in the stack as if they were on a shiny surface when set to true.
ImageStackNavigator
  reflectionGap : Number
The height of the distance between the image and the loader in pixels.
ImageStackNavigator
  rotationAngle : Number
The rotation angle on the y-axis for each unselected item in the stack.
ImageStackNavigator
  scrollBar : ScrollBar
The ScrollBar that appears when hasScrollBar is set to true.
ImageStackNavigator
  selectedChild : DisplayObject
The currently selected Container in the ImageStackNavigator.
ImageStackNavigator
  selectedIndex : int
The index of the item in the ImageStack.
ImageStackNavigator
  selectedItem : Object
The data from the currently selected object in the component.
ImageStackNavigator
  thumbnailField : String
The field to be used as the path to the thumbnail file to load for each item in the dataProvider in the ImageStack.
ImageStackNavigator
  tweenDuration : Number
The amount of time it takes to move all of the items in the stack into position, in milliseconds.
ImageStackNavigator
  useDefaultNavigationBehavior : Boolean
Determines when the selected item is clicked on if it navigates to the specific content.
ImageStackNavigator
  verticalOffset : Number
The distance in pixels the "camera" needs to move along it's y-axis to appear to be above or below the content.
ImageStackNavigator
Protected Properties
 PropertyDefined by
  clippingMask : Sprite
ImageStackNavigator
  container : Base3DContainer
The container that handles the 3D movement.
ImageStackNavigator
  createdRenderers : Array
All of the visible items in the stack in the order they were created.
ImageStackNavigator
  freeItemRenderers : Array
A list of ImageStackHolders that have been removed due to a shortened length in the dataProvider.
ImageStackNavigator
  _selectedIndexChanged : Boolean = false
ImageStackNavigator
Public Methods
 MethodDefined by
  
Constructor.
ImageStackNavigator
  
Runs the deactivate() method on every item in the stack.
ImageStackNavigator
  
Reactivates the selected item in the stack if it was previously deactivated via deactivateContent().
ImageStackNavigator
Protected Methods
 MethodDefined by
  
clickHandler(e:MouseEvent):void
Handles the click on an item in the list.
ImageStackNavigator
  
Creates the navigation panes used in the component when a dataProvider is set.
ImageStackNavigator
  
Run when the selected item has reached the front of the stack and dispatches a NaviagationUIEvent.FOCUS_SET event.
ImageStackNavigator
  
Used in creation of items based on the dataProvider.
ImageStackNavigator
  
keyDownHandler(e:KeyboardEvent):void
Handles the keyDown type of KeyboardEvent.
ImageStackNavigator
  
scrollHandler(e:ScrollEvent):void
Handles the scrolling of the component when hasScrollBar is set to true.
ImageStackNavigator
Events
 EventSummaryDefined by
   Dispatched when an item was clicked to be brought to the front.ImageStackNavigator
   Dispatched when all of the panes have been created based on new data from the dataProvider.ImageStackNavigator
   Dispatched when an item that was selected has been brought to the front.ImageStackNavigator
   Dispatched when the user clicks on an item in the control.ImageStackNavigator
Styles
 StyleDescriptionDefined by
  
horizontalGap
Type: Number
The about of horizontal space in pixels between items in the stack. The default value is 100.
ImageStackNavigator
  
scrollBarStyleName
Type: String
The styleName for the HScrollBar in the component. The default value is "imageStackScrollBarStyle".
ImageStackNavigator
Property detail
clipContentproperty
clipContent:Boolean  [read-write]

Whether to apply a clip mask if the positions and/or sizes of this container's children extend outside the borders of this container. If false, the children of this container remain visible when they are moved or sized outside the borders of this container. If true, the children of this container are clipped.

The default value is false.

Implementation
    public function get clipContent():Boolean
    public function set clipContent(value:Boolean):void
clippingMaskproperty 
protected var clippingMask:Sprite

containerproperty 
protected var container:Base3DContainer

The container that handles the 3D movement.

createdRenderersproperty 
protected var createdRenderers:Array

All of the visible items in the stack in the order they were created. Due to the fact that the child index will change to display the items on top of one another visually, this is the list of all items as they were added.

The default value is [].

dataProviderproperty 
dataProvider:Object  [read-write]

The data that is used to created the visual panes.

The dataProvider requires an imageStackThumbnailFilename as the image to display.

The default value is null.

Implementation
    public function get dataProvider():Object
    public function set dataProvider(value:Object):void

Example
   <slide imageStackThumbnailFilename="path/to/thumbnail/patient1.jpg" />
   <slide imageStackThumbnailFilename="path/to/thumbnail/patient2.png" />
   <slide imageStackThumbnailFilename="path/to/thumbnail/patient3.png" />
   

debugModeproperty 
public var debugMode:Boolean = false

Outputs useful information for debugging this component for developers when true.

The output is typically in the form of trace statements and Alerts.

The default value is false.

depthproperty 
depth:Number  [read-write]

The distance away from the selected item in the stack along the z-axis.

The default value is 300.

Implementation
    public function get depth():Number
    public function set depth(value:Number):void
easingFunctionproperty 
public var easingFunction:String = "easeOutExpo"

Tweening function to use for moving through the component.

Some of these options are not recommended, but provide alternate methods to the standard motion.

The default value is "easeOutExpo".

freeItemRenderersproperty 
protected var freeItemRenderers:Array

A list of ImageStackHolders that have been removed due to a shortened length in the dataProvider. These will be reused if the dataProvider becomes longer in length.

The default value is [].

hasScrollBarproperty 
hasScrollBar:Boolean  [read-write]

Determines whether or not the ImageStackNavigator has a ScrollBar.

The scroll bar is used as an alternate means of navigating the ImageStackNavigator.

The default value is false.

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

Implementation
    public function get hasScrollBar():Boolean
    public function set hasScrollBar(value:Boolean):void
imageHeightproperty 
public var imageHeight:Number = 300

The height of all of the items in the stack.

The default value is 300.

imageWidthproperty 
public var imageWidth:Number = 400

The width of all of the items in the stack.

The default value is 400.

layoutModeproperty 
layoutMode:String  [read-write]

Determines how the visuals are displayed. These modes are determined in the Base3DContainerLayoutModes class.

The default value is "imageStack".

Implementation
    public function get layoutMode():String
    public function set layoutMode(value:String):void

See also

navigationManagerproperty 
navigationManager:INavigationManager  [read-write]

This is a navigation manager that is required if useDefaultNavigationBehavior is set to true.

When this is set, the item clicked in the component will automatically call the navigateToSlideIndex() method of the INavigationManager object.

The default value is null.

Implementation
    public function get navigationManager():INavigationManager
    public function set navigationManager(value:INavigationManager):void
numStackChildrenproperty 
numStackChildren:int  [read-only]

The number of children in the container in the component.

Implementation
    public function get numStackChildren():int
offsetproperty 
offset:Number  [read-write]

The distance in pixels to the left and right from the center point of the selected item in the stack.

This number may need to be higher based on the imageWidth setting, as it depends on how wide each item is.

The default value is 160.

Implementation
    public function get offset():Number
    public function set offset(value:Number):void
reflectionAlphaproperty 
reflectionAlpha:Number  [read-write]

The alpha of the reflection in the image loader.

The default value is .5.

Implementation
    public function get reflectionAlpha():Number
    public function set reflectionAlpha(value:Number):void
reflectionEnabledproperty 
reflectionEnabled:Boolean  [read-write]

Draws a reflection on the items in the stack as if they were on a shiny surface when set to true.

The default value is false.

Implementation
    public function get reflectionEnabled():Boolean
    public function set reflectionEnabled(value:Boolean):void
reflectionGapproperty 
reflectionGap:Number  [read-write]

The height of the distance between the image and the loader in pixels.

The default value is 2.

Implementation
    public function get reflectionGap():Number
    public function set reflectionGap(value:Number):void
rotationAngleproperty 
rotationAngle:Number  [read-write]

The rotation angle on the y-axis for each unselected item in the stack.

The default value is 65.

Implementation
    public function get rotationAngle():Number
    public function set rotationAngle(value:Number):void
scrollBarproperty 
public var scrollBar:ScrollBar

The ScrollBar that appears when hasScrollBar is set to true.

selectedChildproperty 
selectedChild:DisplayObject  [read-write]

The currently selected Container in the ImageStackNavigator.

The default value is null.

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

Implementation
    public function get selectedChild():DisplayObject
    public function set selectedChild(value:DisplayObject):void
selectedIndexproperty 
selectedIndex:int  [read-write]

The index of the item in the ImageStack.

The default value is -1.

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

Implementation
    public function get selectedIndex():int
    public function set selectedIndex(value:int):void
_selectedIndexChangedproperty 
protected var _selectedIndexChanged:Boolean = false
selectedItemproperty 
selectedItem:Object  [read-write]

The data from the currently selected object in the component.

The default value is null.

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

Implementation
    public function get selectedItem():Object
    public function set selectedItem(value:Object):void
thumbnailFieldproperty 
thumbnailField:String  [read-write]

The field to be used as the path to the thumbnail file to load for each item in the dataProvider in the ImageStack.

The default value is "imageStackThumbnailFilename".

Implementation
    public function get thumbnailField():String
    public function set thumbnailField(value:String):void
tweenDurationproperty 
tweenDuration:Number  [read-write]

The amount of time it takes to move all of the items in the stack into position, in milliseconds.

The default value is 325.

Implementation
    public function get tweenDuration():Number
    public function set tweenDuration(value:Number):void
useDefaultNavigationBehaviorproperty 
useDefaultNavigationBehavior:Boolean  [read-write]

Determines when the selected item is clicked on if it navigates to the specific content.

This value when set to true requires the navigationManager to also be set, otherwise the component cannot navigate automatically.

The default value is true.

Implementation
    public function get useDefaultNavigationBehavior():Boolean
    public function set useDefaultNavigationBehavior(value:Boolean):void
verticalOffsetproperty 
verticalOffset:Number  [read-write]

The distance in pixels the "camera" needs to move along it's y-axis to appear to be above or below the content.

This setting subtracts this value from the y position of the items in the container, and adds the value to the projectionCenter of the PerspectiveProjection.

The default value is 0.

Implementation
    public function get verticalOffset():Number
    public function set verticalOffset(value:Number):void
Constructor detail
ImageStackNavigator()constructor
public function ImageStackNavigator()

Constructor.

Method detail
clickHandler()method
protected function clickHandler(e:MouseEvent):void

Handles the click on an item in the list.

If the item is not the selected item, then it brings that item to the front of the stack. If that item is and useDefaultNavigationBehavior is true and navigationManager is not null then it will automatically navigate to the item represented by the item in the dataProvider.

If the item clicked is the selected item, it will just dispatch an ItemClickEvent regardless of the variables mentioned in the previous paragraph.

Parameters
e:MouseEvent — The click event
createNavigation()method 
protected function createNavigation():void

Creates the navigation panes used in the component when a dataProvider is set.

deactivateContent()method 
public function deactivateContent():void

Runs the deactivate() method on every item in the stack.

Useful when component is navigated away from, but content is still playing.

dispatchFocusSetEvent()method 
protected function dispatchFocusSetEvent():void

Run when the selected item has reached the front of the stack and dispatches a NaviagationUIEvent.FOCUS_SET event.

getItemRenderer()method 
protected function getItemRenderer():ImageStackHolder

Used in creation of items based on the dataProvider.

It creates a new ImageStackHolder unless one had been removed previously and stored in freeItemRenderers.

Returns
ImageStackHolder — A used or new ImageStackHolder

See also

keyDownHandler()method 
protected override function keyDownHandler(e:KeyboardEvent):void

Handles the keyDown type of KeyboardEvent.

Parameters
e:KeyboardEvent — The event
reactivateContent()method 
public function reactivateContent():void

Reactivates the selected item in the stack if it was previously deactivated via deactivateContent().

Useful for reactivating the selected item when the component is navigated back to.

See also

scrollHandler()method 
protected function scrollHandler(e:ScrollEvent):void

Handles the scrolling of the component when hasScrollBar is set to true.

Parameters
e:ScrollEvent
Event detail
changeSelectedevent 
Event object type: at.events.NavigationUIEvent
NavigationUIEvent.type property = at.events.NavigationUIEvent.CHANGE_SELECTED

Dispatched when an item was clicked to be brought to the front.

The NavigationalUIEvent.CHANGE_SELECTED constant defines the value of the type property of the event object for a changeSelected event.

childrenCreatedevent  
Event object type: at.events.NavigationUIEvent

Dispatched when all of the panes have been created based on new data from the dataProvider.

focusSetevent  
Event object type: at.events.NavigationUIEvent
NavigationUIEvent.type property = at.events.NavigationUIEvent.FOCUS_SET

Dispatched when an item that was selected has been brought to the front.

The NavigationalUIEvent.FOCUS_SET constant defines the value of the type property of the event object for a focusSet event.

itemClickevent  
Event object type: mx.events.ItemClickEvent

Dispatched when the user clicks on an item in the control.