http://git-wip-us.apache.org/repos/asf/guacamole-website/blob/044692cf/doc/1.0.0/guacamole-common-js/Guacamole.Object.html
----------------------------------------------------------------------
diff --git a/doc/1.0.0/guacamole-common-js/Guacamole.Object.html 
b/doc/1.0.0/guacamole-common-js/Guacamole.Object.html
new file mode 100644
index 0000000..e03de36
--- /dev/null
+++ b/doc/1.0.0/guacamole-common-js/Guacamole.Object.html
@@ -0,0 +1,1110 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Class: Object</title>
+
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+
+<body>
+
+<div id="main">
+
+    <h1 class="page-title">Class: Object</h1>
+
+    
+
+
+
+
+<section>
+
+<header>
+    
+        <h2><span class="attribs"><span class="type-signature"></span></span>
+            <span class="ancestors"><a 
href="Guacamole.html">Guacamole</a>.</span>Object<span 
class="signature">(client, index)</span><span 
class="type-signature"></span></h2>
+        
+    
+</header>
+
+<article>
+    <div class="container-overview">
+    
+        
+
+    
+
+    
+    <h4 class="name" id="Object"><span class="type-signature"></span>new 
Object<span class="signature">(client, index)</span><span 
class="type-signature"></span></h4>
+    
+
+    
+
+
+
+<div class="description">
+    An object used by the Guacamole client to house arbitrarily-many named
+input and output streams.
+</div>
+
+
+
+
+
+
+
+
+
+    <h5>Parameters:</h5>
+    
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>client</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type"><a 
href="Guacamole.Client.html">Guacamole.Client</a></span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last">The client owning this object.</td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>index</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">Number</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last">The index of this object.</td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Object.js.html">Object.js</a>, <a 
href="Object.js.html#line33">line 33</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    
+    </div>
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+        <h3 class="subsection-title">Members</h3>
+
+        
+            
+<h4 class="name" id=".ROOT_STREAM"><span class="type-signature">(static, 
constant) </span>ROOT_STREAM<span class="type-signature"> :String</span></h4>
+
+
+
+
+<div class="description">
+    The reserved name denoting the root stream of any object. The contents of
+the root stream MUST be a JSON map of stream name to mimetype.
+</div>
+
+
+
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">String</span>
+
+
+        </li>
+    </ul>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Object.js.html">Object.js</a>, <a 
href="Object.js.html#line200">line 200</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+            
+<h4 class="name" id=".STREAM_INDEX_MIMETYPE"><span 
class="type-signature">(static, constant) </span>STREAM_INDEX_MIMETYPE<span 
class="type-signature"> :String</span></h4>
+
+
+
+
+<div class="description">
+    The mimetype of a stream containing JSON which maps available stream names
+to their corresponding mimetype. The root stream of a Guacamole.Object MUST
+have this mimetype.
+</div>
+
+
+
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">String</span>
+
+
+        </li>
+    </ul>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Object.js.html">Object.js</a>, <a 
href="Object.js.html#line210">line 210</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+            
+<h4 class="name" id="index"><span class="type-signature"></span>index<span 
class="type-signature"> :Number</span></h4>
+
+
+
+
+<div class="description">
+    The index of this object.
+</div>
+
+
+
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">Number</span>
+
+
+        </li>
+    </ul>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Object.js.html">Object.js</a>, <a 
href="Object.js.html#line112">line 112</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+    
+
+    
+        <h3 class="subsection-title">Methods</h3>
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="createOutputStream"><span 
class="type-signature"></span>createOutputStream<span 
class="signature">(mimetype, name)</span><span class="type-signature"> &rarr; 
{<a href="Guacamole.OutputStream.html">Guacamole.OutputStream</a>}</span></h4>
+    
+
+    
+
+
+
+<div class="description">
+    Creates a new output stream associated with this object and having the
+given mimetype and name. The legality of a mimetype and name is dictated
+by the object itself.
+</div>
+
+
+
+
+
+
+
+
+
+    <h5>Parameters:</h5>
+    
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>mimetype</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">String</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last">The mimetype of the data which will 
be sent to the output stream.</td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>name</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">String</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last">The defined name of an output stream 
within this object.</td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Object.js.html">Object.js</a>, <a 
href="Object.js.html#line187">line 187</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+<div class="param-desc">
+    An output stream which will write blobs to the named output stream
+    of this object.
+</div>
+
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type"><a 
href="Guacamole.OutputStream.html">Guacamole.OutputStream</a></span>
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="requestInputStream"><span 
class="type-signature"></span>requestInputStream<span class="signature">(name, 
bodyCallback<span class="signature-attributes">opt</span>)</span><span 
class="type-signature"></span></h4>
+    
+
+    
+
+
+
+<div class="description">
+    Requests read access to the input stream having the given name. If
+successful, a new input stream will be created.
+</div>
+
+
+
+
+
+
+
+
+
+    <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>name</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">String</span>
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+
+                
+
+                
+                </td>
+            
+
+            
+
+            <td class="description last">The name of the input stream to 
request.</td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>bodyCallback</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">function</span>
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+                    &lt;optional><br>
+                
+
+                
+
+                
+                </td>
+            
+
+            
+
+            <td class="description last">The callback to invoke when the body 
of the requested input stream
+    is received. This callback will be provided a Guacamole.InputStream
+    and its mimetype as its two only arguments. If the onbody handler of
+    this object is overridden, this callback will not be invoked.</td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Object.js.html">Object.js</a>, <a 
href="Object.js.html#line161">line 161</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+        
+    
+
+    
+
+    
+        <h3 class="subsection-title">Events</h3>
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="event:onbody">onbody</h4>
+    
+
+    
+
+
+
+<div class="description">
+    Called when this object receives the body of a requested input stream.
+By default, all objects will invoke the callbacks provided to their
+requestInputStream() functions based on the name of the stream
+requested. This behavior can be overridden by specifying a different
+handler here.
+</div>
+
+
+
+
+
+
+
+
+
+    <h5>Parameters:</h5>
+    
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>inputStream</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type"><a 
href="Guacamole.InputStream.html">Guacamole.InputStream</a></span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last">The input stream of the received 
body.</td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>mimetype</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">String</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last">The mimetype of the data being 
received.</td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>name</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">String</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last">The name of the stream whose body has 
been received.</td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Object.js.html">Object.js</a>, <a 
href="Object.js.html#line131">line 131</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="event:onundefine">onundefine</h4>
+    
+
+    
+
+
+
+<div class="description">
+    Called when this object is being undefined. Once undefined, no further
+communication involving this object may occur.
+</div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Object.js.html">Object.js</a>, <a 
href="Object.js.html#line146">line 146</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+        
+    
+</article>
+
+</section>
+
+
+
+
+</div>
+
+<nav>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a 
href="Guacamole.ArrayBufferReader.html">ArrayBufferReader</a></li><li><a 
href="Guacamole.ArrayBufferWriter.html">ArrayBufferWriter</a></li><li><a 
href="Guacamole.AudioPlayer.html">AudioPlayer</a></li><li><a 
href="Guacamole.AudioRecorder.html">AudioRecorder</a></li><li><a 
href="Guacamole.BlobReader.html">BlobReader</a></li><li><a 
href="Guacamole.BlobWriter.html">BlobWriter</a></li><li><a 
href="Guacamole.ChainedTunnel.html">ChainedTunnel</a></li><li><a 
href="Guacamole.Client.html">Client</a></li><li><a 
href="Guacamole.DataURIReader.html">DataURIReader</a></li><li><a 
href="Guacamole.Display.html">Display</a></li><li><a 
href="Guacamole.Display.VisibleLayer.html">VisibleLayer</a></li><li><a 
href="Guacamole.HTTPTunnel.html">HTTPTunnel</a></li><li><a 
href="Guacamole.InputSink.html">InputSink</a></li><li><a 
href="Guacamole.InputStream.html">InputStream</a></li><li><a 
href="Guacamole.IntegerPool.html">IntegerPool</a></li><l
 i><a href="Guacamole.JSONReader.html">JSONReader</a></li><li><a 
href="Guacamole.Keyboard.html">Keyboard</a></li><li><a 
href="Guacamole.Keyboard.ModifierState.html">ModifierState</a></li><li><a 
href="Guacamole.Layer.html">Layer</a></li><li><a 
href="Guacamole.Layer.Pixel.html">Pixel</a></li><li><a 
href="Guacamole.Mouse.html">Mouse</a></li><li><a 
href="Guacamole.Mouse.State.html">State</a></li><li><a 
href="Guacamole.Mouse.Touchpad.html">Touchpad</a></li><li><a 
href="Guacamole.Mouse.Touchscreen.html">Touchscreen</a></li><li><a 
href="Guacamole.Object.html">Object</a></li><li><a 
href="Guacamole.OnScreenKeyboard.html">OnScreenKeyboard</a></li><li><a 
href="Guacamole.OnScreenKeyboard.Key.html">Key</a></li><li><a 
href="Guacamole.OnScreenKeyboard.Layout.html">Layout</a></li><li><a 
href="Guacamole.OutputStream.html">OutputStream</a></li><li><a 
href="Guacamole.Parser.html">Parser</a></li><li><a 
href="Guacamole.RawAudioFormat.html">RawAudioFormat</a></li><li><a 
href="Guacamole.RawAudioPlayer.html
 ">RawAudioPlayer</a></li><li><a 
