Packagecom.brightcove.api.components
Classpublic class TabBar
InheritanceTabBar Inheritance UIObject Inheritance Component Inheritance flash.events.EventDispatcher

The TabBar 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
  
TabBar(element:Object)
Constructor.
TabBar
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = true):void
[override] Adds a listener for an event.
UIObject
  
appendTab(tabData:Object):void
Appends a single tab into tab bar at the end of the list.
TabBar
 Inherited
getAlpha():Number
Returns the alpha value of the component.
Component
  
getAutoSizeTabs():Boolean
Returns whether tabs resize based on their labels or whether they are fixed width.
TabBar
 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
  
getData():Array
Returns the data currently rendered within the list.
TabBar
  
getDataAtIndex(index:uint):Object
Returns the data stored at the specified index.
TabBar
 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
  
Returns whether the tab bar is hidden if only a single tab is assigned to it.
TabBar
 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
  
getIncludeMenu():Boolean
Returns whether the tabs should include a drop down menu for quick access of items.
TabBar
 Inherited
getIndex():int
Returns the index of this element in its parent's elements array.
Component
  
Returns the horizontal pixel space to the left and right of the label within a tab.
TabBar
  
getLabelField():String
Returns the field in the data object that will be used for labels in the tabs.
TabBar
  
Returns the maximum number of menu rows that can appear in the drop down menu before paging.
TabBar
  
Returns the pixel amount that labels for menu items are inset from the sides of the drop down menu.
TabBar
  
Returns the pixel height of an item in the drop down.
TabBar
  
getMenuWidth():Number
Returns the pixel width of the drop down menu.
TabBar
 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 items currently managed in the list.
TabBar
 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 data stored at the currently selected index.
TabBar
  
Returns the index of the currently selected item in the tabs, or -1.
TabBar
  
getTabAlign():String
Returns whether tabs are aligned to the left or right as they build.
TabBar
  
getTabPadding():Number
Returns the horizontal pixel space between tabs.
TabBar
  
getTabWidth():Number
Returns the fixed pixel width of a tab if autosizeTabs is set to false.
TabBar
 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
  
insertTabAt(tabData:Object, index:uint):void
Inserts a single tab into tab bar at specified location.
TabBar
 Inherited
move(x:Number, y:Number, global:Boolean = false):void
Sets the x,y coordinates of the component.
Component
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
[override] Removes a listener for an event.
UIObject
  
removeTabAt(index:uint):void
Removes a single tab from tab bar at specified location.
TabBar
  
replaceTabAt(tabData:Object, index:uint):void
Replaces the data of a single tab in tab bar at specified location with the specified data.
TabBar
 Inherited
setAlpha(alpha:Number):void
Sets the alpha value of the component.
Component
  
setAutoSizeTabs(autosize:Boolean):void
Sets whether tabs should resize based on their labels or whether they are fixed width.
TabBar
 Inherited
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.
TabBar
 Inherited
setEnabled(enable:Boolean):void
Enables/disables component for events.
UIObject
  
setHideSingleTab(hide:Boolean):void
Sets whether the tab bar should be hidden if only a single tab is assigned to it.
TabBar
 Inherited
setIncludeInLayout(includeInLayout:Boolean):void
Sets whether the component is included in layout calculations and rendering in parent layout box.
Component
  
setIncludeMenu(includeMenu:Boolean):void
Sets whether the tabs should include a drop down menu for quick access of items.
TabBar
  
setLabelBuffer(buffer:Number):void
Sets the horizontal pixel space to the left and right of the label within a tab.
TabBar
  
setLabelField(labelField:String):void
Sets the field in the data object that will be used for labels in the tabs.
TabBar
  
setMaxMenuRows(max:Number):void
Sets the maximum number of menu rows that can appear in the drop down menu before paging.
TabBar
  
setMenuItemInset(inset:Number):void
Sets the pixel amount that labels for menu items are inset from the sides of the drop down menu.
TabBar
  
setMenuRowHeight(height:Number):void
Sets the pixel height of an item in the drop down menu.
TabBar
  
setMenuWidth(width:Number):void
Sets the pixel width of the drop down menu.
TabBar
 Inherited
setRotation(rotation:Number):void
Sets the rotation of the component.
UIObject
  
setSelectedIndex(index:int):void
Sets the currently selected item in the tabs by passing its index.
TabBar
 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
  
setTabAlign(align:String):void
Sets whether tabs are aligned to the left or right as they build.
TabBar
  
setTabPadding(padding:Number):void
Sets the horizontal pixel space between tabs.
TabBar
  
setTabWidth(width:Number):void
Sets the fixed pixel width of a tab if autosizeTabs is set to false.
TabBar
 Inherited
setVisible(visible:Boolean):void
Sets whether the component is visible.
Component
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
TabBar()Constructor
public function TabBar(element:Object)

Constructor.

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

Appends a single tab into tab bar at the end of the list.

Parameters

tabData:Object — data to be used for the tab.

getAutoSizeTabs()method 
public function getAutoSizeTabs():Boolean

Returns whether tabs resize based on their labels or whether they are fixed width.

Returns
Boolean — True if tabs resize based on their labels or whether they are fixed width.
getData()method 
public function getData():Array

Returns the data currently rendered within the list.

Returns
Array — The data rendered within the list, as an array of items.
getDataAtIndex()method 
public function getDataAtIndex(index:uint):Object

Returns the data stored at the specified index.

Parameters

index:uint — index position of the item to retrieve data from.

Returns
Object — The data stored at the specified index.
getHideSingleTab()method 
public function getHideSingleTab():Boolean

Returns whether the tab bar is hidden if only a single tab is assigned to it.

