windowmanager

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <title>Window - Documentation</title> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script>  <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> <li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="BoundingBox.html">BoundingBox</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="BoundingBox.html#clone">clone</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="BoundingBox.html#difference">difference</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="BoundingBox.html#getArea">getArea</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="BoundingBox.html#getBoundingBox">getBoundingBox</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="BoundingBox.html#getCenteredOnPosition">getCenteredOnPosition</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="BoundingBox.html#getCenterPosition">getCenterPosition</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="BoundingBox.html#getColliding">getColliding</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="BoundingBox.html#getCollisionMesh">getCollisionMesh</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="BoundingBox.html#getDistanceSquaredToPoint">getDistanceSquaredToPoint</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="BoundingBox.html#getDistanceToPoint">getDistanceToPoint</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="BoundingBox.html#getEdgeClosest">getEdgeClosest</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="BoundingBox.html#getEdgeClosestOrder">getEdgeClosestOrder</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="BoundingBox.html#getEdgeTouching">getEdgeTouching</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="BoundingBox.html#getHeight">getHeight</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="BoundingBox.html#getIntersection">getIntersection</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="BoundingBox.html#getOtherEdgeTouching">getOtherEdgeTouching</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="BoundingBox.html#getPosition">getPosition</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="BoundingBox.html#getSize">getSize</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="BoundingBox.html#getSnapDelta">getSnapDelta</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="BoundingBox.html#getWidth">getWidth</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="BoundingBox.html#isColliding">isColliding</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="BoundingBox.html#isContains">isContains</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="BoundingBox.html#isNaN">isNaN</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="BoundingBox.html#isTouching">isTouching</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="BoundingBox.html#moveBy">moveBy</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="BoundingBox.html#moveTo">moveTo</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="BoundingBox.html#resizeTo">resizeTo</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="BoundingBox.html#set">set</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="BoundingBox.html#someColliding">someColliding</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="BoundingBox.html#someContains">someContains</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="BoundingBox.html#someTouching">someTouching</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="CollisionMesh.html">CollisionMesh</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CollisionMesh.html#clone">clone</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CollisionMesh.html#getBoundingBox">getBoundingBox</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CollisionMesh.html#getColliding">getColliding</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CollisionMesh.html#getCollisionMesh">getCollisionMesh</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CollisionMesh.html#getHeight">getHeight</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CollisionMesh.html#getPosition">getPosition</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CollisionMesh.html#getSize">getSize</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CollisionMesh.html#getWidth">getWidth</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CollisionMesh.html#isColliding">isColliding</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CollisionMesh.html#isContains">isContains</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CollisionMesh.html#isTouching">isTouching</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CollisionMesh.html#moveBy">moveBy</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CollisionMesh.html#moveTo">moveTo</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CollisionMesh.html#someColliding">someColliding</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CollisionMesh.html#someContains">someContains</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="CollisionMesh.html#someTouching">someTouching</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="EventHandler.html">EventHandler</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="EventHandler.html#addPipe">addPipe</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="EventHandler.html#clearEvent">clearEvent</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="EventHandler.html#emit">emit</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="EventHandler.html#off">off</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="EventHandler.html#on">on</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="EventHandler.html#once">once</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="EventHandler.html#removePipe">removePipe</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Layout.html">Layout</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Layout.html#.getAll">getAll</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Layout.html#.getAllTabbed">getAllTabbed</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Layout.html#.getByID">getByID</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Layout.html#_changeActiveWindow">_changeActiveWindow</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Layout.html#_createTabbedLayoutItem">_createTabbedLayoutItem</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Layout.html#_createTiledLayoutItem">_createTiledLayoutItem</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Layout.html#_tabbed">_tabbed</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Layout.html#_tiled">_tiled</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Layout.html#addWindow">addWindow</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Layout.html#getWindow">getWindow</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Layout.html#getWindows">getWindows</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Layout.html#removeWindow">removeWindow</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Position.html">Position</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Size.html">Size</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Vector.html">Vector</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Vector.html#add">add</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Vector.html#clone">clone</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Vector.html#distance">distance</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Vector.html#distanceSquared">distanceSquared</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Vector.html#getBoundingBox">getBoundingBox</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Vector.html#getCollisionMesh">getCollisionMesh</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Vector.html#getVector">getVector</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Vector.html#isNaN">isNaN</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Vector.html#moveBy">moveBy</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Vector.html#moveTo">moveTo</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Vector.html#set">set</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Vector.html#setMax">setMax</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Vector.html#setMin">setMin</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Vector.html#subtract">subtract</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Window.html">Window</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#.getAll">getAll</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#.getByID">getByID</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#.getCurrent">getCurrent</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#.getMain">getMain</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#addPipe">addPipe</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#bringToFront">bringToFront</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#clearEvent">clearEvent</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#close">close</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#dock">dock</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#emit">emit</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#focus">focus</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#getBounds">getBounds</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#getHeight">getHeight</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#getPosition">getPosition</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#getSize">getSize</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#getTitle">getTitle</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#getWidth">getWidth</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#hide">hide</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#isClosed">isClosed</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#isHidden">isHidden</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#isMaximized">isMaximized</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#isMinimized">isMinimized</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#isReady">isReady</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#isResizable">isResizable</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#isRestored">isRestored</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#isShown">isShown</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#maximize">maximize</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#minimize">minimize</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#moveBy">moveBy</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#moveTo">moveTo</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#off">off</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#on">on</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#once">once</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#onReady">onReady</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#removePipe">removePipe</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#resizable">resizable</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#resizeTo">resizeTo</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#restore">restore</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#setBounds">setBounds</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#setTitle">setTitle</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#show">show</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Window.html#undock">undock</a></span></li><li class="nav-heading">Namespaces</li><li class="nav-heading"><span class="nav-item-type type-namespace">N</span><span class="nav-item-name"><a href="geometry.html">geometry</a></span></li><li class="nav-heading"><span class="nav-item-type type-namespace">N</span><span class="nav-item-name"><a href="messagebus.html">messagebus</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="messagebus.html#.off">off</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="messagebus.html#.on">on</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="messagebus.html#.send">send</a></span></li><li class="nav-heading"><span class="nav-item-type type-namespace">N</span><span class="nav-item-name"><a href="windowmanager.html">windowmanager</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="windowmanager.html#.isReady">isReady</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="windowmanager.html#.onReady">onReady</a></span></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#load">load</a></span></li> </nav> <div id="main"> <h1 class="page-title">Window</h1> <section> <header> <h2> Window </h2> <div class="class-description"><p>A Window class, used to create windows.</p> <p><h5>Example:</h5></p> <pre class="prettyprint source lang-javascript"><code>// Create a new window: let newWindow = new windowmanager.Window({ url: "child.html", // Loads "child.html" based on the current window's url. width: 500, height: 500, show: false // Don't automatically show window on creation }); newWindow.onReady(() => { // Setup window: // ... // Display window: this.show(); this.focus(); });</code></pre></div> </header> <article> <div class="container-overview"> <div class="section-method"> <h2>Constructor</h2> <h4 class="name" id="Window"><span class="type-signature"></span>new Window<span class="signature">(config<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> <p>Creates a window object.</p> <p><h5>Example:</h5></p> <pre class="prettyprint source lang-javascript"><code>// Create a new window: let newWindow = new windowmanager.Window({ url: "child.html", // Loads "child.html" based on the current window's url. width: 500, height: 500 });</code></pre> </div> <dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>config</code></td> <td class="type"> <span class="param-type"><code>Object</code></span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"> <p>Window Configuration</p> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>width</code></td> <td class="type"> <span class="param-type"><code>Number</code></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 800 </td> <td class="description last"> </td> </tr> <tr> <td class="name"><code>height</code></td> <td class="type"> <span class="param-type"><code>Number</code></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 500 </td> <td class="description last"> </td> </tr> <tr> <td class="name"><code>frame</code></td> <td class="type"> <span class="param-type"><code>Boolean</code></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> true </td> <td class="description last"> <p>When true, enables standard OS framing around the window</p> </td> </tr> <tr> <td class="name"><code>resizable</code></td> <td class="type"> <span class="param-type"><code>Boolean</code></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> true </td> <td class="description last"> <p>When true, allows user to resize window by dragging edges</p> </td> </tr> <tr> <td class="name"><code>show</code></td> <td class="type"> <span class="param-type"><code>Boolean</code></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> true </td> <td class="description last"> <p>When true, starts the window in the "show" state rather than "hidden"</p> </td> </tr> <tr> <td class="name"><code>icon</code></td> <td class="type"> <span class="param-type"><code>String</code></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 'favicon.ico' </td> <td class="description last"> <p>Location to favicon</p> </td> </tr> <tr> <td class="name"><code>url</code></td> <td class="type"> <span class="param-type"><code>String</code></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> '.' </td> <td class="description last"> <p>Location to page that the window should load</p> </td> </tr> <tr> <td class="name"><code>draggable</code></td> <td class="type"> <span class="param-type"><code>Boolean</code></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> true </td> <td class="description last"> <p>When true, enables dragging of window.</p> </td> </tr> <tr> <td class="name"><code>container</code></td> <td class="type"> <span class="param-type"><code>String</code></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"> <p>The id of the div to attach the window to</p> </td> </tr> </tbody> </table> </td> </tr> </tbody> </table> </div> </div> <h3 class="subsection-title">Extends</h3> <ul> <li><a href="EventHandler.html">EventHandler</a></li> </ul> <h3 class="subsection-title">Methods</h3> <div class="section-method"> <h4 class="name" id=".getAll"><span class="type-signature">(static) </span>getAll<span class="signature">()</span><span class="type-signature"> → {Array.<<a href="Window.html">Window</a>>}</span></h4> <div class="description"> <p>Returns a list of all <a href="Window.html">Window</a> instances open.</p> <p><h5>Example:</h5></p> <pre class="prettyprint source lang-javascript"><code>// Close all windows: let allWindows = windowmanager.Window.getAll();</code></pre> </div> <dl class="details"> </dl> <div class="section-returns"> <h5>Returns:</h5> <dl class="param-type"> <dt> Type: </dt> <dd> <span class="param-type"><code>Array.<<a href="Window.html">Window</a>></code></span> </dd> </dl> </div> </div> <div class="section-method"> <h4 class="name" id=".getByID"><span class="type-signature">(static) </span>getByID<span class="signature">(id)</span><span class="type-signature"> → {<a href="Window.html">Window</a>|undefined}</span></h4> <div class="description"> <p>Returns the <a href="Window.html">Window</a> instance that has <code>id</code>.</p> <p><h5>Example:</h5></p> <pre class="prettyprint source lang-javascript"><code>// Get window with ID: let window = windowmanager.Window.getById(windowID);</code></pre> </div> <dl class="details"> </dl> <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>id</code></td> <td class="type"> <span class="param-type"><code>String</code></span> | <span class="param-type"><code>Number</code></span> </td> <td class="description last"> </td> </tr> </tbody> </table> <div class="section-returns"> <h5>Returns:</h5> <dl class="param-type"> <dt> Type: </dt> <dd> <span class="param-type"><code><a href="Window.html">Window</a></code></span> | <span class="param-type"><code>undefined</code></span> </dd> </dl> </div> </div> <div class="section-method"> <h4 class="name" id=".getCurrent"><span class="type-signature">(static) </span>getCurrent<span class="signature">()</span><span class="type-signature"> → {<a href="Window.html">Window</a>}</span></h4> <div class="description"> <p>Returns the <a href="Window.html">Window</a> instance that calls this function.</p> <p><h5>Example:</h5></p> <pre class="prettyprint source lang-javascript"><code>// Get current window this code is executing in: let currentWindow = windowmanager.Window.getCurrent();</code></pre> </div> <dl class="details"> </dl> <div class="section-returns"> <h5>Returns:</h5> <dl class="param-type"> <dt> Type: </dt> <dd> <span class="param-type"><code><a href="Window.html">Window</a></code></span> </dd> </dl> </div> </div> <div class="section-method"> <h4 class="name" id=".getMain"><span class="type-signature">(static) </span>getMain<span class="signature">()</span><span class="type-signature"> → {<a href="Window.html">Window</a>}</span></h4> <div class="description"> <p>Returns the <a href="Window.html">Window</a> instance that is the main window.</p> <p><h5>Example:</h5></p> <pre class="prettyprint source lang-javascript"><code>// Get main window of the application: let mainWindow = windowmanager.Window.getMain();</code></pre> </div> <dl class="details"> </dl> <div class="section-returns"> <h5>Returns:</h5> <dl class="param-type"> <dt> Type: </dt> <dd> <span class="param-type"><code><a href="Window.html">Window</a></code></span> </dd> </dl> </div> </div> <div class="section-method"> <h4 class="name" id="addPipe"><span class="type-signature"></span>addPipe<span class="signature">(eventHandler)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="EventHandler.html#addPipe">EventHandler#addPipe</a> </li></ul></dd> </dl> <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>eventHandler</code></td> <td class="type"> <span class="param-type"><code><a href="EventHandler.html">EventHandler</a></code></span> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="bringToFront"><span class="type-signature"></span>bringToFront<span class="signature">(callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> <p>Brings the window instance to the front of all windows.</p> </div> <dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type"><code><a href="global.html#Callback">Callback</a></code></span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="clearEvent"><span class="type-signature"></span>clearEvent<span class="signature">(eventNames)</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="EventHandler.html#clearEvent">EventHandler#clearEvent</a> </li></ul></dd> </dl> <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>eventNames</code></td> <td class="type"> <span class="param-type"><code>String</code></span> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="close"><span class="type-signature"></span>close<span class="signature">(callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> <p>Closes the window instance.</p> </div> <dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type"><code><a href="global.html#Callback">Callback</a></code></span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="dock"><span class="type-signature"></span>dock<span class="signature">(other)</span><span class="type-signature"></span></h4> <div class="description"> <p>Force docking this window to another. They don't need to be touching.</p> </div> <dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>other</code></td> <td class="type"> <span class="param-type"><code><a href="Window.html">Window</a></code></span> </td> <td class="attributes"> </td> <td class="description last"> </td> </tr> <tr> <td class="name"><code></code></td> <td class="type"> <span class="param-type"><code><a href="global.html#Callback">Callback</a></code></span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="emit"><span class="type-signature"></span>emit<span class="signature">(eventName, …args)</span><span class="type-signature"> → {Boolean}</span></h4> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="EventHandler.html#emit">EventHandler#emit</a> </li></ul></dd> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>eventName</code></td> <td class="type"> <span class="param-type"><code>String</code></span> </td> <td class="attributes"> </td> <td class="description last"> </td> </tr> <tr> <td class="name"><code>args</code></td> <td class="type"> <span class="param-type"><code>*</code></span> </td> <td class="attributes"> <repeatable><br> </td> <td class="description last"> <p>Arguments to pass to listeners</p> </td> </tr> </tbody> </table> <div class="section-returns"> <h5>Returns:</h5> <dl class="param-type"> <dt> Type: </dt> <dd> <span class="param-type"><code>Boolean</code></span> </dd> </dl> <div class="param-desc"> <p>true if all handlers return true, else false</p> </div> </div> </div> <div class="section-method"> <h4 class="name" id="focus"><span class="type-signature"></span>focus<span class="signature">(callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> <p>Sets focus to the window instance.</p> </div> <dl class="details"> </dl> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type"><code><a href="global.html#Callback">Callback</a></code></span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"> </td> </tr> </tbody> </table> </div> <div class="section-method"> <h4 class="name" id="getBounds"><span class="type-signature"></span>getBounds<span class="signature">()</span><span class="type-signature"> → {<a href="BoundingBox.html">BoundingBox</a>}</span></h4> <div class="description"> <p>Returns window's bounding box.</p> </div> <dl class="details"> </dl> <div class="section-returns"> <h5>Returns:</h5> <dl class="param-type"> <dt> Type: </dt> <dd> <span class="param-type"><code><a href="BoundingBox.html">BoundingBox</a></code></span> </dd> </dl> </div> </div> <div class="section-method"> <h4 class="name" id="getHeight"><span class="type-signature"></span>getHeight<span class="signature">()</span><span class="type-signature"> → {Number}</span></h4> <div class="description"> <p>Returns window's height.</p> </div> <dl class="details"> </dl> <div class="section-returns"> <h5>Returns:</h5> <dl class="param-type"> <dt>