href="Guacamole.RawAudioRecorder.html">RawAudioRecorder</a></li><li><a 
href="Guacamole.SessionRecording.html">SessionRecording</a></li><li><a 
href="Guacamole.StaticHTTPTunnel.html">StaticHTTPTunnel</a></li><li><a 
href="Guacamole.Status.html">Status</a></li><li><a 
href="Guacamole.StringReader.html">StringReader</a></li><li><a 
href="Guacamole.StringWriter.html">StringWriter</a></li><li><a 
href="Guacamole.Tunnel.html">Tunnel</a></li><li><a 
href="Guacamole.VideoPlayer.html">VideoPlayer</a></li><li><a 
href="Guacamole.WebSocketTunnel.html">WebSocketTunnel</a></li></ul><h3>Events</h3><ul><li><a
 href="Guacamole.ArrayBufferReader.html#event:ondata">ondata</a></li><li><a 
href="Guacamole.ArrayBufferReader.html#event:onend">onend</a></li><li><a 
href="Guacamole.ArrayBufferWriter.html#event:onack">onack</a></li><li><a 
href="Guacamole.AudioRecorder.html#event:onclose">onclose</a></li><li><a 
href="Guacamole.AudioRecorder.html#event:onerror">onerror</a></li><li><a hre
 f="Guacamole.BlobReader.html#event:onend">onend</a></li><li><a 
href="Guacamole.BlobReader.html#event:onprogress">onprogress</a></li><li><a 
href="Guacamole.BlobWriter.html#event:onack">onack</a></li><li><a 
href="Guacamole.BlobWriter.html#event:oncomplete">oncomplete</a></li><li><a 
href="Guacamole.BlobWriter.html#event:onerror">onerror</a></li><li><a 
href="Guacamole.BlobWriter.html#event:onprogress">onprogress</a></li><li><a 
href="Guacamole.ChainedTunnel.html#event:onerror">onerror</a></li><li><a 
href="Guacamole.ChainedTunnel.html#event:oninstruction">oninstruction</a></li><li><a
 
href="Guacamole.ChainedTunnel.html#event:onstatechange">onstatechange</a></li><li><a
 href="Guacamole.Client.html#event:onaudio">onaudio</a></li><li><a 
href="Guacamole.Client.html#event:onclipboard">onclipboard</a></li><li><a 
href="Guacamole.Client.html#event:onerror">onerror</a></li><li><a 
href="Guacamole.Client.html#event:onfile">onfile</a></li><li><a 
href="Guacamole.Client.html#event:onfilesystem">onfilesys
 tem</a></li><li><a 
href="Guacamole.Client.html#event:onname">onname</a></li><li><a 
href="Guacamole.Client.html#event:onpipe">onpipe</a></li><li><a 
href="Guacamole.Client.html#event:onstatechange">onstatechange</a></li><li><a 
href="Guacamole.Client.html#event:onsync">onsync</a></li><li><a 
href="Guacamole.Client.html#event:onvideo">onvideo</a></li><li><a 
href="Guacamole.DataURIReader.html#event:onend">onend</a></li><li><a 
href="Guacamole.Display.html#event:oncursor">oncursor</a></li><li><a 
href="Guacamole.Display.html#event:onresize">onresize</a></li><li><a 
href="Guacamole.HTTPTunnel.html#event:onerror">onerror</a></li><li><a 
href="Guacamole.HTTPTunnel.html#event:oninstruction">oninstruction</a></li><li><a
 
href="Guacamole.HTTPTunnel.html#event:onstatechange">onstatechange</a></li><li><a
 href="Guacamole.InputStream.html#event:onblob">onblob</a></li><li><a 
href="Guacamole.InputStream.html#event:onend">onend</a></li><li><a 
href="Guacamole.JSONReader.html#event:onend">onend</a></li><li><a
  href="Guacamole.JSONReader.html#event:onprogress">onprogress</a></li><li><a 
href="Guacamole.Keyboard.html#event:onkeydown">onkeydown</a></li><li><a 
href="Guacamole.Keyboard.html#event:onkeyup">onkeyup</a></li><li><a 
href="Guacamole.Mouse.Touchpad.html#event:onmousedown">onmousedown</a></li><li><a
 
href="Guacamole.Mouse.Touchpad.html#event:onmousemove">onmousemove</a></li><li><a
 href="Guacamole.Mouse.Touchpad.html#event:onmouseup">onmouseup</a></li><li><a 
href="Guacamole.Mouse.Touchscreen.html#event:onmousedown">onmousedown</a></li><li><a
 
href="Guacamole.Mouse.Touchscreen.html#event:onmousemove">onmousemove</a></li><li><a
 
href="Guacamole.Mouse.Touchscreen.html#event:onmouseup">onmouseup</a></li><li><a
 href="Guacamole.Mouse.html#event:onmousedown">onmousedown</a></li><li><a 
href="Guacamole.Mouse.html#event:onmousemove">onmousemove</a></li><li><a 
href="Guacamole.Mouse.html#event:onmouseout">onmouseout</a></li><li><a 
href="Guacamole.Mouse.html#event:onmouseup">onmouseup</a></li><li><a h
 ref="Guacamole.Object.html#event:onbody">onbody</a></li><li><a 
href="Guacamole.Object.html#event:onundefine">onundefine</a></li><li><a 
href="Guacamole.OnScreenKeyboard.html#event:onkeydown">onkeydown</a></li><li><a 
href="Guacamole.OnScreenKeyboard.html#event:onkeyup">onkeyup</a></li><li><a 
href="Guacamole.OutputStream.html#event:onack">onack</a></li><li><a 
href="Guacamole.Parser.html#event:oninstruction">oninstruction</a></li><li><a 
href="Guacamole.RawAudioRecorder.html#event:onclose">onclose</a></li><li><a 
href="Guacamole.RawAudioRecorder.html#event:onerror">onerror</a></li><li><a 
href="Guacamole.SessionRecording._PlaybackTunnel.html#event:onerror">onerror</a></li><li><a
 
href="Guacamole.SessionRecording._PlaybackTunnel.html#event:oninstruction">oninstruction</a></li><li><a
 
href="Guacamole.SessionRecording._PlaybackTunnel.html#event:onstatechange">onstatechange</a></li><li><a
 href="Guacamole.SessionRecording.html#event:onpause">onpause</a></li><li><a 
href="Guacamole.SessionRecording
 .html#event:onplay">onplay</a></li><li><a 
href="Guacamole.SessionRecording.html#event:onprogress">onprogress</a></li><li><a
 href="Guacamole.SessionRecording.html#event:onseek">onseek</a></li><li><a 
href="Guacamole.StaticHTTPTunnel.html#event:onerror">onerror</a></li><li><a 
href="Guacamole.StaticHTTPTunnel.html#event:oninstruction">oninstruction</a></li><li><a
 
href="Guacamole.StaticHTTPTunnel.html#event:onstatechange">onstatechange</a></li><li><a
 href="Guacamole.StringReader.html#event:onend">onend</a></li><li><a 
href="Guacamole.StringReader.html#event:ontext">ontext</a></li><li><a 
href="Guacamole.StringWriter.html#event:onack">onack</a></li><li><a 
href="Guacamole.Tunnel.html#event:onerror">onerror</a></li><li><a 
href="Guacamole.Tunnel.html#event:oninstruction">oninstruction</a></li><li><a 
href="Guacamole.Tunnel.html#event:onstatechange">onstatechange</a></li><li><a 
href="Guacamole.WebSocketTunnel.html#event:onerror">onerror</a></li><li><a 
href="Guacamole.WebSocketTunnel.html#event:o
 ninstruction">oninstruction</a></li><li><a 
href="Guacamole.WebSocketTunnel.html#event:onstatechange">onstatechange</a></li></ul><h3>Namespaces</h3><ul><li><a
 href="Guacamole.html">Guacamole</a></li><li><a 
