Class Index | File Index

Classes


Class minplayer.display


Extends minplayer.plugin.
Base class used to provide the display and options for any component deriving from this class. Components who derive are expected to provide the elements that they define by implementing the getElements method.
Defined in: minplayer.display.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
minplayer.display(context, options)
Field Summary
Field Attributes Field Name and Description
 
Reset the constructor.
Method Summary
Method Attributes Method Name and Description
 
bind(types, data, fn)
Bind to a media event.
 
 
Returns all the jQuery elements that this component uses.
 
getScaledRect(ratio, rect)
Returns a scaled rectangle provided a ratio and the container rect.
 
Returns if this component is valid and exists within the DOM.
 
Called when the window resizes.
 
trigger(type, data)
Trigger a media event.
Methods borrowed from class minplayer.plugin:
addPlugin, destroy, eachPlugin, getPlugin, loadPlugins, setPlayer
Class Detail
minplayer.display(context, options)
Parameters:
{object} context
The jQuery context this component resides.
{object} options
The options for this component.
Field Detail
constructor
Reset the constructor.
Method Detail
{object} bind(types, data, fn)
Bind to a media event.
Parameters:
{string} types
The event type.
{object} data
The data to bind with the event.
{function} fn
The callback function.
Returns:
{object} The jQuery prototype.

construct()
See:
minplayer.plugin.construct

{object} getElements()
Returns all the jQuery elements that this component uses.
Returns:
{object} An object which defines all the jQuery elements that this component uses.

{object} getScaledRect(ratio, rect)
Returns a scaled rectangle provided a ratio and the container rect.
Parameters:
{number} ratio
The width/height ratio of what is being scaled.
{object} rect
The bounding rectangle for scaling.
Returns:
{object} The Rectangle object of the scaled rectangle.

{boolean} isValid()
Returns if this component is valid and exists within the DOM.
Returns:
{boolean} TRUE if the plugin display is valid.

onResize()
Called when the window resizes.

{object} trigger(type, data)
Trigger a media event.
Parameters:
{string} type
The event type.
{object} data
The event data object.
Returns:
{object} The jQuery prototype.

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Feb 10 2012 02:13:35 GMT+0100 (CET)