StackLayout

Package	com.adobe.mosaic.layouts
Class	public class StackLayout
Inheritance	StackLayout BasicLayout LayoutBase OnDemandEventDispatcher Object
Implements	ISelectable

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtime Versions:

AIR 2.6, Flash Player 10.2

The StackLayout presents only one child at a time, with the child filling up the entire space alloted to the StackLayout. The selection of the child may be done by setting either the selectedIndex property.

StackLayout partially implements ISelectableList so the layout may be used as the dataProvider for a ButtonBar.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		clipAndEnableScrolling : Boolean If true, specifies to clip the children to the boundaries of the viewport.	LayoutBase
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		dropIndicator : DisplayObject The DisplayObject that this layout uses for the drop indicator during a drag-and-drop operation.	LayoutBase
		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
		layoutTarget : GroupBase [read-only] The Group for which the layout is working (arranging and sizing its children).	StackLayout
		selectedIndex : int The index of the currently selected element of the group target.	StackLayout
		target : GroupBase The GroupBase container whose elements are measured, sized and positioned by this layout.	LayoutBase
		typicalLayoutElement : ILayoutElement Used by layouts when fixed row/column sizes are requested but a specific size isn't specified.	LayoutBase
		useVirtualLayout : Boolean A container can hold any number of children.	LayoutBase
		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

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		StackLayout() Constructor	StackLayout
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	OnDemandEventDispatcher
		calculateDropLocation(dragEvent:DragEvent):DropLocation 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 Dispatches an event into the event flow.	OnDemandEventDispatcher
		elementAdded(index:int):void [override] Intercepts the element being added and resizes it to take up the entire space of the layout.	StackLayout
		elementRemoved(index:int):void [override] Removes the given element from the layout and adjusts the selectedIndex if the element being removed as the currently selected element.	StackLayout
		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 Returns the change to the horizontal scroll position to handle different scrolling options.	LayoutBase
		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
		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 Returns the change to the vertical scroll position to handle different scrolling options.	LayoutBase
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	OnDemandEventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		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
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		measure():void Measures the target's default size based on its content, and optionally measures the target's default minimum size.	LayoutBase
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	OnDemandEventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		showDropIndicator(dropLocation:DropLocation):void Sizes, positions and parents the drop indicator based on the specified drop location.	LayoutBase
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void [override] Adjusts the display to show the currently selected item.	StackLayout
		updateScrollRect(w:Number, h:Number):void Called by the target at the end of its updateDisplayList to have the layout update its scrollRect.	LayoutBase
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	OnDemandEventDispatcher

Protected Methods

Hide Inherited Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		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
		getScrollRect():Rectangle Returns the bounds of the target's scroll rectangle in layout coordinates.	LayoutBase
		scrollPositionChanged():void Called when the verticalScrollPosition or horizontalScrollPosition properties change.	LayoutBase

Property Detail

layoutTarget

property

layoutTarget:GroupBase [read-only]

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtime Versions:

AIR 2.6, Flash Player 10.2

The Group for which the layout is working (arranging and sizing its children).

Implementation
public function get layoutTarget():GroupBase

selectedIndex

property

selectedIndex:int

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtime Versions:

AIR 2.6, Flash Player 10.2

The index of the currently selected element of the group target.

This property can be used as the source for data binding. When this property is modified, it dispatches the selectedIndexChanged event.

Implementation
public function get selectedIndex():int
public function set selectedIndex(value:int):void

Constructor Detail

()

Constructor

public function StackLayout()

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtime Versions:

AIR 2.6, Flash Player 10.2

Constructor

Method Detail

elementAdded

()

method

override public function elementAdded(index:int):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtime Versions:

AIR 2.6, Flash Player 10.2

Intercepts the element being added and resizes it to take up the entire space of the layout. If the index matches the selectedIndex, the element is made visible as well.

Parameters

index:int — The index of the element being added.

elementRemoved

()

method

override public function elementRemoved(index:int):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtime Versions:

AIR 2.6, Flash Player 10.2

Removes the given element from the layout and adjusts the selectedIndex if the element being removed as the currently selected element.

Parameters

index:int — The index of the element being removed.

updateDisplayList

()

method

override public function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtime Versions:

AIR 2.6, Flash Player 10.2

Adjusts the display to show the currently selected item.

Parameters

	`unscaledWidth:Number` — The actual width of the target group.

	`unscaledHeight:Number` — The actual height of the target group.

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

StackLayout - AS3 ADEP Composite Application

Classes x

layoutTarget

selectedIndex

StackLayout

elementAdded

elementRemoved

updateDisplayList