You are here

Home » API reference » HTML5 Media 7

JsDoc Reference - minplayer.display in HTML5 Media 7


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, queue)
Field Summary
Field Attributes Field Name and Description
 
constructor
Reset the constructor.
 
onResize
Called when the window resizes.
Fields borrowed from class minplayer.plugin:
active, context, lock, name, options, pluginReady, queue, triggered
Method Summary
Method Attributes Method Name and Description
 
construct()
 
fullscreen(full)
Make this display element go fullscreen.
 
fullScreenElement()
Gets the full screen element.
 
getDisplay()
Returns the display for this component.
 
getElements()
Returns all the jQuery elements that this component uses.
 
getScaledRect(ratio, rect)
Returns a scaled rectangle provided a ratio and the container rect.
 
hide(element)
Wrapper around hide that will always not show.
 
isFullScreen()
Checks to see if we are in fullscreen mode.
 
onFocus(focus)
Determines if the player is in focus or not.
 
toggleFullScreen()
Toggle fullscreen.
Methods borrowed from class minplayer.plugin:
addPlugin, bind, checkQueue, create, destroy, get, isValid, poll, ready, trigger, unbind
Class Detail
minplayer.display(name, context, options, queue)
Parameters:
{string} name
The name of this plugin.
{object} context
The jQuery context this component resides.
{object} options
The options for this component.
{object} queue
The event queue to pass events around.
Field Detail
constructor
Reset the constructor.
onResize
Called when the window resizes.
Method Detail
construct()
See:
minplayer.plugin.construct
fullscreen(full)
Make this display element go fullscreen.
Parameters:
{boolean} full
Tell the player to go into fullscreen or not.
{object} fullScreenElement()
Gets the full screen element.
Returns:
{object} The display to be used for full screen support.
{object} getDisplay()
Returns the display 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.
hide(element)
Wrapper around hide that will always not show.
Parameters:
{object} element
The element you wish to hide.
{boolean} isFullScreen()
Checks to see if we are in fullscreen mode.
Returns:
{boolean} TRUE - fullscreen, FALSE - otherwise.
onFocus(focus)
Determines if the player is in focus or not.
Parameters:
{boolean} focus
If the player is in focus.
toggleFullScreen()
Toggle fullscreen.
Documentation generated by JsDoc Toolkit 2.4.0 on Thu Oct 04 2012 19:54:20 GMT-0700 (PDT)

File

player/doc/symbols/minplayer.display.html
View source 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>JsDoc Reference - minplayer.display</title>

		<style type="text/css">
			/* default.css */
body
{
	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
	width: 800px;
}

.header
{
	clear: both;
	background-color: #ccc;
	padding: 8px;
}

h1
{
	font-size: 150%;
	font-weight: bold;
	padding: 0;
	margin: 1em 0 0 .3em;
}

hr
{
	border: none 0;
	border-top: 1px solid #7F8FB1;
	height: 1px;
}

pre.code
{
	display: block;
	padding: 8px;
	border: 1px dashed #ccc;
}

#index
{
	margin-top: 24px;
	float: left;
	width: 160px;
	position: absolute;
	left: 8px;
	background-color: #F3F3F3;
	padding: 8px;
}

#content
{
	margin-left: 190px;
	width: 600px;
}

.classList
{
	list-style-type: none;
	padding: 0;
	margin: 0 0 0 8px;
	font-family: arial, sans-serif;
	font-size: 1em;
	overflow: auto;
}

.classList li
{
	padding: 0;
	margin: 0 0 8px 0;
}

.summaryTable { width: 100%; }

h1.classTitle
{
	font-size:170%;
	line-height:130%;
}

h2 { font-size: 110%; }
caption, div.sectionTitle
{
	background-color: #7F8FB1;
	color: #fff;
	font-size:130%;
	text-align: left;
	padding: 2px 6px 2px 6px;
	border: 1px #7F8FB1 solid;
}

div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }

.summaryTable td
{
	vertical-align: top;
	padding: 4px;
	border-bottom: 1px #7F8FB1 solid;
	border-right: 1px #7F8FB1 solid;
}

/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
	border-left: 1px #7F8FB1 solid;
	width: 140px;
	text-align: right;
}

td.attributes, .fixedFont
{
	line-height: 15px;
	color: #002EBE;
	font-family: "Courier New",Courier,monospace;
	font-size: 13px;
}

.summaryTable td.nameDescription
{
	text-align: left;
	font-size: 13px;
	line-height: 15px;
}

.summaryTable td.nameDescription, .description
{
	line-height: 15px;
	padding: 4px;
	padding-left: 4px;
}

.summaryTable { margin-bottom: 8px; }

ul.inheritsList
{
	list-style: square;
	margin-left: 20px;
	padding-left: 0;
}

.detailList {
	margin-left: 20px; 
	line-height: 15px;
}
.detailList dt { margin-left: 20px; }

.detailList .heading
{
	font-weight: bold;
	padding-bottom: 6px;
	margin-left: 0;
}

.light, td.attributes, .light a:link, .light a:visited
{
	color: #777;
	font-style: italic;
}

.fineprint
{
	text-align: right;
	font-size: 10px;
}
		</style>
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
</div>
		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
	<li><a href="../symbols/jQuery.fn.minplayer.html">jQuery.fn.minplayer</a></li>
	
	<li><a href="../symbols/minplayer.async.html">minplayer.async</a></li>
	
	<li><a href="../symbols/minplayer.compatibility.html">minplayer.compatibility</a></li>
	
	<li><a href="../symbols/minplayer.display.html">minplayer.display</a></li>
	
	<li><a href="../symbols/minplayer.file.html">minplayer.file</a></li>
	
	<li><a href="../symbols/minplayer.flags.html">minplayer.flags</a></li>
	
	<li><a href="../symbols/minplayer.image.html">minplayer.image</a></li>
	
	<li><a href="../symbols/minplayer.players.base.html">minplayer.players.base</a></li>
	
	<li><a href="../symbols/minplayer.players.flash.html">minplayer.players.flash</a></li>
	
	<li><a href="../symbols/minplayer.players.html5.html">minplayer.players.html5</a></li>
	
	<li><a href="../symbols/minplayer.players.minplayer.html">minplayer.players.minplayer</a></li>
	
	<li><a href="../symbols/minplayer.players.vimeo.html">minplayer.players.vimeo</a></li>
	
	<li><a href="../symbols/minplayer.players.youtube.html">minplayer.players.youtube</a></li>
	
	<li><a href="../symbols/minplayer.plugin.html">minplayer.plugin</a></li>
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Class minplayer.display
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				
				<br />Extends
					<a href="../symbols/minplayer.plugin.html">minplayer.plugin</a>.<br />
				
			
				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.
				
				
					<br /><i>Defined in: </i> <a href="../symbols/src/src_minplayer.display.js.html">minplayer.display.js</a>.
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class minplayer.display.">
				<caption>Class Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/minplayer.display.html#constructor">minplayer.display</a></b>(name, context, options, queue)
							</div>
							<div class="description"></div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class minplayer.display.">
					<caption>Field Summary</caption>
					<thead>
						<tr>
							<th scope="col">Field Attributes</th>
							<th scope="col">Field Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/minplayer.display.html#constructor">constructor</a></b>
								</div>
								<div class="description">Reset the constructor.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">
								<b><a href="../symbols/minplayer.display.html#onResize">onResize</a></b>
								</div>
								<div class="description">Called when the window resizes.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
				<dl class="inheritsList">
				<dt>Fields borrowed from class <a href="../symbols/minplayer.plugin.html">minplayer.plugin</a>: </dt><dd><a href="../symbols/minplayer.plugin.html#active">active</a>, <a href="../symbols/minplayer.plugin.html#context">context</a>, <a href="../symbols/minplayer.plugin.html#lock">lock</a>, <a href="../symbols/minplayer.plugin.html#name">name</a>, <a href="../symbols/minplayer.plugin.html#options">options</a>, <a href="../symbols/minplayer.plugin.html#pluginReady">pluginReady</a>, <a href="../symbols/minplayer.plugin.html#queue">queue</a>, <a href="../symbols/minplayer.plugin.html#triggered">triggered</a></dd>
				</dl>
				
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class minplayer.display.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/minplayer.display.html#construct">construct</a></b>()
								</div>
								<div class="description"></div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/minplayer.display.html#fullscreen">fullscreen</a></b>(full)
								</div>
								<div class="description">Make this display element go fullscreen.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/minplayer.display.html#fullScreenElement">fullScreenElement</a></b>()
								</div>
								<div class="description">Gets the full screen element.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/minplayer.display.html#getDisplay">getDisplay</a></b>()
								</div>
								<div class="description">Returns the display for this component.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/minplayer.display.html#getElements">getElements</a></b>()
								</div>
								<div class="description">Returns all the jQuery elements that this component uses.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/minplayer.display.html#getScaledRect">getScaledRect</a></b>(ratio, rect)
								</div>
								<div class="description">Returns a scaled rectangle provided a ratio and the container rect.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/minplayer.display.html#hide">hide</a></b>(element)
								</div>
								<div class="description">Wrapper around hide that will always not show.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/minplayer.display.html#isFullScreen">isFullScreen</a></b>()
								</div>
								<div class="description">Checks to see if we are in fullscreen mode.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/minplayer.display.html#onFocus">onFocus</a></b>(focus)
								</div>
								<div class="description">Determines if the player is in focus or not.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont"><b><a href="../symbols/minplayer.display.html#toggleFullScreen">toggleFullScreen</a></b>()
								</div>
								<div class="description">Toggle fullscreen.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
				<dl class="inheritsList">
				<dt>Methods borrowed from class <a href="../symbols/minplayer.plugin.html">minplayer.plugin</a>: </dt><dd><a href="../symbols/minplayer.plugin.html#addPlugin">addPlugin</a>, <a href="../symbols/minplayer.plugin.html#bind">bind</a>, <a href="../symbols/minplayer.plugin.html#checkQueue">checkQueue</a>, <a href="../symbols/minplayer.plugin.html#create">create</a>, <a href="../symbols/minplayer.plugin.html#destroy">destroy</a>, <a href="../symbols/minplayer.plugin.html#get">get</a>, <a href="../symbols/minplayer.plugin.html#isValid">isValid</a>, <a href="../symbols/minplayer.plugin.html#poll">poll</a>, <a href="../symbols/minplayer.plugin.html#ready">ready</a>, <a href="../symbols/minplayer.plugin.html#trigger">trigger</a>, <a href="../symbols/minplayer.plugin.html#unbind">unbind</a></dd>
				</dl>
				
			