href="Guacamole.AudioContextFactory.html">AudioContextFactory</a></li></ul>
+</nav>
+
+<br class="clear">
+
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 
3.5.5</a> on Fri Dec 21 2018 13:47:10 GMT-0800 (PST)
+</footer>
+
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/guacamole-website/blob/044692cf/doc/1.0.0/guacamole-common-js/Guacamole.OnScreenKeyboard.Key.html
----------------------------------------------------------------------
diff --git a/doc/1.0.0/guacamole-common-js/Guacamole.OnScreenKeyboard.Key.html 
b/doc/1.0.0/guacamole-common-js/Guacamole.OnScreenKeyboard.Key.html
new file mode 100644
index 0000000..f8dc716
--- /dev/null
+++ b/doc/1.0.0/guacamole-common-js/Guacamole.OnScreenKeyboard.Key.html
@@ -0,0 +1,646 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Class: Key</title>
+
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+
+<body>
+
+<div id="main">
+
+    <h1 class="page-title">Class: Key</h1>
+
+    
+
+
+
+
+<section>
+
+<header>
+    
+        <h2><span class="attribs"><span class="type-signature"></span></span>
+            <span class="ancestors"><a href="Guacamole.html">Guacamole</a><a 
href="Guacamole.OnScreenKeyboard.html">.OnScreenKeyboard</a>.</span>Key<span 
class="signature">(template, name<span 
class="signature-attributes">opt</span>)</span><span 
class="type-signature"></span></h2>
+        
+    
+</header>
+
+<article>
+    <div class="container-overview">
+    
+        
+
+    
+
+    
+    <h4 class="name" id="Key"><span class="type-signature"></span>new Key<span 
class="signature">(template, name<span 
class="signature-attributes">opt</span>)</span><span 
class="type-signature"></span></h4>
+    
+
+    
+
+
+
+<div class="description">
+    Represents a single key, or a single possible behavior of a key. Each key
+on the on-screen keyboard must have at least one associated
+Guacamole.OnScreenKeyboard.Key, whether that key is explicitly defined or
+implied, and may have multiple Guacamole.OnScreenKeyboard.Key if behavior
+depends on modifier states.
+</div>
+
+
+
+
+
+
+
+
+
+    <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>template</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type"><a 
href="Guacamole.OnScreenKeyboard.Key.html">Guacamole.OnScreenKeyboard.Key</a></span>
+|
+
+<span class="param-type">Object</span>
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+
+                
+
+                
+                </td>
+            
+
+            
+
+            <td class="description last">The object whose identically-named 
properties will be used to initialize
+    the properties of this key.</td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>name</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">String</span>
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+                    &lt;optional><br>
+                
+
+                
+
+                
+                </td>
+            
+
+            
+
+            <td class="description last">The name to use instead of any name 
provided within the template, if
+    any. If omitted, the name within the template will be used, assuming the
+    template contains a name.</td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="OnScreenKeyboard.js.html">OnScreenKeyboard.js</a>, <a 
href="OnScreenKeyboard.js.html#line877">line 877</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    
+    </div>
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+        <h3 class="subsection-title">Members</h3>
+
+        
+            
+<h4 class="name" id="keysym"><span class="type-signature"></span>keysym<span 
class="type-signature"> :Number</span></h4>
+
+
+
+
+<div class="description">
+    The keysym to be pressed/released when this key is pressed/released. If
+not provided, this will be derived from the title if the title is a
+single character.
+</div>
+
+
+
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">Number</span>
+
+
+        </li>
+    </ul>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="OnScreenKeyboard.js.html">OnScreenKeyboard.js</a>, <a 
href="OnScreenKeyboard.js.html#line901">line 901</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+            
+<h4 class="name" id="modifier"><span 
class="type-signature"></span>modifier<span class="type-signature"> 
:String</span></h4>
+
+
+
+
+<div class="description">
+    The name of the modifier set when the key is pressed and cleared when
+this key is released, if any. The names of modifiers are distinct from
+the names of keys; both the "RightShift" and "LeftShift" keys may set
+the "shift" modifier, for example. By default, the key will affect no
+modifiers.
+</div>
+
+
+
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">String</span>
+
+
+        </li>
+    </ul>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="OnScreenKeyboard.js.html">OnScreenKeyboard.js</a>, <a 
href="OnScreenKeyboard.js.html#line930">line 930</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+            
+<h4 class="name" id="name"><span class="type-signature"></span>name<span 
class="type-signature"> :String</span></h4>
+
+
+
+
+<div class="description">
+    The unique name identifying this key within the keyboard layout.
+</div>
+
+
+
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">String</span>
+
+
+        </li>
+    </ul>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="OnScreenKeyboard.js.html">OnScreenKeyboard.js</a>, <a 
href="OnScreenKeyboard.js.html#line884">line 884</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+            
+<h4 class="name" id="requires"><span 
class="type-signature"></span>requires<span class="type-signature"> 
:Array.&lt;String></span></h4>
+
+
+
+
+<div class="description">
+    An array containing the names of each modifier required for this key to
+have an effect. For example, a lowercase letter may require nothing,
+while an uppercase letter would require "shift", assuming the Shift key
+is named "shift" within the layout. By default, the key will require
+no modifiers.
+</div>
+
+
+
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">Array.&lt;String></span>
+
+
+        </li>
+    </ul>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="OnScreenKeyboard.js.html">OnScreenKeyboard.js</a>, <a 
href="OnScreenKeyboard.js.html#line941">line 941</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+            
+<h4 class="name" id="title"><span class="type-signature"></span>title<span 
class="type-signature"> :String</span></h4>
+
+
+
+
+<div class="description">
+    The human-readable title that will be displayed to the user within the
+key. If not provided, this will be derived from the key name.
+</div>
+
+
+
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">String</span>
+
+
+        </li>
+    </ul>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="OnScreenKeyboard.js.html">OnScreenKeyboard.js</a>, <a 
href="OnScreenKeyboard.js.html#line892">line 892</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+    
+
+    
+
+    
+
+    
+</article>
+
+</section>
+
+
+
+
+</div>
+
+<nav>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a 
href="Guacamole.ArrayBufferReader.html">ArrayBufferReader</a></li><li><a 
href="Guacamole.ArrayBufferWriter.html">ArrayBufferWriter</a></li><li><a 
href="Guacamole.AudioPlayer.html">AudioPlayer</a></li><li><a 
href="Guacamole.AudioRecorder.html">AudioRecorder</a></li><li><a 
href="Guacamole.BlobReader.html">BlobReader</a></li><li><a 
href="Guacamole.BlobWriter.html">BlobWriter</a></li><li><a 
href="Guacamole.ChainedTunnel.html">ChainedTunnel</a></li><li><a 
href="Guacamole.Client.html">Client</a></li><li><a 
href="Guacamole.DataURIReader.html">DataURIReader</a></li><li><a 
href="Guacamole.Display.html">Display</a></li><li><a 
href="Guacamole.Display.VisibleLayer.html">VisibleLayer</a></li><li><a 
href="Guacamole.HTTPTunnel.html">HTTPTunnel</a></li><li><a 
href="Guacamole.InputSink.html">InputSink</a></li><li><a 
href="Guacamole.InputStream.html">InputStream</a></li><li><a 
href="Guacamole.IntegerPool.html">IntegerPool</a></li><l
 i><a href="Guacamole.JSONReader.html">JSONReader</a></li><li><a 
href="Guacamole.Keyboard.html">Keyboard</a></li><li><a 
href="Guacamole.Keyboard.ModifierState.html">ModifierState</a></li><li><a 
href="Guacamole.Layer.html">Layer</a></li><li><a 
href="Guacamole.Layer.Pixel.html">Pixel</a></li><li><a 
href="Guacamole.Mouse.html">Mouse</a></li><li><a 
href="Guacamole.Mouse.State.html">State</a></li><li><a 
href="Guacamole.Mouse.Touchpad.html">Touchpad</a></li><li><a 
href="Guacamole.Mouse.Touchscreen.html">Touchscreen</a></li><li><a 
href="Guacamole.Object.html">Object</a></li><li><a 
href="Guacamole.OnScreenKeyboard.html">OnScreenKeyboard</a></li><li><a 
href="Guacamole.OnScreenKeyboard.Key.html">Key</a></li><li><a 
href="Guacamole.OnScreenKeyboard.Layout.html">Layout</a></li><li><a 
href="Guacamole.OutputStream.html">OutputStream</a></li><li><a 
href="Guacamole.Parser.html">Parser</a></li><li><a 
href="Guacamole.RawAudioFormat.html">RawAudioFormat</a></li><li><a 
href="Guacamole.RawAudioPlayer.html
 ">RawAudioPlayer</a></li><li><a 
