Packagecom.brightcove.api.components
Classpublic class List
InheritanceList Inheritance ListWidget Inheritance UIObject Inheritance Component Inheritance flash.events.EventDispatcher

The List 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
  
List(element:Object)
Constructor.
List
 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
getAlpha():Number
Returns the alpha value of the component.
Component
 Inherited
Returns whether continuous play is enabled for the list, which automatically advances upon completion of an item.
ListWidget
 Inherited
getBlendMode():String
Returns the blend mode of the component.
UIObject
 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
getData():Array
Returns the data currently rendered within the list.
ListWidget
 Inherited
getDataAtIndex(index:uint):Object
Returns the data stored at the specified index.
ListWidget
 Inherited
getDefinition():String
Returns the XML (BEML) definition of the component.
Component
 Inherited
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
  
getItemInsetH():Number
Returns the pixel amount items are inset horizontally from the side of the component.
List
  
getItemInsetV():Number
Returns the pixel amount items are inset vertically from the side of the component.
List
  
Returns the vertical pixel amount between items in the list.
List
 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 items currently managed in the list.
ListWidget
 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
  
getRowHeight():Number
Returns the pixel height of items in the list.
List
  
Returns the pixel amount that the scroller is inset from the side of the component.
List
  
Returns the pixel width of the scroller.
List
 Inherited
Returns the data stored at the currently selected index.
ListWidget
 Inherited
Returns the index of the currently selected item in the list, or -1.
ListWidget
 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
 Inherited
next():void
Selects the next item in the list.
ListWidget
 Inherited
previous():void
Selects the previous item in the list.
ListWidget
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
[override] Removes a listener for an event.
UIObject
  
scrollTo(index:uint):void
Scrolls the list so the item with the specified index is visible.
List
 Inherited
setAlpha(alpha:Number):void
Sets the alpha value of the component.
Component
 Inherited
setAutomaticAdvance(automaticAdvance:Boolean):void
Enables/disables continuous play for the list, which automatically advances upon completion of an item.
ListWidget
 Inherited
setBlendMode(mode:String):void
Sets the blend mode of the component.
UIObject
 Inherited
setData(data:Array):void
Sets the data to be rendered within the list.
ListWidget
 Inherited
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
  
setItemInsetH(itemInsetH:Number):void
Sets the pixel amount items are inset horizontally from the side of the component.
List
  
setItemInsetV(itemInsetV:Number):void
Sets the pixel amount items are inset vertically from the side of the component.
List
  
setItemLeading(itemLeading:Number):void
Sets the vertical pixel amount between items in the list.
List
 Inherited
setRotation(rotation:Number):void
Sets the rotation of the component.
UIObject
  
setRowHeight(rowHeight:Number):void
Sets the pixel height of items in the list.
List
  
setScrollerInset(scrollerInset:Number):void
Sets the pixel amount that the scroller is inset from the side of the component.
List
  
setScrollerWidth(scrollerWidth:Number):void
Sets the pixel width of the scroller.
List
 Inherited
setSelectedIndex(index:int):void
Sets the currently selected item in the list by passing its index.
ListWidget
 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
setVisible(visible:Boolean):void
Sets whether the component is visible.
Component
 Inherited
showPlaylist(id:Number):Boolean
Sets the data to be rendered within the list by a playlist ID, which results in the videos displayed.
ListWidget
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
List()Constructor
public function List(element:Object)

Constructor.

Parameters
element:Object — layout element to wrap and delegate all calls to.
Method Detail
getItemInsetH()method
public function getItemInsetH():Number

Returns the pixel amount items are inset horizontally from the side of the component.

Returns
Number — The pixel amount items are inset horizontally from the side of the component.
getItemInsetV()method 
public function getItemInsetV():Number

Returns the pixel amount items are inset vertically from the side of the component.

Returns
Number — The pixel amount items are inset vertically from the side of the component.
getItemLeading()method 
public function getItemLeading():Number

Returns the vertical pixel amount between items in the list.

Returns
Number — The vertical pixel amount between items in the list.
getRowHeight()method 
public function getRowHeight():Number

Returns the pixel height of items in the list.

Returns
Number — The pixel height of items in the list.
getScrollerInset()method 
public function getScrollerInset():Number

Returns the pixel amount that the scroller is inset from the side of the component.

Returns
Number — The pixel amount that the scroller is inset from the side of the component.
getScrollerWidth()method 
public function getScrollerWidth():Number

Returns the pixel width of the scroller.

Returns
Number — The pixel amount of the scroller.
scrollTo()method 
public function scrollTo(index:uint):void

Scrolls the list so the item with the specified index is visible.

Parameters

index:uint — index position of the item to be scrolled to.

setItemInsetH()method 
public function setItemInsetH(itemInsetH:Number):void

Sets the pixel amount items are inset horizontally from the side of the component.

Parameters

itemInsetH:Number — pixel amount items are inset horizontally from the side of the component.

setItemInsetV()method 
public function setItemInsetV(itemInsetV:Number):void

Sets the pixel amount items are inset vertically from the side of the component.

Parameters

itemInsetV:Number — pixel amount items are inset vertically from the side of the component.

setItemLeading()method 
public function setItemLeading(itemLeading:Number):void

Sets the vertical pixel amount between items in the list.

Parameters

itemLeading:Number — vertical pixel amount between items in the list.

setRowHeight()method 
public function setRowHeight(rowHeight:Number):void

Sets the pixel height of items in the list.

Parameters

rowHeight:Number — pixel height of items in the list.

setScrollerInset()method 
public function setScrollerInset(scrollerInset:Number):void

Sets the pixel amount that the scroller is inset from the side of the component.

Parameters

scrollerInset:Number — pixel amount that the scroller is inset from the side of the component.

setScrollerWidth()method 
public function setScrollerWidth(scrollerWidth:Number):void

Sets the pixel width of the scroller.

Parameters

scrollerWidth:Number — pixel amount of the scroller.