Package | com.brightcove.api.components |
Class | public class ViewStack |
Inheritance | ViewStack ![]() ![]() ![]() |
Method | Defined By | ||
---|---|---|---|
ViewStack(element:Object)
Constructor. | ViewStack | ||
appendChild(child:String):Boolean [override]
Adds a new child element to the end of the box children array. | ViewStack | ||
![]() | getAlpha():Number
Returns the alpha value of the component. | Component | |
![]() | getBackgroundColor():int
Returns the background color for the box. | LayoutBox | |
![]() | getBackgroundImage():String
Returns the background image for the box. | LayoutBox | |
![]() | getChildAt(index:uint):Object
Returns the child element from the box children array at the specified index. | LayoutBox | |
![]() |
Returns the interface for the layout container of the element. | Component | |
![]() | getDefinition():String
Returns the XML (BEML) definition of the component. | Component | |
![]() | getGutter():Number
Returns the number of pixels for the buffer between elements in the container. | LayoutBox | |
![]() | getHAlign():String
Returns the horizontal alignment (depending of the concrete class) for the box, which determines how child elements are positioned. | LayoutBox | |
![]() | 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 | |
![]() | 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 | |
![]() | getNumChildren():uint
Returns the number of children currently in the box. | LayoutBox | |
![]() | getPadding():Number
Returns the number of pixels for the border of the container. | LayoutBox | |
![]() | 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 | |
getSelectedIndex():uint
Returns the index of the currently visible child element. | ViewStack | ||
getSelectedItemID():String
Returns the ID of the selected item. | ViewStack | ||
![]() | getVAlign():String
Returns the vertical alignment for the box, which determines how child elements are positioned. | LayoutBox | |
![]() | 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 | |
insertChildAt(child:String, index:uint):Boolean [override]
Adds a new child element at the specified position in the box children array. | ViewStack | ||
![]() | move(x:Number, y:Number, global:Boolean = false):void
Sets the x,y coordinates of the component. | Component | |
removeChildAt(index:uint):Boolean [override]
Removes a child element from the box children array at the specified index. | ViewStack | ||
removeChildByID(id:String):Boolean [override]
Removes a child element with the specified ID from the box children array. | ViewStack | ||
![]() | setAlpha(alpha:Number):void
Sets the alpha value of the component. | Component | |
![]() | setBackgroundColor(color:int):void
Sets the background color for the box. | LayoutBox | |
![]() | setBackgroundImage(image:String):void
Sets the background image for the box. | LayoutBox | |
![]() | setGutter(gutter:Number):void
Sets the number of pixels for the buffer between elements in the container. | LayoutBox | |
![]() | setHAlign(align:String):void
Sets the horizontal alignment for the box, which determines how child elements are positioned. | LayoutBox | |
![]() | setIncludeInLayout(includeInLayout:Boolean):void
Sets whether the component is included in layout calculations and rendering in parent layout box. | Component | |
![]() | setPadding(padding:Number):void
Sets the number of pixels for the border of the container. | LayoutBox | |
setSelectedIndex(index:uint):void
Toggles the visibility of the child element at the specified index. | ViewStack | ||
setSelectedItemID(id:String):void
Sets the selected item based on its ID. | ViewStack | ||
![]() | setSize(width:Number, height:Number):void
Sets the pixel dimensions for the wrapped component. | Component | |
![]() | setVAlign(align:String):void
Sets the vertical alignment for the box, which determines how child elements are positioned. | LayoutBox | |
![]() | setVisible(visible:Boolean):void
Sets whether the component is visible. | Component |
ViewStack | () | Constructor |
public function ViewStack(element:Object)
Constructor.
Parameterselement:Object — layout element to wrap and delegate all calls to.
|
appendChild | () | method |
override public function appendChild(child:String):Boolean
Adds a new child element to the end of the box children array.
Parameters
child:String — The BEML definition to be used by the new element.
|
Boolean |
getSelectedIndex | () | method |
public function getSelectedIndex():uint
Returns the index of the currently visible child element.
Returnsuint — The index of the element that should is visible.
|
getSelectedItemID | () | method |
public function getSelectedItemID():String
Returns the ID of the selected item.
ReturnsString — The ID of the selected child element.
|
insertChildAt | () | method |
override public function insertChildAt(child:String, index:uint):Boolean
Adds a new child element at the specified position in the box children array.
Parameters
child:String — The BEML definition to be used by the new element.
| |
index:uint — The index position in which to insert the new element.
|
Boolean |
removeChildAt | () | method |
override public function removeChildAt(index:uint):Boolean
Removes a child element from the box children array at the specified index.
Parameters
index:uint — The index position of the child element.
|
Boolean — True if the child was successfully removed.
|
removeChildByID | () | method |
override public function removeChildByID(id:String):Boolean
Removes a child element with the specified ID from the box children array.
Parameters
id:String — The ID of the child element.
|
Boolean — True if the child was successfully removed.
|
setSelectedIndex | () | method |
public function setSelectedIndex(index:uint):void
Toggles the visibility of the child element at the specified index.
Parameters
index:uint — The index of the element that should be visible.
|
setSelectedItemID | () | method |
public function setSelectedItemID(id:String):void
Sets the selected item based on its ID.
Parameters
id:String — The ID of the child element to select.
|