href="Guacamole.RawAudioRecorder.html">RawAudioRecorder</a></li><li><a 
href="Guacamole.SessionRecording.html">SessionRecording</a></li><li><a 
href="Guacamole.StaticHTTPTunnel.html">StaticHTTPTunnel</a></li><li><a 
href="Guacamole.Status.html">Status</a></li><li><a 
href="Guacamole.StringReader.html">StringReader</a></li><li><a 
href="Guacamole.StringWriter.html">StringWriter</a></li><li><a 
href="Guacamole.Tunnel.html">Tunnel</a></li><li><a 
href="Guacamole.VideoPlayer.html">VideoPlayer</a></li><li><a 
href="Guacamole.WebSocketTunnel.html">WebSocketTunnel</a></li></ul><h3>Events</h3><ul><li><a
 href="Guacamole.ArrayBufferReader.html#event:ondata">ondata</a></li><li><a 
href="Guacamole.ArrayBufferReader.html#event:onend">onend</a></li><li><a 
href="Guacamole.ArrayBufferWriter.html#event:onack">onack</a></li><li><a 
href="Guacamole.AudioRecorder.html#event:onclose">onclose</a></li><li><a 
href="Guacamole.AudioRecorder.html#event:onerror">onerror</a></li><li><a hre
 f="Guacamole.BlobReader.html#event:onend">onend</a></li><li><a 
href="Guacamole.BlobReader.html#event:onprogress">onprogress</a></li><li><a 
href="Guacamole.BlobWriter.html#event:onack">onack</a></li><li><a 
href="Guacamole.BlobWriter.html#event:oncomplete">oncomplete</a></li><li><a 
href="Guacamole.BlobWriter.html#event:onerror">onerror</a></li><li><a 
href="Guacamole.BlobWriter.html#event:onprogress">onprogress</a></li><li><a 
href="Guacamole.ChainedTunnel.html#event:onerror">onerror</a></li><li><a 
href="Guacamole.ChainedTunnel.html#event:oninstruction">oninstruction</a></li><li><a
 
href="Guacamole.ChainedTunnel.html#event:onstatechange">onstatechange</a></li><li><a
 href="Guacamole.Client.html#event:onaudio">onaudio</a></li><li><a 
href="Guacamole.Client.html#event:onclipboard">onclipboard</a></li><li><a 
href="Guacamole.Client.html#event:onerror">onerror</a></li><li><a 
href="Guacamole.Client.html#event:onfile">onfile</a></li><li><a 
href="Guacamole.Client.html#event:onfilesystem">onfilesys
 tem</a></li><li><a 
href="Guacamole.Client.html#event:onname">onname</a></li><li><a 
href="Guacamole.Client.html#event:onpipe">onpipe</a></li><li><a 
href="Guacamole.Client.html#event:onstatechange">onstatechange</a></li><li><a 
href="Guacamole.Client.html#event:onsync">onsync</a></li><li><a 
href="Guacamole.Client.html#event:onvideo">onvideo</a></li><li><a 
href="Guacamole.DataURIReader.html#event:onend">onend</a></li><li><a 
href="Guacamole.Display.html#event:oncursor">oncursor</a></li><li><a 
href="Guacamole.Display.html#event:onresize">onresize</a></li><li><a 
href="Guacamole.HTTPTunnel.html#event:onerror">onerror</a></li><li><a 
href="Guacamole.HTTPTunnel.html#event:oninstruction">oninstruction</a></li><li><a
 
href="Guacamole.HTTPTunnel.html#event:onstatechange">onstatechange</a></li><li><a
 href="Guacamole.InputStream.html#event:onblob">onblob</a></li><li><a 
href="Guacamole.InputStream.html#event:onend">onend</a></li><li><a 
href="Guacamole.JSONReader.html#event:onend">onend</a></li><li><a
  href="Guacamole.JSONReader.html#event:onprogress">onprogress</a></li><li><a 
href="Guacamole.Keyboard.html#event:onkeydown">onkeydown</a></li><li><a 
href="Guacamole.Keyboard.html#event:onkeyup">onkeyup</a></li><li><a 
href="Guacamole.Mouse.Touchpad.html#event:onmousedown">onmousedown</a></li><li><a
 
href="Guacamole.Mouse.Touchpad.html#event:onmousemove">onmousemove</a></li><li><a
 href="Guacamole.Mouse.Touchpad.html#event:onmouseup">onmouseup</a></li><li><a 
href="Guacamole.Mouse.Touchscreen.html#event:onmousedown">onmousedown</a></li><li><a
 
href="Guacamole.Mouse.Touchscreen.html#event:onmousemove">onmousemove</a></li><li><a
 
href="Guacamole.Mouse.Touchscreen.html#event:onmouseup">onmouseup</a></li><li><a
 href="Guacamole.Mouse.html#event:onmousedown">onmousedown</a></li><li><a 
href="Guacamole.Mouse.html#event:onmousemove">onmousemove</a></li><li><a 
href="Guacamole.Mouse.html#event:onmouseout">onmouseout</a></li><li><a 
href="Guacamole.Mouse.html#event:onmouseup">onmouseup</a></li><li><a h
 ref="Guacamole.Object.html#event:onbody">onbody</a></li><li><a 
href="Guacamole.Object.html#event:onundefine">onundefine</a></li><li><a 
href="Guacamole.OnScreenKeyboard.html#event:onkeydown">onkeydown</a></li><li><a 
href="Guacamole.OnScreenKeyboard.html#event:onkeyup">onkeyup</a></li><li><a 
href="Guacamole.OutputStream.html#event:onack">onack</a></li><li><a 
href="Guacamole.Parser.html#event:oninstruction">oninstruction</a></li><li><a 
href="Guacamole.RawAudioRecorder.html#event:onclose">onclose</a></li><li><a 
href="Guacamole.RawAudioRecorder.html#event:onerror">onerror</a></li><li><a 
href="Guacamole.SessionRecording._PlaybackTunnel.html#event:onerror">onerror</a></li><li><a
 
href="Guacamole.SessionRecording._PlaybackTunnel.html#event:oninstruction">oninstruction</a></li><li><a
 
href="Guacamole.SessionRecording._PlaybackTunnel.html#event:onstatechange">onstatechange</a></li><li><a
 href="Guacamole.SessionRecording.html#event:onpause">onpause</a></li><li><a 
href="Guacamole.SessionRecording
 .html#event:onplay">onplay</a></li><li><a 
href="Guacamole.SessionRecording.html#event:onprogress">onprogress</a></li><li><a
 href="Guacamole.SessionRecording.html#event:onseek">onseek</a></li><li><a 
href="Guacamole.StaticHTTPTunnel.html#event:onerror">onerror</a></li><li><a 
href="Guacamole.StaticHTTPTunnel.html#event:oninstruction">oninstruction</a></li><li><a
 
href="Guacamole.StaticHTTPTunnel.html#event:onstatechange">onstatechange</a></li><li><a
 href="Guacamole.StringReader.html#event:onend">onend</a></li><li><a 
href="Guacamole.StringReader.html#event:ontext">ontext</a></li><li><a 
href="Guacamole.StringWriter.html#event:onack">onack</a></li><li><a 
href="Guacamole.Tunnel.html#event:onerror">onerror</a></li><li><a 
href="Guacamole.Tunnel.html#event:oninstruction">oninstruction</a></li><li><a 
href="Guacamole.Tunnel.html#event:onstatechange">onstatechange</a></li><li><a 
href="Guacamole.WebSocketTunnel.html#event:onerror">onerror</a></li><li><a 
href="Guacamole.WebSocketTunnel.html#event:o
 ninstruction">oninstruction</a></li><li><a 
href="Guacamole.WebSocketTunnel.html#event:onstatechange">onstatechange</a></li></ul><h3>Namespaces</h3><ul><li><a
 href="Guacamole.html">Guacamole</a></li><li><a 
