Packagefeathers.media
Classpublic class VolumeSlider
InheritanceVolumeSlider Inheritance Slider Inheritance FeathersControl Inheritance starling.display.Sprite
Implements IMediaPlayerControl

Product Version : Feathers 2.2.0

A specialized slider that controls the volume of a media player that plays audio content.

See also

How to use the Feathers SoundPlayer component
How to use the Feathers VideoPlayer component


Public Properties
 PropertyDefined By
 InheriteddefaultTextEditorFactory : Function
[static] A function used by all UI controls that support text editor to create an ITextEditor instance.
FeathersControl
 InheriteddefaultTextRendererFactory : Function
[static] A function used by all UI controls that support text renderers to create an ITextRenderer instance.
FeathersControl
 Inheriteddepth : int
[read-only] The component's depth in the display list, relative to the stage.
FeathersControl
 InheritedexplicitHeight : Number
[read-only] The height value explicitly set by passing a value to the height setter or by calling the setSize() function.
FeathersControl
 InheritedexplicitMaxHeight : Number
[read-only] The maximum height value explicitly set by passing a value to the maxHeight setter.
FeathersControl
 InheritedexplicitMaxWidth : Number
[read-only] The maximum width value explicitly set by passing a value to the maxWidth setter.
FeathersControl
 InheritedexplicitMinHeight : Number
[read-only] The minimum height value explicitly set by passing a value to the minHeight setter.
FeathersControl
 InheritedexplicitMinWidth : Number
[read-only] The minimum width value explicitly set by passing a value to the minWidth setter.
FeathersControl
 InheritedexplicitWidth : Number
[read-only] The width value explicitly set by passing a value to the width setter or to the setSize() method.
FeathersControl
 InheritedfocusManager : IFocusManager
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The current focus manager for this component.
FeathersControl
 InheritedfocusOwner : IFocusDisplayObject
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Used for associating focusable display objects that are not direct children with an "owner" focusable display object, such as pop-ups.
FeathersControl
  globalStyleProvider : IStyleProvider
[static] The default IStyleProvider for all VolumeSlider components.
VolumeSlider
 Inheritedheight : Number
[override] The height of the component, in pixels.
FeathersControl
 InheritedincludeInLayout : Boolean
Determines if the ILayout should use this object or ignore it.
FeathersControl
 InheritedisCreated : Boolean
[read-only] Determines if the component has been initialized and validated for the first time.
FeathersControl
 InheritedisEnabled : Boolean
Indicates whether the control is interactive or not.
FeathersControl
 InheritedisFocusEnabled : Boolean
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. Determines if this component can receive focus.
FeathersControl
 InheritedisInitialized : Boolean
[read-only] Determines if the component has been initialized yet.
FeathersControl
 InheritedisQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list.
FeathersControl
 InheritedlayoutData : ILayoutData
Extra parameters associated with this display object that will be used by the layout algorithm.
FeathersControl
 InheritedliveDragging : Boolean = true
Determines if the slider dispatches the Event.CHANGE event every time the thumb moves, or only once it stops moving.
Slider
 InheritedmaxHeight : Number
The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 Inheritedmaximum : Number
The slider's value will not go higher than the maximum.
Slider
 InheritedmaximumTrackFactory : Function
A function used to generate the slider's maximum track sub-component.
Slider
 InheritedmaximumTrackProperties : Object
An object that stores properties for the slider's "maximum" track, and the properties will be passed down to the "maximum" track when the slider validates.
Slider
 InheritedmaxWidth : Number
The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
  mediaPlayer : IMediaPlayer
The media player that this component controls.
VolumeSlider
 InheritedminHeight : Number
The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 Inheritedminimum : Number
The slider's value will not go lower than the minimum.
Slider
 InheritedminimumTrackFactory : Function
A function used to generate the slider's minimum track sub-component.
Slider
 InheritedminimumTrackProperties : Object
An object that stores properties for the slider's "minimum" track, and the properties will be passed down to the "minimum" track when the slider validates.
Slider
 InheritedminTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's height is smaller than this value, it will be expanded.
FeathersControl
 InheritedminTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's width is smaller than this value, it will be expanded.
FeathersControl
 InheritedminWidth : Number
The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritednextTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The next object that will receive focus when the tab key is pressed when a focus manager is enabled.
FeathersControl
 Inheritedpage : Number
If the trackInteractionMode property is set to TrackInteractionMode.BY_PAGE, and the slider's track is touched, and the thumb is shown, the slider value will be incremented or decremented by the page value.
Slider
 InheritedpreviousTabFocus : IFocusDisplayObject
The implementation of this property is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface. The previous object that will receive focus when the tab key is pressed while holding shift when a focus manager is enabled.
FeathersControl
 InheritedrepeatDelay : Number
The time, in seconds, before actions are repeated.
Slider
 Inheritedstep : Number
As the slider's thumb is dragged, the value is snapped to a multiple of the step.
Slider
 InheritedstyleName : String
The concatenated styleNameList, with values separated by spaces.
FeathersControl
 InheritedstyleNameList : TokenList
