qnx.fuse.ui.slider.VolumeSlider

VolumeSlider

Properties | Methods | Events | Examples


Packageqnx.fuse.ui.slider
Classpublic class VolumeSlider
InheritanceVolumeSlider Inheritance Slider Inheritance SliderBase Inheritance UIComponent Inheritance flash.display.MovieClip

The VolumeSlider component provides the functionality for implementing a volume control.

The VolumeSlider component is fundamentally similar to the Slider component except that it implemements a customized look and feel:

A volume slider control.



Class information:
BlackBerry 10 Version:   10.0.0

View the examples

See also

Slider



Public Properties

 PropertyDefined By
 Inheritedactive : Boolean
Gets or sets a value that determines whether the control is active and enabled.
Slider
 InheritedanimateToValue : Boolean
When set to true, the Slider will animate when setting the value property on the Slider.
Slider
  audioBoostEnabled : Boolean
Gets or sets a value that enables AudioBoost visuals on the VolumeSlider.
VolumeSlider
 InheritedcontextActions : Vector.<ActionSet>
Gets or Sets a Vector of ActionSet objects.
UIComponent
 InheritedcontextMultiSelectText : String
Gets or Sets a String to be displayed when showing the Multi Select Context Menu.
UIComponent
 InheritedcurrentTheme : String
[read-only] Returns the current theme this component is styled with.
UIComponent
 InheriteddoubleClickIncrement : Number
Specifies a percentage between 0.0 and 1.0 that the slider should move when double clicked.
SliderBase
 InheritedexplicitHeight : Number
[read-only] Returns the explicit height (actual height, in pixels) of the UI component.
UIComponent
 InheritedexplicitWidth : Number
[read-only] Returns the explicit width (actual width, in pixels) of the UI component.
UIComponent
  iconPadding : int
Gets or sets the padding between the icon and slider.
VolumeSlider
 Inheritedid : String
The id is a name for the component that can be used in CSS using the # selector.
UIComponent
 InheritedincludeInLayout : Boolean
Specifies whether or not the component should be included in its parent container's layout.
UIComponent
 InheritedlayoutData : Object
Gets or sets the layoutData.
UIComponent
 Inheritedlocale : String
Gets or sets the current locale of the component.
UIComponent
 Inheritedmaximum : Number
Gets or sets the maximum value of the slider.
Slider
  maxUnboostedAudioLevel : Number
Gets or sets the maximum value of the VolumeSlider when audioBoostEnabled is set to true.
VolumeSlider
 InheritedminHeight : Number
Gets or sets the minimum preferred height of the control.
UIComponent
 Inheritedminimum : Number
Gets or sets the minimum value of the slider.
Slider
 InheritedminWidth : Number
Gets or sets the minimum preferred width of the control.
UIComponent
  showVolumeIcon : Boolean
Gets or sets wether the volume icon should be shown or not.
VolumeSlider
 InheritedstyleChildren : Boolean
Allows you to style the children of this component with CSS.
UIComponent
 Inheritedvalue : Number
Gets or sets the current value of the slider.
Slider

Protected Properties

 PropertyDefined By
 InheritedaccessibilityImplimentationClass : Class
UIComponent
  cssID : String
[override] [read-only] Returns the CSS ID of the component.
VolumeSlider
 InheritedexplicitLocale : Boolean
Set to true when the locale property has been set externally.
UIComponent
 InheritedinternalID : String
The Component's Id used for styling.
UIComponent
 InheritedlongPressEnabled : Boolean
Specifies whether the UIComponent can detect a long press.
UIComponent

Public Methods

 MethodDefined By
  
Creates a VolumeSlider instance.
VolumeSlider
 Inherited
Cancels a long press from occuring on the component.
UIComponent
 Inherited
childChanged(resizedChild:DisplayObject = null):Boolean
Notifies the UIComponent that one or more of its children has changed in a manner that may affect this object's layout.
UIComponent
 Inherited
destroy():void
Call this method when you want to have your object collected by the garbage collector.
UIComponent
 Inherited
Returns the CSS selector for the object, composing it from its position in the display hierarchy and an optional ID selector.
UIComponent
 Inherited
Returns the size options for the given control.
UIComponent
 Inherited
Calling this method results in a call to the components validateDisplayList() method before the display list is rendered.
UIComponent
 Inherited
Calling this method results in a call to the components validateProperties() method before the display list is rendered.
UIComponent
 Inherited
measure(availableWidth:Number, availableHeight:Number):LayoutMeasurement
This method calls doMeasure() in order to calculate the preferred size of the control.
UIComponent
 Inherited
setActualSize(w:Number, h:Number):void
Sets the width and height of the object without setting the explicitWidth and explicitHeight.
UIComponent
  
setAudioBoostFillSkin(linkage:Object):void
Sets the audio boost fill skin for the slider.
VolumeSlider
  
setAudioBoostTrackSkin(linkage:Object):void
Sets the audio boost skin for the track of the slider.
VolumeSlider
 Inherited
setFillSkin(skin:Object):void
Sets the fill skin for the slider.
SliderBase
 Inherited
