| Package | spark.layouts |
| Class | public class CarouselLayout |
| Inheritance | CarouselLayout  PerspectiveAnimationNavigatorLayoutBase AnimationNavigatorLayoutBase NavigatorLayoutBase LayoutBase OnDemandEventDispatcher Object |
| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
 | This class is experimental, which means it has not been tested or documented as thoroughly as other core Apache Flex classes. |
The position of the elements is determined by the radii
radiusX, radiusY and radiusZ.
These can be properties can be set the negative values to produce
a ring of elements surrounding the view point.
The rotation of the elements is determined by the
rotationX and rotationY properties.
"none" is used for a rotation property,
no rotation is applied to the element around the corresponding axis."standard" is used for a rotation property,
the element will be rotated so that it faces outwards around the arc."reversed" is used for a rotation property,
the element will be rotated so that it faces inwards around the arc.
Hide MXML SyntaxThe <st:CarouselLayout> tag inherits all of the
tag attributes of its superclass, and adds the following tag attributes:
<st:AccordionLayout Properties angle="360" depthColor="-1" depthColorAlpha="1" horizontalAlign="center|left|right" horizontalAlignOffset="0" horizontalAlignOffsetPercent="0" numUnselectedElements="-1" radiusX="100" radiusY="0" radiusZ="NaN" rotateX="none|reversed|standard" rotateY="none|reversed|standard" verticalAlign="bottom|middle|top" verticalAlignOffset="0" verticalAlignOffsetPercent="0" />
| Property | Defined By | ||
|---|---|---|---|
| angle : Number
The segment of a circle to rotate the elements around. | CarouselLayout | ||
 | animationValue : Number [read-only]
