docker.jsdoc.html 16 KB

Raw Blame History Permalink

<!DOCTYPE html>

<html lang="en">
<head>
	<meta charset="utf-8">
	<meta name="viewport" content="width=device-width">
	<title> Source: docker.jsdoc</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-12">

		<div id="main">


		<h1 class="page-title">Source: docker.jsdoc</h1>

<section>
    <article>
        <pre
            class="sunlight-highlight-javascript linenums">/**
 * Options for a [docker]{@link module:wcDocker} instance.
 *
 * @typedef {Object} module:wcDocker~Options
 * @property {String} [themePath='Themes'] - A folder path where all docker theme files can be found.
 * @property {String} [theme='default'] - The active docker theme.
 * @property {String} [loadingClass='fa fa-spinner fa-pulse'] - Any class name to use for the loading screen icon.
 * @property {Boolean} [allowContextMenu=true] - Overrides the default right click menu with ones that interact with docker.
 * @property {Boolean} [hideOnResize=false] - If true, panels will hide their contents as they are being resized.
 * @property {Boolean} [allowCollapse=true] - Allows users to collapse panels to the sides of the docker view.
 * @property {Number} [responseRate=10] - This determines how often updates are performed (in milliseconds).
 * @property {Number} [moveStartDelay=300] - The time delay (in milliseconds) before a panel drag operation will start.
 * @property {Number|String} [edgeAnchorSize=50] - Determines the size of the anchor points when docking a panel to the outer edge of the window. Can be a pixel value, or a string with a 'px' or '%' suffix.
 * @property {Number|String} [panelAnchorSize='15%'] - Determines the size of the anchor points when docking a panel along the side of another panel. Can be a pixel value, or a string with a 'px' or '%' suffix.
 * @property {Number|String} [detachToWidth=600] - Determines the new width when a panel is detached (0 = Don't change). Can be a pixel value, or a string with a 'px' or '%' suffix.
 * @property {Number|String} [detachToHeight=400] - Determines the new height when a panel is detached (0 = Don't change).  Can be a pixel value, or a string with a 'px' or '%' suffix.
 * @property {Object} [wcPanelClass] - Defines a class object to use in replacement of the default wcPanel object.
 * @property {Object} [wcGhostClass] - Defines a class object to use in replacement of the default wcGhost object.
 * @property {Object} [wcSplitterClass] - Defines a class object to use in replacement of the default wcSplitter object.
 * @property {Object} [wcFrameClass] - Defines a class object to use in replacement of the default wcFrame object.
 * @property {Object} [wcCollapserClass] - Defines a class object to use in replacement of the default wcCollapser object.
 * @property {Object} [wcLayoutSimpleClass] - Defines a class object to use in replacement of the default wcLayoutSimple object.
 * @property {Object} [wcLayoutTableClass] - Defines a class object to use in replacement of the default wcLayoutTable object.
 * @property {Object} [wcDrawerClass] - Defines a class object to use in replacement of the default wcDrawer object.
 * @property {Object} [wcTabFrameClass] - Defines a class object to use in replacement of the default wcTabFrame object.
 */

/**
 * A rectangle structure.
 * @typedef {Object} module:wcDocker~Rect
 * @property {Number|String} [x] - X coordinate of the rectangle. Can be a pixel position, or a string with a 'px' or '%' suffix.
 * @property {Number|String} [y] - Y coordinate of the rectangle. Can be a pixel position, or a string with a 'px' or '%' suffix.
 * @property {Number|String} [w] - Width of the rectangle. Can be a pixel position, or a string with a 'px' or '%' suffix.
 * @property {Number|String} [h] - Height of the rectangle. Can be a pixel position, or a string with a 'px' or '%' suffix.
 */

/**
 * A rectangle structure.
 * @typedef {Object} module:wcDocker~AnchorRect
 * @property {Number|String} [x] - X coordinate of the rectangle. Can be a pixel position, or a string with a 'px' or '%' suffix.
 * @property {Number|String} [y] - Y coordinate of the rectangle. Can be a pixel position, or a string with a 'px' or '%' suffix.
 * @property {Number|String} [w] - Width of the rectangle. Can be a pixel position, or a string with a 'px' or '%' suffix.
 * @property {Number|String} [h] - Height of the rectangle. Can be a pixel position, or a string with a 'px' or '%' suffix.
 * @property {module:wcDocker.TAB} [tabOrientation] - Desired orientation of tab widgets.
 */

/**
 * A bounding structure
 * @typedef {Object} module:wcDocker~Bounds
 * @property {Number} top - The upper, or top bound (percentage value between 0 and 1).
 * @property {Number} bottom - The lower, or bottom bound (percentage value between 0 and 1).
 * @property {Number} left - The left bound (percentage value between 0 and 1).
 * @property {Number} right - The right bound (percentage value between 0 and 1).
 */