setLayoutBounds(bounds:Rectangle):void
Sets the receiver's size and location to the rectangular area specified by the arguments.
UIComponent
 Inherited
setPosition(x:Number, y:Number):void
Sets the x and y position of the component.
UIComponent
 Inherited
setThumbSkin(skin:Object):void
Sets the skin for the slider thumb button.
SliderBase
 Inherited
setTrackSkin(skin:Object):void
Sets the skin for the track of the slider.
SliderBase
 Inherited
updateDefaultLocale(updateChildren:Boolean = true):void
Updates the locale property to be the same as the locale of the device.
UIComponent
 Inherited
Lets a component that contains text know that it should update its font formats as the font settings have changed.
UIComponent
 Inherited
Validates the display list of the component by calling the updateDisplayList().
UIComponent
 Inherited
Validates the component immediately by calling validateProperties(), validateSizes(), and validateDisplayList() if necessary.
UIComponent
 Inherited
Validates the properties of the component by calling the commitProperties() method.
UIComponent

Protected Methods

 MethodDefined By
 Inherited
Adds the listeners for actually dragging and for when dragging is to stop.
SliderBase
 Inherited
Adds the listeners responsible for starting to Drag the Thumb or Drag along the Track.
SliderBase
 Inherited
allowShowContextMenu(target:IEventDispatcher):Boolean
When the user presses on the component this method is called with the object that dispatched the event.
UIComponent
 Inherited
Process properties of the component.
UIComponent
 Inherited
Process the state of the component.
UIComponent
 Inherited
Style the component after the style has changed.
UIComponent
  
createAudioBoostTrackSkin(linkage:Object):void
Creates the Audio Boost Track Skin based on the passed in linkage object.
VolumeSlider
 Inherited
createFill(linkage:Object):void
Creates the fill skin based on the passed in linkage object.
SliderBase
 Inherited
Creates an empty sprite which will be used for detecting clicks within the bounds of the slider to allow for dragging when not touching the thumb.
SliderBase
 Inherited
createThumb(linkage:Object):void
Create the Thumb Skin based on the passed in linkage object.
SliderBase
 Inherited
createTrack(linkage:Object):void
Creates the Track Skin based on the passed in linkage object.
SliderBase
 Inherited
doMeasure(availableWidth:Number, availableHeight:Number):LayoutMeasurement
Performs a measurement on the control, and returns a LayoutMeasurement instance containing the available width and height within the layout.
UIComponent
 Inherited
excemptFromCSSStyling(target:*, property:String = null):void
Exempts a property on an object from being styled by CSS.
UIComponent
 Inherited
flushCache():void
Invoked as part of parentLayoutChanged.
UIComponent
 Inherited
getStyleApplier():Function
A style applier is a method that gets called every time a property from the stylesheet should be applied to the component.
UIComponent
 Inherited
onAdded():void
Called when the instance is added to the stage.
UIComponent
 Inherited
Is called when a user is no longer long pressing on the component.
UIComponent
 Inherited
Is called when a user long presses on the component.
UIComponent
 Inherited
onRemoved():void
Called when the instance is removed from the stage.
UIComponent
 Inherited
Invalidates the parent's size and display list if includeInLayout property is set to true.
UIComponent
 Inherited
Calling this function will refresh the ContextMenu with whatever actions were set by contextActions.
UIComponent
 Inherited
Removes the listeners for actually dragging and for when dragging is to stop.
SliderBase
 Inherited
Removes the listeners responsible for starting to Drag the Thumb or Drag along the Track.
SliderBase
 Inherited
Shows the context menu if there are contextActions associated with the control.
UIComponent
 Inherited
styleState():void
Style the component after state has changed.
UIComponent
 Inherited
Called when the position of the thumb on the x axis has changed.
SliderBase
 Inherited
Called when the thumb has been pressed by the user.
SliderBase
 Inherited
Called when the thumb has been released by the user.
SliderBase
 Inherited
Called when the track has been double clicked by the user.
SliderBase
 Inherited
Called when the track has been pressed by the user.
SliderBase
 Inherited
Updates the left and right constraints for determining the thumb position.
SliderBase
 Inherited
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Sets the size and position of the children of the component.
UIComponent
 Inherited
updateFill():void
Updates the Fill skin to take up a certain width or percentage of the Slider.
SliderBase
 Inherited
Updates the Hit Sprite to be as large as the bounds of the Slider.
SliderBase

Events

 Event Summary Defined By
 InheritedDispatched when an action in the Context Menu is selected.UIComponent
 InheritedDispatched when the Context Menu has closed to the DISMISSED state.UIComponent
 InheritedDispatched when the ContextMenu is closing to the DISMISSED state.UIComponent
 InheritedDispatched when the Context Menu has opened to the PEEK or EXPANDED state.UIComponent
 InheritedDispatched when the ContextMenu is opening from the DISMISSED state.UIComponent
 InheritedDispatched when the CrossCut multiselect has been canceled.UIComponent
 InheritedDispatched when a slide event has ended.Slider
 InheritedDispatched when a slide event has started.Slider
 InheritedDispatched when the value of the slider has changed during a slide action.Slider