If the animationType is "direct" the animationValue
will ease from 1 to 0. | AnimationNavigatorLayoutBase | |
| clipAndEnableScrolling : Boolean
If true, specifies to clip the children to the boundaries of the viewport. | LayoutBase | |
| depthColor : int
The color tint to apply to elements as their are moved back on the z axis. | CarouselLayout | ||
| depthColorAlpha : Number
The alpha to be used for the color tint that is applied to elements
as their are moved back on the z axis. | CarouselLayout | ||
| dropIndicator : DisplayObject
The DisplayObject that this layout uses for
the drop indicator during a drag-and-drop operation. | LayoutBase | |
| duration : Number
The duration of the animation in milliseconds. | AnimationNavigatorLayoutBase | |
| easer : IEaser
The easing behavior for this effect. | AnimationNavigatorLayoutBase | |
| elementHorizontalAlign : String
The horizontal transform point of elements. | CarouselLayout | ||
| elements : Vector.<IVisualElement> [read-only] | NavigatorLayoutBase | |
| elementVerticalAlign : String
The vertical transform point of elements. | CarouselLayout | ||
| fieldOfView : Number
fieldOfView
| PerspectiveAnimationNavigatorLayoutBase | |
| firstIndexInView : int [read-only]
firstIndexInView
| NavigatorLayoutBase | |
| focalLength : Number
focalLength
| PerspectiveAnimationNavigatorLayoutBase | |
| horizontalAlign : String
The horizontal position of the selected element in the viewport. | CarouselLayout | ||
| horizontalAlignOffset : Number
The offset in pixels to be used in conjunction with horizontalAlign
to set the horizontal position of the selected element in the viewport. | CarouselLayout | ||
| horizontalAlignOffsetPercent : Number
The offset as a percentage of the unscaled width of the viewport
to be used in conjunction with horizontalAlign to set the horizontal
position of the selected element in the viewport. | CarouselLayout | ||
| horizontalScrollPosition : 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 | |
| indicesInLayout : Vector.<int> [read-only]
A convenience method for determining the elements included in the layout. | NavigatorLayoutBase | |
| indicesNotInLayout : Vector.<int> [read-only]
A convenience method for determining the elements excluded from the layout. | NavigatorLayoutBase | |
| lastIndexInView : int [read-only]
lastIndexInView
| NavigatorLayoutBase | |
| numElementsInLayout : int [read-only]
Returns an int specifying number of elements included in the layout. | NavigatorLayoutBase | |
| numElementsNotInLayout : int [read-only]
Returns an int specifying number of elements not included in the layout. | NavigatorLayoutBase | |
| numIndicesInView : int [read-only]
inheritDoc
| NavigatorLayoutBase | |
| numUnselectedElements : int
The number of items to show either side of the selected item
are positioned around this element. | CarouselLayout | ||
| projectionCenterX : Number
projectionCenterX
| PerspectiveAnimationNavigatorLayoutBase | |
| projectionCenterY : Number
projectionCenterY
| PerspectiveAnimationNavigatorLayoutBase | |
| radiusX : Number
The radius to be used on the x axis for the SemiCarouselLayout. | CarouselLayout | ||
| radiusY : Number
The radius to be used on the y axis for the SemiCarouselLayout. | CarouselLayout | ||
| radiusZ : Number
The radius to be used on the z axis for the SemiCarouselLayout. | CarouselLayout | ||
| renderingData : Boolean [read-only]
inheritDoc
| NavigatorLayoutBase | |
| rotateX : String
Whether rotation should be applied to the x axis of elements. | CarouselLayout | ||
| rotateY : String
Whether rotation should be applied to the y axis of elements. | CarouselLayout | ||
| scrollBarDirection : String
The direction of the ScrollBar to use for navigation. | NavigatorLayoutBase | |
| selectedElement : IVisualElement [read-only]
| NavigatorLayoutBase | |
| selectedIndex : int
The index of the selected INavigatorLayout item. | NavigatorLayoutBase | |
| sizeChangedInLayoutPass : Boolean [read-only] | NavigatorLayoutBase | |
| target : GroupBase [override]
The GroupBase container whose elements are measured, sized and positioned
by this layout. | PerspectiveAnimationNavigatorLayoutBase | |
| typicalLayoutElement : ILayoutElement
Used by layouts when fixed row/column sizes are requested but
a specific size isn't specified. | LayoutBase | |
| unscaledHeight : Number [read-only]
A convenience method for determining the unscaled height of the viewport. | NavigatorLayoutBase | |
| unscaledWidth : Number [read-only]
A convenience method for determining the unscaled width of the viewport. | NavigatorLayoutBase | |
| useScrollBarForNavigation : Boolean
useScrollBarForNavigation
| NavigatorLayoutBase | |
| useVirtualLayout : Boolean
A container can hold any number of children. | LayoutBase | |
| verticalAlign : String
The vertical position of the selected element in the viewport. | CarouselLayout | ||
| verticalAlignOffset : Number
The offset in pixels to be used in conjunction with verticalAlign
to set the vertical position of the selected element in the viewport. | CarouselLayout | ||
| verticalAlignOffsetPercent : Number
The offset as a percentage of the unscaled height of the viewport
to be used in conjunction with verticalAlign to set the vertical
position of the selected element in the viewport. | CarouselLayout | ||
| verticalScrollPosition : 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 | |
| Method | Defined By | ||
|---|---|---|---|
Constructor. | CarouselLayout | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void | OnDemandEventDispatcher | |
|
Calculates the drop location in the data provider of the drop target for
the specified dragEvent. | LayoutBase | |
| clearVirtualLayoutCache():void
When useVirtualLayout is true,
this method can be used by the layout target
to clear cached layout information when the target changes. | LayoutBase | |
| dispatchEvent(event:Event):Boolean | OnDemandEventDispatcher | |
| 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 | |
| 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 | |
| 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 | |
| getHorizontalScrollPositionDelta(navigationUnit:uint):Number [override] | NavigatorLayoutBase | |
| 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 | |
| getScrollPositionDeltaToElement(index:int):Point
Computes the verticalScrollPosition and
horizontalScrollPosition deltas needed to
scroll the element at the specified index into view. | LayoutBase | |
| getVerticalScrollPositionDelta(navigationUnit:uint):Number [override] | NavigatorLayoutBase | |
| hasEventListener(type:String):Boolean | OnDemandEventDispatcher | |
| hideDropIndicator():void
Hides the previously shown drop indicator,
created by the showDropIndicator() method,
removes it from the display list and also stops the drag scrolling. | LayoutBase | |
| invalidateTargetSize():void | NavigatorLayoutBase | |
| isAnimating():Boolean
Returns whether the layout is currently animating. | AnimationNavigatorLayoutBase | |
| measure():void [override] | NavigatorLayoutBase | |
| removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void | OnDemandEventDispatcher | |
| showDropIndicator(dropLocation:DropLocation):void
Sizes, positions and parents the drop indicator based on the specified
drop location. | LayoutBase | |
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void [override]
Sizes and positions the target's elements. | CarouselLayout | ||
| updateScrollRect(w:Number, h:Number):void [override] | NavigatorLayoutBase | |
| willTrigger(type:String):Boolean | OnDemandEventDispatcher | |
| Method | Defined By | ||
|---|---|---|---|
| applyColorTransformToElement(element:IVisualElement, colorTransform:ColorTransform):void | NavigatorLayoutBase | |
| calculateDragScrollDelta(dropLocation:DropLocation, elapsedTime:Number):Point
Calculates how much to scroll for the specified dropLocation
during a drag and drop gesture. | LayoutBase | |
| 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 | |
| calculateDropIndicatorBounds(dropLocation:DropLocation):Rectangle
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 | |
| getElementBoundsAboveScrollRect(scrollRect:Rectangle):Rectangle
Returns the bounds of the first layout element that either spans or
is above the scrollRect's top edge. | LayoutBase | |
| getElementBoundsBelowScrollRect(scrollRect:Rectangle):Rectangle
Returns the bounds of the first layout element that either spans or
is below the scrollRect's bottom edge. | LayoutBase | |
| 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 | |
| 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 | |
| getElementLayoutBoundsHeight(element:IVisualElement, postLayoutTransform:Boolean = true):Number | NavigatorLayoutBase | |
| getElementLayoutBoundsWidth(element:IVisualElement, postLayoutTransform:Boolean = true):Number | NavigatorLayoutBase | |
|
Returns a reference to the views Scroller if there is one. | NavigatorLayoutBase | |
| getScrollRect():Rectangle
Returns the bounds of the target's scroll rectangle in layout coordinates. | LayoutBase | |
| indicesInView(firstIndexinView:int, numIndicesInView:int):void | NavigatorLayoutBase | |
| invalidateSelectedIndex(index:int, offset:Number):void [override]
| AnimationNavigatorLayoutBase | |
| invalidateTargetDisplayList():void | NavigatorLayoutBase | |
restoreElement(element:IVisualElement):void [override]
Restores the element to reset any changes to is visible properties. | CarouselLayout | ||
| scrollPositionChanged():void [override] | NavigatorLayoutBase | |
| setElementLayoutBoundsSize(element:IVisualElement, postLayoutTransform:Boolean = true):void | NavigatorLayoutBase | |
updateDisplayListBetween():void [override]
| CarouselLayout | ||
updateDisplayListReal():void [override]
| CarouselLayout | ||
updateDisplayListVirtual():void [override]
| CarouselLayout | ||
| updateElements():void | NavigatorLayoutBase | |
| updateElementsInLayout():void | NavigatorLayoutBase | |
updateIndicesInView():void [override]
To be overridden in subclasses. | CarouselLayout | ||
| updateScrollBar(index:int, offset:Number):void | NavigatorLayoutBase | |
| updateScrollerForContent():void | NavigatorLayoutBase | |
| updateScrollerForNavigation():void | NavigatorLayoutBase | |
| angle | property |
Show MXML Syntaxangle:Number| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
The segment of a circle to rotate the elements around.
The default value is 360.
public function get angle():Number public function set angle(value:Number):void| depthColor | property |
depthColor:int| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
The color tint to apply to elements as their are moved back on the z axis.
If a valid color is added to elements are tinted as they are moved
back on the z axis taking into account the depthColorAlpha
specified. If a value of -1 is set for the color no tinting is applied.
The default value is -1.
public function get depthColor():int public function set depthColor(value:int):voidSee also
| depthColorAlpha | property |
depthColorAlpha:Number| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
The alpha to be used for the color tint that is applied to elements as their are moved back on the z axis.
The default value is 1.
public function get depthColorAlpha():Number public function set depthColorAlpha(value:Number):voidSee also
| elementHorizontalAlign | property |
elementHorizontalAlign:String| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
The horizontal transform point of elements.
Valid values are HorizontalAlign.LEFT, HorizontalAlign.CENTER
and HorizontalAlign.RIGHT.
The default value is "center".
public function get elementHorizontalAlign():String public function set elementHorizontalAlign(value:String):voidSee also
| elementVerticalAlign | property |
elementVerticalAlign:String| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
The vertical transform point of elements.
Valid values are VerticalAlign.TOP, VerticalAlign.MIDDLE
and VerticalAlign.BOTTOM.
The default value is "middle".
public function get elementVerticalAlign():String public function set elementVerticalAlign(value:String):voidSee also
| horizontalAlign | property |
horizontalAlign:String| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
The horizontal position of the selected element in the viewport. All other elements are positioned around this element.
Valid values are HorizontalAlign.LEFT, HorizontalAlign.CENTER
and HorizontalAlign.RIGHT.
The default value is "center".
public function get horizontalAlign():String public function set horizontalAlign(value:String):voidSee also
| horizontalAlignOffset | property |
horizontalAlignOffset:Number| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
The offset in pixels to be used in conjunction with horizontalAlign
to set the horizontal position of the selected element in the viewport. All other elements
are positioned around this element.
If horizontalAlignOffsetPercent is set after this property,
this property is set automatically depending on the value of horizontalAlignOffsetPercent.
The default value is 0.
public function get horizontalAlignOffset():Number public function set horizontalAlignOffset(value:Number):voidSee also
| horizontalAlignOffsetPercent | property |
horizontalAlignOffsetPercent:Number| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
The offset as a percentage of the unscaled width of the viewport
to be used in conjunction with horizontalAlign to set the horizontal
position of the selected element in the viewport. All other elements are
positioned around this element.
Setting this property overrides any value set on horizontalAlignOffset.
The default value is 0.
public function get horizontalAlignOffsetPercent():Number public function set horizontalAlignOffsetPercent(value:Number):voidSee also
| numUnselectedElements | property |
numUnselectedElements:int| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
The number of items to show either side of the selected item are positioned around this element.
Valid values are HorizontalAlign.LEFT, HorizontalAlign.CENTER
and HorizontalAlign.RIGHT.
The default value is 2.
public function get numUnselectedElements():int public function set numUnselectedElements(value:int):void| radiusX | property |
radiusX:Number| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
The radius to be used on the x axis for the SemiCarouselLayout.
The default value is 100.
public function get radiusX():Number public function set radiusX(value:Number):void| radiusY | property |
radiusY:Number| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
The radius to be used on the y axis for the SemiCarouselLayout.
The default value is 0.
public function get radiusY():Number public function set radiusY(value:Number):void| radiusZ | property |
radiusZ:Number| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
The radius to be used on the z axis for the SemiCarouselLayout.
If a value of NaN is passed the largest of radiusX
or radiusY is used.
The default value is NaN.
public function get radiusZ():Number public function set radiusZ(value:Number):voidSee also
| rotateX | property |
rotateX:String| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Whether rotation should be applied to the x axis of elements.
The default value is true.
public function get rotateX():String public function set rotateX(value:String):void| rotateY | property |
rotateY:String| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Whether rotation should be applied to the y axis of elements.
The default value is true.
public function get rotateY():String public function set rotateY(value:String):void| verticalAlign | property |
verticalAlign:String| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
The vertical position of the selected element in the viewport. All other elements are positioned around this element.
Valid values are VerticalAlign.TOP, VerticalAlign.MIDDLE
and VerticalAlign.BOTTOM.
The default value is "middle".
public function get verticalAlign():String public function set verticalAlign(value:String):voidSee also
| verticalAlignOffset | property |
verticalAlignOffset:Number| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
The offset in pixels to be used in conjunction with verticalAlign
to set the vertical position of the selected element in the viewport. All other elements
are positioned around this element.
If verticalAlignOffsetPercent is set after this property,
this property is set automatically depending on the value of verticalAlignOffsetPercent.
The default value is 0.
public function get verticalAlignOffset():Number public function set verticalAlignOffset(value:Number):voidSee also
| verticalAlignOffsetPercent | property |
verticalAlignOffsetPercent:Number| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
The offset as a percentage of the unscaled height of the viewport
to be used in conjunction with verticalAlign to set the vertical
position of the selected element in the viewport. All other elements are
positioned around this element.
Setting this property overrides any value set on verticalAlignOffset.
The default value is 0.
public function get verticalAlignOffsetPercent():Number public function set verticalAlignOffsetPercent(value:Number):voidSee also
| CarouselLayout | () | Constructor |
public function CarouselLayout()| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Constructor.
| restoreElement | () | method |
override protected function restoreElement(element:IVisualElement):void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Restores the element to reset any changes to is visible properties. This method should be overridden in a subclass to return any elements used in the layout to its default state when it is removed from the targets displayList or when the target is removed from the layout.
Parameters
element:IVisualElement — The element to be restored.
|
| updateDisplayList | () | method |
override public function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
Sizes and positions the target's elements.
This is one of the methods that you must override when creating a
subclass of LayoutBase. The other method is measure().
You do not call these methods directly. Flex calls this method as part
of a layout pass. A layout pass consists of three phases.
First, if the target's properties are invalid, the LayoutManager calls
the target's commitProperties method.
Second, if the target's size is invalid, LayoutManager calls the target's
validateSize() method. The target's validateSize()
will in turn call the layout's measure() to calculate the
target's default size unless it was explicitly specified by both target's
explicitWidth and explicitHeight properties.
If the default size changes, Flex will invalidate the target's display list.
Last, if the target's display list is invalid, LayoutManager calls the target's
validateDisplayList. The target's validateDisplayList
will in turn call the layout's updateDisplayList method to
size and position the target's elements.
A typical implementation iterates through the target's elements
and uses the methods defined by the ILayoutElement to
position and resize the elements. Then the layout must also calculate and set
the target's contentWidth and contentHeight
properties to define the target's scrolling region.
Parameters
unscaledWidth:Number — Specifies the width of the target, in pixels,
in the targets's coordinates.
| |
unscaledHeight:Number — Specifies the height of the component, in pixels,
in the target's coordinates.
|
| updateDisplayListBetween | () | method |
override protected function updateDisplayListBetween():void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
| updateDisplayListReal | () | method |
override protected function updateDisplayListReal():void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
| updateDisplayListVirtual | () | method |
override protected function updateDisplayListVirtual():void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
| updateIndicesInView | () | method |
override protected function updateIndicesInView():void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 4 |
| Runtime Versions : | Flash Player 10, AIR 1.5 |
To be overridden in subclasses. indicesInView() should be invoked
in this method updating the first and last index in view.