href="Guacamole.AudioContextFactory.html">AudioContextFactory</a></li></ul>
+</nav>
+
+<br class="clear">
+
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 
3.5.5</a> on Fri Dec 21 2018 13:47:10 GMT-0800 (PST)
+</footer>
+
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/guacamole-website/blob/044692cf/doc/1.0.0/guacamole-common-js/Guacamole.OnScreenKeyboard.Layout.html
----------------------------------------------------------------------
diff --git 
a/doc/1.0.0/guacamole-common-js/Guacamole.OnScreenKeyboard.Layout.html 
b/doc/1.0.0/guacamole-common-js/Guacamole.OnScreenKeyboard.Layout.html
new file mode 100644
index 0000000..b9f0ee9
--- /dev/null
+++ b/doc/1.0.0/guacamole-common-js/Guacamole.OnScreenKeyboard.Layout.html
@@ -0,0 +1,677 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Class: Layout</title>
+
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+
+<body>
+
+<div id="main">
+
+    <h1 class="page-title">Class: Layout</h1>
+
+    
+
+
+
+
+<section>
+
+<header>
+    
+        <h2><span class="attribs"><span class="type-signature"></span></span>
+            <span class="ancestors"><a href="Guacamole.html">Guacamole</a><a 
href="Guacamole.OnScreenKeyboard.html">.OnScreenKeyboard</a>.</span>Layout<span 
class="signature">(template)</span><span class="type-signature"></span></h2>
+        
+    
+</header>
+
+<article>
+    <div class="container-overview">
+    
+        
+
+    
+
+    
+    <h4 class="name" id="Layout"><span class="type-signature"></span>new 
Layout<span class="signature">(template)</span><span 
class="type-signature"></span></h4>
+    
+
+    
+
+
+
+<div class="description">
+    Represents an entire on-screen keyboard layout, including all available
+keys, their behaviors, and their relative position and sizing.
+</div>
+
+
+
+
+
+
+
+
+
+    <h5>Parameters:</h5>
+    
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>template</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type"><a 
href="Guacamole.OnScreenKeyboard.Layout.html">Guacamole.OnScreenKeyboard.Layout</a></span>
+|
+
+<span class="param-type">Object</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last">The object whose identically-named 
properties will be used to initialize
+    the properties of this layout.</td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="OnScreenKeyboard.js.html">OnScreenKeyboard.js</a>, <a 
href="OnScreenKeyboard.js.html#line796">line 796</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    
+    </div>
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+        <h3 class="subsection-title">Members</h3>
+
+        
+            
+<h4 class="name" id="keys"><span class="type-signature"></span>keys<span 
class="type-signature"> :Object.&lt;String, (Number|String|<a 
href="Guacamole.OnScreenKeyboard.Key.html">Guacamole.OnScreenKeyboard.Key</a>|Array.&lt;<a
 
href="Guacamole.OnScreenKeyboard.Key.html">Guacamole.OnScreenKeyboard.Key</a>>)></span></h4>
+
+
+
+
+<div class="description">
+    Map of key name to corresponding keysym, title, or key object. If only
+the keysym or title is provided, the key object will be created
+implicitly. In all cases, the name property of the key object will be
+taken from the name given in the mapping.
+</div>
+
+
+
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">Object.&lt;String, (Number|String|<a 
href="Guacamole.OnScreenKeyboard.Key.html">Guacamole.OnScreenKeyboard.Key</a>|Array.&lt;<a
 
href="Guacamole.OnScreenKeyboard.Key.html">Guacamole.OnScreenKeyboard.Key</a>>)></span>
+
+
+        </li>
+    </ul>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="OnScreenKeyboard.js.html">OnScreenKeyboard.js</a>, <a 
href="OnScreenKeyboard.js.html#line823">line 823</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+            
+<h4 class="name" id="keyWidths"><span 
class="type-signature"></span>keyWidths<span class="type-signature"> 
:Object.&lt;String, Number></span></h4>
+
+
+
+
+<div class="description">
+    The width of each key, in arbitrary units, relative to other keys in
+this layout. The true pixel size of each key will be determined by the
+overall size of the keyboard. If not defined here, the width of each
+key will default to 1.
+</div>
+
+
+
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">Object.&lt;String, Number></span>
+
+
+        </li>
+    </ul>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="OnScreenKeyboard.js.html">OnScreenKeyboard.js</a>, <a 
href="OnScreenKeyboard.js.html#line856">line 856</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+            
+<h4 class="name" id="language"><span 
class="type-signature"></span>language<span class="type-signature"> 
:String</span></h4>
+
+
+
+
+<div class="description">
+    The language of keyboard layout, such as "en_US". This property is for
+informational purposes only, but it is recommend to conform to the
+[language code]_[country code] format.
+</div>
+
+
+
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">String</span>
+
+
+        </li>
+    </ul>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="OnScreenKeyboard.js.html">OnScreenKeyboard.js</a>, <a 
href="OnScreenKeyboard.js.html#line805">line 805</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+            
+<h4 class="name" id="layout"><span class="type-signature"></span>layout<span 
class="type-signature"> :Object</span></h4>
+
+
+
+
+<div class="description">
+    Arbitrarily nested, arbitrarily grouped key names. The contents of the
+layout will be traversed to produce an identically-nested grouping of
+keys in the DOM tree. All strings will be transformed into their
+corresponding sets of keys, while all objects and arrays will be
+transformed into named groups and anonymous groups respectively. Any
+numbers present will be transformed into gaps of that size, scaled
+according to the same units as each key.
+</div>
+
+
+
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">Object</span>
+
+
+        </li>
+    </ul>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="OnScreenKeyboard.js.html">OnScreenKeyboard.js</a>, <a 
href="OnScreenKeyboard.js.html#line836">line 836</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+            
+<h4 class="name" id="type"><span class="type-signature"></span>type<span 
class="type-signature"> :String</span></h4>
+
+
+
+
+<div class="description">
+    The type of keyboard layout, such as "qwerty". This property is for
+informational purposes only, and does not conform to any standard.
+</div>
+
+
+
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">String</span>
+
+
+        </li>
+    </ul>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="OnScreenKeyboard.js.html">OnScreenKeyboard.js</a>, <a 
href="OnScreenKeyboard.js.html#line813">line 813</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+            
+<h4 class="name" id="width"><span class="type-signature"></span>width<span 
class="type-signature"> :Number</span></h4>
+
+
+
+
+<div class="description">
+    The width of the entire keyboard, in arbitrary units. The width of each
+key is relative to this width, as both width values are assumed to be in
+the same units. The conversion factor between these units and pixels is
+derived later via a call to resize() on the Guacamole.OnScreenKeyboard.
+</div>
+
+
+
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">Number</span>
+
+
+        </li>
+    </ul>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="OnScreenKeyboard.js.html">OnScreenKeyboard.js</a>, <a 
href="OnScreenKeyboard.js.html#line846">line 846</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+    
+
+    
+
+    
+
+    
+</article>
+
+</section>
+
+
+
+
+</div>
+
+<nav>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a 
href="Guacamole.ArrayBufferReader.html">ArrayBufferReader</a></li><li><a 
href="Guacamole.ArrayBufferWriter.html">ArrayBufferWriter</a></li><li><a 
href="Guacamole.AudioPlayer.html">AudioPlayer</a></li><li><a 
href="Guacamole.AudioRecorder.html">AudioRecorder</a></li><li><a 
href="Guacamole.BlobReader.html">BlobReader</a></li><li><a 
href="Guacamole.BlobWriter.html">BlobWriter</a></li><li><a 
href="Guacamole.ChainedTunnel.html">ChainedTunnel</a></li><li><a 
href="Guacamole.Client.html">Client</a></li><li><a 
href="Guacamole.DataURIReader.html">DataURIReader</a></li><li><a 
href="Guacamole.Display.html">Display</a></li><li><a 
href="Guacamole.Display.VisibleLayer.html">VisibleLayer</a></li><li><a 
href="Guacamole.HTTPTunnel.html">HTTPTunnel</a></li><li><a 
href="Guacamole.InputSink.html">InputSink</a></li><li><a 
href="Guacamole.InputStream.html">InputStream</a></li><li><a 
href="Guacamole.IntegerPool.html">IntegerPool</a></li><l
 i><a href="Guacamole.JSONReader.html">JSONReader</a></li><li><a 
href="Guacamole.Keyboard.html">Keyboard</a></li><li><a 
href="Guacamole.Keyboard.ModifierState.html">ModifierState</a></li><li><a 
href="Guacamole.Layer.html">Layer</a></li><li><a 
href="Guacamole.Layer.Pixel.html">Pixel</a></li><li><a 
href="Guacamole.Mouse.html">Mouse</a></li><li><a 
href="Guacamole.Mouse.State.html">State</a></li><li><a 
href="Guacamole.Mouse.Touchpad.html">Touchpad</a></li><li><a 
href="Guacamole.Mouse.Touchscreen.html">Touchscreen</a></li><li><a 
href="Guacamole.Object.html">Object</a></li><li><a 
href="Guacamole.OnScreenKeyboard.html">OnScreenKeyboard</a></li><li><a 
href="Guacamole.OnScreenKeyboard.Key.html">Key</a></li><li><a 
href="Guacamole.OnScreenKeyboard.Layout.html">Layout</a></li><li><a 
href="Guacamole.OutputStream.html">OutputStream</a></li><li><a 
href="Guacamole.Parser.html">Parser</a></li><li><a 
href="Guacamole.RawAudioFormat.html">RawAudioFormat</a></li><li><a 
href="Guacamole.RawAudioPlayer.html
 ">RawAudioPlayer</a></li><li><a 