[read-only] Contains a list of all "styles" assigned to this control.
FeathersControl
 InheritedstyleProvider : IStyleProvider
When a component initializes, a style provider may be used to set properties that affect the component's visual appearance.
FeathersControl
 InheritedthumbFactory : Function
A function used to generate the slider's thumb sub-component.
Slider
 InheritedthumbProperties : Object
An object that stores properties for the slider's thumb, and the properties will be passed down to the thumb when the slider validates.
Slider
 InheritedtoolTip : String
Text to display in a tool tip to when hovering over this component, if the ToolTipManager is enabled.
FeathersControl
 Inheritedvalue : Number
The value of the slider, between the minimum and maximum.
Slider
 Inheritedwidth : Number
[override] The width of the component, in pixels.
FeathersControl
Protected Properties
 PropertyDefined By
 InheritedactualHeight : Number = 0
The final height value that should be used for layout.
FeathersControl
 InheritedactualMinHeight : Number = 0
The final minimum height value that should be used for layout.
FeathersControl
 InheritedactualMinWidth : Number = 0
The final minimum width value that should be used for layout.
FeathersControl
 InheritedactualWidth : Number = 0
The final width value that should be used for layout.
FeathersControl
 InheriteddefaultStyleProvider : IStyleProvider
[read-only] When the FeathersControl constructor is called, the styleProvider property is set to this value.
FeathersControl
 InheritedmaximumTrack : DisplayObject
The maximum track sub-component.
Slider
 InheritedmaximumTrackStyleName : String = "feathers-slider-maximum-track"
The value added to the styleNameList of the maximum track.
Slider
 InheritedminimumTrack : DisplayObject
The minimum track sub-component.
Slider
 InheritedminimumTrackStyleName : String = "feathers-slider-minimum-track"
The value added to the styleNameList of the minimum track.
Slider
 Inheritedthumb : DisplayObject
The thumb sub-component.
Slider
 InheritedthumbStyleName : String = "feathers-slider-thumb"
The value added to the styleNameList of the thumb.
Slider
Public Methods
 MethodDefined By
  
Constructor.
VolumeSlider
 Inherited
getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle
[override] Feathers components use an optimized getBounds() implementation that may sometimes behave differently than regular Starling display objects.
FeathersControl
 Inherited
hideFocus():void
The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.
FeathersControl
 Inherited
If the component has not yet initialized, initializes immediately.
FeathersControl
 Inherited
invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending.
FeathersControl
 Inherited
isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not.
FeathersControl
 Inherited
move(x:Number, y:Number):void
Sets both the x and the y positions of the control in a single function call.
FeathersControl
 Inherited
Resets the styleProvider property to its default value, which is usually the global style provider for the component.
FeathersControl
 Inherited
setSize(width:Number, height:Number):void
Sets both the width and the height of the control in a single function call.
FeathersControl
 Inherited
showFocus():void
The implementation of this method is provided for convenience, but it cannot be used unless a subclass implements the IFocusDisplayObject interface.
FeathersControl
 Inherited
validate():void
Immediately validates the display object, if it is invalid.
FeathersControl
Protected Methods
 MethodDefined By
 Inherited
If the component's dimensions have not been set explicitly, it will measure its content and determine an ideal size for itself.
Slider
 Inherited
clearInvalidationFlag(flag:String):void
Clears an invalidation flag.
FeathersControl
 Inherited
Creates and adds the maximumTrack sub-component and removes the old instance, if one exists.
Slider
 Inherited
Creates and adds the minimumTrack sub-component and removes the old instance, if one exists.
Slider
 Inherited
Creates and adds the thumb sub-component and removes the old instance, if one exists.
Slider
 Inherited
draw():void
Override to customize layout and to adjust properties of children.
FeathersControl
 Inherited
focusInHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_IN that may be overridden in subclasses to perform additional actions when the component receives focus.
FeathersControl
 Inherited
focusOutHandler(event:Event):void
Default event handler for FeathersEventType.FOCUS_OUT that may be overridden in subclasses to perform additional actions when the component loses focus.
FeathersControl
 Inherited
The next style that is set will not be restricted.
FeathersControl
 Inherited
initialize():void
Called the first time that the UI control is added to the stage, and you should override this function to customize the initialization process.
FeathersControl
 Inherited
processStyleRestriction(key:Object):Boolean
Used by setters for properties that are considered "styles" to determine if the setter has been called directly on the component or from a style provider.
FeathersControl
 Inherited
Updates the focus indicator skin by showing or hiding it and adjusting its position and dimensions.
FeathersControl
 Inherited
saveMeasurements(width:Number, height:Number, minWidth:Number = 0, minHeight:Number = 0):Boolean
Saves the dimensions and minimum dimensions calculated for the component.
FeathersControl
 Inherited
setInvalidationFlag(flag:String):void
Sets an invalidation flag.
FeathersControl
 Inherited
setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean
Sets the width and height of the control, with the option of invalidating or not.
FeathersControl
Events
 Event Summary Defined By
 InheritedDispatched when the user starts dragging the slider's thumb or track.Slider
 InheritedDispatched when the slider's value changes.Slider
 InheritedDispatched after the component has validated for the first time.FeathersControl
 InheritedDispatched when the user stops dragging the slider's thumb or track.Slider
 InheritedDispatched after initialize() has been called, but before the first time that draw() has been called.FeathersControl
 InheritedDispatched when the width or height of the control changes.FeathersControl
Styles
 StyleDefined By
 Inherited
A style name to add to the slider's maximum track sub-component.
Slider
 Inherited
A style name to add to the slider's minimum track sub-component.
Slider
 Inherited
A style name to add to the slider's thumb sub-component.
Slider
 Inherited
direction : String
Determines if the slider's thumb can be dragged horizontally or vertically.
Slider
 Inherited
focusIndicatorSkin : DisplayObject
If this component supports focus, this optional skin will be displayed above the component when showFocus() is called.
FeathersControl
 Inherited
focusPadding : Number
Quickly sets all focus padding properties to the same value.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's bottom edge and the bottom edge of the focus indicator skin.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's left edge and the left edge of the focus indicator skin.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's right edge and the right edge of the focus indicator skin.
FeathersControl
 Inherited
The minimum space, in pixels, between the object's top edge and the top edge of the focus indicator skin.
FeathersControl
 Inherited
The space, in pixels, between the maximum position of the thumb and the maximum edge of the track.
Slider
 Inherited
The space, in pixels, between the minimum position of the thumb and the minimum edge of the track.
Slider
 Inherited
showThumb : Boolean
Determines if the thumb should be displayed.
Slider
 Inherited
thumbOffset : Number
Offsets the position of the thumb by a certain number of pixels in a direction perpendicular to the track.
Slider
 Inherited
Determines how the slider's value changes when the track is touched.
Slider
 Inherited
Determines how the minimum and maximum track skins are positioned and sized.
Slider
 Inherited
Determines how the minimum and maximum track skins are positioned and sized.
Slider
Public Constants
 ConstantDefined By
  DEFAULT_CHILD_STYLE_NAME_MAXIMUM_TRACK : String = "feathers-volume-slider-maximum-track"
[static] The default value added to the styleNameList of the maximum track.
VolumeSlider
  DEFAULT_CHILD_STYLE_NAME_MINIMUM_TRACK : String = "feathers-volume-slider-minimum-track"
[static] The default value added to the styleNameList of the minimum track.
VolumeSlider
  DEFAULT_CHILD_STYLE_NAME_THUMB : String = "feathers-volume-slider-thumb"
[static] The default value added to the styleNameList of the thumb.
VolumeSlider
 InheritedINVALIDATION_FLAG_ALL : String = "all"
[static] Flag to indicate that everything is invalid and should be redrawn.
FeathersControl
 InheritedINVALIDATION_FLAG_DATA : String = "data"
[static] Invalidation flag to indicate that the primary data displayed by the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_FOCUS : String = "focus"
[static] Invalidation flag to indicate that the focus of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_LAYOUT : String = "layout"
[static] Invalidation flag to indicate that the layout of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SCROLL : String = "scroll"
[static] Invalidation flag to indicate that the scroll position of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SELECTED : String = "selected"
[static] Invalidation flag to indicate that the selection of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SIZE : String = "size"
[static] Invalidation flag to indicate that the dimensions of the UI control have changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SKIN : String = "skin"
[static] Invalidation flag to indicate that the skin of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STATE : String = "state"
[static] Invalidation flag to indicate that the state has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STYLES : String = "styles"
[static] Invalidation flag to indicate that the styles or visual appearance of the UI control has changed.
FeathersControl
Property Detail
globalStyleProviderproperty
public static var globalStyleProvider:IStyleProvider

The default IStyleProvider for all VolumeSlider components.

The default value is null.

See also

mediaPlayerproperty 
mediaPlayer:IMediaPlayer

The media player that this component controls.


Implementation
    public function get mediaPlayer():IMediaPlayer
    public function set mediaPlayer(value:IMediaPlayer):void
Constructor Detail
VolumeSlider()Constructor
public function VolumeSlider()

Constructor.

Constant Detail
DEFAULT_CHILD_STYLE_NAME_MAXIMUM_TRACKConstant
public static const DEFAULT_CHILD_STYLE_NAME_MAXIMUM_TRACK:String = "feathers-volume-slider-maximum-track"

The default value added to the styleNameList of the maximum track.

See also

DEFAULT_CHILD_STYLE_NAME_MINIMUM_TRACKConstant 
public static const DEFAULT_CHILD_STYLE_NAME_MINIMUM_TRACK:String = "feathers-volume-slider-minimum-track"

The default value added to the styleNameList of the minimum track.

See also

DEFAULT_CHILD_STYLE_NAME_THUMBConstant 
public static const DEFAULT_CHILD_STYLE_NAME_THUMB:String = "feathers-volume-slider-thumb"

The default value added to the styleNameList of the thumb.

See also