Package | com.brightcove.api.components |
Class | public class ComboBox |
Inheritance | ComboBox ![]() ![]() ![]() |
Method | Defined By | ||
---|---|---|---|
ComboBox(element:Object)
Constructor. | ComboBox | ||
![]() | 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 | |
getAnimated():Boolean
Returns whether the combo animates when opening and closing. | ComboBox | ||
![]() | 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. | ComboBox | ||
getDataAtIndex(index:uint):Object
Returns the data stored at the specified index. | ComboBox | ||
![]() | 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. | ComboBox | ||
getItemInsetV():Number
Returns the pixel amount items are inset vertically from the side of the component. | ComboBox | ||
getItemLeading():Number
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 | ||
getLabelBufferLeft():Number
Returns the horizontal pixel space to the left of the label. | ComboBox | ||
getLabelBufferRight():Number
Returns the horizontal pixel space to the right of the label. | ComboBox | ||
getLabelBufferTop():Number
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 | ||
![]() | 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. | ComboBox | ||
![]() | 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. | ComboBox | ||
getScrollerInset():Number
Returns the pixel amount that the scroller is inset from the side of the component. | ComboBox | ||
getScrollerWidth():Number
Returns the pixel width of the scroller. | ComboBox | ||
getSelectedData():Object
Returns the data stored at the currently selected index. | ComboBox | ||
getSelectedIndex():int
Returns the index of the currently selected item in the list, or -1. | ComboBox | ||
![]() | 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 | |
![]() | removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void [override]
Removes a listener for an event. | UIObject | |
![]() | 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 | ||
![]() | 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 | ||
![]() | 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. | 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 | ||
![]() | 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 | ||
![]() | 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 |
ComboBox | () | Constructor |
public function ComboBox(element:Object)
Constructor.
Parameterselement:Object — layout element to wrap and delegate all calls to.
|
getAnimated | () | method |
public function getAnimated():Boolean
Returns whether the combo animates when opening and closing.
ReturnsBoolean — True if the combo animates when opening and closing.
|
getData | () | method |
public function getData():Array
Returns the data currently rendered within the list.
ReturnsArray — 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.
|
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.
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.
|
getLabel | () | method |
public function getLabel():String
Returns the string that will appear in the combo if no item is selected.
ReturnsString — 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.
ReturnsNumber — 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.
ReturnsNumber — 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.
ReturnsNumber — 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.
ReturnsString — 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.
Returnsuint — 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.
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.
|
getSelectedData | () | method |
public function getSelectedData():Object
Returns the data stored at the currently selected index.
ReturnsObject — 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.
Returnsint — 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.
|