Packagespark.layouts.supportClasses
Classpublic class PerspectiveAnimationNavigatorLayoutBase
InheritancePerspectiveAnimationNavigatorLayoutBase Inheritance AnimationNavigatorLayoutBase Inheritance NavigatorLayoutBase Inheritance LayoutBase Inheritance OnDemandEventDispatcher Inheritance Object
Subclasses CarouselLayout, CoverflowLayout, TimeMachineLayout

This class is experimental, which means it has not been tested or documented as thoroughly as other core Apache Flex classes.



Public Properties
 PropertyDefined By
 InheritedanimationValue : Number
[read-only]  If the animationType is "direct" the animationValue will ease from 1 to 0.
AnimationNavigatorLayoutBase
 InheritedclipAndEnableScrolling : Boolean
If true, specifies to clip the children to the boundaries of the viewport.
LayoutBase
 InheriteddropIndicator : DisplayObject
The DisplayObject that this layout uses for the drop indicator during a drag-and-drop operation.
LayoutBase
 Inheritedduration : Number
The duration of the animation in milliseconds.
AnimationNavigatorLayoutBase
 Inheritedeaser : IEaser
The easing behavior for this effect.
AnimationNavigatorLayoutBase
 Inheritedelements : Vector.<IVisualElement>
[read-only]
NavigatorLayoutBase
  fieldOfView : Number
 fieldOfView  
PerspectiveAnimationNavigatorLayoutBase
 InheritedfirstIndexInView : int
[read-only] firstIndexInView
NavigatorLayoutBase
  focalLength : Number
 focalLength  
PerspectiveAnimationNavigatorLayoutBase
 InheritedhorizontalScrollPosition : Number
The x coordinate of the origin of the viewport in the component's coordinate system, where the default value is (0,0) corresponding to the upper-left corner of the component.
LayoutBase
 InheritedindicesInLayout : Vector.<int>
[read-only] A convenience method for determining the elements included in the layout.
NavigatorLayoutBase
 InheritedindicesNotInLayout : Vector.<int>
[read-only] A convenience method for determining the elements excluded from the layout.
NavigatorLayoutBase
 InheritedlastIndexInView : int
[read-only] lastIndexInView
NavigatorLayoutBase
 InheritednumElementsInLayout : int
[read-only] Returns an int specifying number of elements included in the layout.
NavigatorLayoutBase
 InheritednumElementsNotInLayout : int
[read-only] Returns an int specifying number of elements not included in the layout.
NavigatorLayoutBase
 InheritednumIndicesInView : int
[read-only] inheritDoc
NavigatorLayoutBase
  projectionCenterX : Number
 projectionCenterX
PerspectiveAnimationNavigatorLayoutBase
  projectionCenterY : Number
 projectionCenterY
PerspectiveAnimationNavigatorLayoutBase
 InheritedrenderingData : Boolean
[read-only] inheritDoc
NavigatorLayoutBase
 InheritedscrollBarDirection : String
The direction of the ScrollBar to use for navigation.
NavigatorLayoutBase
 InheritedselectedElement : IVisualElement
[read-only]
NavigatorLayoutBase
 InheritedselectedIndex : int
The index of the selected INavigatorLayout item.
NavigatorLayoutBase
 InheritedsizeChangedInLayoutPass : Boolean
[read-only]
NavigatorLayoutBase
  target : GroupBase
[override] The GroupBase container whose elements are measured, sized and positioned by this layout.
PerspectiveAnimationNavigatorLayoutBase
 InheritedtypicalLayoutElement : ILayoutElement
Used by layouts when fixed row/column sizes are requested but a specific size isn't specified.
LayoutBase
 InheritedunscaledHeight : Number
[read-only] A convenience method for determining the unscaled height of the viewport.
NavigatorLayoutBase
 InheritedunscaledWidth : Number
[read-only] A convenience method for determining the unscaled width of the viewport.
NavigatorLayoutBase
 InheriteduseScrollBarForNavigation : Boolean
useScrollBarForNavigation
NavigatorLayoutBase
 InheriteduseVirtualLayout : Boolean
A container can hold any number of children.
LayoutBase
 InheritedverticalScrollPosition : Number
The y coordinate of the origin of the viewport in the component's coordinate system, where the default value is (0,0) corresponding to the upper-left corner of the component.
LayoutBase
Protected Properties
 PropertyDefined By
 Inherited_elements : Vector.<IVisualElement>
