Packagecom.brightcove.api.components
Classpublic class VolumeControl
InheritanceVolumeControl Inheritance UIObject Inheritance Component Inheritance flash.events.EventDispatcher

The VolumeControl 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
  
VolumeControl(element:Object)
Constructor.
VolumeControl
 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 volume control popup will animate in and out.
VolumeControl
 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
 Inherited
getDefinition():String
Returns the XML (BEML) definition of the component.
Component
  
getDirection():String
Returns the direction of the rollover popup.
VolumeControl
 Inherited
getEnabled():Boolean
Returns whether component is enabled.
UIObject
 Inherited
getHeight():Number
Returns the pixel height of the component.
Component
  
Returns the horizontal padding around the controls in the popup scrollbar.
VolumeControl
  
Returns the horizontal alignment for the icon.
VolumeControl
  
Returns the vertical alignment for the icon.
VolumeControl
  
getIconName():String
Returns the name of the current icon displayed.
VolumeControl
  
Returns the pixel amount on the x axis the icon is offset from its aligned position.
VolumeControl
  
Returns the pixel amount on the y axis the icon is offset from its aligned position.
VolumeControl
  
getIconScale():Number
Returns the percent scale at which to render the icon.
VolumeControl
 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
  
getIsToggled():Boolean
Returns whether the button is currently in its toggled state.
VolumeControl
  
Returns the name of the icon displayed when component is toggled.
VolumeControl
  
Returns the tooltip, if any, applied to the component when toggled.
VolumeControl
 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 height of the popup scrollbar.
VolumeControl
 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
  
getShowBack():Boolean
Returns whether the background graphic for the button should be shown (if any is assigned through the theme).
VolumeControl
  
Returns the height of the slider in the popup scrollbar.
VolumeControl
  
getTooltip():String
Returns the tooltip, if any, applied to the component.
VolumeControl
  
Returns the vertical padding around the controls in the popup scrollbar.
VolumeControl
 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 volume control popup will animate in and out.
VolumeControl
 Inherited
setBlendMode(mode:String):void
Sets the blend mode of the component.
UIObject
  
setDirection(direction:String):void
Sets the direction of the rollover popup.
VolumeControl
 Inherited
setEnabled(enable:Boolean):void
Enables/disables component for events.
UIObject
  
setHorizontalPadding(padding:Number):void
Sets the horizontal padding around the controls in the popup scrollbar.
VolumeControl
  
setIconAlignmentH(alignment:String):void
Sets the horizontal alignment for the icon.
VolumeControl
  
setIconAlignmentV(alignment:String):void
Sets the vertical alignment for the icon.
VolumeControl
  
setIconName(name:String):void
Sets the current icon displayed.
VolumeControl
  
setIconOffsetX(offset:Number):void
Sets the pixel amount on the x axis the icon should be offset from its aligned position.
VolumeControl
  
setIconOffsetY(offset:Number):void
Sets the pixel amount on the y axis the icon should be offset from its aligned position.
VolumeControl
  
setIconScale(scale:Number):void
Sets the percent scale at which to render the icon.
VolumeControl
 Inherited
setIncludeInLayout(includeInLayout:Boolean):void
Sets whether the component is included in layout calculations and rendering in parent layout box.
Component
  
setIsToggled(toggled:Boolean):void
Sets whether the button is currently in its toggled state.
VolumeControl
  
setMutedIconName(name:String):void
Sets the icon displayed when component is toggled.
VolumeControl
  
setMutedTooltip(tooltip:String):void
Sets the tooltip for the component when toggled.
VolumeControl
  
setPopupHeight(height:Number):void
Sets the height of the popup scrollbar.
VolumeControl
 Inherited
setRotation(rotation:Number):void
Sets the rotation of the component.
UIObject
  
setShowBack(show:Boolean):void
Sets whether the background graphic for the button should be shown (if any is assigned through the theme).
VolumeControl
 Inherited
setSize(width:Number, height:Number):void
Sets the pixel dimensions for the wrapped component.
Component
  
setSliderHeight(height:Number):void
Sets the height of the slider in the popup scrollbar.
VolumeControl
 Inherited
setStyles(styles:String):void
Overrides specific styles for a component by accepting a semicolon-delimited list of style names and colors.
UIObject
  
setTooltip(tooltip:String):void
Sets the tooltip for the component.
VolumeControl
  
setVerticalPadding(padding:Number):void
Sets the vertical padding around the controls in the popup scrollbar.
VolumeControl
 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
