Packagecom.brightcove.api.components
Classpublic class TileList
InheritanceTileList Inheritance ListWidget Inheritance UIObject Inheritance Component Inheritance flash.events.EventDispatcher

The TileList UI component in the player. Download the code examples for TileList from the article, Player API Examples.



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
  
TileList(element:Object)
Constructor.
TileList
 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
  
Returns how a page will animate in: (move || wipe || none).
TileList
 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
  
Returns the pixel amount that the nav buttons will be moved horizontally in a vertical list.
TileList
  
Returns the pixel amount that the nav buttons will be moved vertically in a horizontal list.
TileList
  
getButtonSize():Number
Returns the pixel size, width and height, of the navigation buttons.
TileList
  
Returns whether the list centers its content within its area.
TileList
  
Returns the number of columns that can be displayed based on the size settings.
TileList
  
Returns the pixel gutter between each column.
TileList
  
Returns the pixel width of each visual column in the list.
TileList
 Inherited
Returns the interface for the layout container of the element.
Component
  
Returns the pixel space that items are inset horizontally from the top and bottom of the list.
TileList
  
Returns the pixel space that items are inset vertically from the top and bottom of the list.
TileList
 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
 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
  
Returns the number of columns represented visually for the list.
TileList
 Inherited
Returns the number of items currently managed in the list.
ListWidget
  
Returns the number of pages of data in the list.
TileList
  
Returns the number of rows represented visually for the list.
TileList
  
Returns the index of the current page displayed.
TileList
 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
  
Returns the number of rows that can be displayed based on the size settings.
TileList
  
getRowGutter():Number
Returns the pixel gutter between each row.
TileList
  
getRowHeight():Number
Returns the pixel height of each visual row in the list.
TileList
  
Returns the direction that pages will be scrolled, horizontal or vertical.
TileList
 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
  
getUseBlur():Boolean
Returns whether the list should blur its items when animating to new pages.
TileList
 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
 Inherited
setAlpha(alpha:Number):void
Sets the alpha value of the component.
Component
  
setAnimationType(type:String):void
Sets how a page will animate in: (move || wipe || scale || none).
TileList
 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
  
setButtonOffsetX(offset:Number):void
Sets the pixel amount that the nav buttons will be moved horizontally in a vertical list.
TileList
  
setButtonOffsetY(offset:Number):void
Sets the pixel amount that the nav buttons will be moved vertically in a horizontal list.
TileList
  
setButtonSize(size:Number):void
Sets the pixel size, width and height, of the navigation buttons.
TileList
  
setCenterContent(center:Boolean):void
Sets whether the list should center its content within its area.
TileList
  
setColumnGutter(gutter:Number):void
Sets the pixel gutter between each column.
TileList
  
setColumnWidth(width:Number):void
Sets the pixel width of each visual column in the list.
TileList
  
setContentInsetH(inset:Number):void
Sets the pixel space that items are inset horizontally from the top and bottom of the list.
TileList
  
setContentInsetV(inset:Number):void
Sets the pixel space that items are inset vertically from the top and bottom of the list.
TileList
 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
  
setNumColumns(columns:int):void
Sets the number of columns represented visually for the list.
TileList
  
setNumRows(rows:int):void
Sets the number of rows represented visually for the list.
TileList
 Inherited
setRotation(rotation:Number):void
Sets the rotation of the component.
UIObject
  
setRowGutter(gutter:Number):void
Sets the pixel gutter between each row.
TileList
  
setRowHeight(height:Number):void
Sets the pixel height of each visual row in the list.
TileList
  
setScrollDirection(direction:String):void
Sets the direction that pages will be scrolled, horizontal or vertical.
TileList
 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
  
setUseBlur(useBlur:Boolean):void
Sets whether the list should blur its items when animating to new pages.
TileList
 Inherited
setVisible(visible:Boolean):void
Sets whether the component is visible.
Component
  
showNextPage():Boolean
Renders and tweens on the next page of data.
TileList
  
showPage(index:uint):Boolean
Renders and tweens on the specified page of data.
TileList
 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
  
Renders and tweens on the previous page of data.
TileList
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
TileList()Constructor
public function TileList(element:Object)

Constructor.

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

Returns how a page will animate in: (move || wipe || none).

Returns
String — How a page will animate in: (move || wipe || none).
getButtonOffsetX()method 
public function getButtonOffsetX():Number

Returns the pixel amount that the nav buttons will be moved horizontally in a vertical list.

Returns
Number — The pixel amount that the nav buttons will be moved horizontally in a vertical list.
getButtonOffsetY()method 
public function getButtonOffsetY():Number

Returns the pixel amount that the nav buttons will be moved vertically in a horizontal list.

Returns
Number — The pixel amount that the nav buttons will be moved vertically in a horizontal list.
getButtonSize()method 
public function getButtonSize():Number

Returns the pixel size, width and height, of the navigation buttons.

Returns
Number — The pixel size, width and height, of the navigation buttons.
getCenterContent()method 
public function getCenterContent():Boolean

Returns whether the list centers its content within its area.

Returns
Boolean — True if content centers within content area.
getColumnCount()method 
public function getColumnCount():int

Returns the number of columns that can be displayed based on the size settings.

Returns
int — The number of columns that can be displayed based on the size settings.
getColumnGutter()method 
public function getColumnGutter():Number

Returns the pixel gutter between each column.

Returns
Number — The pixel gutter between each column.
getColumnWidth()method 
public function getColumnWidth():Number