href="Guacamole.RawAudioRecorder.html">RawAudioRecorder</a></li><li><a 
href="Guacamole.SessionRecording.html">SessionRecording</a></li><li><a 
href="Guacamole.StaticHTTPTunnel.html">StaticHTTPTunnel</a></li><li><a 
href="Guacamole.Status.html">Status</a></li><li><a 
href="Guacamole.StringReader.html">StringReader</a></li><li><a 
href="Guacamole.StringWriter.html">StringWriter</a></li><li><a 
href="Guacamole.Tunnel.html">Tunnel</a></li><li><a 
href="Guacamole.VideoPlayer.html">VideoPlayer</a></li><li><a 
href="Guacamole.WebSocketTunnel.html">WebSocketTunnel</a></li></ul><h3>Events</h3><ul><li><a
 href="Guacamole.ArrayBufferReader.html#event:ondata">ondata</a></li><li><a 
href="Guacamole.ArrayBufferReader.html#event:onend">onend</a></li><li><a 
href="Guacamole.ArrayBufferWriter.html#event:onack">onack</a></li><li><a 
href="Guacamole.AudioRecorder.html#event:onclose">onclose</a></li><li><a 
href="Guacamole.AudioRecorder.html#event:onerror">onerror</a></li><li><a hre
 f="Guacamole.BlobReader.html#event:onend">onend</a></li><li><a 
href="Guacamole.BlobReader.html#event:onprogress">onprogress</a></li><li><a 
href="Guacamole.BlobWriter.html#event:onack">onack</a></li><li><a 
href="Guacamole.BlobWriter.html#event:oncomplete">oncomplete</a></li><li><a 
href="Guacamole.BlobWriter.html#event:onerror">onerror</a></li><li><a 
href="Guacamole.BlobWriter.html#event:onprogress">onprogress</a></li><li><a 
href="Guacamole.ChainedTunnel.html#event:onerror">onerror</a></li><li><a 
href="Guacamole.ChainedTunnel.html#event:oninstruction">oninstruction</a></li><li><a
 
href="Guacamole.ChainedTunnel.html#event:onstatechange">onstatechange</a></li><li><a
 href="Guacamole.Client.html#event:onaudio">onaudio</a></li><li><a 
href="Guacamole.Client.html#event:onclipboard">onclipboard</a></li><li><a 
href="Guacamole.Client.html#event:onerror">onerror</a></li><li><a 
href="Guacamole.Client.html#event:onfile">onfile</a></li><li><a 
href="Guacamole.Client.html#event:onfilesystem">onfilesys
 tem</a></li><li><a 
href="Guacamole.Client.html#event:onname">onname</a></li><li><a 
href="Guacamole.Client.html#event:onpipe">onpipe</a></li><li><a 
href="Guacamole.Client.html#event:onstatechange">onstatechange</a></li><li><a 
href="Guacamole.Client.html#event:onsync">onsync</a></li><li><a 
href="Guacamole.Client.html#event:onvideo">onvideo</a></li><li><a 
href="Guacamole.DataURIReader.html#event:onend">onend</a></li><li><a 
href="Guacamole.Display.html#event:oncursor">oncursor</a></li><li><a 
href="Guacamole.Display.html#event:onresize">onresize</a></li><li><a 
href="Guacamole.HTTPTunnel.html#event:onerror">onerror</a></li><li><a 
href="Guacamole.HTTPTunnel.html#event:oninstruction">oninstruction</a></li><li><a
 
href="Guacamole.HTTPTunnel.html#event:onstatechange">onstatechange</a></li><li><a
 href="Guacamole.InputStream.html#event:onblob">onblob</a></li><li><a 
href="Guacamole.InputStream.html#event:onend">onend</a></li><li><a 
href="Guacamole.JSONReader.html#event:onend">onend</a></li><li><a
  href="Guacamole.JSONReader.html#event:onprogress">onprogress</a></li><li><a 
href="Guacamole.Keyboard.html#event:onkeydown">onkeydown</a></li><li><a 
href="Guacamole.Keyboard.html#event:onkeyup">onkeyup</a></li><li><a 
href="Guacamole.Mouse.Touchpad.html#event:onmousedown">onmousedown</a></li><li><a
 
href="Guacamole.Mouse.Touchpad.html#event:onmousemove">onmousemove</a></li><li><a
 href="Guacamole.Mouse.Touchpad.html#event:onmouseup">onmouseup</a></li><li><a 
href="Guacamole.Mouse.Touchscreen.html#event:onmousedown">onmousedown</a></li><li><a
 
href="Guacamole.Mouse.Touchscreen.html#event:onmousemove">onmousemove</a></li><li><a
 
href="Guacamole.Mouse.Touchscreen.html#event:onmouseup">onmouseup</a></li><li><a
 href="Guacamole.Mouse.html#event:onmousedown">onmousedown</a></li><li><a 
href="Guacamole.Mouse.html#event:onmousemove">onmousemove</a></li><li><a 
href="Guacamole.Mouse.html#event:onmouseout">onmouseout</a></li><li><a 
href="Guacamole.Mouse.html#event:onmouseup">onmouseup</a></li><li><a h
 ref="Guacamole.Object.html#event:onbody">onbody</a></li><li><a 
href="Guacamole.Object.html#event:onundefine">onundefine</a></li><li><a 
href="Guacamole.OnScreenKeyboard.html#event:onkeydown">onkeydown</a></li><li><a 
href="Guacamole.OnScreenKeyboard.html#event:onkeyup">onkeyup</a></li><li><a 
href="Guacamole.OutputStream.html#event:onack">onack</a></li><li><a 
href="Guacamole.Parser.html#event:oninstruction">oninstruction</a></li><li><a 
href="Guacamole.RawAudioRecorder.html#event:onclose">onclose</a></li><li><a 
href="Guacamole.RawAudioRecorder.html#event:onerror">onerror</a></li><li><a 
href="Guacamole.SessionRecording._PlaybackTunnel.html#event:onerror">onerror</a></li><li><a
 
href="Guacamole.SessionRecording._PlaybackTunnel.html#event:oninstruction">oninstruction</a></li><li><a
 
href="Guacamole.SessionRecording._PlaybackTunnel.html#event:onstatechange">onstatechange</a></li><li><a
 href="Guacamole.SessionRecording.html#event:onpause">onpause</a></li><li><a 
href="Guacamole.SessionRecording
 .html#event:onplay">onplay</a></li><li><a 
href="Guacamole.SessionRecording.html#event:onprogress">onprogress</a></li><li><a
 href="Guacamole.SessionRecording.html#event:onseek">onseek</a></li><li><a 
href="Guacamole.StaticHTTPTunnel.html#event:onerror">onerror</a></li><li><a 
href="Guacamole.StaticHTTPTunnel.html#event:oninstruction">oninstruction</a></li><li><a
 
href="Guacamole.StaticHTTPTunnel.html#event:onstatechange">onstatechange</a></li><li><a
 href="Guacamole.StringReader.html#event:onend">onend</a></li><li><a 
href="Guacamole.StringReader.html#event:ontext">ontext</a></li><li><a 
href="Guacamole.StringWriter.html#event:onack">onack</a></li><li><a 
href="Guacamole.Tunnel.html#event:onerror">onerror</a></li><li><a 
href="Guacamole.Tunnel.html#event:oninstruction">oninstruction</a></li><li><a 
href="Guacamole.Tunnel.html#event:onstatechange">onstatechange</a></li><li><a 
href="Guacamole.WebSocketTunnel.html#event:onerror">onerror</a></li><li><a 
href="Guacamole.WebSocketTunnel.html#event:o
 ninstruction">oninstruction</a></li><li><a 
href="Guacamole.WebSocketTunnel.html#event:onstatechange">onstatechange</a></li></ul><h3>Namespaces</h3><ul><li><a
 href="Guacamole.html">Guacamole</a></li><li><a 
