| Package | lunas.containers |
| Class | public class ListContainer |
| Inheritance | ListContainer  Container CoreComponent Background CoreSprite flash.display.Sprite |
| Subclasses | MatrixContainer, ScrollContainer |
| 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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 | ||
| 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 | |
| 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 | |
| Property | Defined By | ||
|---|---|---|---|
| _area : Sprite
This area sprite defines a hide background display back of the display. | ListContainer | ||
| _areaPen : RectanglePen
The pen of the area IPen object. | ListContainer | ||
| _background : Sprite
This Background reference defines a background display. | ListContainer | ||
| _backgroundPen : RectanglePen
The pen of the background Pen object. | ListContainer | ||
| _bound : Rectangle
The Rectangle internal bound object of the container. | ListContainer | ||
| _container : Sprite
This CoreSprite reference defines a container display. | ListContainer | ||
| _mask : Sprite
This CoreShape reference defines a mask display. | ListContainer | ||
| _maskPen : RectanglePen
The pen of the mask IPen object. | ListContainer | ||
| _scope : DisplayObjectContainer
The scope of the active display of this container component. | CoreComponent | |
| Method | Defined By | ||
|---|---|---|---|
ListContainer(direction:String = vertical)
Creates a new ListContainer instance. | ListContainer | ||
| addChild(child:DisplayObject):DisplayObject [override]
Adds a child DisplayObject instance to this DisplayObjectContainer instance. | Container | |
| addChildAt(child:DisplayObject, index:int):DisplayObject [override]
Adds a child DisplayObject instance to this DisplayObjectContainer instance. | Container | |
| 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. | ListContainer | ||
| 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 | ||
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 | |
| notifyResized():void
Notify an event when you resize the component. | Background | |
| 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. | Container | |
| removeChildAt(index:int):DisplayObject [override]
Removes a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer. | Container | |
| 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. | Container | |
| removeRange(from:int, to:int):Array
Removes a range of childs in the container. | Container | |
| 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 | |
| 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 | |
| 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 | ||
|---|---|---|---|
| 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 | ||
| _area | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesprotected var _area:SpriteThis area sprite defines a hide background display back of the display.
| _areaPen | property |
protected var _areaPen:RectanglePenThe pen of the area IPen object.
| _background | property |
protected var _background:SpriteThis Background reference defines a background display.
| _backgroundPen | property |
protected var _backgroundPen:RectanglePenThe pen of the background Pen object.
| _bound | property |
protected var _bound:RectangleThe Rectangle internal bound object of the container.
| _container | property |
protected var _container:SpriteThis CoreSprite reference defines a container display.
| _mask | property |
protected var _mask:SpriteThis CoreShape reference defines a mask display.
| _maskPen | property |
protected var _maskPen:RectanglePenThe pen of the mask IPen object.
| area | property |
area:Sprite [read-only] Returns the area reference of this component.
public function get area():Sprite| areaPen | property |
areaPen:IPen [read-only] Indicates the area Pen reference of this component.
public function get areaPen():IPen| background | property |
background:Sprite [read-only] Indicates the background reference of this component.
public function get background():Sprite| backgroundPen | property |
backgroundPen:IPen [read-only] Indicates the background Pen reference of this component.
public function get backgroundPen():IPen| childCount | property |
childCount:intDeterminates the number of childs in this container. If this value is -1 no mask effect is apply over the list container, all the childs are visible.
public function get childCount():int public function set childCount(value:int):void| maskIsActive | property |
maskIsActive:BooleanIndicates if the mask is active or not over this container.
public function get maskIsActive():Boolean public function set maskIsActive(value:Boolean):void| maskView | property |
maskView:Sprite [read-only] Determinates the mask reference of this container.
public function get maskView():Sprite| propHeight | property |
public var propHeight:String = heightThe height property name use in the container to layout all items.
| propWidth | property |
public var propWidth:String = widthThe width property name use in the container to layout all items.
| propX | property |
public var propX:String = xThe x property name use in the container to layout all items.
| propY | property |
public var propY:String = yThe y property name use in the container to layout all items.
| rectangle | property |
rectangle:Rectangle [read-only] Returns the internal Rectangle object of this display.
public function get rectangle():Rectangle| space | property |
space:NumberIndicates the space value (in pixel) between 2 childs in the list.
public function get space():Number public function set space(value:Number):void| spaceH | property |
spaceH:NumberIndicates the space value (in pixel) between 2 childs in the list when the direction is horizontal.
public function get spaceH():Number public function set spaceH(value:Number):void| spaceV | property |
spaceV:NumberIndicates the space value (in pixel) between 2 childs in the list when the direction is vertical.
public function get spaceV():Number public function set spaceV(value:Number):void| useScrollRect | property |
useScrollRect:BooleanIndicates if this container use a scrollRect reference to mask the content.
public function get useScrollRect():Boolean public function set useScrollRect(value:Boolean):void| ListContainer | () | Constructor |
public function ListContainer(direction:String = vertical)Creates a new ListContainer instance.
Parametersdirection:String (default = vertical)graphics.Direction).
|
| changeChildsPosition | () | method |
public function changeChildsPosition():voidRefreshs and changes the child position of all childs in the container.
| draw | () | method |
override public function draw(... arguments):voidDraws the view of the component.
Parameters
... arguments |
| getChildPositionAt | () | method |
public function getChildPositionAt(n:Number):PointReturns the child position with the specified index and the current direction of this display.
Parameters
n:Number |
Point — the child position with the specified index and the current direction of this display.
|
| getCoordinateProperty | () | method |
public function getCoordinateProperty():StringReturns the string representation of the coordinate attribute used in this display with the current direction value.
ReturnsString — the string representation of the coordinate attribute used in this display with the current direction value.
|
| getSizeProperty | () | method |
public function getSizeProperty():StringReturns the string representation of the size attribute with the current direction.
ReturnsString — the string representation of the size attribute with the current direction.
|
| lockMask | () | method |
public function lockMask():voidUse the mask protection.
| refreshBackground | () | method |
protected function refreshBackground():voidRefresh the mask view of the display.
| refreshMask | () | method |
protected function refreshMask():voidRefresh the mask view of the display.
| unlockMask | () | method |
public function unlockMask():voidUnlock the mask protect.
| updateLayout | () | method |
override protected function updateLayout(layout:Layout = null):voidInvoked when the container layout change.
Parameters
layout:Layout (default = null) |