Returns
Boolean — Whether the tab bar is hidden if only a single tab is assigned to it.
getIncludeMenu()method 
public function getIncludeMenu():Boolean

Returns whether the tabs should include a drop down menu for quick access of items.

Returns
Boolean — True if the tabs should include a drop down menu for quick access of items.
getLabelBuffer()method 
public function getLabelBuffer():Number

Returns the horizontal pixel space to the left and right of the label within a tab.

Returns
Number — The horizontal pixel space to the left and right of the label within a tab.
getLabelField()method 
public function getLabelField():String

Returns the field in the data object that will be used for labels in the tabs.

Returns
String — The field in the data object that will be used for a tab's label.
getMaxMenuRows()method 
public function getMaxMenuRows():Number

Returns the maximum number of menu rows that can appear in the drop down menu before paging.

Returns
Number — The maximum number of menu rows that can appear in the drop down menu before paging.
getMenuItemInset()method 
public function getMenuItemInset():Number

Returns the pixel amount that labels for menu items are inset from the sides of the drop down menu.

Returns
Number — The pixel amount that labels for menu items are inset from the sides of the drop down menu.
getMenuRowHeight()method 
public function getMenuRowHeight():Number

Returns the pixel height of an item in the drop down.

Returns
Number — The pixel height of an item in the drop down.
getMenuWidth()method 
public function getMenuWidth():Number

Returns the pixel width of the drop down menu.

Returns
Number — The pixel width of the drop down menu.
getNumItems()method 
public function getNumItems():uint

Returns the number of items currently managed in the list.

Returns
uint — The number of items in the list, incuding non-visible.
getSelectedData()method 
public function getSelectedData():Object

Returns the data stored at the currently selected index.

Returns
Object — The data stored at the currently selected index.
getSelectedIndex()method 
public function getSelectedIndex():int

Returns the index of the currently selected item in the tabs, or -1.

Returns
int — The index of the currently selected item.
getTabAlign()method 
public function getTabAlign():String

Returns whether tabs are aligned to the left or right as they build.

Returns
String — Whether tabs are aligned to the left or right as they build.
getTabPadding()method 
public function getTabPadding():Number

Returns the horizontal pixel space between tabs.

Returns
Number — The horizontal pixel space between tabs.
getTabWidth()method 
public function getTabWidth():Number

Returns the fixed pixel width of a tab if autosizeTabs is set to false.

Returns
Number — The fixed pixel width of a tab if autosizeTabs is set to false.
insertTabAt()method 
public function insertTabAt(tabData:Object, index:uint):void

Inserts a single tab into tab bar at specified location.

Parameters

tabData:Object — data to be used for the tab.
 
index:uint — index in the tabs to insert the new tab.

removeTabAt()method 
public function removeTabAt(index:uint):void

Removes a single tab from tab bar at specified location.

Parameters

index:uint — index of the tab in the tabs to remove.

replaceTabAt()method 
public function replaceTabAt(tabData:Object, index:uint):void

Replaces the data of a single tab in tab bar at specified location with the specified data.

Parameters

tabData:Object — data to be used for the tab.
 
index:uint — index in the tabs to replace with the new tab.

setAutoSizeTabs()method 
public function setAutoSizeTabs(autosize:Boolean):void

Sets whether tabs should resize based on their labels or whether they are fixed width.

Parameters

autosize:Boolean — if tabs should resize based on their labels or whether they are fixed width.

setData()method 
public function setData(data:Array):void

Sets the data to be rendered within the list.

Parameters

data:Array — data to render within the list, as an array of items.

setHideSingleTab()method 
public function setHideSingleTab(hide:Boolean):void

Sets whether the tab bar should be hidden if only a single tab is assigned to it.

Parameters

hide:Boolean — if the tab bar should be hidden if only a single tab is assigned to it.

setIncludeMenu()method 
public function setIncludeMenu(includeMenu:Boolean):void

Sets whether the tabs should include a drop down menu for quick access of items.

Parameters

includeMenu:Boolean — if the tabs should include a drop down menu for quick access of items.

setLabelBuffer()method 
public function setLabelBuffer(buffer:Number):void

Sets the horizontal pixel space to the left and right of the label within a tab.

Parameters

buffer:Number — horizontal pixel space to the left and right of the label within a tab.

setLabelField()method 
public function setLabelField(labelField:String):void

Sets the field in the data object that will be used for labels in the tabs.

Parameters

labelField:String — field in the data object that will be used for a tab's label.

setMaxMenuRows()method 
public function setMaxMenuRows(max:Number):void

Sets the maximum number of menu rows that can appear in the drop down menu before paging.

Parameters

max:Number — maximum number of menu rows that can appear in the drop down menu before paging.

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

Sets the pixel amount that labels for menu items are inset from the sides of the drop down menu.

Parameters

inset:Number — pixel amount that labels for menu items are inset from the sides of the drop down menu.

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

Sets the pixel height of an item in the drop down menu.

Parameters

height:Number — pixel height of an item in the drop down.

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

Sets the pixel width of the drop down menu.

Parameters

width:Number — pixel width of the drop down menu.

setSelectedIndex()method 
public function setSelectedIndex(index:int):void

Sets the currently selected item in the tabs by passing its index.

Parameters

index:int — index of the item to select in the tabs.

setTabAlign()method 
public function setTabAlign(align:String):void

Sets whether tabs are aligned to the left or right as they build.

Parameters

align:String — or "right".

setTabPadding()method 
public function setTabPadding(padding:Number):void

Sets the horizontal pixel space between tabs.

Parameters

padding:Number — horizontal pixel space between tabs.

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

Sets the fixed pixel width of a tab if autosizeTabs is set to false.

Parameters

width:Number — fixed pixel width of a tab if autosizeTabs is set to false.