dojox/av/widget/VolumeButton.js

• Provides:

  • dojox.av.widget.VolumeButton

• Requires:

  • dijit._Widget in common
  • dijit._Templated in common
  • dijit.form.Button in common

• dojox.av.widget.VolumeButton

  • type

    Function

  • chains:
    • dijit._Widget: (prototype)
    • dijit._Templated.prototype: (prototype)
    • dijit._Widget: (call)
    • dijit._Templated: (call)
  • summary

    A volume widget to use with dojox.av.widget.Player

  • description

    Controls and displays the volume of the media. This widget
    opens a slider on click that is used to adjust the volume.
    The icon changes according to the volume level.

• dojox.av.widget.VolumeButton.templateString

  • type

    Object

• dojox.av.widget.VolumeButton.postCreate

  • summary

    Initialize the widget.

  • type

    Function

• dojox.av.widget.VolumeButton.handleWidth

• dojox.av.widget.VolumeButton.width

• dojox.av.widget.VolumeButton.slotWidth

  • type

    Number

• dojox.av.widget.VolumeButton.volumeSlider

  • type

    Object

• dojox.av.widget.VolumeButton.setMedia

  • parameters:
    • med: (typeof Object)
  • summary

    A common method to set the media in all Player widgets.
    May do connections and initializations.

  • type

    Function

• dojox.av.widget.VolumeButton.media

• dojox.av.widget.VolumeButton.updateIcon

  • parameters:
    • vol: (typeof Float)
  • summary

    Changes the icon on the button according to volume level.

  • type

    Function

• dojox.av.widget.VolumeButton.onShowVolume

  • parameters:
    • evt: (typeof DOMEvent)
  • summary

    Shows the volume slider.

  • type

    Function

• dojox.av.widget.VolumeButton.showing

  • type

    bool

• dojox.av.widget.VolumeButton.x

  • type

    Number

• dojox.av.widget.VolumeButton.clickOff

  • type

    Object

• dojox.av.widget.VolumeButton.onDocClick

  • parameters:
    • evt: (typeof DOMEvent)
  • summary

    Fired on document.onmousedown. Checks if clicked inside
    of this widget or not.

  • type

    Function

• dojox.av.widget.VolumeButton.onHideVolume

  • summary

    Hides volume slider.

  • type

    Function

• dojox.av.widget.VolumeButton.onDrag

  • parameters:
    • evt: (typeof DOMEvent)
  • summary

    Fired on mousemove. Updates volume and position of
    slider handle.

  • type

    Function

• dojox.av.widget.VolumeButton.startDrag

  • summary

    Fired on mousedown of the slider handle.

  • type

    Function

• dojox.av.widget.VolumeButton.isDragging

  • type

    bool

• dojox.av.widget.VolumeButton.cmove

  • type

    Object

• dojox.av.widget.VolumeButton.cup

  • type

    Object

• dojox.av.widget.VolumeButton.endDrag

  • summary

    Fired on mouseup of the slider handle.

  • type

    Function

• dojox.av.widget.VolumeButton.handleOver

  • summary

    Highlights the slider handle on mouseover, and
    stays highlighted during drag.

  • type

    Function

• dojox.av.widget.VolumeButton.handleOut

  • summary

    Unhighlights handle onmouseover, or on endDrag.

  • type

    Function

• dojox.av.widget.VolumeButton._getVolumeDim

  • summary

    Gets dimensions of slider background node.
    Only uses dojo.coords once, unless the page
    or player is resized.

  • type

    Function

• dojox.av.widget.VolumeButton._domCoords

  • type

    Object

• dojox.av.widget.VolumeButton._getHandleDim

  • summary

    Gets dimensions of slider handle.
    Only uses dojo.marginBox once.

  • type

    Function

• dojox.av.widget.VolumeButton._handleCoords

  • type

    Object

• dojox.av.widget.VolumeButton.onResize

  • parameters:
    • playerDimensions: (typeof Object)
  • summary

    Fired on player resize. Zeros dimensions
    so that it can be calculated again.

  • type

    Function

• dojox.av.widget

  • type

    Object

• dojox.av

  • type

    Object

• dojox

  • type

    Object