NavigatorLayoutBase
Public Methods
 MethodDefined By
  
Constructor.
PerspectiveAnimationNavigatorLayoutBase
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
OnDemandEventDispatcher
 Inherited
Calculates the drop location in the data provider of the drop target for the specified dragEvent.
LayoutBase
 Inherited
When useVirtualLayout is true, this method can be used by the layout target to clear cached layout information when the target changes.
LayoutBase
 Inherited
dispatchEvent(event:Event):Boolean
OnDemandEventDispatcher
 Inherited
elementAdded(index:int):void
Called by the target after a layout element has been added and before the target's size and display list are validated.
LayoutBase
 Inherited
elementRemoved(index:int):void
This method must is called by the target after a layout element has been removed and before the target's size and display list are validated.
LayoutBase
 Inherited
getElementBounds(index:int):Rectangle
Returns the specified element's layout bounds as a Rectangle or null if the index is invalid, the corresponding element is null, includeInLayout=false, or if this layout's target property is null.
LayoutBase
 Inherited
getHorizontalScrollPositionDelta(navigationUnit:uint):Number
[override]
NavigatorLayoutBase
 Inherited
getNavigationDestinationIndex(currentIndex:int, navigationUnit:uint, arrowKeysWrapFocus:Boolean):int
Delegation method that determines which item to navigate to based on the current item in focus and user input in terms of NavigationUnit.
LayoutBase
  
getProjectionRectAtZ(z:Number):Rectangle
Returns the visible projection plane at a specific depth.
PerspectiveAnimationNavigatorLayoutBase
 Inherited
Computes the verticalScrollPosition and horizontalScrollPosition deltas needed to scroll the element at the specified index into view.
LayoutBase
 Inherited
getVerticalScrollPositionDelta(navigationUnit:uint):Number
[override]
NavigatorLayoutBase
 Inherited
hasEventListener(type:String):Boolean
OnDemandEventDispatcher
 Inherited
Hides the previously shown drop indicator, created by the showDropIndicator() method, removes it from the display list and also stops the drag scrolling.
LayoutBase
 Inherited
NavigatorLayoutBase
 Inherited
isAnimating():Boolean
 Returns whether the layout is currently animating.
AnimationNavigatorLayoutBase
 Inherited
measure():void
[override]
NavigatorLayoutBase
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
OnDemandEventDispatcher
 Inherited
showDropIndicator(dropLocation:DropLocation):void
Sizes, positions and parents the drop indicator based on the specified drop location.
LayoutBase
 Inherited
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
[override] Sizes and positions the target's elements.
NavigatorLayoutBase
 Inherited
updateScrollRect(w:Number, h:Number):void
[override]
NavigatorLayoutBase
 Inherited
willTrigger(type:String):Boolean
OnDemandEventDispatcher
Protected Methods
 MethodDefined By
 Inherited
applyColorTransformToElement(element:IVisualElement, colorTransform:ColorTransform):void
NavigatorLayoutBase
 Inherited
calculateDragScrollDelta(dropLocation:DropLocation, elapsedTime:Number):Point
Calculates how much to scroll for the specified dropLocation during a drag and drop gesture.
LayoutBase
 Inherited
calculateDropIndex(x:Number, y:Number):int
Returns the index where a new item should be inserted if the user releases the mouse at the specified coordinates while completing a drag and drop gesture.
LayoutBase
 Inherited
Calculates the bounds for the drop indicator that provides visual feedback to the user of where the items will be inserted at the end of a drag and drop gesture.
LayoutBase
 Inherited
getElementBoundsAboveScrollRect(scrollRect:Rectangle):Rectangle
Returns the bounds of the first layout element that either spans or is above the scrollRect's top edge.
LayoutBase
 Inherited
getElementBoundsBelowScrollRect(scrollRect:Rectangle):Rectangle
Returns the bounds of the first layout element that either spans or is below the scrollRect's bottom edge.
LayoutBase
 Inherited
getElementBoundsLeftOfScrollRect(scrollRect:Rectangle):Rectangle
Returns the bounds of the first layout element that either spans or is to the left of the scrollRect's left edge.
LayoutBase
 Inherited
getElementBoundsRightOfScrollRect(scrollRect:Rectangle):Rectangle
Returns the bounds of the first layout element that either spans or is to the right of the scrollRect's right edge.
LayoutBase
 Inherited
getElementLayoutBoundsHeight(element:IVisualElement, postLayoutTransform:Boolean = true):Number
NavigatorLayoutBase
 Inherited
