Packagecom.brightcove.api.components
Classpublic class TextRegion
InheritanceTextRegion Inheritance Container Inheritance UIObject Inheritance Component Inheritance flash.events.EventDispatcher

The TextRegion 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
  
TextRegion(element:Object)
Constructor.
TextRegion
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = true):void
[override] Adds a listener for an event.
UIObject
 Inherited
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
 Inherited
Returns the background color for the box.
Container
 Inherited
Returns the background image for the box.
Container
 Inherited
getBlendMode():String
Returns the blend mode of the component.
UIObject
 Inherited
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
 Inherited
getGutter():Number
Returns the number of pixels for the buffer between elements in the container.
Container
 Inherited
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
 Inherited
Returns the number of children currently in the box.
Container
 Inherited
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
 Inherited
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
 Inherited
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
 Inherited
removeChildAt(index:uint):Boolean
Removes a child element from the box children array at the specified index.
Container
 Inherited
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
 Inherited
setBackgroundColor(color:int):void
Sets the background color for the box.
Container
 Inherited
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
 Inherited
setGutter(gutter:Number):void
Sets the number of pixels for the buffer between elements in the container.
Container
 Inherited
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
 Inherited
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
 Inherited
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
TextRegion()Constructor
public function TextRegion(element:Object)

Constructor.

Parameters
element:Object — layout element to wrap and delegate all calls to.