href="Guacamole.AudioContextFactory.html">AudioContextFactory</a></li></ul>
+</nav>
+
+<br class="clear">
+
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 
3.5.5</a> on Fri Dec 21 2018 13:47:10 GMT-0800 (PST)
+</footer>
+
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/guacamole-website/blob/044692cf/doc/1.0.0/guacamole-common-js/Guacamole.OnScreenKeyboard.html
----------------------------------------------------------------------
diff --git a/doc/1.0.0/guacamole-common-js/Guacamole.OnScreenKeyboard.html 
b/doc/1.0.0/guacamole-common-js/Guacamole.OnScreenKeyboard.html
new file mode 100644
index 0000000..d0a9d6d
--- /dev/null
+++ b/doc/1.0.0/guacamole-common-js/Guacamole.OnScreenKeyboard.html
@@ -0,0 +1,976 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Class: OnScreenKeyboard</title>
+
+    <script src="scripts/prettify/prettify.js"> </script>
+    <script src="scripts/prettify/lang-css.js"> </script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+
+<body>
+
+<div id="main">
+
+    <h1 class="page-title">Class: OnScreenKeyboard</h1>
+
+    
+
+
+
+
+<section>
+
+<header>
+    
+        <h2><span class="attribs"><span class="type-signature"></span></span>
+            <span class="ancestors"><a 
href="Guacamole.html">Guacamole</a>.</span>OnScreenKeyboard<span 
class="signature">(layout)</span><span class="type-signature"></span></h2>
+        
+    
+</header>
+
+<article>
+    <div class="container-overview">
+    
+        
+
+    
+
+    
+    <h4 class="name" id="OnScreenKeyboard"><span 
class="type-signature"></span>new OnScreenKeyboard<span 
class="signature">(layout)</span><span class="type-signature"></span></h4>
+    
+
+    
+
+
+
+<div class="description">
+    Dynamic on-screen keyboard. Given the layout object for an on-screen
+keyboard, this object will construct a clickable on-screen keyboard with its
+own key events.
+</div>
+
+
+
+
+
+
+
+
+
+    <h5>Parameters:</h5>
+    
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>layout</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type"><a 
href="Guacamole.OnScreenKeyboard.Layout.html">Guacamole.OnScreenKeyboard.Layout</a></span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last">The layout of the on-screen keyboard 
to display.</td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="OnScreenKeyboard.js.html">OnScreenKeyboard.js</a>, <a 
href="OnScreenKeyboard.js.html#line31">line 31</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    
+    </div>
+
+    
+
+    
+
+    
+        <h3 class="subsection-title">Classes</h3>
+
+        <dl>
+            <dt><a href="Guacamole.OnScreenKeyboard.Key.html">Key</a></dt>
+            <dd></dd>
+        
+            <dt><a 
href="Guacamole.OnScreenKeyboard.Layout.html">Layout</a></dt>
+            <dd></dd>
+        </dl>
+    
+
+    
+
+    
+
+    
+
+    
+        <h3 class="subsection-title">Members</h3>
+
+        
+            
+<h4 class="name" id="keys"><span class="type-signature"></span>keys<span 
class="type-signature"> :Object.&lt;String, Array.&lt;<a 
href="Guacamole.OnScreenKeyboard.Key.html">Guacamole.OnScreenKeyboard.Key</a>>></span></h4>
+
+
+
+
+<div class="description">
+    Map of all key names to their corresponding set of keys. Each key name
+may correspond to multiple keys due to the effect of modifiers.
+</div>
+
+
+
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">Object.&lt;String, Array.&lt;<a 
href="Guacamole.OnScreenKeyboard.Key.html">Guacamole.OnScreenKeyboard.Key</a>>></span>
+
+
+        </li>
+    </ul>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="OnScreenKeyboard.js.html">OnScreenKeyboard.js</a>, <a 
href="OnScreenKeyboard.js.html#line543">line 543</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+            
+<h4 class="name" id="layout"><span class="type-signature"></span>layout<span 
class="type-signature"> :<a 
href="Guacamole.OnScreenKeyboard.Layout.html">Guacamole.OnScreenKeyboard.Layout</a></span></h4>
+
+
+
+
+<div class="description">
+    The keyboard layout provided at time of construction.
+</div>
+
+
+
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type"><a 
href="Guacamole.OnScreenKeyboard.Layout.html">Guacamole.OnScreenKeyboard.Layout</a></span>
+
+
+        </li>
+    </ul>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="OnScreenKeyboard.js.html">OnScreenKeyboard.js</a>, <a 
href="OnScreenKeyboard.js.html#line427">line 427</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+            
+<h4 class="name" id="touchMouseThreshold"><span 
class="type-signature"></span>touchMouseThreshold<span class="type-signature"> 
:Number</span></h4>
+
+
+
+
+<div class="description">
+    The number of mousemove events to require before re-enabling mouse
+event handling after receiving a touch event.
+</div>
+
+
+
+    <h5>Type:</h5>
+    <ul>
+        <li>
+            
+<span class="param-type">Number</span>
+
+
+        </li>
+    </ul>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="OnScreenKeyboard.js.html">OnScreenKeyboard.js</a>, <a 
href="OnScreenKeyboard.js.html#line404">line 404</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+    
+
+    
+        <h3 class="subsection-title">Methods</h3>
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="getElement"><span 
class="type-signature"></span>getElement<span class="signature">()</span><span 
class="type-signature"> &rarr; {Element}</span></h4>
+    
+
+    
+
+
+
+<div class="description">
+    Returns the element containing the entire on-screen keyboard.
+</div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="OnScreenKeyboard.js.html">OnScreenKeyboard.js</a>, <a 
href="OnScreenKeyboard.js.html#line433">line 433</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+<div class="param-desc">
+    The element containing the entire on-screen keyboard.
+</div>
+
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">Element</span>
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="resize"><span 
class="type-signature"></span>resize<span class="signature">(width)</span><span 
class="type-signature"></span></h4>
+    
+
+    
+
+
+
+<div class="description">
+    Resizes all elements within this Guacamole.OnScreenKeyboard such that
+the width is close to but does not exceed the specified width. The
+height of the keyboard is determined based on the width.
+</div>
+
+
+
+
+
+
+
+
+
+    <h5>Parameters:</h5>
+    
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>width</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">Number</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last">The width to resize this 
Guacamole.OnScreenKeyboard
+                      to, in pixels.</td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="OnScreenKeyboard.js.html">OnScreenKeyboard.js</a>, <a 
href="OnScreenKeyboard.js.html#line445">line 445</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+        
+    
+
+    
+
+    
+        <h3 class="subsection-title">Events</h3>
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="event:onkeydown">onkeydown</h4>
+    
+
+    
+
+
+
+<div class="description">
+    Fired whenever the user presses a key on this Guacamole.OnScreenKeyboard.
+</div>
+
+
+
+
+
+
+
+
+
+    <h5>Parameters:</h5>
+    
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>keysym</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">Number</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last">The keysym of the key being 
pressed.</td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="OnScreenKeyboard.js.html">OnScreenKeyboard.js</a>, <a 
href="OnScreenKeyboard.js.html#line412">line 412</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="event:onkeyup">onkeyup</h4>
+    
+
+    
+
+
+
+<div class="description">
+    Fired whenever the user releases a key on this Guacamole.OnScreenKeyboard.
+</div>
+
+
+
+
+
+
+
+
+
+    <h5>Parameters:</h5>
+    
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>keysym</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">Number</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last">The keysym of the key being 
released.</td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="OnScreenKeyboard.js.html">OnScreenKeyboard.js</a>, <a 
href="OnScreenKeyboard.js.html#line420">line 420</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+        
+    
+</article>
+
+</section>
+
+
+
+
+</div>
+
+<nav>
+    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a 
href="Guacamole.ArrayBufferReader.html">ArrayBufferReader</a></li><li><a 
href="Guacamole.ArrayBufferWriter.html">ArrayBufferWriter</a></li><li><a 
href="Guacamole.AudioPlayer.html">AudioPlayer</a></li><li><a 
href="Guacamole.AudioRecorder.html">AudioRecorder</a></li><li><a 
href="Guacamole.BlobReader.html">BlobReader</a></li><li><a 
href="Guacamole.BlobWriter.html">BlobWriter</a></li><li><a 
href="Guacamole.ChainedTunnel.html">ChainedTunnel</a></li><li><a 
href="Guacamole.Client.html">Client</a></li><li><a 
href="Guacamole.DataURIReader.html">DataURIReader</a></li><li><a 
href="Guacamole.Display.html">Display</a></li><li><a 
href="Guacamole.Display.VisibleLayer.html">VisibleLayer</a></li><li><a 
href="Guacamole.HTTPTunnel.html">HTTPTunnel</a></li><li><a 
href="Guacamole.InputSink.html">InputSink</a></li><li><a 
href="Guacamole.InputStream.html">InputStream</a></li><li><a 
href="Guacamole.IntegerPool.html">IntegerPool</a></li><l
 i><a href="Guacamole.JSONReader.html">JSONReader</a></li><li><a 
href="Guacamole.Keyboard.html">Keyboard</a></li><li><a 
href="Guacamole.Keyboard.ModifierState.html">ModifierState</a></li><li><a 
href="Guacamole.Layer.html">Layer</a></li><li><a 
href="Guacamole.Layer.Pixel.html">Pixel</a></li><li><a 
href="Guacamole.Mouse.html">Mouse</a></li><li><a 
href="Guacamole.Mouse.State.html">State</a></li><li><a 
href="Guacamole.Mouse.Touchpad.html">Touchpad</a></li><li><a 
href="Guacamole.Mouse.Touchscreen.html">Touchscreen</a></li><li><a 
href="Guacamole.Object.html">Object</a></li><li><a 
href="Guacamole.OnScreenKeyboard.html">OnScreenKeyboard</a></li><li><a 
href="Guacamole.OnScreenKeyboard.Key.html">Key</a></li><li><a 
href="Guacamole.OnScreenKeyboard.Layout.html">Layout</a></li><li><a 
href="Guacamole.OutputStream.html">OutputStream</a></li><li><a 
href="Guacamole.Parser.html">Parser</a></li><li><a 
href="Guacamole.RawAudioFormat.html">RawAudioFormat</a></li><li><a 
href="Guacamole.RawAudioPlayer.html
 ">RawAudioPlayer</a></li><li><a 