<!-- ============================== events summary ======================== -->
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Class Detail
				</div>
				
				<div class="fixedFont">
						<b>minplayer.display</b>(name, context, options, queue)
				</div>
				
				<div class="description">
					
					
				</div>
				
				
				
				
					
						<dl class="detailList">
						<dt class="heading">Parameters:</dt>
						
							<dt>
								<span class="light fixedFont">{string}</span>  <b>name</b>
								
							</dt>
								<dd>The name of this plugin.</dd>
						
							<dt>
								<span class="light fixedFont">{object}</span>  <b>context</b>
								
							</dt>
								<dd>The jQuery context this component resides.</dd>
						
							<dt>
								<span class="light fixedFont">{object}</span>  <b>options</b>
								
							</dt>
								<dd>The options for this component.</dd>
						
							<dt>
								<span class="light fixedFont">{object}</span>  <b>queue</b>
								
							</dt>
								<dd>The event queue to pass events around.</dd>
						
						</dl>
					
					
					
					
					
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			
				<div class="sectionTitle">
					Field Detail
				</div>
				
					<a name="constructor"> </a>
					<div class="fixedFont">
					
					
					<b>constructor</b>
					
					</div>
					<div class="description">
						Reset the constructor.
						
						
					</div>
					
					

						
						
						
						

					<hr />
				
					<a name="onResize"> </a>
					<div class="fixedFont">
					
					
					<b>onResize</b>
					
					</div>
					<div class="description">
						Called when the window resizes.
						
						
					</div>
					
					

						
						
						
						

					
				
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name="construct"> </a>
					<div class="fixedFont">
					
					
					<b>construct</b>()
					
					</div>
					<div class="description">
						
						
						
					</div>
					
					
					
						
						
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">See:</dt>
							
								<dd>minplayer.plugin.construct</dd>
							
							</dl>
						

					<hr />
				
					<a name="fullscreen"> </a>
					<div class="fixedFont">
					
					
					<b>fullscreen</b>(full)
					
					</div>
					<div class="description">
						Make this display element go fullscreen.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{boolean}</span> <b>full</b>
									
								</dt>
								<dd>Tell the player to go into fullscreen or not.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="fullScreenElement"> </a>
					<div class="fixedFont">
					
					<span class="light">{object}</span>
					<b>fullScreenElement</b>()
					
					</div>
					<div class="description">
						Gets the full screen element.
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{object}</span> The display to be used for full screen support.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="getDisplay"> </a>
					<div class="fixedFont">
					
					<span class="light">{object}</span>
					<b>getDisplay</b>()
					
					</div>
					<div class="description">
						Returns the display for this component.
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{object}</span> The jQuery context for this display.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="getElements"> </a>
					<div class="fixedFont">
					
					<span class="light">{object}</span>
					<b>getElements</b>()
					
					</div>
					<div class="description">
						Returns all the jQuery elements that this component uses.
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{object}</span> An object which defines all the jQuery elements that
this component uses.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="getScaledRect"> </a>
					<div class="fixedFont">
					
					<span class="light">{object}</span>
					<b>getScaledRect</b>(ratio, rect)
					
					</div>
					<div class="description">
						Returns a scaled rectangle provided a ratio and the container rect.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{number}</span> <b>ratio</b>
									
								</dt>
								<dd>The width/height ratio of what is being scaled.</dd>
							
								<dt>
									<span class="light fixedFont">{object}</span> <b>rect</b>
									
								</dt>
								<dd>The bounding rectangle for scaling.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{object}</span> The Rectangle object of the scaled rectangle.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="hide"> </a>
					<div class="fixedFont">
					
					
					<b>hide</b>(element)
					
					</div>
					<div class="description">
						Wrapper around hide that will always not show.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{object}</span> <b>element</b>
									
								</dt>
								<dd>The element you wish to hide.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="isFullScreen"> </a>
					<div class="fixedFont">
					
					<span class="light">{boolean}</span>
					<b>isFullScreen</b>()
					
					</div>
					<div class="description">
						Checks to see if we are in fullscreen mode.
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{boolean}</span> TRUE - fullscreen, FALSE - otherwise.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name="onFocus"> </a>
					<div class="fixedFont">
					
					
					<b>onFocus</b>(focus)
					
					</div>
					<div class="description">
						Determines if the player is in focus or not.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{boolean}</span> <b>focus</b>
									
								</dt>
								<dd>If the player is in focus.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name="toggleFullScreen"> </a>
					<div class="fixedFont">
					
					
					<b>toggleFullScreen</b>()
					
					</div>
					<div class="description">
						Toggle fullscreen.
						
						
					</div>
					
					
					
						
						
						
						
						
						
						

					
				
			
			
<!-- ============================== event details ========================= -->		
			
			
			<hr />
		</div>

		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
			
			Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0 on Thu Oct 04 2012 19:54:20 GMT-0700 (PDT)
		</div>
	</body>
</html>