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(name, context, options)
Field Summary
Field Attributes Field Name and Description
 
Reset the constructor.
Fields borrowed from class minplayer.plugin:
lock, name, options, pluginReady, queue, triggered
Method Summary
Method Attributes Method Name and Description
 
 
getDisplay(context, options)
Returns the display for this component.
 
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.
Methods borrowed from class minplayer.plugin:
addPlugin, bind, checkQueue, destroy, get, loadPlugins, ready, trigger, unbind
Class Detail
minplayer.display(name, context, options)
Parameters:
{string} name
The name of this plugin.
{object} context
The jQuery context this component resides.
{object} options
The options for this component.
Field Detail
constructor
Reset the constructor.
Method Detail
construct()
See:
minplayer.plugin.construct

{object} getDisplay(context, options)
Returns the display for this component.
Parameters:
{object} context
The original context.
{object} options
The options for this component.
Returns:
{object} The jQuery context for this display.

{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.

Documentation generated by JsDoc Toolkit 2.4.0 on Sun Feb 26 2012 19:19:18 GMT-0600 (CST)