Packageorg.openvideoplayer.components.ui.controlbar
Classpublic class ControlBar
InheritanceControlBar Inheritance flash.display.Sprite

This is the main class for the ControlBar component. This class holds all the public API calls for the component and is meant to be the class that is instantiated and referenced by your player.


Public Properties
 PropertyDefined By
  controlBarBackgroundAlpha : Number
Accessor for the main background alpha of the control bar.
ControlBar
  controlBarBackgroundColor : Number
Accessor for the background color for both the control bar's main background as well as each controls background that is added to the control bar.
ControlBar
  controlUpperHighlightAlpha : Number
Accessor for the alpha of the highlight that covers 50% height of both the control bar's main background shape and all the controls main backgrounds.
ControlBar
  controlUpperHighlightColor : uint
Accessor for the color of the highlight that covers 50% height of both the control bar's main background shape and all the controls main backgrounds.
ControlBar
  downloadProgressBarColor : uint
Accessor for the scrub bar's download progress bar color.
ControlBar
  height : Number
[override] Accessor for the height of the entire control bar.
ControlBar
  iconAlpha : Number
Accessor for the icon alpha that all the controls use.
ControlBar
  iconColor : uint
Accessor for the icon color that all the controls use.
ControlBar
  progressBarColor : uint
Accessor for the scrub bar's progress bar color.
ControlBar
  sliderTrackBackgroundColor : uint
Accessor for the color of the scrub bar's background.
ControlBar
  strokeAlpha : Number
Accessor for the stroke alpha of the control bar and all the controls.
ControlBar
  strokeColor : uint
Accessor for the stroke color of the control bar and all the controls.
ControlBar
  width : Number
[override] Accessor for the width of the entire control bar.
ControlBar
Public Methods
 MethodDefined By
  
ControlBar()
ControlBar
  
addControl(value:BaseComponent):void
Use this method to add a single instantiated BaseComponent Control to the Component.
ControlBar
  
addControls(value:Array):void
Use this method to add and Array of already instantiated BaseComponent Controls to the Component at one time.
ControlBar
  
getControl(type:String):BaseComponent
Use this method to get a reference to the BaseComponent Control after it has been added to the control bar.
ControlBar
Property Detail
controlBarBackgroundAlphaproperty
controlBarBackgroundAlpha:Number

Accessor for the main background alpha of the control bar. Change this property if the you want to alter the main backgrounds's alpha transparency This property will not effect the entire alpha of the component. Default 1


Implementation
    public function get controlBarBackgroundAlpha():Number
    public function set controlBarBackgroundAlpha(value:Number):void
controlBarBackgroundColorproperty 
controlBarBackgroundColor:Number

Accessor for the background color for both the control bar's main background as well as each controls background that is added to the control bar. Default 0x000000


Implementation
    public function get controlBarBackgroundColor():Number
    public function set controlBarBackgroundColor(value:Number):void
controlUpperHighlightAlphaproperty 
controlUpperHighlightAlpha:Number

Accessor for the alpha of the highlight that covers 50% height of both the control bar's main background shape and all the controls main backgrounds. Default 0.1


Implementation
    public function get controlUpperHighlightAlpha():Number
    public function set controlUpperHighlightAlpha(value:Number):void
controlUpperHighlightColorproperty 
controlUpperHighlightColor:uint

Accessor for the color of the highlight that covers 50% height of both the control bar's main background shape and all the controls main backgrounds. Default 0xFFFFFF


Implementation
    public function get controlUpperHighlightColor():uint
    public function set controlUpperHighlightColor(value:uint):void
downloadProgressBarColorproperty 
downloadProgressBarColor:uint

Accessor for the scrub bar's download progress bar color. The download progress bar is used to indicate the current download progress for an item that the control bar is controlling. An example of this would be on a progressive download video file it would show the BytesLoaded vs the BytesTotal of the FLV. Default 0x666666


Implementation
    public function get downloadProgressBarColor():uint
    public function set downloadProgressBarColor(value:uint):void
heightproperty 
height:Number[override]

Accessor for the height of the entire control bar. If you set this value before or after the control bar has been constructed it will automatically update all elements of the control bar. This property will not affect the height of each individual control within the control bar. Default 30


Implementation
    public function get height():Number
    public function set height(value:Number):void
iconAlphaproperty 
iconAlpha:Number

Accessor for the icon alpha that all the controls use. Default 1


Implementation
    public function get iconAlpha():Number
    public function set iconAlpha(value:Number):void
iconColorproperty 
iconColor:uint

Accessor for the icon color that all the controls use. Default 0xFFFFFF


Implementation
    public function get iconColor():uint
    public function set iconColor(value:uint):void
progressBarColorproperty 
progressBarColor:uint

Accessor for the scrub bar's progress bar color. The progress bar is different from the download progress bar in that it shows the current progress of what ever the control bar is controlling. Default 0x000000


Implementation
    public function get progressBarColor():uint
    public function set progressBarColor(value:uint):void
sliderTrackBackgroundColorproperty 
sliderTrackBackgroundColor:uint

Accessor for the color of the scrub bar's background. Default 0xFFFFFF


Implementation
    public function get sliderTrackBackgroundColor():uint
    public function set sliderTrackBackgroundColor(value:uint):void
strokeAlphaproperty 
strokeAlpha:Number

Accessor for the stroke alpha of the control bar and all the controls. Default 0.5


Implementation
    public function get strokeAlpha():Number
    public function set strokeAlpha(value:Number):void
strokeColorproperty 
strokeColor:uint

Accessor for the stroke color of the control bar and all the controls. Default 0xFFFFFF


Implementation
    public function get strokeColor():uint
    public function set strokeColor(value:uint):void
widthproperty 
width:Number[override]

Accessor for the width of the entire control bar. If you set this value before or after the control bar has been constructed it will automatically update all elements of the control bar. Default 360


Implementation
    public function get width():Number
    public function set width(value:Number):void
Constructor Detail
ControlBar()Constructor
public function ControlBar()

Method Detail
addControl()method
public function addControl(value:BaseComponent):void

Use this method to add a single instantiated BaseComponent Control to the Component. You can add a single item at anytime.

Parameters

value:BaseComponent — Takes an instantiated BaseComponent Controls

addControls()method 
public function addControls(value:Array):void

Use this method to add and Array of already instantiated BaseComponent Controls to the Component at one time. The order of the controls in the Array will determine the layout of them. If you wish to add a space or spaces in your control bar between controls refer to the FlexibleSpacer control to do so

Parameters

value:Array — Takes an array of already instantiated BaseComponent Controls

getControl()method 
public function getControl(type:String):BaseComponent

Use this method to get a reference to the BaseComponent Control after it has been added to the control bar. You will find all the string constants in the ControlType.as class.

Parameters

type:String — ControlType string constant.

Returns
BaseComponent —




Fri Jan 21 2011, 01:35 PM -08:00