<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title> Module: wcSplitter</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.dark.css">
<link type="text/css" rel="stylesheet" href="styles/site.slate.css">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top ">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand" href="index.html"><div style='font-size:15px;line-height:15px;margin-top:-5px;'>Web Cabin Docker<br>v3.0.0 (pre-release)</div></a>
<button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
<div class="navbar-collapse collapse" id="topNavigation">
<ul class="nav navbar-nav">
<li class="dropdown">
<a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b class="caret"></b></a>
<ul class="dropdown-menu inline">
<li><a href="module-wcBase.html">wcBase</a></li><li><a href="module-wcCollapser.html">wcCollapser</a></li><li><a href="module-wcDocker.html">wcDocker</a></li><li><a href="module-wcDrawer.html">wcDrawer</a></li><li><a href="module-wcFrame.html">wcFrame</a></li><li><a href="module-wcGhost.html">wcGhost</a></li><li><a href="module-wcIFrame.html">wcIFrame</a></li><li><a href="module-wcLayout.html">wcLayout</a></li><li><a href="module-wcLayoutSimple.html">wcLayoutSimple</a></li><li><a href="module-wcLayoutTable.html">wcLayoutTable</a></li><li><a href="module-wcPanel.html">wcPanel</a></li><li><a href="module-wcSplitter.html">wcSplitter</a></li><li><a href="module-wcTabFrame.html">wcTabFrame</a></li>
</ul>
</li>
<li class="dropdown">
<a href="events.list.html" class="dropdown-toggle" data-toggle="dropdown">Events<b class="caret"></b></a>
<ul class="dropdown-menu inline">
<li><a href="module-wcDocker.html#event:onEvent">wcDocker#event:onEvent</a></li>
</ul>
</li>
<li class="dropdown">
<a href="tutorials.list.html" class="dropdown-toggle" data-toggle="dropdown">Tutorials<b class="caret"></b></a>
<ul class="dropdown-menu inline">
<li><a href="tutorial-1.0-getting-started.html">Getting Started</a></li><li><a href="tutorial-2.0-tips-and-tricks.html">Tips and Tricks</a></li><li><a href="tutorial-3.0-widgets.html">Widgets</a></li>
</ul>
</li>
<li class="dropdown">
<a href="externals.list.html" class="dropdown-toggle" data-toggle="dropdown">Externals<b class="caret"></b></a>
<ul class="dropdown-menu inline">
<li><a href="external-domNode.html">domNode</a></li><li><a href="external-jQuery.html">jQuery</a></li>
</ul>
</li>
</ul>
<div class="col-sm-3 col-md-3">
<form class="navbar-form" role="search">
<div class="input-group">
<input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
<div class="input-group-btn">
<button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
</div>
</div>
</form>
</div>
</div>
</div>
</div>
<div class="container" id="toc-content">
<div class="row">
<div class="col-md-8">
<div id="main">
<h1 class="page-title">Module: wcSplitter</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="splitter.js.html">splitter.js</a>,
<a href="splitter.js.html#sunlight-1-line-1">line 1</a>
</li>
</ul>
</dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<hr>
<dt class="name" id="$pane">
<h4 id="$pane"><toc class="attribs"><span class="type-signature"></span></toc>var <toc class="member"><b>$pane</b></toc></h4>
</dt>
<dd>
<div class="description">
<p style="margin-left:20px;">An array of two elements representing each side of the splitter.
Index 0 is always either top or left depending on <a href="module-wcDocker.html#.ORIENTATION">orientation</a>.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<<a href="external-jQuery.html#~Object">external:jQuery~Object</a>></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="splitter.js.html">splitter.js</a>,
<a href="splitter.js.html#sunlight-1-line-37">line 37</a>
</li>
</ul>
</dd>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<hr>
<dt>
<h4 class="name" id=".constructor"><toc class="attribs"><span class="type-signature"><static> </span></toc>function <toc class="method"><b>constructor</b>(container, parent, orientation)</toc>
</h4>
</dt>
<dd>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>container</code></td>
<td class="type">
<span class="param-type"><a href="external-jQuery.html#~selector">external:jQuery~selector</a></span>
|
<span class="param-type"><a href="external-jQuery.html#~Object">external:jQuery~Object</a></span>
|
<span class="param-type"><a href="external-domNode.html">external:domNode</a></span>
</td>
<td class="description last">A container element for this splitter.</td>
</tr>
<tr>
<td class="name"><code>parent</code></td>
<td class="type">
<span class="param-type">wcLayout</span>
|
<span class="param-type"><a href="wcSplitter.html">wcSplitter</a></span>
|
<span class="param-type">wcDocker</span>
</td>
<td class="description last">The splitter's parent object.</td>
</tr>
<tr>
<td class="name"><code>orientation</code></td>
<td class="type">
<span class="param-type"><a href="module-wcDocker.html#.ORIENTATION">module:wcDocker.ORIENTATION</a></span>
</td>
<td class="description last">The orientation of the splitter bar.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="splitter.js.html">splitter.js</a>,
<a href="splitter.js.html#sunlight-1-line-25">line 25</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="animPos"><toc class="attribs"><span class="type-signature"></span></toc>function <toc class="method"><b>animPos</b>(value)</toc>
</h4>
</dt>
<dd>
<div class="description">
<p style="margin-left:20px;">Animates to a given splitter position.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">Assigns the target splitter position. Value must be a percentage between 0 and 1.</td>
</tr>
<tr>
<td class="name"><code></code></td>
<td class="type">
<span class="param-type">module:wcSplitter~onFinished</span>
</td>
<td class="description last">A finished event handler.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="splitter.js.html">splitter.js</a>,
<a href="splitter.js.html#sunlight-1-line-203">line 203</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="bottom"><toc class="attribs"><span class="type-signature"></span></toc>function <toc class="method"><b>bottom</b>( [item])</toc>
->
<i><small>
<span class="param-type"><a href="module-wcLayout.html">module:wcLayout</a></span>
|
<span class="param-type"><a href="module-wcPanel.html">module:wcPanel</a></span>
|
<span class="param-type"><a href="module-wcFrame.html">module:wcFrame</a></span>
|
<span class="param-type"><a href="wcSplitter.html">wcSplitter</a></span>
|
<span class="param-type">Boolean</span>
</small></i>
</h4>
</dt>
<dd>
<div class="description">
<p style="margin-left:20px;">Gets, or Sets the element associated with the bottom pane (for vertical layouts).</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>item</code></td>
<td class="type">
<span class="param-type"><a href="module-wcLayout.html">module:wcLayout</a></span>
|
<span class="param-type"><a href="module-wcPanel.html">module:wcPanel</a></span>
|
<span class="param-type"><a href="module-wcFrame.html">module:wcFrame</a></span>
|
<span class="param-type"><a href="wcSplitter.html">wcSplitter</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">If supplied, the pane will be replaced with this item.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="splitter.js.html">splitter.js</a>,
<a href="splitter.js.html#sunlight-1-line-304">line 304</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
- The current object assigned to the pane, or false.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="module-wcLayout.html">module:wcLayout</a></span>
|
<span class="param-type"><a href="module-wcPanel.html">module:wcPanel</a></span>
|
<span class="param-type"><a href="module-wcFrame.html">module:wcFrame</a></span>
|
<span class="param-type"><a href="wcSplitter.html">wcSplitter</a></span>
|
<span class="param-type">Boolean</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="destroy"><toc class="attribs"><span class="type-signature"></span></toc>function <toc class="method"><b>destroy</b>( [destroyPanes])</toc>
</h4>
</dt>
<dd>
<div class="description">
<p style="margin-left:20px;">Destroys the splitter.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>destroyPanes</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
true
</td>
<td class="description last">If true, both panes attached will be destroyed as well. Use false if you plan to continue using the objects assigned to each pane, or make sure to remove them first before destruction.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="splitter.js.html">splitter.js</a>,
<a href="splitter.js.html#sunlight-1-line-337">line 337</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="initLayouts"><toc class="attribs"><span class="type-signature"></span></toc>function <toc class="method"><b>initLayouts</b>( [topLeftLayout] [, bottomRightLayout])</toc>
</h4>
</dt>
<dd>
<div class="description">
<p style="margin-left:20px;">Initializes the two <a href="module-wcSplitter.html#$pane">panes</a> of the splitter with its own layouts.<br>
This should be used to initialize the splitter when creating one for use inside your panel.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>topLeftLayout</code></td>
<td class="type">
<span class="param-type"><a href="module-wcDocker.html#.LAYOUT">module:wcDocker.LAYOUT</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
wcDocker.LAYOUT.TABLE
</td>
<td class="description last">The type of layout to use for the top or left pane.</td>
</tr>
<tr>
<td class="name"><code>bottomRightLayout</code></td>
<td class="type">
<span class="param-type"><a href="module-wcDocker.html#.LAYOUT">module:wcDocker.LAYOUT</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
wcDocker.LAYOUT.TABLE
</td>
<td class="description last">The type of layout to use for the bottom or right pane.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="splitter.js.html">splitter.js</a>,
<a href="splitter.js.html#sunlight-1-line-56">line 56</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="left"><toc class="attribs"><span class="type-signature"></span></toc>function <toc class="method"><b>left</b>( [item])</toc>
->
<i><small>
<span class="param-type"><a href="module-wcLayout.html">module:wcLayout</a></span>
|
<span class="param-type"><a href="module-wcPanel.html">module:wcPanel</a></span>
|
<span class="param-type"><a href="module-wcFrame.html">module:wcFrame</a></span>
|
<span class="param-type"><a href="wcSplitter.html">wcSplitter</a></span>
|
<span class="param-type">Boolean</span>
</small></i>
</h4>
</dt>
<dd>
<div class="description">
<p style="margin-left:20px;">Gets, or Sets the element associated with the left side pane (for horizontal layouts).</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>item</code></td>
<td class="type">
<span class="param-type"><a href="module-wcLayout.html">module:wcLayout</a></span>
|
<span class="param-type"><a href="module-wcPanel.html">module:wcPanel</a></span>
|
<span class="param-type"><a href="module-wcFrame.html">module:wcFrame</a></span>
|
<span class="param-type"><a href="wcSplitter.html">wcSplitter</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">If supplied, the pane will be replaced with this item.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="splitter.js.html">splitter.js</a>,
<a href="splitter.js.html#sunlight-1-line-274">line 274</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
- The current object assigned to the pane, or false.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="module-wcLayout.html">module:wcLayout</a></span>
|
<span class="param-type"><a href="module-wcPanel.html">module:wcPanel</a></span>
|
<span class="param-type"><a href="module-wcFrame.html">module:wcFrame</a></span>
|
<span class="param-type"><a href="wcSplitter.html">wcSplitter</a></span>
|
<span class="param-type">Boolean</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="maxSize"><toc class="attribs"><span class="type-signature"></span></toc>function <toc class="method"><b>maxSize</b>()</toc>
->
<i><small>
<span class="param-type"><a href="module-wcDocker.html#~Size">module:wcDocker~Size</a></span>
</small></i>
</h4>
</dt>
<dd>
<div class="description">
<p style="margin-left:20px;">Gets the maximum size constraint of the outer splitter area.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="splitter.js.html">splitter.js</a>,
<a href="splitter.js.html#sunlight-1-line-146">line 146</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
- The maximum size.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="module-wcDocker.html#~Size">module:wcDocker~Size</a></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="minSize"><toc class="attribs"><span class="type-signature"></span></toc>function <toc class="method"><b>minSize</b>()</toc>
->
<i><small>
<span class="param-type"><a href="module-wcDocker.html#~Size">module:wcDocker~Size</a></span>
</small></i>
</h4>
</dt>
<dd>
<div class="description">
<p style="margin-left:20px;">Gets the minimum size constraint of the outer splitter area.</p>
</div>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="splitter.js.html">splitter.js</a>,
<a href="splitter.js.html#sunlight-1-line-108">line 108</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
The minimum size.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="module-wcDocker.html#~Size">module:wcDocker~Size</a></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="orientation"><toc class="attribs"><span class="type-signature"></span></toc>function <toc class="method"><b>orientation</b>(orientation)</toc>
</h4>
</dt>
<dd>
<div class="description">
<p style="margin-left:20px;">Gets, or Sets the orientation of the splitter.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>orientation</code></td>
<td class="type">
<span class="param-type"><a href="module-wcDocker.html#.ORIENTATION">module:wcDocker.ORIENTATION</a></span>
</td>
<td class="description last">The new orientation of the splitter.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="splitter.js.html">splitter.js</a>,
<a href="splitter.js.html#sunlight-1-line-74">line 74</a>
</li>
</ul>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="pane"><toc class="attribs"><span class="type-signature"></span></toc>function <toc class="method"><b>pane</b>(index [, item])</toc>
->
<i><small>
<span class="param-type"><a href="module-wcLayout.html">module:wcLayout</a></span>
|
<span class="param-type"><a href="module-wcPanel.html">module:wcPanel</a></span>
|
<span class="param-type"><a href="module-wcFrame.html">module:wcFrame</a></span>
|
<span class="param-type"><a href="wcSplitter.html">wcSplitter</a></span>
|
<span class="param-type">Boolean</span>
</small></i>
</h4>
</dt>
<dd>
<div class="description">
<p style="margin-left:20px;">Gets, or Sets the element associated with a pane.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
</td>
<td class="description last">The index of the pane, only 0 and 1 are valid.</td>
</tr>
<tr>
<td class="name"><code>item</code></td>
<td class="type">
<span class="param-type"><a href="module-wcLayout.html">module:wcLayout</a></span>
|
<span class="param-type"><a href="module-wcPanel.html">module:wcPanel</a></span>
|
<span class="param-type"><a href="module-wcFrame.html">module:wcFrame</a></span>
|
<span class="param-type"><a href="wcSplitter.html">wcSplitter</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">If supplied, the pane will be replaced with this item.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="splitter.js.html">splitter.js</a>,
<a href="splitter.js.html#sunlight-1-line-243">line 243</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
- The current object assigned to the pane, or false.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="module-wcLayout.html">module:wcLayout</a></span>
|
<span class="param-type"><a href="module-wcPanel.html">module:wcPanel</a></span>
|
<span class="param-type"><a href="module-wcFrame.html">module:wcFrame</a></span>
|
<span class="param-type"><a href="wcSplitter.html">wcSplitter</a></span>
|
<span class="param-type">Boolean</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="pos"><toc class="attribs"><span class="type-signature"></span></toc>function <toc class="method"><b>pos</b>( [value])</toc>
->
<i><small>
<span class="param-type">Number</span>
</small></i>
</h4>
</dt>
<dd>
<div class="description">
<p style="margin-left:20px;">Get, or Set the current splitter position.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>value</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">If supplied, assigns a new splitter position. Value must be a percentage value between 0 and 1.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="splitter.js.html">splitter.js</a>,
<a href="splitter.js.html#sunlight-1-line-184">line 184</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
- The current position.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Number</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="right"><toc class="attribs"><span class="type-signature"></span></toc>function <toc class="method"><b>right</b>( [item])</toc>
->
<i><small>
<span class="param-type"><a href="module-wcLayout.html">module:wcLayout</a></span>
|
<span class="param-type"><a href="module-wcPanel.html">module:wcPanel</a></span>
|
<span class="param-type"><a href="module-wcFrame.html">module:wcFrame</a></span>
|
<span class="param-type"><a href="wcSplitter.html">wcSplitter</a></span>
|
<span class="param-type">Boolean</span>
</small></i>
</h4>
</dt>
<dd>
<div class="description">
<p style="margin-left:20px;">Gets, or Sets the element associated with the right side pane (for horizontal layouts).</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>item</code></td>
<td class="type">
<span class="param-type"><a href="module-wcLayout.html">module:wcLayout</a></span>
|
<span class="param-type"><a href="module-wcPanel.html">module:wcPanel</a></span>
|
<span class="param-type"><a href="module-wcFrame.html">module:wcFrame</a></span>
|
<span class="param-type"><a href="wcSplitter.html">wcSplitter</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">If supplied, the pane will be replaced with this item.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="splitter.js.html">splitter.js</a>,
<a href="splitter.js.html#sunlight-1-line-284">line 284</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
- The current object assigned to the pane, or false.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="module-wcLayout.html">module:wcLayout</a></span>
|
<span class="param-type"><a href="module-wcPanel.html">module:wcPanel</a></span>
|
<span class="param-type"><a href="module-wcFrame.html">module:wcFrame</a></span>
|
<span class="param-type"><a href="wcSplitter.html">wcSplitter</a></span>
|
<span class="param-type">Boolean</span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="scrollable"><toc class="attribs"><span class="type-signature"></span></toc>function <toc class="method"><b>scrollable</b>(index [, x] [, y])</toc>
->
<i><small>
<span class="param-type"><a href="module-wcDocker.html#~Scrollable">module:wcDocker~Scrollable</a></span>
</small></i>
</h4>
</dt>
<dd>
<div class="description">
<p style="margin-left:20px;">Gets, or Sets whether a pane can be scrolled via scroll bars.
By default, scrolling is enabled in both directions.</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="attributes">
</td>
<td class="description last">The index of the pane, only 0 and 1 are valid.</td>
</tr>
<tr>
<td class="name"><code>x</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Whether to allow scrolling in the horizontal direction.</td>
</tr>
<tr>
<td class="name"><code>y</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">Whether to allow scrolling in the vertical direction.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="splitter.js.html">splitter.js</a>,
<a href="splitter.js.html#sunlight-1-line-314">line 314</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
- The current scroll state for each direction.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="module-wcDocker.html#~Scrollable">module:wcDocker~Scrollable</a></span>
</dd>
</dl>
</dd>
<hr>
<dt>
<h4 class="name" id="top"><toc class="attribs"><span class="type-signature"></span></toc>function <toc class="method"><b>top</b>( [item])</toc>
->
<i><small>
<span class="param-type"><a href="module-wcLayout.html">module:wcLayout</a></span>
|
<span class="param-type"><a href="module-wcPanel.html">module:wcPanel</a></span>
|
<span class="param-type"><a href="module-wcFrame.html">module:wcFrame</a></span>
|
<span class="param-type"><a href="wcSplitter.html">wcSplitter</a></span>
|
<span class="param-type">Boolean</span>
</small></i>
</h4>
</dt>
<dd>
<div class="description">
<p style="margin-left:20px;">Gets, or Sets the element associated with the top pane (for vertical layouts).</p>
</div>
<h5>Parameters:</h5>
<table class="params table table-striped">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Argument</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>item</code></td>
<td class="type">
<span class="param-type"><a href="module-wcLayout.html">module:wcLayout</a></span>
|
<span class="param-type"><a href="module-wcPanel.html">module:wcPanel</a></span>
|
<span class="param-type"><a href="module-wcFrame.html">module:wcFrame</a></span>
|
<span class="param-type"><a href="wcSplitter.html">wcSplitter</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">If supplied, the pane will be replaced with this item.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source method-doc-label method-doc-details-label">Source:</dt>
<dd class="tag-source">
<ul class="dummy">
<li>
<a href="splitter.js.html">splitter.js</a>,
<a href="splitter.js.html#sunlight-1-line-294">line 294</a>
</li>
</ul>
</dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
- The current object assigned to the pane, or false.
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="module-wcLayout.html">module:wcLayout</a></span>
|
<span class="param-type"><a href="module-wcPanel.html">module:wcPanel</a></span>
|
<span class="param-type"><a href="module-wcFrame.html">module:wcFrame</a></span>
|
<span class="param-type"><a href="wcSplitter.html">wcSplitter</a></span>
|
<span class="param-type">Boolean</span>
</dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
</div>
<div class="clearfix"></div>
<div class="col-md-3">
<div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
</div>
</div>
</div>
<div class="modal fade" id="searchResults">
<div class="modal-dialog">
<div class="modal-content">
<div class="modal-header">
<button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
<h4 class="modal-title">Search results</h4>
</div>
<div class="modal-body"></div>
<div class="modal-footer">
<button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
</div>
</div><!-- /.modal-content -->
</div><!-- /.modal-dialog -->
</div>
<footer>
<span class="copyright">
2014-2016 Jeff Houde (<a href='mailto:lochemage@webcabin.org'>lochemage@webcabin.org</a>)
</span>
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
on 2016-08-28
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
</footer>
<script src="scripts/docstrap.lib.js"></script>
<script src="scripts/toc.js"></script>
<script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
<script>
$( function () {
$( "[id*='$']" ).each( function () {
var $this = $( this );
$this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
} );
$( ".tutorial-section pre, .readme-section pre" ).each( function () {
var $this = $( this );
var example = $this.find( "code" );
exampleText = example.html();
var lang = /{@lang (.*?)}/.exec( exampleText );
if ( lang && lang[1] ) {
exampleText = exampleText.replace( lang[0], "" );
example.html( exampleText );
lang = lang[1];
} else {
var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
lang = langClassMatch ? langClassMatch[1] : "javascript";
}
if ( lang ) {
$this
.addClass( "sunlight-highlight-" + lang )
.addClass( "linenums" )
.html( example.html() );
}
} );
Sunlight.highlightAll( {
lineNumbers : true,
showMenu : true,
enableDoclinks : true
} );
$.catchAnchorLinks( {
navbarOffset: 10
} );
$( "#toc" ).toc( {
anchorName : function ( i, heading, prefix ) {
return $( heading ).attr( "id" ) || ( prefix + i );
},
selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
showAndHide : false,
smoothScrolling: true
} );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
$( '.dropdown-toggle' ).dropdown();
$( "table" ).each( function () {
var $this = $( this );
$this.addClass('table');
} );
} );
</script>
<!--Navigation and Symbol Display-->
<!-- Piwik Analytics -->
<script type="text/javascript">
var _paq = _paq || [];
_paq.push(['trackPageView']);
_paq.push(['enableLinkTracking']);
(function() {
var u="https://analytics.webcabin.org/";
_paq.push(['setTrackerUrl', u+'piwik.php']);
_paq.push(['setSiteId', 6]);
var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
g.type='text/javascript'; g.async=true; g.defer=true; g.src=u+'piwik.js'; s.parentNode.insertBefore(g,s);
})();
</script>
<noscript><p><img src="https://analytics.webcabin.org/piwik.php?idsite=6" style="border:0;" alt="" /></p></noscript>
<!-- End Piwik Code -->
<script type="text/javascript">
$(document).ready(function() {
SearcherDisplay.init();
});
</script>
</body>
</html>