Package | com.brightcove.api.components |
Class | public class UIObject |
Inheritance | UIObject ![]() ![]() |
Subclasses | AdvertisingContext, Banner, Button, ComboBox, Container, ExpandingBanner, GraphicBlock, Image, Label, Link, ListWidget, Playhead, SWFLoader, TabBar, TitleLabel, VolumeControl |
Method | Defined 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 | ||
![]() | getAlpha():Number
Returns the alpha value of the component. | Component | |
getBlendMode():String
Returns the blend mode of the component. | UIObject | ||
![]() |
Returns the interface for the layout container of the element. | Component | |
getCSS():String
Returns the CSS used for this component instance. | UIObject | ||
![]() | getDefinition():String
Returns the XML (BEML) definition of the component. | Component | |
getEnabled():Boolean
Returns whether component is enabled. | UIObject | ||
![]() | 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 | |
![]() | 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 | |
getRotation():Number
Returns the rotation of the component. | UIObject | ||
![]() | 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 | |
![]() | 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 | ||
![]() | 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 | ||
![]() | 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 | ||
![]() | 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 | ||
![]() | setVisible(visible:Boolean):void
Sets whether the component is visible. | Component |
Method | Defined By | ||
---|---|---|---|
redispatchEvent(event:Event):void
Sends the specified event, usually sent from a handler in order to bubble up non-bubbling events. | UIObject |
UIObject | () | Constructor |
public function UIObject(element:Object)
Constructor.
Parameterselement:Object — layout element to wrap and delegate all calls to.
|
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.
ReturnsString — The blend mode of the component.
|
getCSS | () | method |
public function getCSS():String
Returns the CSS used for this component instance.
ReturnsString — The CSS (as a String) used for this component instance.
|
getEnabled | () | method |
public function getEnabled():Boolean
Returns whether component is enabled.
ReturnsBoolean — Boolean value showing whether component is enabled.
|
getRotation | () | method |
public function getRotation():Number
Returns the rotation of the component.
ReturnsNumber — 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".
|