| Package | lunas.containers |
| Class | public class ScrollContainer |
| Inheritance | ScrollContainer  ListContainer Container CoreComponent Background CoreSprite flash.display.Sprite |
| Subclasses | AutoScrollContainer |
Example :
package examples
{
import graphics.Direction;
import lunas.containers.ScrollContainer;
import vegas.colors.Color;
import flash.display.Sprite;
import flash.display.StageScaleMode;
import flash.events.KeyboardEvent;
import flash.ui.Keyboard;
public dynamic class ScrollContainerExample extends Sprite
{
public function ScrollContainerExample()
{
container = new ScrollContainer() ;
container.x = 25 ;
container.y = 25 ;
container.space = 10 ;
container.spaceH = 50 ;
container.spaceV = 20 ;
container.childCount = 5 ;
//container.useScrollRect = true ;
container.direction = Direction.HORIZONTAL ;
addChild( container ) ;
for (var i:uint = 0 ; i < 10 ; i++ )
{
var s:* = new Square() ; // MovieClip loaded from the library.
var c:Color = new Color(s) ;
c.rgb = Math.random() 0xFFFFFF ;
container.addChild( s ) ;
}
stage.scaleMode = StageScaleMode.NO_SCALE ;
stage.addEventListener( KeyboardEvent.KEY_DOWN , keyDown ) ;
}
public var container:ScrollContainer ;
public function keyDown( e:KeyboardEvent ):void
{
var code:uint = e.keyCode ;
switch( code )
{
case Keyboard.LEFT :
{
container.scroll -- ;
break ;
}
case Keyboard.RIGHT :
{
container.scroll ++ ;
break ;
}
case Keyboard.SPACE :
{
container.direction = container.direction == Direction.HORIZONTAL ? Direction.VERTICAL : Direction.HORIZONTAL ;
break ;
}
case Keyboard.UP :
{
container.fixScroll = !container.fixScroll ;
break ;
}
case Keyboard.DOWN :
{
container.noScrollEasing = !container.noScrollEasing ;
break ;
}
}
}
}
}
| Property | Defined By | ||
|---|---|---|---|
 | align : uint
