qnx.fuse.ui.core.IContainer

IContainer

Properties | Methods


Packageqnx.fuse.ui.core
Interfacepublic interface IContainer extends IInvalidating
Implementors Container

The interface implemented by the Container class.

Class information:
BlackBerry 10 Version:   10.0.0

See also

Container



Public Properties

 PropertyDefined By
  contentHeight : Number
[read-only] Gets the height of the content.
IContainer
  contentWidth : Number
[read-only] Gets the width of the content.
IContainer
  layout : ILayout
Gets or sets the layout for the group.
IContainer
  numChildren : int
[read-only] Returns the number of children (DisplayObject) in the container.
IContainer
  scrollDirection : String
Gets or sets the scroll direction of the container.
IContainer

Public Methods

 MethodDefined By
  
addChild(child:DisplayObject):DisplayObject
Adds a child to the Container.
IContainer
  
addChildAt(child:DisplayObject, index:int):DisplayObject
Adds a child to the container at a given index.
IContainer
  
childChanged(resizedChild:DisplayObject = null):Boolean
Notifies the layout that the given child has changed either its size flags, the result of its measure method, or the value of its layout data.
IContainer
  
getChildAt(index:int):DisplayObject
Gets the child at the given index.
IContainer
 Inherited
Calling this method results in a call to the components validateDisplayList() method before the display list is rendered.
IInvalidating
 Inherited
Calling this method results in a call to the components validateProperties() method before the display list is rendered.
IInvalidating
  
removeChild(child:DisplayObject):DisplayObject
Removes a child (DisplayObject) from the container.
IContainer
  
removeChildAt(index:int):DisplayObject
Removes a child (DisplayObject) from the container, given the index of the child.
IContainer
  
setChildIndex(child:DisplayObject, index:int):void
Sets the index of a given child (DisplayObject).
IContainer
  
swapChildren(child1:DisplayObject, child2:DisplayObject):void
Swaps the index values of two children.
IContainer
  
swapChildrenAt(index1:int, index2:int):void
Swaps two children given the index of both children.
IContainer
 Inherited
Validates the display list of the component by calling the updateDisplayList().
IInvalidating
 Inherited
Validates the component immediately by calling validateProperties(), validateSizes(), and validateDisplayList() if necessary.
IInvalidating
 Inherited
Validates the properties of the component by calling the commitProperties() method.
IInvalidating

Property Detail

contentHeight


contentHeight:Number  [read-only]

Gets the height of the content.


Implementation

public function get contentHeight():Number

contentWidth


contentWidth:Number  [read-only]

Gets the width of the content.


Implementation

public function get contentWidth():Number

layout


layout:ILayout

Gets or sets the layout for the group.


Implementation

public function get layout():ILayout
public function set layout(value:ILayout):void

numChildren


numChildren:int  [read-only]

Returns the number of children (DisplayObject) in the container.


Implementation

public function get numChildren():int

scrollDirection


scrollDirection:String

Gets or sets the scroll direction of the container.


Implementation

public function get scrollDirection():String
public function set scrollDirection(value:String):void

See also

ScrollDirection

Method Detail

addChild()


public function addChild(child:DisplayObject):DisplayObject

Adds a child to the Container.

Parameters

child:DisplayObject — The child (DisplayObject) to add to the container.

Returns

DisplayObject — DisplayObject

addChildAt()


public function addChildAt(child:DisplayObject, index:int):DisplayObject

Adds a child to the container at a given index.

Parameters

child:DisplayObject — The child (DisplayObject) to add to the container.
index:int — The index at which to add the child.

Returns

DisplayObject — DisplayObject

childChanged()


public function childChanged(resizedChild:DisplayObject = null):Boolean

Notifies the layout that the given child has changed either its size flags, the result of its measure method, or the value of its layout data. Should also be called if a child is added/removed from the IContainer or if a child's LayoutData is changed. Returns true if this change may have affected the measurement or size flags of the layout. Returns false if there is no possibility of the change affecting the the measurement or size flags of the layout.

Parameters

resizedChild:DisplayObject (default = null) — The child (DisplayObject) to test.

Returns

Boolean

getChildAt()


public function getChildAt(index:int):DisplayObject

Gets the child at the given index.

Parameters

index:int — The child (DisplayObject) to return.

Returns

DisplayObject — DisplayObject

removeChild()


public function removeChild(child:DisplayObject):DisplayObject

Removes a child (DisplayObject) from the container.

Parameters

child:DisplayObject — The child to remove from the container.

Returns

DisplayObject — DisplayObject

removeChildAt()


public function removeChildAt(index:int):DisplayObject

Removes a child (DisplayObject) from the container, given the index of the child.

Parameters

index:int — The child to remove from the container.

Returns

DisplayObject — DisplayObject

setChildIndex()


public function setChildIndex(child:DisplayObject, index:int):void

Sets the index of a given child (DisplayObject).

Parameters

child:DisplayObject — The child object for which to set the index.
index:int — The new index value of the child.

swapChildren()


public function swapChildren(child1:DisplayObject, child2:DisplayObject):void

Swaps the index values of two children.

Parameters

child1:DisplayObject — The first child.
child2:DisplayObject — The second child.

swapChildrenAt()


public function swapChildrenAt(index1:int, index2:int):void

Swaps two children given the index of both children.

Parameters

index1:int — The index of the first child.
index2:int — The index of the second child.





comments powered by Disqus