Packagecom.brightcove.api.components
Classpublic class UIObject
InheritanceUIObject Inheritance Component Inheritance flash.events.EventDispatcher
Subclasses AdvertisingContext, Banner, Button, ComboBox, Container, ExpandingBanner, GraphicBlock, Image, Label, Link, ListWidget, Playhead, SWFLoader, TabBar, TitleLabel, VolumeControl

Abstract base class for all UI components 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
  
UIObject(element:Object)
Constructor.
UIObject
  
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = true):void
[override] Adds a listener for an event.
UIObject
 Inherited
getAlpha():Number
Returns the alpha value of the component.
Component
  
getBlendMode():String
Returns the blend mode of the component.
UIObject
 Inherited
Returns the interface for the layout container of the element.
Component
  
getCSS():String
Returns the CSS used for this component instance.
UIObject
 Inherited
getDefinition():String
Returns the XML (BEML) definition of the component.
Component
  
getEnabled():Boolean
Returns whether component is enabled.
UIObject
 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 interface for the layout element that is the previous sibling to this element in the parent containers's element array.
Component
  
getRotation():Number
Returns the rotation of the component.
UIObject
 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
move(x:Number, y:Number, global:Boolean = false):void
Sets the x,y coordinates of the component.
Component
  
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
  
setBlendMode(mode:String):void
Sets the blend mode of the component.
UIObject
  
setEnabled(enable:Boolean):void
Enables/disables component for events.
UIObject
 Inherited
setIncludeInLayout(includeInLayout:Boolean):void
Sets whether the component is included in layout calculations and rendering in parent layout box.
Component
  
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
  
setStyles(styles:String):void
Overrides specific styles for a component by accepting a semicolon-delimited list of style names and colors.
UIObject
 Inherited
setVisible(visible:Boolean):void
Sets whether the component is visible.
Component
Protected Methods
 MethodDefined By
  
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
UIObject()Constructor
public function UIObject(element:Object)

Constructor.

Parameters
element:Object — layout element to wrap and delegate all calls to.
Method Detail
addEventListener()method
override public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = true):void

Adds a listener for an event.

Parameters

type:String — from Sprite. See AS3 docs.
 
listener:Function — from Sprite. See AS3 docs.
 
useCapture:Boolean (default = false) — from Sprite. See AS3 docs.
 
priority:int (default = 0) — from Sprite. See AS3 docs.
 
useWeakReference:Boolean (default = true) — from Sprite. See AS3 docs.

getBlendMode()method 
public function getBlendMode():String

Returns the blend mode of the component.

Returns
String — The blend mode of the component.
getCSS()method 
public function getCSS():String

Returns the CSS used for this component instance.

Returns
String — The CSS (as a String) used for this component instance.
getEnabled()method 
public function getEnabled():Boolean

Returns whether component is enabled.

Returns
Boolean — Boolean value showing whether component is enabled.
getRotation()method 
public function getRotation():Number

Returns the rotation of the component.

Returns
Number — The rotation of the component in degrees.
redispatchEvent()method 
protected function redispatchEvent(event:Event):void

Sends the specified event, usually sent from a handler in order to bubble up non-bubbling events.

Parameters

event:Event — event.

removeEventListener()method 
override public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Removes a listener for an event.

Parameters

type:String — from Sprite. See AS3 docs.
 
listener:Function — from Sprite. See AS3 docs.
 
useCapture:Boolean (default = false) — from Sprite. See AS3 docs.

setBlendMode()method 
public function setBlendMode(mode:String):void

Sets the blend mode of the component.

Parameters

mode:String — blend mode of the component.

setEnabled()method 
public function setEnabled(enable:Boolean):void

Enables/disables component for events.

Parameters

enable:Boolean — value to enable (true) or disable (false).

setRotation()method 
public function setRotation(rotation:Number):void

Sets the rotation of the component.

Parameters

rotation:Number — rotation of the component in degrees.

setStyles()method 
public function setStyles(styles:String):void

Overrides specific styles for a component by accepting a semicolon-delimited list of style names and colors.

Parameters

styles:String — semicolon-delimited list of style properties in the form "style-name:#nnnnnn;style-name:#nnnnnn".