The alignement of the background. | Background | |
| area : Sprite [read-only]
Returns the area reference of this component. | ListContainer | |
| areaPen : IPen [read-only]
Indicates the area Pen reference of this component. | ListContainer | |
| autoSize : Boolean
Indicates if the background is resizing when the stage resize event is invoked. | Background | |
| background : Sprite [read-only]
Indicates the background reference of this component. | ListContainer | |
| backgroundPen : IPen [read-only]
Indicates the background Pen reference of this component. | ListContainer | |
| border : EdgeMetrics
Indicates the thickness, in pixels, of the four edge regions around a visual component. | CoreComponent | |
| bottomLeftRadius : Number
The radius of the bottom-left corner, in pixels. | Background | |
| bottomRightRadius : Number
The radius of the bottom-right corner, in pixels. | Background | |
| bottomScroll : Number [read-only]
Determinates the bottom scroll value. | ScrollContainer | ||
| bubbles : Boolean = true
Indicates if the events use bubbling when are dispatched. | CoreComponent | |
| builder : Builder
Indicates the Builder reference of this instance. | CoreComponent | |
| childCount : int
Determinates the number of childs in this container. | ListContainer | |
| componentInspectorSetting : Boolean
Initialize when the Flash component settings are initialized (only in Flash with a compiled component). | CoreComponent | |
| direction : String
Indicates the direction value of the background when the display is in this "full" mode (default value is null). | Background | |
| enabled : Boolean
Indicates the enabled state of the component. | CoreComponent | |
| fill : IFillStyle
Determinates the IFillStyle reference of this display. | Background | |
| fixScroll : Boolean
Indicates if the scroll is fixed. | ScrollContainer | ||
| gradientMatrix : Matrix
The matrix value to draw the gradient fill. | Background | |
| gradientRotation : Number = 0
The rotation value to draw the gradient fill. | Background | |
| gradientTranslation : Point
The translation vector to draw the gradient fill. | Background | |
| group : Boolean
Indicates with a boolean if this object is grouped. | CoreComponent | |
| groupName : String
Indicates the name of the group of this object. | CoreComponent | |
| h : Number
Determinates the virtual height value of this component. | Background | |
| invert : Boolean
Inverts the z-depth of the childs in the container. | Container | |
| isFull : Boolean
Indicates if the background use full size (use Stage.stageWidth and Stage.stageHeight to resize the background). | Background | |
| layout : Layout
Determinates the layout of this container. | CoreComponent | |
| line : ILineStyle
Determinates the ILineStyle reference of this display. | Background | |
| logger : Logger
Determinates the internal ILogger reference of this Logable object. | CoreSprite | |
| maskIsActive : Boolean
Indicates if the mask is active or not over this container. | ListContainer | |
| maskView : Sprite [read-only]
Determinates the mask reference of this container. | ListContainer | |
| maxHeight : Number
This property defined the maximum height of this display. | Background | |
| maxscroll : Number [read-only]
Returns the maxscroll value. | ScrollContainer | ||
| maxWidth : Number
Defines the maximum width of this display. | Background | |
| minHeight : Number
This property defined the mimimun height of this display (This value is >= 0). | Background | |
| minWidth : Number
This property defined the mimimun width of this display (This value is >= 0). | Background | |
| noScrollEasing : Boolean
Indicates if the scroll use an easing effect. | ScrollContainer | ||
| numChildren : int [override] [read-only]
Determinates the number of children of this object. | Container | |
| propHeight : String = height
The height property name use in the container to layout all items. | ListContainer | |
| propWidth : String = width
The width property name use in the container to layout all items. | ListContainer | |
| propX : String = x
The x property name use in the container to layout all items. | ListContainer | |
| propY : String = y
The y property name use in the container to layout all items. | ListContainer | |
| rectangle : Rectangle [read-only]
Returns the internal Rectangle object of this display. | ListContainer | |
| scroll : Number
Returns the scroll value of this container. | ScrollContainer | ||
| scrollDuration : Number = 12
Indicates the scroll duration. | ScrollContainer | ||
| scrollEasing : Function
Indicates the scroll easing method. | ScrollContainer | ||
| space : Number
Indicates the space value (in pixel) between 2 childs in the list. | ListContainer | |
| spaceH : Number
Indicates the space value (in pixel) between 2 childs in the list when the direction is horizontal. | ListContainer | |
| spaceV : Number
Indicates the space value (in pixel) between 2 childs in the list when the direction is vertical. | ListContainer | |
| style : Style
Returns the style of this component. | CoreComponent | |
| topLeftRadius : Number
The radius of the upper-left corner, in pixels. | Background | |
| topRightRadius : Number
The radius of the upper-right corner, in pixels. | Background | |
| useCacheAsBitmap : Boolean
Indicates if the container use cacheAsBitmap flag when the scroll is in progress. | ScrollContainer | ||
| useGradientBox : Boolean
Indicates if the IFillStyle of this display use gradient box matrix (only if the IFillStyle is a FillGradientStyle). | Background | |
| useScrollRect : Boolean
Indicates if this container use a scrollRect reference to mask the content. | ListContainer | |
| w : Number
Determinates the virtual height value of this component. | Background | |
| Method | Defined By | ||
|---|---|---|---|
ScrollContainer(direction:String = vertical)
Creates a new ScrollContainer instance. | ScrollContainer | ||
addChild(child:DisplayObject):DisplayObject [override]
Adds a child DisplayObject instance to this DisplayObjectContainer instance. | ScrollContainer | ||
addChildAt(child:DisplayObject, index:int):DisplayObject [override]
Adds a child DisplayObject instance to this DisplayObjectContainer instance. | ScrollContainer | ||
| areInaccessibleObjectsUnderPoint(point:Point):Boolean [override]
Indicates whether the security restrictions would cause any display objects to be omitted from the list returned by calling the DisplayObjectContainer.getObjectsUnderPoint() method with the specified point point. | Container | |
| changeChildsPosition():void
Refreshs and changes the child position of all childs in the container. | ListContainer | |
| clear():void
Removes all childs in the container. | Container | |
| contains(child:DisplayObject):Boolean [override]
Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself. | Container | |
| containsAt(index:int):Boolean
Returns true if a child exist in the display list at the specified index value. | Container | |
| doLater():void
Launch an event with a delayed interval. | Background | |
draw(... arguments):void [override]
Draws the view of the component. | ScrollContainer | ||
| getBuilderRenderer():Class
Returns the Builder constructor use to initialize this component. | CoreComponent | |
| getChildAt(index:int):DisplayObject [override]
Returns the child display object instance that exists at the specified index. | Container | |
| getChildByName(name:String):DisplayObject [override]
Returns the child display object that exists with the specified name. | Container | |
| getChildIndex(child:DisplayObject):int [override]
Returns the index position of a child DisplayObject instance. | Container | |
| getChildPositionAt(n:Number):Point
Returns the child position with the specified index and the current direction of this display. | ListContainer | |
getContainerPos():Number
Returns the current container position. | ScrollContainer | ||
| getCoordinateProperty():String
Returns the string representation of the coordinate attribute used in this display with the current direction value. | ListContainer | |
| getObjectsUnderPoint(point:Point):Array [override]
Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance. | Container | |
| getSizeProperty():String
Returns the string representation of the size attribute with the current direction. | ListContainer | |
| getStyleRenderer():Class
Returns the Style constructor use to initialize this component. | CoreComponent | |
| groupPolicyChanged():void
Invoked when the group property or the groupName property changed. | CoreComponent | |
| hide():void
Hides the component. | CoreComponent | |
| initBackgroundPen(graphic:* = null):IPen
Init the pen to draw the background of this display. | Background | |
| initialize():void
Initialize the component. | CoreComponent | |
| isLocked():Boolean
Returns true if the object is locked. | CoreSprite | |
| isVisible():Boolean
Returns true if the component is visible. | CoreComponent | |
| lock():void [override]
Locks the object. | CoreComponent | |
| lockMask():void
Use the mask protection. | ListContainer | |
| move(x:Number, y:Number):void
Moves the component. | CoreComponent | |
| notifyChanged():void
Notify a change in this component. | CoreComponent | |
| notifyEnabled():void
Notify an event when the enabled property is changed. | CoreComponent | |
notifyFinish():void
Invoked when the scroll is finished. | ScrollContainer | ||
| notifyResized():void
Notify an event when you resize the component. | Background | |
notifyScroll():void
Notify a scroll ComponentEvent. | ScrollContainer | ||
notifyStart():void
Invoked when the scroll is started. | ScrollContainer | ||
| refresh(init:*):void
Refresh and initialize the display with a generic object and invoke the "update" method. | Background | |
| registerView(scope:DisplayObjectContainer = null):void
Registers the view of this component. | CoreComponent | |
removeChild(child:DisplayObject):DisplayObject [override]
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance. | ScrollContainer | ||
removeChildAt(index:int):DisplayObject [override]
Removes a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer. | ScrollContainer | ||
removeChildsAt(index:int, size:Number):Array [override]
Removes all childs in the model defined for the first item by the specified index value,
this method remove the first and the size - 1 items. | ScrollContainer | ||
removeRange(from:int, to:int):Array [override]
Removes a range of childs in the container. | ScrollContainer | ||
| resetLock():void
Reset the lock security of the display. | CoreSprite | |
| resize(e:Event = null):void
Resize and update the background. | Background | |
| scope():DisplayObject
Returns the real scope reference of this component. | CoreComponent | |
| setChildIndex(child:DisplayObject, index:int):void [override]
Changes the position of an existing child in the display object container. | Container | |
| setCornerRadius(n:Number):void
Defines all corner radius of the background (upper-left, upper-right, bottom-left and bottom-right). | Background | |
setScroll(value:Number, noEvent:Boolean = false):void
Sets the scroll value of the container. | ScrollContainer | ||
| setSize(w:Number, h:Number):void
Sets the virtual width (w) and height (h) values of the component. | Background | |
| setStyle(... args):void
Sets the style property on the style declaration or object. | CoreComponent | |
| show():void
Shows the component. | CoreComponent | |
speedScroll(n:Number):void
Scroll the container without scroll and without notify an event. | ScrollContainer | ||
| swapChildren(child1:DisplayObject, child2:DisplayObject):void [override]
Swaps the z-order (front-to-back order) of the two specified child objects. | Container | |
| swapChildrenAt(index1:int, index2:int):void [override]
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the child list. | Container | |
| toArray():Array
Returns the Array representation of all childs in this container. | Container | |
| unlock():void [override]
Unlocks the display. | CoreComponent | |
| unlockMask():void
Unlock the mask protect. | ListContainer | |
| unregisterView():void
Unregisters the view of this component. | CoreComponent | |
| update():void [override]
Updates the component. | CoreComponent | |
| viewChanged():void
This method is invoked after the draw() method in the update() method. | Background | |
| viewDestroyed(e:Event = null):void
Invoked when the component is removed. | CoreComponent | |
| viewEnabled():void
Invoked when the enabled property of the component change. | Background | |
| viewResize():void
Invoked when the component is resized. | Background | |
| viewStyleChanged(e:Event = null):void
Invoked when the component Style changed. | CoreComponent | |
| Method | Defined By | ||
|---|---|---|---|
_refreshChilds(... arguments):void
Invoked to refreshChilds during the scroll of this container. | ScrollContainer | ||
| addedToStage(e:Event = null):void
Invoked when the display is added to the stage. | CoreSprite | |
| addedToStageResize(e:Event = null):void
Invoked when the display is removed from the stage to enable the autoSize mode. | Background | |
| fireComponentEvent(type:String):void
Dispatchs a ComponentEvent with the specified type. | CoreComponent | |
| refreshBackground():void
Refresh the mask view of the display. | ListContainer | |
| refreshMask():void
Refresh the mask view of the display. | ListContainer | |
| removedFromStage(e:Event = null):void
Invoked when the display is removed from the stage. | CoreSprite | |
| removedFromStageResize(e:Event = null):void
Invoked when the display is removed from the stage to disable the autoSize mode. | Background | |
| renderLayout(layout:Layout = null):void
Receives a message when the layout emit when is rendered. | CoreComponent | |
| updateLayout(layout:Layout = null):void [override]
Invoked when the container layout change. | ListContainer | |
| bottomScroll | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesbottomScroll:Number [read-only] Determinates the bottom scroll value.
public function get bottomScroll():Number| fixScroll | property |
public var fixScroll:BooleanIndicates if the scroll is fixed.
| maxscroll | property |
maxscroll:Number [read-only] Returns the maxscroll value.
public function get maxscroll():Number| noScrollEasing | property |
public var noScrollEasing:BooleanIndicates if the scroll use an easing effect.
| scroll | property |
scroll:NumberReturns the scroll value of this container.
public function get scroll():Number public function set scroll(value:Number):void| scrollDuration | property |
public var scrollDuration:Number = 12Indicates the scroll duration.
| scrollEasing | property |
public var scrollEasing:FunctionIndicates the scroll easing method.
| useCacheAsBitmap | property |
public var useCacheAsBitmap:BooleanIndicates if the container use cacheAsBitmap flag when the scroll is in progress.
| ScrollContainer | () | Constructor |
public function ScrollContainer(direction:String = vertical)Creates a new ScrollContainer instance.
Parametersdirection:String (default = vertical)graphics.Direction).
|
| _refreshChilds | () | method |
protected function _refreshChilds(... arguments):voidInvoked to refreshChilds during the scroll of this container.
Parameters
... arguments |
| addChild | () | method |
override public function addChild(child:DisplayObject):DisplayObjectAdds a child DisplayObject instance to this DisplayObjectContainer instance. The child is added to the front (top) of all other children in this DisplayObjectContainer instance. (To add a child to a specific index position, use the addChildAt() method.) If you add a child object that already has a different display object container as a parent, the object is removed from the child list of the other display object container.
Parameters
child:DisplayObject — The DisplayObject instance to add as a child of this DisplayObjectContainer instance.
|
DisplayObject — The DisplayObject instance that you pass in the child parameter.
|
ArgumentError — Throws if the child is the same as the parent. Also throws if the caller is a child (or grandchild etc.) of the child being added.
|
| addChildAt | () | method |
override public function addChildAt(child:DisplayObject, index:int):DisplayObjectAdds a child DisplayObject instance to this DisplayObjectContainer instance. The child is added at the index position specified. An index of 0 represents the back (bottom) of the display list for this DisplayObjectContainer object.
Parameters
child:DisplayObject — The DisplayObject instance to add as a child of this DisplayObjectContainer instance.
| |
index:int — The index position to which the child is added. If you specify a currently occupied index position, the child object that exists at that position and all higher positions are moved up one position in the child list.
|
DisplayObject — The DisplayObject instance that you pass in the child parameter.
|
RangeError — Throws if the index position does not exist in the child list.
| |
ArgumentError — Throws if the child is the same as the parent. Also throws if the caller is a child (or grandchild etc.) of the child being added.
|
| draw | () | method |
override public function draw(... arguments):voidDraws the view of the component.
Parameters
... arguments |
| getContainerPos | () | method |
public function getContainerPos():NumberReturns the current container position.
ReturnsNumber — the current container position.
|
| notifyFinish | () | method |
public function notifyFinish():voidInvoked when the scroll is finished.
| notifyScroll | () | method |
public function notifyScroll():voidNotify a scroll ComponentEvent.
| notifyStart | () | method |
public function notifyStart():voidInvoked when the scroll is started.
| removeChild | () | method |
override public function removeChild(child:DisplayObject):DisplayObjectRemoves the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance. The parent property of the removed child is set to null , and the object is garbage collected if no other references to the child exist. The index positions of any display objects above the child in the DisplayObjectContainer are decreased by 1.
Parameters
child:DisplayObject — The DisplayObject instance to remove.
|
DisplayObject — The DisplayObject instance that you pass in the child parameter.
|
ArgumentError — Throws if the child parameter is not a child of this object.
|
| removeChildAt | () | method |
override public function removeChildAt(index:int):DisplayObjectRemoves a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer. The parent property of the removed child is set to null, and the object is garbage collected if no other references to the child exist. The index positions of any display objects above the child in the DisplayObjectContainer are decreased by 1.
Parameters
index:int — The child index of the DisplayObject to remove.
|
DisplayObject — The DisplayObject instance that was removed.
|
RangeError — Throws if the index does not exist in the child list.
| |
SecurityError — This child display object belongs to a sandbox to which the calling object does not have access.
You can avoid this situation by having the child movie call the Security.allowDomain() method.
|
| removeChildsAt | () | method |
override public function removeChildsAt(index:int, size:Number):Array
Removes all childs in the model defined for the first item by the specified index value,
this method remove the first and the size - 1 items.
Parameters
index:int | |
size:Number |
Array |
RangeError — if the index value is out of the bounds of the container elements.
|
| removeRange | () | method |
override public function removeRange(from:int, to:int):ArrayRemoves a range of childs in the container.
Parameters
from:int | |
to:int |
Array — the array representation of all removed items.
|
RangeError — if the index value is out of the bounds of the container elements.
|
| setScroll | () | method |
public function setScroll(value:Number, noEvent:Boolean = false):voidSets the scroll value of the container.
Parameters
value:Number — the scroll value.
| |
noEvent:Boolean (default = false)true.
|
| speedScroll | () | method |
public function speedScroll(n:Number):voidScroll the container without scroll and without notify an event.
Parameters
n:Number |