guacamole-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mjum...@apache.org
Subject [41/51] [partial] incubator-guacamole-website git commit: Deploy draft documentation for 0.9.12-incubating.
Date Sun, 19 Mar 2017 22:49:26 GMT
http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/31f2d19d/content/doc/0.9.12-incubating/guacamole-common-js/Guacamole.Keyboard.html
----------------------------------------------------------------------
diff --git a/content/doc/0.9.12-incubating/guacamole-common-js/Guacamole.Keyboard.html b/content/doc/0.9.12-incubating/guacamole-common-js/Guacamole.Keyboard.html
new file mode 100644
index 0000000..685263f
--- /dev/null
+++ b/content/doc/0.9.12-incubating/guacamole-common-js/Guacamole.Keyboard.html
@@ -0,0 +1,1181 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Class: Keyboard</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: Keyboard</h1>
+
+    
+
+
+
+
+<section>
+
+<header>
+    
+        <h2>
+            <span class="ancestors"><a href="Guacamole.html">Guacamole</a>.</span>Keyboard</h2>
+        
+    
+</header>
+
+<article>
+    <div class="container-overview">
+    
+        
+
+    
+
+    <h4 class="name" id="Keyboard"><span class="type-signature"></span>new
Keyboard<span class="signature">(element)</span><span class="type-signature"></span></h4>
+
+    
+
+
+
+<div class="description">
+    Provides cross-browser and cross-keyboard keyboard for a specific element.
+Browser and keyboard layout variation is abstracted away, providing events
+which represent keys as their corresponding X11 keysym.
+</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>element</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">Element</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last">The Element to use to provide keyboard events.</td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Keyboard.js.html">Keyboard.js</a>, <a href="Keyboard.js.html#line30">line
30</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    
+    </div>
+
+    
+
+    
+
+    
+        <h3 class="subsection-title">Classes</h3>
+
+        <dl>
+            <dt><a href="Guacamole.Keyboard.ModifierState.html">ModifierState</a></dt>
+            <dd></dd>
+        </dl>
+    
+
+     
+
+    
+
+    
+        <h3 class="subsection-title">Members</h3>
+
+        
+            
+<h4 class="name" id="modifiers"><span class="type-signature"></span>modifiers<span
class="type-signature"></span></h4>
+
+
+
+
+<div class="description">
+    All modifiers and their states.
+</div>
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Keyboard.js.html">Keyboard.js</a>, <a href="Keyboard.js.html#line529">line
529</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+            
+<h4 class="name" id="pressed"><span class="type-signature"></span>pressed<span
class="type-signature"></span></h4>
+
+
+
+
+<div class="description">
+    The state of every key, indexed by keysym. If a particular key is
+pressed, the value of pressed for that keysym will be true. If a key
+is not currently pressed, it will not be defined.
+</div>
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Keyboard.js.html">Keyboard.js</a>, <a href="Keyboard.js.html#line536">line
536</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+    
+
+    
+        <h3 class="subsection-title">Methods</h3>
+
+        
+            
+
+    
+
+    <h4 class="name" id="press"><span class="type-signature"></span>press<span
class="signature">(keysym)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
+
+    
+
+
+
+<div class="description">
+    Marks a key as pressed, firing the keydown event if registered. Key
+repeat for the pressed key will start after a delay if that key is
+not a modifier. The return value of this function depends on the
+return value of the keydown event handler, if any.
+</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 to press.</td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Keyboard.js.html">Keyboard.js</a>, <a href="Keyboard.js.html#line724">line
724</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+<div class="param-desc">
+    true if event should NOT be canceled, false otherwise.
+</div>
+
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">Boolean</span>
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+        
+            
+
+    
+
+    <h4 class="name" id="release"><span class="type-signature"></span>release<span
class="signature">(keysym)</span><span class="type-signature"></span></h4>
+
+    
+
+
+
+<div class="description">
+    Marks a key as released, firing the keyup event if registered.
+</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 to release.</td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Keyboard.js.html">Keyboard.js</a>, <a href="Keyboard.js.html#line767">line
767</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+        
+            
+
+    
+
+    <h4 class="name" id="reset"><span class="type-signature"></span>reset<span
class="signature">()</span><span class="type-signature"></span></h4>
+
+    
+
+
+
+<div class="description">
+    Resets the state of this keyboard, releasing all keys, and firing keyup
+events for each released key.
+</div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Keyboard.js.html">Keyboard.js</a>, <a href="Keyboard.js.html#line791">line
791</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+        
+            
+
+    
+
+    <h4 class="name" id="~isPrintable"><span class="type-signature">(inner) </span>isPrintable<span
class="signature">(keysym)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
+
+    
+
+
+
+<div class="description">
+    Returns true if the given keysym corresponds to a printable character,
+false otherwise.
+</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 to check.</td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Keyboard.js.html">Keyboard.js</a>, <a href="Keyboard.js.html#line603">line
603</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+<div class="param-desc">
+    true if the given keysym corresponds to a printable character,
+    false otherwise.
+</div>
+
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">Boolean</span>
+
+
+    </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 with the element associated
+with this Guacamole.Keyboard in focus.
+</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="Keyboard.js.html">Keyboard.js</a>, <a href="Keyboard.js.html#line47">line
47</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+<div class="param-desc">
+    true if the key event should be allowed through to the
+                  browser, false otherwise.
+</div>
+
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">Boolean</span>
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+        
+            
+
+    
+
+    <h4 class="name" id="event:onkeyup">onkeyup</h4>
+
+    
+
+
+
+<div class="description">
+    Fired whenever the user releases a key with the element associated
+with this Guacamole.Keyboard in focus.
+</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="Keyboard.js.html">Keyboard.js</a>, <a href="Keyboard.js.html#line56">line
56</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.InputStream.html">InputStream</a></li><li><a
href="Guacamole.IntegerPool.html">IntegerPool</a></li><li><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.RawAudioR
 ecorder.html">RawAudioRecorder</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
