Packagecom.brightcove.api.components
Classpublic class ComboBox
InheritanceComboBox Inheritance UIObject Inheritance Component Inheritance flash.events.EventDispatcher

The ComboBox 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
  
ComboBox(element:Object)
Constructor.
ComboBox
 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
  
getAnimated():Boolean
Returns whether the combo animates when opening and closing.
ComboBox
 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.
ComboBox
  
getDataAtIndex(index:uint):Object
Returns the data stored at the specified index.
ComboBox
 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.
ComboBox
  
getItemInsetV():Number
Returns the pixel amount items are inset vertically from the side of the component.
ComboBox
  
Returns the vertical pixel amount between items in the list.
ComboBox
  
getLabel():String
Returns the string that will appear in the combo if no item is selected.
ComboBox
  
Returns the horizontal pixel space to the left of the label.
ComboBox
  
Returns the horizontal pixel space to the right of the label.
ComboBox
  
Returns the vertical pixel space to the top of the label.
ComboBox
  
getLabelField():String
Returns the property of the items that is used for display of the label.
ComboBox
 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.
ComboBox
 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.
ComboBox
  
Returns the pixel amount that the scroller is inset from the side of the component.
ComboBox
  
Returns the pixel width of the scroller.
ComboBox
  
Returns the data stored at the currently selected index.
ComboBox
  
Returns the index of the currently selected item in the list, or -1.
ComboBox
 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
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
  
setAnimated(animated:Boolean):void
Sets whether the combo animates when opening and closing.
ComboBox
 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.
ComboBox
 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.
ComboBox
  
setItemInsetV(itemInsetV:Number):void
Sets the pixel amount items are inset vertically from the side of the component.
ComboBox
  
setItemLeading(itemLeading:Number):void
Sets the vertical pixel amount between items in the list.
ComboBox
  
setLabel(label:String):void
Sets the string that will appear in the combo if no item is selected.
ComboBox
  
setLabelBufferLeft(buffer:Number):void
Sets the horizontal pixel space to the left of the label.
ComboBox
  
setLabelBufferRight(buffer:Number):void
Sets the horizontal pixel space to the right of the label.
ComboBox
  
setLabelBufferTop(buffer:Number):void
Sets the vertical pixel space to the top of the label.
ComboBox
  
setLabelField(field:String):void
Sets the property of the items that should be used for display of the label.
ComboBox
 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.
ComboBox
  
setScrollerInset(scrollerInset:Number):void
Sets the pixel amount that the scroller is inset from the side of the component.
ComboBox
  
setScrollerWidth(scrollerWidth:Number):void
Sets the pixel width of the scroller.
ComboBox
  
setSelectedIndex(index:int):void
Sets the currently selected item in the list by passing its index.
ComboBox
 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
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
ComboBox()Constructor
public function ComboBox(element:Object)

Constructor.

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

Returns whether the combo animates when opening and closing.

Returns
Boolean — True if the combo animates when opening and closing.
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.
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.
getLabel()method 
public function getLabel():String

Returns the string that will appear in the combo if no item is selected.

Returns
String — The string that will appear in the combo if no item is selected.
getLabelBufferLeft()method 
public function getLabelBufferLeft():Number

Returns the horizontal pixel space to the left of the label.

Returns
Number — The horizontal pixel space to the left of the label.
getLabelBufferRight()method 
public function getLabelBufferRight():Number

Returns the horizontal pixel space to the right of the label.

Returns
Number — The horizontal pixel space to the right of the label.
getLabelBufferTop()method 
public function getLabelBufferTop():Number

Returns the vertical pixel space to the top of the label.

Returns
Number — The vertical pixel space to the top of the label.
getLabelField()method 
public function getLabelField():String

Returns the property of the items that is used for display of the label.

Returns
String — The property of the items that is used for display of the label.
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.
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.
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 list, or -1.

Returns
int — The index of the currently selected item.
setAnimated()method 
public function setAnimated(animated:Boolean):void

Sets whether the combo animates when opening and closing.

Parameters

animated:Boolean — if the combo animates when opening and closing.

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.

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.

setLabel()method 
public function setLabel(label:String):void

Sets the string that will appear in the combo if no item is selected.

Parameters

label:String — string that will appear in the combo if no item is selected.

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

Sets the horizontal pixel space to the left of the label.

Parameters

buffer:Number — horizontal pixel space to the left of the label.

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

Sets the horizontal pixel space to the right of the label.

Parameters

buffer:Number — horizontal pixel space to the right of the label.

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

Sets the vertical pixel space to the top of the label.

Parameters

buffer:Number — vertical pixel space to the top of the label.

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

Sets the property of the items that should be used for display of the label.

Parameters

field:String — property of the items that should be used for display of the label.

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.

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

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

Parameters

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