windowmanager
Version:
A framework to manage multiple dockable, HTML windows
105 lines (71 loc) • 12.7 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Home - Documentation</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="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BoundingBox.html">BoundingBox</a><ul class='methods'><li data-type='method'><a href="BoundingBox.html#clone">clone</a></li><li data-type='method'><a href="BoundingBox.html#difference">difference</a></li><li data-type='method'><a href="BoundingBox.html#getArea">getArea</a></li><li data-type='method'><a href="BoundingBox.html#getBoundingBox">getBoundingBox</a></li><li data-type='method'><a href="BoundingBox.html#getCenteredOnPosition">getCenteredOnPosition</a></li><li data-type='method'><a href="BoundingBox.html#getCenterPosition">getCenterPosition</a></li><li data-type='method'><a href="BoundingBox.html#getColliding">getColliding</a></li><li data-type='method'><a href="BoundingBox.html#getCollisionMesh">getCollisionMesh</a></li><li data-type='method'><a href="BoundingBox.html#getDistanceSquaredToPoint">getDistanceSquaredToPoint</a></li><li data-type='method'><a href="BoundingBox.html#getDistanceToPoint">getDistanceToPoint</a></li><li data-type='method'><a href="BoundingBox.html#getEdgeClosest">getEdgeClosest</a></li><li data-type='method'><a href="BoundingBox.html#getEdgeClosestOrder">getEdgeClosestOrder</a></li><li data-type='method'><a href="BoundingBox.html#getEdgeTouching">getEdgeTouching</a></li><li data-type='method'><a href="BoundingBox.html#getHeight">getHeight</a></li><li data-type='method'><a href="BoundingBox.html#getIntersection">getIntersection</a></li><li data-type='method'><a href="BoundingBox.html#getOtherEdgeTouching">getOtherEdgeTouching</a></li><li data-type='method'><a href="BoundingBox.html#getPosition">getPosition</a></li><li data-type='method'><a href="BoundingBox.html#getSize">getSize</a></li><li data-type='method'><a href="BoundingBox.html#getSnapDelta">getSnapDelta</a></li><li data-type='method'><a href="BoundingBox.html#getWidth">getWidth</a></li><li data-type='method'><a href="BoundingBox.html#isColliding">isColliding</a></li><li data-type='method'><a href="BoundingBox.html#isContains">isContains</a></li><li data-type='method'><a href="BoundingBox.html#isNaN">isNaN</a></li><li data-type='method'><a href="BoundingBox.html#isTouching">isTouching</a></li><li data-type='method'><a href="BoundingBox.html#moveBy">moveBy</a></li><li data-type='method'><a href="BoundingBox.html#moveTo">moveTo</a></li><li data-type='method'><a href="BoundingBox.html#resizeTo">resizeTo</a></li><li data-type='method'><a href="BoundingBox.html#set">set</a></li><li data-type='method'><a href="BoundingBox.html#someColliding">someColliding</a></li><li data-type='method'><a href="BoundingBox.html#someContains">someContains</a></li><li data-type='method'><a href="BoundingBox.html#someTouching">someTouching</a></li></ul></li><li><a href="CollisionMesh.html">CollisionMesh</a><ul class='methods'><li data-type='method'><a href="CollisionMesh.html#clone">clone</a></li><li data-type='method'><a href="CollisionMesh.html#getBoundingBox">getBoundingBox</a></li><li data-type='method'><a href="CollisionMesh.html#getColliding">getColliding</a></li><li data-type='method'><a href="CollisionMesh.html#getCollisionMesh">getCollisionMesh</a></li><li data-type='method'><a href="CollisionMesh.html#getHeight">getHeight</a></li><li data-type='method'><a href="CollisionMesh.html#getPosition">getPosition</a></li><li data-type='method'><a href="CollisionMesh.html#getSize">getSize</a></li><li data-type='method'><a href="CollisionMesh.html#getWidth">getWidth</a></li><li data-type='method'><a href="CollisionMesh.html#isColliding">isColliding</a></li><li data-type='method'><a href="CollisionMesh.html#isContains">isContains</a></li><li data-type='method'><a href="CollisionMesh.html#isTouching">isTouching</a></li><li data-type='method'><a href="CollisionMesh.html#moveBy">moveBy</a></li><li data-type='method'><a href="CollisionMesh.html#moveTo">moveTo</a></li><li data-type='method'><a href="CollisionMesh.html#someColliding">someColliding</a></li><li data-type='method'><a href="CollisionMesh.html#someContains">someContains</a></li><li data-type='method'><a href="CollisionMesh.html#someTouching">someTouching</a></li></ul></li><li><a href="EventHandler.html">EventHandler</a><ul class='methods'><li data-type='method'><a href="EventHandler.html#addPipe">addPipe</a></li><li data-type='method'><a href="EventHandler.html#clearEvent">clearEvent</a></li><li data-type='method'><a href="EventHandler.html#emit">emit</a></li><li data-type='method'><a href="EventHandler.html#off">off</a></li><li data-type='method'><a href="EventHandler.html#on">on</a></li><li data-type='method'><a href="EventHandler.html#once">once</a></li><li data-type='method'><a href="EventHandler.html#removePipe">removePipe</a></li></ul></li><li><a href="Position.html">Position</a></li><li><a href="Size.html">Size</a></li><li><a href="Vector.html">Vector</a><ul class='methods'><li data-type='method'><a href="Vector.html#add">add</a></li><li data-type='method'><a href="Vector.html#clone">clone</a></li><li data-type='method'><a href="Vector.html#distance">distance</a></li><li data-type='method'><a href="Vector.html#distanceSquared">distanceSquared</a></li><li data-type='method'><a href="Vector.html#getBoundingBox">getBoundingBox</a></li><li data-type='method'><a href="Vector.html#getCollisionMesh">getCollisionMesh</a></li><li data-type='method'><a href="Vector.html#getVector">getVector</a></li><li data-type='method'><a href="Vector.html#isNaN">isNaN</a></li><li data-type='method'><a href="Vector.html#moveBy">moveBy</a></li><li data-type='method'><a href="Vector.html#moveTo">moveTo</a></li><li data-type='method'><a href="Vector.html#set">set</a></li><li data-type='method'><a href="Vector.html#setMax">setMax</a></li><li data-type='method'><a href="Vector.html#setMin">setMin</a></li><li data-type='method'><a href="Vector.html#subtract">subtract</a></li></ul></li><li><a href="Window.html">Window</a><ul class='methods'><li data-type='method'><a href="Window.html#.getAll">getAll</a></li><li data-type='method'><a href="Window.html#.getByID">getByID</a></li><li data-type='method'><a href="Window.html#.getCurrent">getCurrent</a></li><li data-type='method'><a href="Window.html#addPipe">addPipe</a></li><li data-type='method'><a href="Window.html#bringToFront">bringToFront</a></li><li data-type='method'><a href="Window.html#clearEvent">clearEvent</a></li><li data-type='method'><a href="Window.html#close">close</a></li><li data-type='method'><a href="Window.html#dock">dock</a></li><li data-type='method'><a href="Window.html#emit">emit</a></li><li data-type='method'><a href="Window.html#focus">focus</a></li><li data-type='method'><a href="Window.html#getBounds">getBounds</a></li><li data-type='method'><a href="Window.html#getHeight">getHeight</a></li><li data-type='method'><a href="Window.html#getPosition">getPosition</a></li><li data-type='method'><a href="Window.html#getSize">getSize</a></li><li data-type='method'><a href="Window.html#getTitle">getTitle</a></li><li data-type='method'><a href="Window.html#getWidth">getWidth</a></li><li data-type='method'><a href="Window.html#hide">hide</a></li><li data-type='method'><a href="Window.html#isClosed">isClosed</a></li><li data-type='method'><a href="Window.html#isHidden">isHidden</a></li><li data-type='method'><a href="Window.html#isMaximized">isMaximized</a></li><li data-type='method'><a href="Window.html#isMinimized">isMinimized</a></li><li data-type='method'><a href="Window.html#isReady">isReady</a></li><li data-type='method'><a href="Window.html#isRestored">isRestored</a></li><li data-type='method'><a href="Window.html#isShown">isShown</a></li><li data-type='method'><a href="Window.html#maximize">maximize</a></li><li data-type='method'><a href="Window.html#minimize">minimize</a></li><li data-type='method'><a href="Window.html#moveBy">moveBy</a></li><li data-type='method'><a href="Window.html#moveTo">moveTo</a></li><li data-type='method'><a href="Window.html#off">off</a></li><li data-type='method'><a href="Window.html#on">on</a></li><li data-type='method'><a href="Window.html#once">once</a></li><li data-type='method'><a href="Window.html#onReady">onReady</a></li><li data-type='method'><a href="Window.html#removePipe">removePipe</a></li><li data-type='method'><a href="Window.html#resizeTo">resizeTo</a></li><li data-type='method'><a href="Window.html#restore">restore</a></li><li data-type='method'><a href="Window.html#setBounds">setBounds</a></li><li data-type='method'><a href="Window.html#setTitle">setTitle</a></li><li data-type='method'><a href="Window.html#show">show</a></li><li data-type='method'><a href="Window.html#undock">undock</a></li></ul></li></ul><h3>Namespaces</h3><ul><li><a href="geometry.html">geometry</a></li><li><a href="messagebus.html">messagebus</a><ul class='methods'><li data-type='method'><a href="messagebus.html#.off">off</a></li><li data-type='method'><a href="messagebus.html#.on">on</a></li><li data-type='method'><a href="messagebus.html#.send">send</a></li></ul></li><li><a href="windowmanager.html">windowmanager</a><ul class='methods'><li data-type='method'><a href="windowmanager.html#.isReady">isReady</a></li><li data-type='method'><a href="windowmanager.html#.onReady">onReady</a></li></ul></li></ul><h3><a href="global.html">Global</a></h3>
</nav>
<div id="main">
<section class="readme">
<article><h1>windowmanager.js</h1><p><a href="https://badge.fury.io/js/windowmanager"><img src="https://badge.fury.io/js/windowmanager.svg" alt="npm version"></a><br>
A framework to manage multiple dockable HTML windows.<br>
This extension is designed to support multiple different different encapsulation runtimes.<br>
See <a href="https://eikospartners.github.io/windowmanagerjs/">API Documentation</a> for more information.</p>
<p>Runtimes supported:</p>
<ul>
<li>Modern Web Browsers (Chrome, Firefox, IE, Edge, Safari)</li>
<li><a href="https://openfin.co/">OpenFin</a></li>
<li><a href="http://electron.atom.io/">Electron</a></li>
</ul>
<p>Future runtimes:</p>
<ul>
<li><a href="http://nwjs.io/">NW.js</a></li>
</ul>
<h2>Live Example</h2><p>You can see a live demo at <a href="http://blotter.eikospartners.com/install">Eikos Partners Blotter Demonstration</a>.<br>
An open source example can be found at: https://github.com/aesalazar/windowmanagerjsdemo<br>
A basic example to get started:</p>
<pre class="prettyprint source lang-javascript"><code>// Create a new window:
let childWindow = new windowmanager.Window({
url: "child.html", // Loads "child.html" based on the current window's url.
width: 500,
height: 500
});
// Execute code when window is ready for commands:
childWindow.onReady(() => {
childWindow.focus(); // Set focus to childWindow.
});</code></pre><h2>Installing via NPM</h2><p>Run <code>npm install --save windowmanager</code><br>
The windowmanager script is located in <code>node_modules/windowmanager/dist/windowmanager.js</code>.</p>
<h2>Download Packaged Script</h2><ol>
<li>Download either one of the following scripts from the dist folder (which contains the latest nightly version):<ul>
<li><a href="https://raw.githubusercontent.com/EikosPartners/windowmanagerjs/master/dist/windowmanager.js">windowmanager</a></li>
<li><a href="https://raw.githubusercontent.com/EikosPartners/windowmanagerjs/master/dist/windowmanager.min.js">windowmanager.min</a></li>
</ul>
</li>
<li>Add the script to the your application. Do not add it to a builder, since bundling or compiling with babelify will break the script.</li>
</ol></article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Thu Jan 26 2017 13:33:47 GMT-0500 (Eastern Standard Time) using the Minami theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>