Package | com.brightcove.api.components |
Class | public class List |
Inheritance | List ![]() ![]() ![]() ![]() |
Method | Defined By | ||
---|---|---|---|
List(element:Object)
Constructor. | List | ||
![]() | 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 | |
![]() | getAutomaticAdvance():Boolean
Returns whether continuous play is enabled for the list, which automatically advances upon completion of an item. | ListWidget | |
![]() | 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 | |
![]() | getData():Array
Returns the data currently rendered within the list. | ListWidget | |
![]() | getDataAtIndex(index:uint):Object
Returns the data stored at the specified index. | ListWidget | |
![]() | 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 | |
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 | ||
getItemLeading():Number
Returns the vertical pixel amount between items in the list. | List | ||
![]() | 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 | |
![]() | getNumItems():uint
Returns the number of items currently managed in the list. | ListWidget | |
![]() | 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 | |
getRowHeight():Number
Returns the pixel height of items in the list. | List | ||
getScrollerInset():Number
Returns the pixel amount that the scroller is inset from the side of the component. | List | ||
getScrollerWidth():Number
Returns the pixel width of the scroller. | List | ||
![]() | getSelectedData():Object
Returns the data stored at the currently selected index. | ListWidget | |
![]() | getSelectedIndex():int
Returns the index of the currently selected item in the list, or -1. | ListWidget | |
![]() | 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 | |
![]() | next():void
Selects the next item in the list. | ListWidget | |
![]() | previous():void
Selects the previous item in the list. | ListWidget | |
![]() | 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 | ||
![]() | setAlpha(alpha:Number):void
Sets the alpha value of the component. | Component | |
![]() | setAutomaticAdvance(automaticAdvance:Boolean):void
Enables/disables continuous play for the list, which automatically advances upon completion of an item. | ListWidget | |
![]() | setBlendMode(mode:String):void
Sets the blend mode of the component. | UIObject | |
![]() | setData(data:Array):void
Sets the data to be rendered within the list. | ListWidget | |
![]() | 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 | |
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 | ||
![]() | 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 | ||
![]() | setSelectedIndex(index:int):void
Sets the currently selected item in the list by passing its index. | ListWidget | |
![]() | 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 | |
![]() | showPlaylist(id:Number):Boolean
Sets the data to be rendered within the list by a playlist ID, which results in the videos displayed. | ListWidget |
List | () | Constructor |
public function List(element:Object)
Constructor.
Parameterselement:Object — layout element to wrap and delegate all calls to.
|
getItemInsetH | () | method |
public function getItemInsetH():Number
Returns the pixel amount items are inset horizontally from the side of the component.
ReturnsNumber — 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.
ReturnsNumber — 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.
ReturnsNumber — The vertical pixel amount between items in the list.
|
getRowHeight | () | method |
public function getRowHeight():Number
Returns the pixel height of items in the list.
ReturnsNumber — 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.
ReturnsNumber — 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.
ReturnsNumber — 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.
|