VolumeControl()Constructor
public function VolumeControl(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 volume control popup will animate in and out.

Returns
Boolean — True if the volume control popup will animate in and out.
getDirection()method 
public function getDirection():String

Returns the direction of the rollover popup.

Returns
String — The direction of the rollover popup.
getHorizontalPadding()method 
public function getHorizontalPadding():Number

Returns the horizontal padding around the controls in the popup scrollbar.

Returns
Number — Returns the horizontal padding around the controls in the popup scrollbar.
getIconAlignmentH()method 
public function getIconAlignmentH():String

Returns the horizontal alignment for the icon.

Returns
String — The horizontal alignment setting for the button icon.
getIconAlignmentV()method 
public function getIconAlignmentV():String

Returns the vertical alignment for the icon.

Returns
String — The vertical alignment setting for the button icon.
getIconName()method 
public function getIconName():String

Returns the name of the current icon displayed.

Returns
String — The name of the current icon displayed.
getIconOffsetX()method 
public function getIconOffsetX():Number

Returns the pixel amount on the x axis the icon is offset from its aligned position.

Returns
Number — The pixel amount on the x axis the icon is offset from its aligned position.
getIconOffsetY()method 
public function getIconOffsetY():Number

Returns the pixel amount on the y axis the icon is offset from its aligned position.

Returns
Number — The pixel amount on the y axis the icon is offset from its aligned position.
getIconScale()method 
public function getIconScale():Number

Returns the percent scale at which to render the icon.

Returns
Number — The percent scale at which to render the icon.
getIsToggled()method 
public function getIsToggled():Boolean

Returns whether the button is currently in its toggled state.

Returns
Boolean — True if the button is currently in its toggled state.
getMutedIconName()method 
public function getMutedIconName():String

Returns the name of the icon displayed when component is toggled.

Returns
String — The name of the icon displayed when component is toggled.
getMutedTooltip()method 
public function getMutedTooltip():String

Returns the tooltip, if any, applied to the component when toggled.

Returns
String — Returns the string tooltip text when component is toggled.
getPopupHeight()method 
public function getPopupHeight():Number

Returns the height of the popup scrollbar.

Returns
Number — Returns the height of the popup scrollbar.
getShowBack()method 
public function getShowBack():Boolean

Returns whether the background graphic for the button should be shown (if any is assigned through the theme).

Returns
Boolean — False if the background graphic is not to be shown.
getSliderHeight()method 
public function getSliderHeight():Number

Returns the height of the slider in the popup scrollbar.

Returns
Number — Returns the height of the slider in the popup scrollbar.
getTooltip()method 
public function getTooltip():String

Returns the tooltip, if any, applied to the component.

Returns
String — Returns the string tooltip text.
getVerticalPadding()method 
public function getVerticalPadding():Number

Returns the vertical padding around the controls in the popup scrollbar.

Returns
Number — The vertical padding around the controls in the popup scrollbar.
setAnimated()method 
public function setAnimated(animated:Boolean):void

Sets whether the volume control popup will animate in and out.

Parameters

animated:Boolean — if the volume control popup will animate in and out.

setDirection()method 
public function setDirection(direction:String):void

Sets the direction of the rollover popup.

Parameters

direction:String — direction of the rollover popup.

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

Sets the horizontal padding around the controls in the popup scrollbar.

Parameters

padding:Number — horizontal padding around the controls in the popup scrollbar.

setIconAlignmentH()method 
public function setIconAlignmentH(alignment:String):void

Sets the horizontal alignment for the icon.

Parameters

alignment:String — horizontal alignment setting for the button icon.

setIconAlignmentV()method 
public function setIconAlignmentV(alignment:String):void

Sets the vertical alignment for the icon.

Parameters

alignment:String — vertical alignment setting for the button icon.

setIconName()method 
public function setIconName(name:String):void

Sets the current icon displayed.

Parameters

name:String — name of the current icon to display.

setIconOffsetX()method 
public function setIconOffsetX(offset:Number):void

Sets the pixel amount on the x axis the icon should be offset from its aligned position.

Parameters

offset:Number — pixel amount on the x axis the icon should offset from its aligned position.

setIconOffsetY()method 
public function setIconOffsetY(offset:Number):void

Sets the pixel amount on the y axis the icon should be offset from its aligned position.

Parameters

offset:Number — pixel amount on the y axis the icon should offset from its aligned position.

setIconScale()method 
public function setIconScale(scale:Number):void

Sets the percent scale at which to render the icon.

Parameters

scale:Number — percent scale at which to render the icon.

setIsToggled()method 
public function setIsToggled(toggled:Boolean):void

Sets whether the button is currently in its toggled state.

Parameters

toggled:Boolean — to set the button in its toggled state.

setMutedIconName()method 
public function setMutedIconName(name:String):void

Sets the icon displayed when component is toggled.

Parameters

name:String — name of the icon to display when component is toggled.

setMutedTooltip()method 
public function setMutedTooltip(tooltip:String):void

Sets the tooltip for the component when toggled.

Parameters

tooltip:String — string to use for the tooltip text when component is toggled.

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

Sets the height of the popup scrollbar.

Parameters

height:Number — height of the popup scrollbar.

setShowBack()method 
public function setShowBack(show:Boolean):void

Sets whether the background graphic for the button should be shown (if any is assigned through the theme).

Parameters

show:Boolean — if the background graphic is not to be shown.

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

Sets the height of the slider in the popup scrollbar.

Parameters

height:Number — height of the slider in the popup scrollbar.

setTooltip()method 
public function setTooltip(tooltip:String):void

Sets the tooltip for the component.

Parameters

tooltip:String — string to use for the tooltip text.

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

Sets the vertical padding around the controls in the popup scrollbar.

Parameters

padding:Number — vertical padding around the controls in the popup scrollbar.