Package | com.brightcove.api.components |
Class | public class ExpandingBanner |
Inheritance | ExpandingBanner ![]() ![]() ![]() |
Method | Defined By | ||
---|---|---|---|
ExpandingBanner(element:Object)
Constructor. | ExpandingBanner | ||
![]() | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = true):void [override]
Adds a listener for an event. | UIObject | |
contract():void
Collapse the Banner. | ExpandingBanner | ||
expand():void
Expands the Banner. | ExpandingBanner | ||
![]() | 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 | |
getExpanded():Boolean
Returns whether or not Banner is expanded. | ExpandingBanner | ||
![]() | 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 | |
synchBannerWithExternal(adObj:Object):void
Allows for the player to render the synched banner units without playing a video ad. | ExpandingBanner |
ExpandingBanner | () | Constructor |
public function ExpandingBanner(element:Object)
Constructor.
Parameterselement:Object — layout element to wrap and delegate all calls to.
|
contract | () | method |
public function contract():void
Collapse the Banner.
expand | () | method |
public function expand():void
Expands the Banner.
getExpanded | () | method |
public function getExpanded():Boolean
Returns whether or not Banner is expanded.
ReturnsBoolean — Boolean specifying expanded state.
|
synchBannerWithExternal | () | method |
public function synchBannerWithExternal(adObj:Object):void
Allows for the player to render the synched banner units without playing a video ad. The banners are rendered above the disabled player and navigation so they may be clicked on for click-thru functionality. This enables a DHTML video ad outside of the player to synch with banner assets within the player. The ad format must be one recognized by the player for it to play, otherwise it will be ignored.
Parameters
adObj:Object — An object containing properties that match the rich media ad template for a synched banner accepted by
the player. [more descriptive explanation of these ad objects can be found in the ad docs]
|