getElementLayoutBoundsWidth(element:IVisualElement, postLayoutTransform:Boolean = true):Number
NavigatorLayoutBase
 Inherited
Returns a reference to the views Scroller if there is one.
NavigatorLayoutBase
 Inherited
getScrollRect():Rectangle
Returns the bounds of the target's scroll rectangle in layout coordinates.
LayoutBase
 Inherited
indicesInView(firstIndexinView:int, numIndicesInView:int):void
NavigatorLayoutBase
 Inherited
invalidateSelectedIndex(index:int, offset:Number):void
[override]
AnimationNavigatorLayoutBase
 Inherited
NavigatorLayoutBase
 Inherited
Restores the element to reset any changes to is visible properties.
NavigatorLayoutBase
 Inherited
[override]
NavigatorLayoutBase
 Inherited
setElementLayoutBoundsSize(element:IVisualElement, postLayoutTransform:Boolean = true):void
NavigatorLayoutBase
  
[override]
PerspectiveAnimationNavigatorLayoutBase
 Inherited
NavigatorLayoutBase
 Inherited
NavigatorLayoutBase
 Inherited
 To be overridden in subclasses.
AnimationNavigatorLayoutBase
 Inherited
updateScrollBar(index:int, offset:Number):void
NavigatorLayoutBase
 Inherited
NavigatorLayoutBase
 Inherited
NavigatorLayoutBase
Events
 Event Summary Defined By
 Inherited The IndexChangeEvent.CHANGE constant defines the value of the type property of the event object for a change event, which indicates that an index has changed, such as when a List-based control changes its selection.NavigatorLayoutBase
 Inherited The FlexEvent.VALUE_COMMIT constant defines the value of the type property of the event object for a valueCommit event.NavigatorLayoutBase
Protected Constants
 ConstantDefined By
 InheritedDIRECT : String = direct
[static] An animationType value passed to the constructor.
AnimationNavigatorLayoutBase
 InheritedINDIRECT : String = indirect
[static] An animationType value passed to the constructor.
AnimationNavigatorLayoutBase
Property Detail
fieldOfViewproperty
fieldOfView:Number

Language Version : ActionScript  
Product Version : Flex 4
Runtime Versions : Flash Player 10 -  , AIR 1.5 -  

 fieldOfView  


Implementation
    public function get fieldOfView():Number
    public function set fieldOfView(value:Number):void
focalLengthproperty 
focalLength:Number

Language Version : ActionScript  
Product Version : Flex 4
Runtime Versions : Flash Player 10 -  , AIR 1.5 -  

 focalLength  


Implementation
    public function get focalLength():Number
    public function set focalLength(value:Number):void
projectionCenterXproperty 
projectionCenterX:Number

Language Version : ActionScript  
Product Version : Flex 4
Runtime Versions : Flash Player 10 -  , AIR 1.5 -  

 projectionCenterX

The default value is 0  .


Implementation
    public function get projectionCenterX():Number
    public function set projectionCenterX(value:Number):void
projectionCenterYproperty 
projectionCenterY:Number

Language Version : ActionScript  
Product Version : Flex 4
Runtime Versions : Flash Player 10 -  , AIR 1.5 -  

 projectionCenterY

The default value is NaN  .


Implementation
    public function get projectionCenterY():Number
    public function set projectionCenterY(value:Number):void
targetproperty 
target:GroupBase[override]

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

The GroupBase container whose elements are measured, sized and positioned by this layout.

Subclasses may override the setter to perform target specific actions. For example a 3D layout may set the target's maintainProjectionCenter property here.


Implementation
    public function get target():GroupBase
    public function set target(value:GroupBase):void
Constructor Detail
PerspectiveAnimationNavigatorLayoutBase()Constructor
public function PerspectiveAnimationNavigatorLayoutBase(animationType:String)

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Constructor.

Parameters
animationType:String — The type of animation.
Method Detail
getProjectionRectAtZ()method
public function getProjectionRectAtZ(z:Number):Rectangle

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5

Returns the visible projection plane at a specific depth.

Parameters

z:Number — The depth of the projection plane.

Returns
Rectangle — Rectangle A Rectangle object with the coordinates of the projection plane.
updateDisplayListBetween()method 
override protected function updateDisplayListBetween():void

Language Version : ActionScript 3.0
Product Version : Flex 4
Runtime Versions : Flash Player 10, AIR 1.5