/**
 * A coordinate structure.
 * @typedef {Object} module:wcDocker~Coordinate
 * @property {Number} x - X coordinate.
 * @property {Number} y - Y coordinate.
 */

/**
 * A 2D size structure.
 * @typedef {Object} module:wcDocker~Size
 * @property {Number} x - Width.
 * @property {Number} y - Height.
 */

/**
 * Determines whether the container will allow scroll bars to appear on each axis.
 * @typedef {Object} module:wcDocker~Scrollable
 * @property {Boolean} x - Whether scrolling is enabled in the horizontal direction.
 * @property {Boolean} y - Whether scrolling is enabled in the vertical direction.
 */

/**
 * Determines whether the container should fit the size of its contents instead of scroll for each axis.
 * @typedef {Object} module:wcDocker~FitContents
 * @property {Boolean} x - Whether scrolling is enabled in the horizontal direction.
 * @property {Boolean} y - Whether scrolling is enabled in the vertical direction.
 */

 /**
 * Options for adding a new panel.
 * @typedef {Object} module:wcDocker~PanelOptions
 * @property {Number|String} [x] - X coordinate of the panel center (if floating). Can be a pixel position, or a string with a 'px' or '%' suffix.
 * @property {Number|String} [y] - Y coordinate of the panel center (if floating). Can be a pixel position, or a string with a 'px' or '%' suffix.
 * @property {Number|String} [w] - Desired width of the panel. Can be a pixel position, or a string with a 'px' or '%' suffix.
 * @property {Number|String} [h] - Desired height of the panel. Can be a pixel position, or a string with a 'px' or '%' suffix.
 * @property {module:wcDocker.TAB} [tabOrientation] - Desired position of tab widgets when using [wcDocker.DOCK.STACKED]{@link module:wcDocker.DOCK}. &lt;b>Not supported on IE8 or below.&lt;/b>
 */

/**
 * Options object for registering new panel types.
 * @typedef module:wcDocker~registerOptions
 * @property {module:wcDocker~onCreatePanel} onCreate  - A function or an object constructor for the panel.
 * @property {module:wcDocker.LAYOUT} [layout=wcDocker.LAYOUT.TABLE] - If supplied, overrides the default layout used for this panel.
 * @property {String} [icon]                    - A CSS class name to draw an icon in the panels tab widget.
 * @property {String} [faicon]                  - An icon name using the [Font-Awesome]{@link http://fortawesome.github.io/Font-Awesome/} library. You must download and link to the library first.
 * @property {String|Boolean} [title]           - Assign a custom name to the panels tab. A false value will hide the tab entirely.
 * @property {Boolean} [isPrivate]              - If true, the user will not be able to create this panel type.
 * @property {Boolean} [isPersistent]           - If true, when the user closes this panel, it will only be hidden instead of completely destroyed. When the user creates an instance of this panel, it will first attempt to un-hide an already existing panel before creating a new instance.
 * @property {Number} [limit]                   - Enforces a limited number of this panel type from being created by the user.
 * @property {Object} [options]                 - A custom options object to be passed into the new panel constructor or creation function as the second parameter.
 */

 /**
 * A function or an object constructor for the panel. This function is called using the 'new' operator.
 * @callback module:wcDocker~onCreatePanel
 * @param {module:wcPanel} panel - The panel being constructed.
 * @param {module:wcPanel~options} [options] - An options object passed in from [wcDocker.registerPanelType()]{@link module:wcDocker#registerPanelType}'s options.options parameter.
 */

/**
 * An event handler callback. Each is registered to a event type using the [wcDocker.on()]{@link module:wcDocker#on} or [wcPanel.on()]{@link module:wcPanel~on} functions.
 * @event module:wcDocker#onEvent
 * @type {Function}
 * @param {module:wcPanel|NULL} panel - The panel invoking the event, or NULL if global.
 * @param {Object} [data] - A data object passed by the invoker.
 */

/**
 * Anchor data.
 * @typedef {Object} module:wcDocker~Anchor
 * @property {Boolean} self - Whether the anchor is hovering over the moving panel.
 * @property {module:wcDocker.DOCK} loc - The location of the anchor on the panel.
 * @property {module:wcLayout} item - The panel layout being hovered over.
 * @property {module:wcDocker.TAB} tab - The tab location.
 * @property {}
 * @property {Number} [x] - X coordinate of the anchor.
 * @property {Number} [y] - Y coordinate of the anchor.
 * @property {Number} [w] - Width of the anchor.
 * @property {Number} [h] - Height of the anchor.
 */

</pre>
    </article>
</section>


		</div>
	</div>

	<div class="clearfix"></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">&times;</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>