Package | com.brightcove.api.components |
Class | public class LayoutBox |
Inheritance | LayoutBox ![]() ![]() |
Subclasses | ViewStack |
Method | Defined By | ||
---|---|---|---|
LayoutBox(element:Object)
Constructor. | LayoutBox | ||
appendChild(child:String):Boolean
Adds a new child element to the end of the box children array. | LayoutBox | ||
![]() | getAlpha():Number
Returns the alpha value of the component. | Component | |
getBackgroundColor():int
Returns the background color for the box. | LayoutBox | ||
getBackgroundImage():String
Returns the background image for the box. | LayoutBox | ||
getChildAt(index:uint):Object
Returns the child element from the box children array at the specified index. | LayoutBox | ||
![]() |
Returns the interface for the layout container of the element. | Component | |
![]() | getDefinition():String
Returns the XML (BEML) definition of the component. | Component | |
getGutter():Number
Returns the number of pixels for the buffer between elements in the container. | LayoutBox | ||
getHAlign():String
Returns the horizontal alignment (depending of the concrete class) for the box, which determines how child elements are positioned. | LayoutBox | ||
![]() | getHeight():Number
Returns the pixel height of the component. | Component | |
![]() | getID():String
Returns the ID of the component, as defined in the XML. | Component | |
![]() | getIncludeInLayout():Boolean
Returns whether the component is included in layout calculations and rendering in parent layout box. | Component | |
![]() | getIndex():int
Returns the index of this element in its parent's elements array. | Component | |
![]() | getNextSibling():Object
Returns the interface for the layout element that is the next sibling to this element in the parent containers's element array. | Component | |
![]() | getNodeName():String
Returns the node name of the element. | Component | |
getNumChildren():uint
Returns the number of children currently in the box. | LayoutBox | ||
getPadding():Number
Returns the number of pixels for the border of the container. | LayoutBox | ||
![]() | getPreviousSibling():Object
Returns the interface for the layout element that is the previous sibling to this element in the parent containers's element array. | Component | |
getVAlign():String
Returns the vertical alignment for the box, which determines how child elements are positioned. | LayoutBox | ||
![]() | getVisible():Boolean
Returns whether the component is visible. | Component | |
![]() | getWidth():Number
Returns the pixel width of the component. | Component | |
![]() | getX(global:Boolean = false):Number
Returns the position of the component on the x axis. | Component | |
![]() | getY(global:Boolean = false):Number
Returns the position of the component on the y axis. | Component | |
insertChildAt(child:String, index:uint):Boolean
Adds a new child element at the specified position in the box children array. | LayoutBox | ||
![]() | move(x:Number, y:Number, global:Boolean = false):void
Sets the x,y coordinates of the component. | Component | |
removeChildAt(index:uint):Boolean
Removes a child element from the box children array at the specified index. | LayoutBox | ||
removeChildByID(id:String):Boolean
Removes a child element with the specified ID from the box children array. | LayoutBox | ||
![]() | setAlpha(alpha:Number):void
Sets the alpha value of the component. | Component | |
setBackgroundColor(color:int):void
Sets the background color for the box. | LayoutBox | ||
setBackgroundImage(image:String):void
Sets the background image for the box. | LayoutBox | ||
setGutter(gutter:Number):void
Sets the number of pixels for the buffer between elements in the container. | LayoutBox | ||
setHAlign(align:String):void
Sets the horizontal alignment for the box, which determines how child elements are positioned. | LayoutBox | ||
![]() | setIncludeInLayout(includeInLayout:Boolean):void
Sets whether the component is included in layout calculations and rendering in parent layout box. | Component | |
setPadding(padding:Number):void
Sets the number of pixels for the border of the container. | LayoutBox | ||
![]() | setSize(width:Number, height:Number):void
Sets the pixel dimensions for the wrapped component. | Component | |
setVAlign(align:String):void
Sets the vertical alignment for the box, which determines how child elements are positioned. | LayoutBox | ||
![]() | setVisible(visible:Boolean):void
Sets whether the component is visible. | Component |
LayoutBox | () | Constructor |
public function LayoutBox(element:Object)
Constructor.
Parameterselement:Object — layout element to wrap and delegate all calls to.
|
appendChild | () | method |
public function appendChild(child:String):Boolean
Adds a new child element to the end of the box children array.
Parameters
child:String — XML definition to be used by the new element.
|
Boolean — True if the element was successfully added.
|
getBackgroundColor | () | method |
public function getBackgroundColor():int
Returns the background color for the box.
Returnsint — The background color for the box, or -1 if there is none.
|
getBackgroundImage | () | method |
public function getBackgroundImage():String
Returns the background image for the box.
ReturnsString — The background image of the box.
|
getChildAt | () | method |
public function getChildAt(index:uint):Object
Returns the child element from the box children array at the specified index.
Parameters
index:uint — index position of the child element.
|
Object — The interface for the child element at the specified index.
|
getGutter | () | method |
public function getGutter():Number
Returns the number of pixels for the buffer between elements in the container.
ReturnsNumber — The number of pixels for the buffer between elements in the container.
|
getHAlign | () | method |
public function getHAlign():String
Returns the horizontal alignment (depending of the concrete class) for the box, which determines how child elements are positioned.
ReturnsString — The horizontal alignment for the box, which determines how child elements are positioned.
|
getNumChildren | () | method |
public function getNumChildren():uint
Returns the number of children currently in the box.
Returnsuint — The number of children in the box.
|
getPadding | () | method |
public function getPadding():Number
Returns the number of pixels for the border of the container.
ReturnsNumber — The number of pixels for the border of the container.
|
getVAlign | () | method |
public function getVAlign():String
Returns the vertical alignment for the box, which determines how child elements are positioned.
ReturnsString — The vertical alignment for the box, which determines how child elements are positioned.
|
insertChildAt | () | method |
public function insertChildAt(child:String, index:uint):Boolean
Adds a new child element at the specified position in the box children array.
Parameters
child:String — XML definition to be used by the new element.
| |
index:uint — The index position in which to insert the new element.
|
Boolean — True if the element was successfully added.
|
removeChildAt | () | method |
public function removeChildAt(index:uint):Boolean
Removes a child element from the box children array at the specified index.
Parameters
index:uint — index position of the child element.
|
Boolean — True if the child was successfully removed.
|
removeChildByID | () | method |
public function removeChildByID(id:String):Boolean
Removes a child element with the specified ID from the box children array.
Parameters
id:String — ID of the child element.
|
Boolean — True if the child was successfully removed.
|
setBackgroundColor | () | method |
public function setBackgroundColor(color:int):void
Sets the background color for the box.
Parameters
color:int — background color for the box, or -1 if there should be none.
|
setBackgroundImage | () | method |
public function setBackgroundImage(image:String):void
Sets the background image for the box.
Parameters
image:String — background image to load into the box.
|
setGutter | () | method |
public function setGutter(gutter:Number):void
Sets the number of pixels for the buffer between elements in the container.
Parameters
gutter:Number — number of pixels for the buffer between elements in the container.
|
setHAlign | () | method |
public function setHAlign(align:String):void
Sets the horizontal alignment for the box, which determines how child elements are positioned.
Parameters
align:String — horizontal alignment for the box, which determines how child elements are positioned.
|
setPadding | () | method |
public function setPadding(padding:Number):void
Sets the number of pixels for the border of the container.
Parameters
padding:Number — number of pixels for the border of the container.
|
setVAlign | () | method |
public function setVAlign(align:String):void
Sets the vertical alignment for the box, which determines how child elements are positioned.
Parameters
align:String — vertical alignment for the box, which determines how child elements are positioned.
|