A style name to add to the button's volume slider sub-component. Typically used by a theme to provide different styles to different buttons.

In the following example, a custom volume slider style name is passed to the button:

button.customVolumeSliderStyleName = "my-custom-volume-slider";

In your theme, you can target this sub-component style name to provide different styles than the default:

getStyleProviderForClass( VolumeSlider ).setFunctionForStyleName( "my-custom-volume-slider", setCustomVolumeSliderStyles );

The default value is null.

See also

The default IStyleProvider for all MuteToggleButton components.

The default value is null.

See also

The media player that this component controls.

Determines if a VolumeSlider component is displayed as a pop-up when hovering over the toggle button. This property is intended for use on desktop platforms only. On mobile platforms, Starling does not dispatch events for hover, so the volume slider will not be shown.

In the following example, showing the volume slider is enabled:

button.showVolumeSliderOnHover = true;

The default value is false.

See also

A function used to generate the button's pop-up volume slider sub-component. The volume slider must be an instance of VolumeSlider. This factory can be used to change properties on the volume slider when it is first created. For instance, if you are skinning Feathers components without a theme, you might use this factory to set skins and other styles on the volume slider.

The function should have the following signature:

function():VolumeSlider

In the following example, a custom volume slider factory is passed to the button:

button.volumeSliderFactory = function():VolumeSlider
{
    var popUpSlider:VolumeSlider = new VolumeSlider();
    popUpSlider.direction = Direction.VERTICAL;
    return popUpSlider;
};

The default value is null.

See also

An object that stores properties for the button's pop-up volume slider sub-component, and the properties will be passed down to the volume slider when the button validates. For a list of available properties, refer to feathers.media.VolumeSlider.

If the subcomponent has its own subcomponents, their properties can be set too, using attribute @ notation. For example, to set the skin on the thumb which is in a SimpleScrollBar, which is in a List, you can use the following syntax:

list.verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);

Setting properties in a volumeSliderFactory function instead of using volumeSliderProperties will result in better performance.

In the following example, the volume slider properties are passed to the button:

button.volumeSliderProperties.direction = Direction.VERTICAL;

The default value is null.

See also

The default value added to the styleNameList of the pop-up volume slider. This variable is protected so that sub-classes can customize the volume slider style name in their constructors instead of using the default style name defined by DEFAULT_CHILD_STYLE_NAME_VOLUME_SLIDER.

To customize the volume slider style name without subclassing, see customVolumeSliderStyleName.

See also

Constructor.

Closes the pop-up volume slider, if it is open.

Creates and adds the volume slider sub-component and removes the old instance, if one exists.

Meant for internal use, and subclasses may override this function with a custom implementation.

See also

Disposes the display object.

Opens the pop-up volume slider, if it isn't already open.

Dispatched when the pop-up volume slider is closed.

The properties of the event object have the following values:

Dispatched when the pop-up volume slider is opened.

The properties of the event object have the following values:

A manager that handles the details of how to display the pop-up volume slider.

In the following example, a pop-up content manager is provided:

button.popUpContentManager = new CalloutPopUpContentManager();

The default value is null.

The default value added to the styleNameList of the pop-up volume slider.

See also