href="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">onfilesystem</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">ons
 tatechange</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">onkey
 up</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
href="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.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:oninstruction">oninstruction</a></li><li><a
href="Guacamole.W
 ebSocketTunnel.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.4.0</a>
on Sat Mar 18 2017 19:26:49 GMT-0700 (PDT)
+</footer>
+
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+        <!-- Google Analytics -->
+        <script type="text/javascript">
+          (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+          (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+          m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+          })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+          ga('create', 'UA-75289145-1', 'auto');
+          ga('send', 'pageview');
+        </script>
+</body>
+</html>
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/31f2d19d/content/doc/0.9.12-incubating/guacamole-common-js/Guacamole.Layer.Pixel.html
----------------------------------------------------------------------
diff --git a/content/doc/0.9.12-incubating/guacamole-common-js/Guacamole.Layer.Pixel.html
b/content/doc/0.9.12-incubating/guacamole-common-js/Guacamole.Layer.Pixel.html
new file mode 100644
index 0000000..cac0879
--- /dev/null
+++ b/content/doc/0.9.12-incubating/guacamole-common-js/Guacamole.Layer.Pixel.html
@@ -0,0 +1,548 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>JSDoc: Class: Pixel</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: Pixel</h1>
+
+    
+
+
+
+
+<section>
+
+<header>
+    
+        <h2>
+            <span class="ancestors"><a href="Guacamole.html">Guacamole</a><a
href="Guacamole.Layer.html">.Layer</a>.</span>Pixel</h2>
+        
+    
+</header>
+
+<article>
+    <div class="container-overview">
+    
+        
+
+    
+
+    <h4 class="name" id="Pixel"><span class="type-signature"></span>new
Pixel<span class="signature">(r, g, b, a)</span><span class="type-signature"></span></h4>
+
+    
+
+
+
+<div class="description">
+    Represents a single pixel of image data. All components have a minimum value
+of 0 and a maximum value of 255.
+</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>r</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">Number</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last">The red component of this pixel.</td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>g</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">Number</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last">The green component of this pixel.</td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>b</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">Number</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last">The blue component of this pixel.</td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>a</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">Number</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last">The alpha component of this pixel.</td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Layer.js.html">Layer.js</a>, <a href="Layer.js.html#line952">line
952</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    
+    </div>
+
+    
+
+    
+
+    
+
+     
+
+    
+
+    
+        <h3 class="subsection-title">Members</h3>
+
+        
+            
+<h4 class="name" id="alpha"><span class="type-signature"></span>alpha<span
class="type-signature"></span></h4>
+
+
+
+
+<div class="description">
+    The alpha component of this pixel, where 0 is the minimum value,
+and 255 is the maximum.
+</div>
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Layer.js.html">Layer.js</a>, <a href="Layer.js.html#line976">line
976</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+            
+<h4 class="name" id="blue"><span class="type-signature"></span>blue<span
class="type-signature"></span></h4>
+
+
+
+
+<div class="description">
+    The blue component of this pixel, where 0 is the minimum value,
+and 255 is the maximum.
+</div>
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Layer.js.html">Layer.js</a>, <a href="Layer.js.html#line970">line
970</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+            
+<h4 class="name" id="green"><span class="type-signature"></span>green<span
class="type-signature"></span></h4>
+
+
+
+
+<div class="description">
+    The green component of this pixel, where 0 is the minimum value,
+and 255 is the maximum.
+</div>
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Layer.js.html">Layer.js</a>, <a href="Layer.js.html#line964">line
964</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+            
+<h4 class="name" id="red"><span class="type-signature"></span>red<span
class="type-signature"></span></h4>
+
+
+
+
+<div class="description">
+    The red component of this pixel, where 0 is the minimum value,
+and 255 is the maximum.
+</div>
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="Layer.js.html">Layer.js</a>, <a href="Layer.js.html#line958">line
958</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.InputStream.html">InputStream</a></li><li><a
href="Guacamole.IntegerPool.html">IntegerPool</a></li><li><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.RawAudioR
 ecorder.html">RawAudioRecorder</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
href="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">onfilesystem</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">ons
 tatechange</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">onkey
 up</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
href="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.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:oninstruction">oninstruction</a></li><li><a
href="Guacamole.W
 ebSocketTunnel.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.4.0</a>
on Sat Mar 18 2017 19:26:49 GMT-0700 (PDT)
+</footer>
+
+<script> prettyPrint(); </script>
+<script src="scripts/linenumber.js"> </script>
+        <!-- Google Analytics -->
+        <script type="text/javascript">
+          (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+          (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+          m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+          })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+          ga('create', 'UA-75289145-1', 'auto');
+          ga('send', 'pageview');
+        </script>
+</body>
+</html>
\ No newline at end of file



Mime
View raw message