Protected Constants

 ConstantDefined By
 InheritedANIMATION_TIME : Number = 0.5
[static]
Slider

Property Detail

audioBoostEnabled


audioBoostEnabled:Boolean

Gets or sets a value that enables AudioBoost visuals on the VolumeSlider. When set to true, the slider is allowed to travel to its maximum value. Otherwise, its maximum is clamped at maxUnboostedAudioLevel.


Implementation

public function get audioBoostEnabled():Boolean
public function set audioBoostEnabled(value:Boolean):void

cssID


cssID:String  [read-only]
[override]

Returns the CSS ID of the component. The CSS ID is used for identifying the type of component in CSS.

The default value is VolumeSlider.


Implementation

protected function get cssID():String

iconPadding


iconPadding:int

Gets or sets the padding between the icon and slider.


Implementation

public function get iconPadding():int
public function set iconPadding(value:int):void

maxUnboostedAudioLevel


maxUnboostedAudioLevel:Number

Gets or sets the maximum value of the VolumeSlider when audioBoostEnabled is set to true.


Implementation

public function get maxUnboostedAudioLevel():Number
public function set maxUnboostedAudioLevel(value:Number):void

showVolumeIcon


showVolumeIcon:Boolean

Gets or sets wether the volume icon should be shown or not.


Implementation

public function get showVolumeIcon():Boolean
public function set showVolumeIcon(value:Boolean):void

Constructor Detail

VolumeSlider()


public function VolumeSlider()

Creates a VolumeSlider instance.

Method Detail

createAudioBoostTrackSkin()


protected function createAudioBoostTrackSkin(linkage:Object):void

Creates the Audio Boost Track Skin based on the passed in linkage object.

The linkage parameter can be one of three different types: Class, String, or DisplayObject instance.

  • If you pass in a Class, a new instance of that class is created.
  • If you pass in a String, flash.utils.getDefinitionByName will be used to try and determine a class to use.
  • If you pass in a DisplayObject instance it is used as the skin the x and y values of the instance are set to 0.

Parameters

linkage:Object — A Class, String, or DisplayObject instance.

setAudioBoostFillSkin()


public function setAudioBoostFillSkin(linkage:Object):void

Sets the audio boost fill skin for the slider. The audio boost fill skin is the area of the track to the left of the slider thumb button (in a horizontal slider) that represents the current value of the slider when the value of the slider is past the maxUnboostedAudioLevel.

The linkage parameter can be one of three different types: Class, String, or DisplayObject instance.

  • If you pass in a Class, a new instance of that class is created.
  • If you pass in a String, flash.utils.getDefinitionByName will be used to try and determine a class to use.

Note: Do not pass in an instance of a skin class. This may cause unexpected behavior.

Parameters

linkage:Object — The fill skin to set.

setAudioBoostTrackSkin()


public function setAudioBoostTrackSkin(linkage:Object):void

Sets the audio boost skin for the track of the slider. The audio boost track is the vertical or horizontal line that the thumb button moves along when audio boost is enabled.

The linkage parameter can be one of three different types: Class, String, or DisplayObject instance.

  • If you pass in a Class, a new instance of that class is created.
  • If you pass in a String, flash.utils.getDefinitionByName will be used to try and determine a class to use.

Note: Do not pass in an instance of a skin class. This may cause unexpected behavior.

Parameters

linkage:Object — A Class or String linkage.

Examples

In the following example, a VolumeSlider instance is created and added to the stage. Event listeners are added to listen for slider movement events.
package
{
    import flash.display.Sprite;
    
    import qnx.fuse.ui.events.SliderEvent;
    import qnx.fuse.ui.slider.VolumeSlider;
    
    [SWF(height="1280", width="768", frameRate="60", backgroundColor="#FFFFFF")]
    public class sliderSample extends Sprite
    {
        private var myVSlider:VolumeSlider;
        
        public function sliderSample()
        {
            initializeUI();
        }
        
        private function initializeUI():void
        {
            myVSlider = new VolumeSlider();
            myVSlider.setPosition(300, 300);
            myVSlider.minimum = 0;
            myVSlider.maximum = 100;
            myVSlider.value = 50;
            // listen to the when the slider moves
            myVSlider.addEventListener( SliderEvent.MOVE, sliderChange );
            // listen to the when the slider starts to move
            myVSlider.addEventListener( SliderEvent.START, sliderStart );
            // listen to the end of the slider event
            myVSlider.addEventListener( SliderEvent.END, sliderStop );
            this.addChild( myVSlider );
        }
        
        private function sliderChange( event:SliderEvent ):void
        {
            var newlevel:int = Math.round( event.target.value );
            trace( "slider value: ", newlevel );
        }
        
        private function sliderStart( event:SliderEvent ):void
        {
            var newlevel:int = Math.round( event.target.value );
            trace( "started moving at: ", newlevel );
        }
        
        private function sliderStop( event:SliderEvent ):void
        {
            var newlevel:int = Math.round( event.target.value );
            trace( "stopped moving at: ", newlevel );
        }
    }
}
     




comments powered by Disqus