Returns the pixel width of each visual column in the list.

Returns
Number — The pixel width of each visual column in the list.
getContentInsetH()method 
public function getContentInsetH():Number

Returns the pixel space that items are inset horizontally from the top and bottom of the list.

Returns
Number — The pixel space that items are inset horizontally from the top and bottom of the list.
getContentInsetV()method 
public function getContentInsetV():Number

Returns the pixel space that items are inset vertically from the top and bottom of the list.

Returns
Number — The pixel space that items are inset vertically from the top and bottom of the list.
getNumColumns()method 
public function getNumColumns():int

Returns the number of columns represented visually for the list.

Returns
int — The number of columns represented visually for the list.
getNumPages()method 
public function getNumPages():uint

Returns the number of pages of data in the list.

Returns
uint — The number of pages of data in the list.
getNumRows()method 
public function getNumRows():int

Returns the number of rows represented visually for the list.

Returns
int — The number of rows represented visually for the list.
getPageIndex()method 
public function getPageIndex():uint

Returns the index of the current page displayed.

Returns
uint — The index of the current page displayed.
getRowCount()method 
public function getRowCount():int

Returns the number of rows that can be displayed based on the size settings.

Returns
int — The number of rows that can be displayed based on the size settings.
getRowGutter()method 
public function getRowGutter():Number

Returns the pixel gutter between each row.

Returns
Number — The pixel gutter between each row.
getRowHeight()method 
public function getRowHeight():Number

Returns the pixel height of each visual row in the list.

Returns
Number — The pixel height of each visual row in the list.
getScrollDirection()method 
public function getScrollDirection():String

Returns the direction that pages will be scrolled, horizontal or vertical.

Returns
String — The direction that pages will be scrolled, horizontal or vertical.
getUseBlur()method 
public function getUseBlur():Boolean

Returns whether the list should blur its items when animating to new pages.

Returns
Boolean — True to blur the list's items when animating to new pages.
setAnimationType()method 
public function setAnimationType(type:String):void

Sets how a page will animate in: (move || wipe || scale || none).

Parameters

type:String — a page will animate in: (move || wipe || scale || none).

setButtonOffsetX()method 
public function setButtonOffsetX(offset:Number):void

Sets the pixel amount that the nav buttons will be moved horizontally in a vertical list.

Parameters

offset:Number — pixel amount that the nav buttons will be moved horizontally in a vertical list.

setButtonOffsetY()method 
public function setButtonOffsetY(offset:Number):void

Sets the pixel amount that the nav buttons will be moved vertically in a horizontal list.

Parameters

offset:Number — pixel amount that the nav buttons will be moved vertically in a horizontal list.

setButtonSize()method 
public function setButtonSize(size:Number):void

Sets the pixel size, width and height, of the navigation buttons.

Parameters

size:Number — pixel size, width and height, of the navigation buttons.

setCenterContent()method 
public function setCenterContent(center:Boolean):void

Sets whether the list should center its content within its area.

Parameters

center:Boolean — to have content centered within content area.

setColumnGutter()method 
public function setColumnGutter(gutter:Number):void

Sets the pixel gutter between each column.

Parameters

gutter:Number — pixel gutter between each column.

setColumnWidth()method 
public function setColumnWidth(width:Number):void

Sets the pixel width of each visual column in the list.

Parameters

width:Number — pixel width of each visual column in the list.

setContentInsetH()method 
public function setContentInsetH(inset:Number):void

Sets the pixel space that items are inset horizontally from the top and bottom of the list.

Parameters

inset:Number — pixel space that items are inset horizontally from the top and bottom of the list.

setContentInsetV()method 
public function setContentInsetV(inset:Number):void

Sets the pixel space that items are inset vertically from the top and bottom of the list.

Parameters

inset:Number — pixel space that items are inset vertically from the top and bottom of the list.

setNumColumns()method 
public function setNumColumns(columns:int):void

Sets the number of columns represented visually for the list.

Parameters

columns:int — number of columns represented visually for the list.

setNumRows()method 
public function setNumRows(rows:int):void

Sets the number of rows represented visually for the list.

Parameters

rows:int — number of rows represented visually for the list.

setRowGutter()method 
public function setRowGutter(gutter:Number):void

Sets the pixel gutter between each row.

Parameters

gutter:Number — pixel gutter between each row.

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

Sets the pixel height of each visual row in the list.

Parameters

height:Number — pixel height of each visual row in the list.

setScrollDirection()method 
public function setScrollDirection(direction:String):void

Sets the direction that pages will be scrolled, horizontal or vertical.

Parameters

direction:String — direction that pages will be scrolled, horizontal or vertical.

setUseBlur()method 
public function setUseBlur(useBlur:Boolean):void

Sets whether the list should blur its items when animating to new pages.

Parameters

useBlur:Boolean — to blur the list's items when animating to new pages.

showNextPage()method 
public function showNextPage():Boolean

Renders and tweens on the next page of data.

Returns
Boolean — True if next page is valid page and can be moved to in the list's current state.
showPage()method 
public function showPage(index:uint):Boolean

Renders and tweens on the specified page of data.

Parameters

index:uint — index of the page to show.

Returns
Boolean — True if page is valid page and can be moved to in the list's current state.
showPreviousPage()method 
public function showPreviousPage():Boolean

Renders and tweens on the previous page of data.

Returns
Boolean — True if previous page is valid page and can be moved to in the list's current state.