href="Guacamole.RawAudioRecorder.html">RawAudioRecorder</a></li><li><a 
href="Guacamole.SessionRecording.html">SessionRecording</a></li><li><a 
href="Guacamole.StaticHTTPTunnel.html">StaticHTTPTunnel</a></li><li><a 
href="Guacamole.Status.html">Status</a></li><li><a 
href="Guacamole.StringReader.html">StringReader</a></li><li><a 
href="Guacamole.StringWriter.html">StringWriter</a></li><li><a 
href="Guacamole.Tunnel.html">Tunnel</a></li><li><a 
href="Guacamole.VideoPlayer.html">VideoPlayer</a></li><li><a 
href="Guacamole.WebSocketTunnel.html">WebSocketTunnel</a></li></ul><h3>Events</h3><ul><li><a
 href="Guacamole.ArrayBufferReader.html#event:ondata">ondata</a></li><li><a 
href="Guacamole.ArrayBufferReader.html#event:onend">onend</a></li><li><a 
href="Guacamole.ArrayBufferWriter.html#event:onack">onack</a></li><li><a 
href="Guacamole.AudioRecorder.html#event:onclose">onclose</a></li><li><a 
href="Guacamole.AudioRecorder.html#event:onerror">onerror</a></li><li><a hre
 f="Guacamole.BlobReader.html#event:onend">onend</a></li><li><a 
href="Guacamole.BlobReader.html#event:onprogress">onprogress</a></li><li><a 
href="Guacamole.BlobWriter.html#event:onack">onack</a></li><li><a 
href="Guacamole.BlobWriter.html#event:oncomplete">oncomplete</a></li><li><a 
href="Guacamole.BlobWriter.html#event:onerror">onerror</a></li><li><a 
href="Guacamole.BlobWriter.html#event:onprogress">onprogress</a></li><li><a 
href="Guacamole.ChainedTunnel.html#event:onerror">onerror</a></li><li><a 
href="Guacamole.ChainedTunnel.html#event:oninstruction">oninstruction</a></li><li><a
 
href="Guacamole.ChainedTunnel.html#event:onstatechange">onstatechange</a></li><li><a
 href="Guacamole.Client.html#event:onaudio">onaudio</a></li><li><a 
href="Guacamole.Client.html#event:onclipboard">onclipboard</a></li><li><a 
href="Guacamole.Client.html#event:onerror">onerror</a></li><li><a 
href="Guacamole.Client.html#event:onfile">onfile</a></li><li><a 
href="Guacamole.Client.html#event:onfilesystem">onfilesys
 tem</a></li><li><a 
href="Guacamole.Client.html#event:onname">onname</a></li><li><a 
href="Guacamole.Client.html#event:onpipe">onpipe</a></li><li><a 
href="Guacamole.Client.html#event:onstatechange">onstatechange</a></li><li><a 
href="Guacamole.Client.html#event:onsync">onsync</a></li><li><a 
href="Guacamole.Client.html#event:onvideo">onvideo</a></li><li><a 
href="Guacamole.DataURIReader.html#event:onend">onend</a></li><li><a 
href="Guacamole.Display.html#event:oncursor">oncursor</a></li><li><a 
href="Guacamole.Display.html#event:onresize">onresize</a></li><li><a 
href="Guacamole.HTTPTunnel.html#event:onerror">onerror</a></li><li><a 
href="Guacamole.HTTPTunnel.html#event:oninstruction">oninstruction</a></li><li><a
 
href="Guacamole.HTTPTunnel.html#event:onstatechange">onstatechange</a></li><li><a
 href="Guacamole.InputStream.html#event:onblob">onblob</a></li><li><a 
href="Guacamole.InputStream.html#event:onend">onend</a></li><li><a 
href="Guacamole.JSONReader.html#event:onend">onend</a></li><li><a
  href="Guacamole.JSONReader.html#event:onprogress">onprogress</a></li><li><a 
href="Guacamole.Keyboard.html#event:onkeydown">onkeydown</a></li><li><a 
href="Guacamole.Keyboard.html#event:onkeyup">onkeyup</a></li><li><a 
href="Guacamole.Mouse.Touchpad.html#event:onmousedown">onmousedown</a></li><li><a
 
href="Guacamole.Mouse.Touchpad.html#event:onmousemove">onmousemove</a></li><li><a
 href="Guacamole.Mouse.Touchpad.html#event:onmouseup">onmouseup</a></li><li><a 
href="Guacamole.Mouse.Touchscreen.html#event:onmousedown">onmousedown</a></li><li><a
 
href="Guacamole.Mouse.Touchscreen.html#event:onmousemove">onmousemove</a></li><li><a
 
href="Guacamole.Mouse.Touchscreen.html#event:onmouseup">onmouseup</a></li><li><a
 href="Guacamole.Mouse.html#event:onmousedown">onmousedown</a></li><li><a 
href="Guacamole.Mouse.html#event:onmousemove">onmousemove</a></li><li><a 
href="Guacamole.Mouse.html#event:onmouseout">onmouseout</a></li><li><a 
href="Guacamole.Mouse.html#event:onmouseup">onmouseup</a></li><li><a h
 ref="Guacamole.Object.html#event:onbody">onbody</a></li><li><a 
href="Guacamole.Object.html#event:onundefine">onundefine</a></li><li><a 
href="Guacamole.OnScreenKeyboard.html#event:onkeydown">onkeydown</a></li><li><a 
href="Guacamole.OnScreenKeyboard.html#event:onkeyup">onkeyup</a></li><li><a 
href="Guacamole.OutputStream.html#event:onack">onack</a></li><li><a 
href="Guacamole.Parser.html#event:oninstruction">oninstruction</a></li><li><a 
href="Guacamole.RawAudioRecorder.html#event:onclose">onclose</a></li><li><a 
href="Guacamole.RawAudioRecorder.html#event:onerror">onerror</a></li><li><a 
href="Guacamole.SessionRecording._PlaybackTunnel.html#event:onerror">onerror</a></li><li><a
 
href="Guacamole.SessionRecording._PlaybackTunnel.html#event:oninstruction">oninstruction</a></li><li><a
 
href="Guacamole.SessionRecording._PlaybackTunnel.html#event:onstatechange">onstatechange</a></li><li><a
 href="Guacamole.SessionRecording.html#event:onpause">onpause</a></li><li><a 
href="Guacamole.SessionRecording
 .html#event:onplay">onplay</a></li><li><a 
href="Guacamole.SessionRecording.html#event:onprogress">onprogress</a></li><li><a
 href="Guacamole.SessionRecording.html#event:onseek">onseek</a></li><li><a 
href="Guacamole.StaticHTTPTunnel.html#event:onerror">onerror</a></li><li><a 
href="Guacamole.StaticHTTPTunnel.html#event:oninstruction">oninstruction</a></li><li><a
 
href="Guacamole.StaticHTTPTunnel.html#event:onstatechange">onstatechange</a></li><li><a
 href="Guacamole.StringReader.html#event:onend">onend</a></li><li><a 
href="Guacamole.StringReader.html#event:ontext">ontext</a></li><li><a 
href="Guacamole.StringWriter.html#event:onack">onack</a></li><li><a 
href="Guacamole.Tunnel.html#event:onerror">onerror</a></li><li><a 
href="Guacamole.Tunnel.html#event:oninstruction">oninstruction</a></li><li><a 
href="Guacamole.Tunnel.html#event:onstatechange">onstatechange</a></li><li><a 
href="Guacamole.WebSocketTunnel.html#event:onerror">onerror</a></li><li><a 
href="Guacamole.WebSocketTunnel.html#event:o
 ninstruction">oninstruction</a></li><li><a 
href="Guacamole.WebSocketTunnel.html#event:onstatechange">onstatechange</a></li></ul><h3>Namespaces</h3><ul><li><a
 href="Guacamole.html">Guacamole</a></li><li><a 
href="Guacamole.AudioContextFactory.html">AudioContextFactory</a></li></ul>
+</nav>
+
+<br class="clear">
+
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 
3.5.5</a> on Fri Dec 21 2018 13:47:10 GMT-0800 (PST)
+</footer>
+
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>
\ No newline at end of file

Reply via email to