canopy/www/doc/client/poppedPanel.html

1451 lines
14 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: poppedPanel</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: poppedPanel</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>poppedPanel<span class="signature">(panel, panelBody, cPanel)</span><span class="type-signature"></span></h2>
<div class="class-description">Class which represents a single instance of a popped-out panel</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="poppedPanel"><span class="type-signature"></span>new poppedPanel<span class="signature">(panel, panelBody, cPanel)</span><span class="type-signature"></span></h4>
<div class="description">
Instantiates a new Popped Panel Object
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>panel</code></td>
<td class="type">
<span class="param-type"><a href="panelObj.html">panelObj</a></span>
</td>
<td class="description last">Panel Object to apply to Popped Panel</td>
</tr>
<tr>
<td class="name"><code>panelBody</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last">Raw HTML to inject into panel body, defaults to panel page if null</td>
</tr>
<tr>
<td class="name"><code>cPanel</code></td>
<td class="type">
<span class="param-type"><a href="cPanel.html">cPanel</a></span>
</td>
<td class="description last">Parent Canopy Panel Management Object</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cpanel.js.html">cpanel.js</a>, <a href="cpanel.js.html#line328">line 328</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="cPanel"><span class="type-signature"></span>cPanel<span class="type-signature"></span></h4>
<div class="description">
Parent Canopy Panel Management Object
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cpanel.js.html">cpanel.js</a>, <a href="cpanel.js.html#line374">line 374</a>
</li></ul></dd>
</dl>
<h4 class="name" id="keepAlive"><span class="type-signature"></span>keepAlive<span class="type-signature"></span></h4>
<div class="description">
Disables this.panel.closer() calls from this.closer()
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cpanel.js.html">cpanel.js</a>, <a href="cpanel.js.html#line379">line 379</a>
</li></ul></dd>
</dl>
<h4 class="name" id="panel"><span class="type-signature"></span>panel<span class="type-signature"></span></h4>
<div class="description">
Panel Object to apply to Popped Panel
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cpanel.js.html">cpanel.js</a>, <a href="cpanel.js.html#line339">line 339</a>
</li></ul></dd>
</dl>
<h4 class="name" id="panelBody"><span class="type-signature"></span>panelBody<span class="type-signature"></span></h4>
<div class="description">
Raw HTML to inject into panel body, defaults to panel page if null
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cpanel.js.html">cpanel.js</a>, <a href="cpanel.js.html#line344">line 344</a>
</li></ul></dd>
</dl>
<h4 class="name" id="pinnedPanelCloseIcon"><span class="type-signature"></span>pinnedPanelCloseIcon<span class="type-signature"></span></h4>
<div class="description">
Popped Panel Close Icon
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cpanel.js.html">cpanel.js</a>, <a href="cpanel.js.html#line369">line 369</a>
</li></ul></dd>
</dl>
<h4 class="name" id="pinnedPanelDiv"><span class="type-signature"></span>pinnedPanelDiv<span class="type-signature"></span></h4>
<div class="description">
Popped Panel Container Div
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cpanel.js.html">cpanel.js</a>, <a href="cpanel.js.html#line354">line 354</a>
</li></ul></dd>
</dl>
<h4 class="name" id="pinnedPanelDoc"><span class="type-signature"></span>pinnedPanelDoc<span class="type-signature"></span></h4>
<div class="description">
Popped Panel Document Div
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cpanel.js.html">cpanel.js</a>, <a href="cpanel.js.html#line364">line 364</a>
</li></ul></dd>
</dl>
<h4 class="name" id="pinnedPanelTitle"><span class="type-signature"></span>pinnedPanelTitle<span class="type-signature"></span></h4>
<div class="description">
Popped Panel Title
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cpanel.js.html">cpanel.js</a>, <a href="cpanel.js.html#line359">line 359</a>
</li></ul></dd>
</dl>
<h4 class="name" id="window"><span class="type-signature"></span>window<span class="type-signature"></span></h4>
<div class="description">
Browser Window taken up by the Popped Panel
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cpanel.js.html">cpanel.js</a>, <a href="cpanel.js.html#line349">line 349</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="asyncConstructor"><span class="type-signature">(async) </span>asyncConstructor<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Continuation of constructor method for asynchronous function calls
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cpanel.js.html">cpanel.js</a>, <a href="cpanel.js.html#line388">line 388</a>
</li></ul></dd>
</dl>
<h4 class="name" id="closer"><span class="type-signature"></span>closer<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Called upon close/exit of panel
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cpanel.js.html">cpanel.js</a>, <a href="cpanel.js.html#line442">line 442</a>
</li></ul></dd>
</dl>
<h4 class="name" id="fillContainer"><span class="type-signature"></span>fillContainer<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Fills container window with Popped Panel container elements
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cpanel.js.html">cpanel.js</a>, <a href="cpanel.js.html#line408">line 408</a>
</li></ul></dd>
</dl>
<h4 class="name" id="pin"><span class="type-signature"></span>pin<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Pins panel next to chat
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cpanel.js.html">cpanel.js</a>, <a href="cpanel.js.html#line466">line 466</a>
</li></ul></dd>
</dl>
<h4 class="name" id="popContainer"><span class="type-signature"></span>popContainer<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Pops/Opens container window upon start
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cpanel.js.html">cpanel.js</a>, <a href="cpanel.js.html#line399">line 399</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setupInput"><span class="type-signature"></span>setupInput<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Defines default input-related popped-panel Event Listeners
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cpanel.js.html">cpanel.js</a>, <a href="cpanel.js.html#line433">line 433</a>
</li></ul></dd>
</dl>
<h4 class="name" id="unpop"><span class="type-signature"></span>unpop<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Un-pops panel into active-panel slot
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="cpanel.js.html">cpanel.js</a>, <a href="cpanel.js.html#line453">line 453</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="addURLPopup.html">addURLPopup</a></li><li><a href="cPanel.html">cPanel</a></li><li><a href="channel.html">channel</a></li><li><a href="chatBox.html">chatBox</a></li><li><a href="chatPostprocessor.html">chatPostprocessor</a></li><li><a href="commandPreprocessor.html">commandPreprocessor</a></li><li><a href="commandProcessor.html">commandProcessor</a></li><li><a href="defaultTitlesPopup.html">defaultTitlesPopup</a></li><li><a href="emotePanel.html">emotePanel</a></li><li><a href="hlsBase.html">hlsBase</a></li><li><a href="hlsLiveStreamHandler.html">hlsLiveStreamHandler</a></li><li><a href="mediaHandler.html">mediaHandler</a></li><li><a href="newPlaylistPopup.html">newPlaylistPopup</a></li><li><a href="nullHandler.html">nullHandler</a></li><li><a href="panelObj.html">panelObj</a></li><li><a href="player.html">player</a></li><li><a href="playlistManager.html">playlistManager</a></li><li><a href="poppedPanel.html">poppedPanel</a></li><li><a href="rawFileBase.html">rawFileBase</a></li><li><a href="rawFileHandler.html">rawFileHandler</a></li><li><a href="renamePopup.html">renamePopup</a></li><li><a href="settingsPanel.html">settingsPanel</a></li><li><a href="userList.html">userList</a></li><li><a href="youtubeEmbedHandler.html">youtubeEmbedHandler</a></li></ul><h3>Global</h3><ul><li><a href="global.html#onYouTubeIframeAPIReady">onYouTubeIframeAPIReady</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Fri Sep 05 2025 05:52:25 GMT-0400 (Eastern Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>