Packagecom.brightcove.api.components
Classpublic class Container
InheritanceContainer Inheritance UIObject Inheritance Component Inheritance flash.events.EventDispatcher
Subclasses MediaControls, TextRegion

The Container UI component in the player.



Public Properties
 PropertyDefined By
 Inheritedcomponent : Object
[read-only] Returns a reference to the wrapped API element in the player, which can be used to get access to new methods that might not be defined within this version of the SWC.
Component
Public Methods
 MethodDefined By
  
Container(element:Object)
Constructor.
Container
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = true):void
[override] Adds a listener for an event.
UIObject
  
appendChild(child:String):Boolean
Adds a new child element to the end of the box children array.
Container
 Inherited
getAlpha():Number
Returns the alpha value of the component.
Component
  
Returns the background color for the box.
Container
  
Returns the background image for the box.
Container
 Inherited
getBlendMode():String
Returns the blend mode of the component.
UIObject
  
getChildAt(index:uint):Component
Returns the child element from the box children array at the specified index.
Container
 Inherited
Returns the interface for the layout container of the element.
Component
 Inherited
getCSS():String
Returns the CSS used for this component instance.
UIObject
 Inherited
getDefinition():String
Returns the XML (BEML) definition of the component.
Component
 Inherited
getEnabled():Boolean
Returns whether component is enabled.
UIObject
  
getGutter():Number
Returns the number of pixels for the buffer between elements in the container.
Container
  
getHAlign():String
Returns the horizontal alignment (depending of the concrete class) for the box, which determines how child elements are positioned.
Container
 Inherited
getHeight():Number
Returns the pixel height of the component.
Component
 Inherited
getID():String
Returns the ID of the component, as defined in the XML.
Component
 Inherited
Returns whether the component is included in layout calculations and rendering in parent layout box.
Component
 Inherited
getIndex():int
Returns the index of this element in its parent's elements array.
Component
 Inherited
Returns the interface for the layout element that is the next sibling to this element in the parent containers's element array.
Component
 Inherited
getNodeName():String
Returns the node name of the element.
Component
  
Returns the number of children currently in the box.
Container
  
getPadding():Number
Returns the number of pixels for the border of the container.
Container
 Inherited
Returns the interface for the layout element that is the previous sibling to this element in the parent containers's element array.
Component
 Inherited
getRotation():Number
Returns the rotation of the component.
UIObject
  
getVAlign():String
Returns the vertical alignment for the box, which determines how child elements are positioned.
Container
 Inherited
getVisible():Boolean
Returns whether the component is visible.
Component
 Inherited
getWidth():Number
Returns the pixel width of the component.
Component
 Inherited
getX(global:Boolean = false):Number
Returns the position of the component on the x axis.
Component
 Inherited
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.
Container
 Inherited
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.
Container
  
removeChildByID(id:String):Boolean
Removes a child element with the specified ID from the box children array.
Container
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
[override] Removes a listener for an event.
UIObject
 Inherited
setAlpha(alpha:Number):void
Sets the alpha value of the component.
Component
  
setBackgroundColor(color:int):void
Sets the background color for the box.
Container
  
setBackgroundImage(image:String):void
Sets the background image for the box.
Container
 Inherited
setBlendMode(mode:String):void
Sets the blend mode of the component.
UIObject
 Inherited
setEnabled(enable:Boolean):void
Enables/disables component for events.
UIObject
  
setGutter(gutter:Number):void
Sets the number of pixels for the buffer between elements in the container.
Container
  
setHAlign(align:String):void
Sets the horizontal alignment for the box, which determines how child elements are positioned.
Container
 Inherited
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.
Container
 Inherited
setRotation(rotation:Number):void
Sets the rotation of the component.
UIObject
 Inherited
setSize(width:Number, height:Number):void
Sets the pixel dimensions for the wrapped component.
Component
 Inherited
setStyles(styles:String):void
Overrides specific styles for a component by accepting a semicolon-delimited list of style names and colors.
UIObject
  
setVAlign(align:String):void
Sets the vertical alignment for the box, which determines how child elements are positioned.
Container
 Inherited
setVisible(visible:Boolean):void
Sets whether the component is visible.
Component
Protected Methods
 MethodDefined By
 Inherited
redispatchEvent(event:Event):void
Sends the specified event, usually sent from a handler in order to bubble up non-bubbling events.
UIObject
Events
 Event Summary Defined By
 InheritedDispatched when a UI element in the player is clicked.Component
 InheritedDispatched when a UI element in the player is rolled off.Component
 InheritedDispatched when a UI element in the player is rolled over.Component
 InheritedDispatched when a property changes in a bindable component.Component
Constructor Detail
Container()Constructor
public function Container(element:Object)

Constructor.

Parameters
element:Object — layout element to wrap and delegate all calls to.
Method Detail
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.

Returns
Boolean — True if the element was successfully added.
getBackgroundColor()method 
public function getBackgroundColor():int

Returns the background color for the box.

Returns
int — 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.

Returns
String — The background image of the box.
getChildAt()method 
public function getChildAt(index:uint):Component

Returns the child element from the box children array at the specified index.

Parameters

index:uint — index position of the child element.

Returns
Component — 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.

Returns
Number — 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.

Returns
String — 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.

Returns
uint — The number of children in the box.
getPadding()method 
public function getPadding():Number

Returns the number of pixels for the border of the container.

Returns
Number — 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.

Returns
String — 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 — index position in which to insert the new element.

Returns
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.

Returns
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.

Returns
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.