http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/af9b9c05/content/doc/0.8.3/guacamole-common-js/symbols/Guacamole.OnScreenKeyboard.html ---------------------------------------------------------------------- diff --git a/content/doc/0.8.3/guacamole-common-js/symbols/Guacamole.OnScreenKeyboard.html b/content/doc/0.8.3/guacamole-common-js/symbols/Guacamole.OnScreenKeyboard.html new file mode 100644 index 0000000..51a9ffd --- /dev/null +++ b/content/doc/0.8.3/guacamole-common-js/symbols/Guacamole.OnScreenKeyboard.html @@ -0,0 +1,650 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta http-equiv="content-type" content="text/html; charset=utf-8" /> + <meta name="generator" content="JsDoc Toolkit" /> + + <title>JsDoc Reference - Guacamole.OnScreenKeyboard</title> + + <style type="text/css"> + /* default.css */ +body +{ + font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif; + width: 800px; +} + +.header +{ + clear: both; + background-color: #ccc; + padding: 8px; +} + +h1 +{ + font-size: 150%; + font-weight: bold; + padding: 0; + margin: 1em 0 0 .3em; +} + +hr +{ + border: none 0; + border-top: 1px solid #7F8FB1; + height: 1px; +} + +pre.code +{ + display: block; + padding: 8px; + border: 1px dashed #ccc; +} + +#index +{ + margin-top: 24px; + float: left; + width: 160px; + position: absolute; + left: 8px; + background-color: #F3F3F3; + padding: 8px; +} + +#content +{ + margin-left: 190px; + width: 600px; +} + +.classList +{ + list-style-type: none; + padding: 0; + margin: 0 0 0 8px; + font-family: arial, sans-serif; + font-size: 1em; + overflow: auto; +} + +.classList li +{ + padding: 0; + margin: 0 0 8px 0; +} + +.summaryTable { width: 100%; } + +h1.classTitle +{ + font-size:170%; + line-height:130%; +} + +h2 { font-size: 110%; } +caption, div.sectionTitle +{ + background-color: #7F8FB1; + color: #fff; + font-size:130%; + text-align: left; + padding: 2px 6px 2px 6px; + border: 1px #7F8FB1 solid; +} + +div.sectionTitle { margin-bottom: 8px; } +.summaryTable thead { display: none; } + +.summaryTable td +{ + vertical-align: top; + padding: 4px; + border-bottom: 1px #7F8FB1 solid; + border-right: 1px #7F8FB1 solid; +} + +/*col#summaryAttributes {}*/ +.summaryTable td.attributes +{ + border-left: 1px #7F8FB1 solid; + width: 140px; + text-align: right; +} + +td.attributes, .fixedFont +{ + line-height: 15px; + color: #002EBE; + font-family: "Courier New",Courier,monospace; + font-size: 13px; +} + +.summaryTable td.nameDescription +{ + text-align: left; + font-size: 13px; + line-height: 15px; +} + +.summaryTable td.nameDescription, .description +{ + line-height: 15px; + padding: 4px; + padding-left: 4px; +} + +.summaryTable { margin-bottom: 8px; } + +ul.inheritsList +{ + list-style: square; + margin-left: 20px; + padding-left: 0; +} + +.detailList { + margin-left: 20px; + line-height: 15px; +} +.detailList dt { margin-left: 20px; } + +.detailList .heading +{ + font-weight: bold; + padding-bottom: 6px; + margin-left: 0; +} + +.light, td.attributes, .light a:link, .light a:visited +{ + color: #777; + font-style: italic; +} + +.fineprint +{ + text-align: right; + font-size: 10px; +} + </style> + </head> + + <body> +<!-- ============================== header ================================= --> + <!-- begin static/header.html --> + <div id="header"> +</div> + <!-- end static/header.html --> + +<!-- ============================== classes index ============================ --> + <div id="index"> + <!-- begin publish.classesIndex --> + <div align="center"><a href="../index.html">Class Index</a> +| <a href="../files.html">File Index</a></div> +<hr /> +<h2>Classes</h2> +<ul class="classList"> + + <li><i><a href="../symbols/_global_.html">_global_</a></i></li> + + <li><a href="../symbols/Guacamole.html">Guacamole</a></li> + + <li><a href="../symbols/Guacamole.AudioChannel.html">Guacamole.AudioChannel</a></li> + + <li><a href="../symbols/Guacamole.AudioChannel.Packet.html">Guacamole.AudioChannel.Packet</a></li> + + <li><a href="../symbols/Guacamole.Blob.html">Guacamole.Blob</a></li> + + <li><a href="../symbols/Guacamole.ChainedTunnel.html">Guacamole.ChainedTunnel</a></li> + + <li><a href="../symbols/Guacamole.Client.html">Guacamole.Client</a></li> + + <li><a href="../symbols/Guacamole.Client.LayerContainer.html">Guacamole.Client.LayerContainer</a></li> + + <li><a href="../symbols/Guacamole.HTTPTunnel.html">Guacamole.HTTPTunnel</a></li> + + <li><a href="../symbols/Guacamole.Keyboard.html">Guacamole.Keyboard</a></li> + + <li><a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a></li> + + <li><a href="../symbols/Guacamole.Layer.Pixel.html">Guacamole.Layer.Pixel</a></li> + + <li><a href="../symbols/Guacamole.Mouse.html">Guacamole.Mouse</a></li> + + <li><a href="../symbols/Guacamole.Mouse.State.html">Guacamole.Mouse.State</a></li> + + <li><a href="../symbols/Guacamole.Mouse.Touchpad.html">Guacamole.Mouse.Touchpad</a></li> + + <li><a href="../symbols/Guacamole.Mouse.Touchscreen.html">Guacamole.Mouse.Touchscreen</a></li> + + <li><a href="../symbols/Guacamole.OnScreenKeyboard.html">Guacamole.OnScreenKeyboard</a></li> + + <li><a href="../symbols/Guacamole.OnScreenKeyboard.Cap.html">Guacamole.OnScreenKeyboard.Cap</a></li> + + <li><a href="../symbols/Guacamole.OnScreenKeyboard.Key.html">Guacamole.OnScreenKeyboard.Key</a></li> + + <li><a href="../symbols/Guacamole.Parser.html">Guacamole.Parser</a></li> + + <li><a href="../symbols/Guacamole.Tunnel.html">Guacamole.Tunnel</a></li> + + <li><a href="../symbols/Guacamole.WebSocketTunnel.html">Guacamole.WebSocketTunnel</a></li> + +</ul> +<hr /> + <!-- end publish.classesIndex --> + </div> + + <div id="content"> +<!-- ============================== class title ============================ --> + <h1 class="classTitle"> + + Class Guacamole.OnScreenKeyboard + </h1> + +<!-- ============================== class summary ========================== --> + <p class="description"> + + + + + + + <br /><i>Defined in: </i> <a href="../symbols/src/src_main_resources_oskeyboard.js.html">oskeyboard.js</a>. + + </p> + +<!-- ============================== constructor summary ==================== --> + + <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class Guacamole.OnScreenKeyboard."> + <caption>Class Summary</caption> + <thead> + <tr> + <th scope="col">Constructor Attributes</th> + <th scope="col">Constructor Name and Description</th> + </tr> + </thead> + <tbody> + <tr> + <td class="attributes"> </td> + <td class="nameDescription" > + <div class="fixedFont"> + <b><a href="../symbols/Guacamole.OnScreenKeyboard.html#constructor">Guacamole.OnScreenKeyboard</a></b>(url) + </div> + <div class="description">Dynamic on-screen keyboard.</div> + </td> + </tr> + </tbody> + </table> + + +<!-- ============================== properties summary ===================== --> + + + + <table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class Guacamole.OnScreenKeyboard."> + <caption>Field Summary</caption> + <thead> + <tr> + <th scope="col">Field Attributes</th> + <th scope="col">Field Name and Description</th> + </tr> + </thead> + <tbody> + + <tr> + <td class="attributes"> </td> + <td class="nameDescription"> + <div class="fixedFont"> + <b><a href="../symbols/Guacamole.OnScreenKeyboard.html#touchMouseThreshold">touchMouseThreshold</a></b> + </div> + <div class="description">The number of mousemove events to require before re-enabling mouse +event handling after receiving a touch event.</div> + </td> + </tr> + + </tbody> + </table> + + + + + +<!-- ============================== methods summary ======================== --> + + + + <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class Guacamole.OnScreenKeyboard."> + <caption>Method Summary</caption> + <thead> + <tr> + <th scope="col">Method Attributes</th> + <th scope="col">Method Name and Description</th> + </tr> + </thead> + <tbody> + + <tr> + <td class="attributes"> </td> + <td class="nameDescription"> + <div class="fixedFont"><b><a href="../symbols/Guacamole.OnScreenKeyboard.html#getElement">getElement</a></b>() + </div> + <div class="description">Returns the element containing the entire on-screen keyboard.</div> + </td> + </tr> + + <tr> + <td class="attributes"> </td> + <td class="nameDescription"> + <div class="fixedFont"><b><a href="../symbols/Guacamole.OnScreenKeyboard.html#resize">resize</a></b>(width) + </div> + <div class="description">Resizes all elements within this Guacamole.OnScreenKeyboard such that +the width is close to but does not exceed the specified width.</div> + </td> + </tr> + + </tbody> + </table> + + + + +<!-- ============================== events summary ======================== --> + + + + <table class="summaryTable" cellspacing="0" summary="A summary of the events documented in the class Guacamole.OnScreenKeyboard."> + <caption>Event Summary</caption> + <thead> + <tr> + <th scope="col">Event Attributes</th> + <th scope="col">Event Name and Description</th> + </tr> + </thead> + <tbody> + + <tr> + <td class="attributes"> </td> + <td class="nameDescription"> + <div class="fixedFont"><b><a href="../symbols/Guacamole.OnScreenKeyboard.html#event:onkeydown">onkeydown</a></b>(keysym) + </div> + <div class="description">Fired whenever the user presses a key on this Guacamole.OnScreenKeyboard.</div> + </td> + </tr> + + <tr> + <td class="attributes"> </td> + <td class="nameDescription"> + <div class="fixedFont"><b><a href="../symbols/Guacamole.OnScreenKeyboard.html#event:onkeyup">onkeyup</a></b>(keysym) + </div> + <div class="description">Fired whenever the user releases a key on this Guacamole.OnScreenKeyboard.</div> + </td> + </tr> + + </tbody> + </table> + + + + + +<!-- ============================== constructor details ==================== --> + + <div class="details"><a name="constructor"> </a> + <div class="sectionTitle"> + Class Detail + </div> + + <div class="fixedFont"> + <b>Guacamole.OnScreenKeyboard</b>(url) + </div> + + <div class="description"> + Dynamic on-screen keyboard. Given the URL to an XML keyboard layout file, +this object will download and use the XML to construct a clickable on-screen +keyboard with its own key events. + + </div> + + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{String}</span> <b>url</b> + + </dt> + <dd>The URL of an XML keyboard layout file.</dd> + + </dl> + + + + + + + + + </div> + + +<!-- ============================== field details ========================== --> + + <div class="sectionTitle"> + Field Detail + </div> + + <a name="touchMouseThreshold"> </a> + <div class="fixedFont"> + + + <b>touchMouseThreshold</b> + + </div> + <div class="description"> + The number of mousemove events to require before re-enabling mouse +event handling after receiving a touch event. + + + </div> + + + + + + + + + + + + +<!-- ============================== method details ========================= --> + + <div class="sectionTitle"> + Method Detail + </div> + + <a name="getElement"> </a> + <div class="fixedFont"> + + <span class="light">{Element}</span> + <b>getElement</b>() + + </div> + <div class="description"> + Returns the element containing the entire on-screen keyboard. + + + </div> + + + + + + + + + <dl class="detailList"> + <dt class="heading">Returns:</dt> + + <dd><span class="light fixedFont">{Element}</span> The element containing the entire on-screen keyboard.</dd> + + </dl> + + + + + <hr /> + + <a name="resize"> </a> + <div class="fixedFont"> + + + <b>resize</b>(width) + + </div> + <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> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{Number}</span> <b>width</b> + + </dt> + <dd>The width to resize this Guacamole.OnScreenKeyboard + to, in pixels.</dd> + + </dl> + + + + + + + + + + + + +<!-- ============================== event details ========================= --> + + <div class="sectionTitle"> + Event Detail + </div> + + <a name="event:onkeydown"> </a> + <div class="fixedFont"> + + + <b>onkeydown</b>(keysym) + + </div> + <div class="description"> + Fired whenever the user presses a key on this Guacamole.OnScreenKeyboard. + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{Number}</span> <b>keysym</b> + + </dt> + <dd>The keysym of the key being pressed.</dd> + + </dl> + + + + + + + + + <hr /> + + <a name="event:onkeyup"> </a> + <div class="fixedFont"> + + + <b>onkeyup</b>(keysym) + + </div> + <div class="description"> + Fired whenever the user releases a key on this Guacamole.OnScreenKeyboard. + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{Number}</span> <b>keysym</b> + + </dt> + <dd>The keysym of the key being released.</dd> + + </dl> + + + + + + + + + + + + + <hr /> + </div> + + +<!-- ============================== footer ================================= --> + <div class="fineprint" style="clear:both"> + + Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/"; target="_blank">JsDoc Toolkit</a> 2.4.0 on Fri Mar 28 2014 21:41:24 GMT-0700 (PDT) + </div> + +<!-- 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> +<!-- End Google Analytics --> + </body> +</html>
http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/af9b9c05/content/doc/0.8.3/guacamole-common-js/symbols/Guacamole.Parser.html ---------------------------------------------------------------------- diff --git a/content/doc/0.8.3/guacamole-common-js/symbols/Guacamole.Parser.html b/content/doc/0.8.3/guacamole-common-js/symbols/Guacamole.Parser.html new file mode 100644 index 0000000..bdeb684 --- /dev/null +++ b/content/doc/0.8.3/guacamole-common-js/symbols/Guacamole.Parser.html @@ -0,0 +1,503 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta http-equiv="content-type" content="text/html; charset=utf-8" /> + <meta name="generator" content="JsDoc Toolkit" /> + + <title>JsDoc Reference - Guacamole.Parser</title> + + <style type="text/css"> + /* default.css */ +body +{ + font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif; + width: 800px; +} + +.header +{ + clear: both; + background-color: #ccc; + padding: 8px; +} + +h1 +{ + font-size: 150%; + font-weight: bold; + padding: 0; + margin: 1em 0 0 .3em; +} + +hr +{ + border: none 0; + border-top: 1px solid #7F8FB1; + height: 1px; +} + +pre.code +{ + display: block; + padding: 8px; + border: 1px dashed #ccc; +} + +#index +{ + margin-top: 24px; + float: left; + width: 160px; + position: absolute; + left: 8px; + background-color: #F3F3F3; + padding: 8px; +} + +#content +{ + margin-left: 190px; + width: 600px; +} + +.classList +{ + list-style-type: none; + padding: 0; + margin: 0 0 0 8px; + font-family: arial, sans-serif; + font-size: 1em; + overflow: auto; +} + +.classList li +{ + padding: 0; + margin: 0 0 8px 0; +} + +.summaryTable { width: 100%; } + +h1.classTitle +{ + font-size:170%; + line-height:130%; +} + +h2 { font-size: 110%; } +caption, div.sectionTitle +{ + background-color: #7F8FB1; + color: #fff; + font-size:130%; + text-align: left; + padding: 2px 6px 2px 6px; + border: 1px #7F8FB1 solid; +} + +div.sectionTitle { margin-bottom: 8px; } +.summaryTable thead { display: none; } + +.summaryTable td +{ + vertical-align: top; + padding: 4px; + border-bottom: 1px #7F8FB1 solid; + border-right: 1px #7F8FB1 solid; +} + +/*col#summaryAttributes {}*/ +.summaryTable td.attributes +{ + border-left: 1px #7F8FB1 solid; + width: 140px; + text-align: right; +} + +td.attributes, .fixedFont +{ + line-height: 15px; + color: #002EBE; + font-family: "Courier New",Courier,monospace; + font-size: 13px; +} + +.summaryTable td.nameDescription +{ + text-align: left; + font-size: 13px; + line-height: 15px; +} + +.summaryTable td.nameDescription, .description +{ + line-height: 15px; + padding: 4px; + padding-left: 4px; +} + +.summaryTable { margin-bottom: 8px; } + +ul.inheritsList +{ + list-style: square; + margin-left: 20px; + padding-left: 0; +} + +.detailList { + margin-left: 20px; + line-height: 15px; +} +.detailList dt { margin-left: 20px; } + +.detailList .heading +{ + font-weight: bold; + padding-bottom: 6px; + margin-left: 0; +} + +.light, td.attributes, .light a:link, .light a:visited +{ + color: #777; + font-style: italic; +} + +.fineprint +{ + text-align: right; + font-size: 10px; +} + </style> + </head> + + <body> +<!-- ============================== header ================================= --> + <!-- begin static/header.html --> + <div id="header"> +</div> + <!-- end static/header.html --> + +<!-- ============================== classes index ============================ --> + <div id="index"> + <!-- begin publish.classesIndex --> + <div align="center"><a href="../index.html">Class Index</a> +| <a href="../files.html">File Index</a></div> +<hr /> +<h2>Classes</h2> +<ul class="classList"> + + <li><i><a href="../symbols/_global_.html">_global_</a></i></li> + + <li><a href="../symbols/Guacamole.html">Guacamole</a></li> + + <li><a href="../symbols/Guacamole.AudioChannel.html">Guacamole.AudioChannel</a></li> + + <li><a href="../symbols/Guacamole.AudioChannel.Packet.html">Guacamole.AudioChannel.Packet</a></li> + + <li><a href="../symbols/Guacamole.Blob.html">Guacamole.Blob</a></li> + + <li><a href="../symbols/Guacamole.ChainedTunnel.html">Guacamole.ChainedTunnel</a></li> + + <li><a href="../symbols/Guacamole.Client.html">Guacamole.Client</a></li> + + <li><a href="../symbols/Guacamole.Client.LayerContainer.html">Guacamole.Client.LayerContainer</a></li> + + <li><a href="../symbols/Guacamole.HTTPTunnel.html">Guacamole.HTTPTunnel</a></li> + + <li><a href="../symbols/Guacamole.Keyboard.html">Guacamole.Keyboard</a></li> + + <li><a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a></li> + + <li><a href="../symbols/Guacamole.Layer.Pixel.html">Guacamole.Layer.Pixel</a></li> + + <li><a href="../symbols/Guacamole.Mouse.html">Guacamole.Mouse</a></li> + + <li><a href="../symbols/Guacamole.Mouse.State.html">Guacamole.Mouse.State</a></li> + + <li><a href="../symbols/Guacamole.Mouse.Touchpad.html">Guacamole.Mouse.Touchpad</a></li> + + <li><a href="../symbols/Guacamole.Mouse.Touchscreen.html">Guacamole.Mouse.Touchscreen</a></li> + + <li><a href="../symbols/Guacamole.OnScreenKeyboard.html">Guacamole.OnScreenKeyboard</a></li> + + <li><a href="../symbols/Guacamole.OnScreenKeyboard.Cap.html">Guacamole.OnScreenKeyboard.Cap</a></li> + + <li><a href="../symbols/Guacamole.OnScreenKeyboard.Key.html">Guacamole.OnScreenKeyboard.Key</a></li> + + <li><a href="../symbols/Guacamole.Parser.html">Guacamole.Parser</a></li> + + <li><a href="../symbols/Guacamole.Tunnel.html">Guacamole.Tunnel</a></li> + + <li><a href="../symbols/Guacamole.WebSocketTunnel.html">Guacamole.WebSocketTunnel</a></li> + +</ul> +<hr /> + <!-- end publish.classesIndex --> + </div> + + <div id="content"> +<!-- ============================== class title ============================ --> + <h1 class="classTitle"> + + Class Guacamole.Parser + </h1> + +<!-- ============================== class summary ========================== --> + <p class="description"> + + + + + + + <br /><i>Defined in: </i> <a href="../symbols/src/src_main_resources_guacamole.js.html">guacamole.js</a>. + + </p> + +<!-- ============================== constructor summary ==================== --> + + <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class Guacamole.Parser."> + <caption>Class Summary</caption> + <thead> + <tr> + <th scope="col">Constructor Attributes</th> + <th scope="col">Constructor Name and Description</th> + </tr> + </thead> + <tbody> + <tr> + <td class="attributes"> </td> + <td class="nameDescription" > + <div class="fixedFont"> + <b><a href="../symbols/Guacamole.Parser.html#constructor">Guacamole.Parser</a></b>() + </div> + <div class="description">Simple Guacamole protocol parser that invokes an oninstruction event when +full instructions are available from data received via receive().</div> + </td> + </tr> + </tbody> + </table> + + +<!-- ============================== properties summary ===================== --> + + +<!-- ============================== methods summary ======================== --> + + + + <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class Guacamole.Parser."> + <caption>Method Summary</caption> + <thead> + <tr> + <th scope="col">Method Attributes</th> + <th scope="col">Method Name and Description</th> + </tr> + </thead> + <tbody> + + <tr> + <td class="attributes"> </td> + <td class="nameDescription"> + <div class="fixedFont"><b><a href="../symbols/Guacamole.Parser.html#receive">receive</a></b>(packet) + </div> + <div class="description">Appends the given instruction data packet to the internal buffer of +this Guacamole.Parser, executing all completed instructions at +the beginning of this buffer, if any.</div> + </td> + </tr> + + </tbody> + </table> + + + + +<!-- ============================== events summary ======================== --> + + + + <table class="summaryTable" cellspacing="0" summary="A summary of the events documented in the class Guacamole.Parser."> + <caption>Event Summary</caption> + <thead> + <tr> + <th scope="col">Event Attributes</th> + <th scope="col">Event Name and Description</th> + </tr> + </thead> + <tbody> + + <tr> + <td class="attributes"> </td> + <td class="nameDescription"> + <div class="fixedFont"><b><a href="../symbols/Guacamole.Parser.html#event:oninstruction">oninstruction</a></b>(opcode, parameters) + </div> + <div class="description">Fired once for every complete Guacamole instruction received, in order.</div> + </td> + </tr> + + </tbody> + </table> + + + + + +<!-- ============================== constructor details ==================== --> + + <div class="details"><a name="constructor"> </a> + <div class="sectionTitle"> + Class Detail + </div> + + <div class="fixedFont"> + <b>Guacamole.Parser</b>() + </div> + + <div class="description"> + Simple Guacamole protocol parser that invokes an oninstruction event when +full instructions are available from data received via receive(). + + </div> + + + + + + + + + + + + + </div> + + +<!-- ============================== field details ========================== --> + + +<!-- ============================== method details ========================= --> + + <div class="sectionTitle"> + Method Detail + </div> + + <a name="receive"> </a> + <div class="fixedFont"> + + + <b>receive</b>(packet) + + </div> + <div class="description"> + Appends the given instruction data packet to the internal buffer of +this Guacamole.Parser, executing all completed instructions at +the beginning of this buffer, if any. + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{String}</span> <b>packet</b> + + </dt> + <dd>The instruction data to append.</dd> + + </dl> + + + + + + + + + + + + +<!-- ============================== event details ========================= --> + + <div class="sectionTitle"> + Event Detail + </div> + + <a name="event:oninstruction"> </a> + <div class="fixedFont"> + + + <b>oninstruction</b>(opcode, parameters) + + </div> + <div class="description"> + Fired once for every complete Guacamole instruction received, in order. + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{String}</span> <b>opcode</b> + + </dt> + <dd>The Guacamole instruction opcode.</dd> + + <dt> + <span class="light fixedFont">{Array}</span> <b>parameters</b> + + </dt> + <dd>The parameters provided for the instruction, + if any.</dd> + + </dl> + + + + + + + + + + + + + <hr /> + </div> + + +<!-- ============================== footer ================================= --> + <div class="fineprint" style="clear:both"> + + Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/"; target="_blank">JsDoc Toolkit</a> 2.4.0 on Fri Mar 28 2014 21:41:25 GMT-0700 (PDT) + </div> + +<!-- 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> +<!-- End Google Analytics --> + </body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/af9b9c05/content/doc/0.8.3/guacamole-common-js/symbols/Guacamole.Tunnel.html ---------------------------------------------------------------------- diff --git a/content/doc/0.8.3/guacamole-common-js/symbols/Guacamole.Tunnel.html b/content/doc/0.8.3/guacamole-common-js/symbols/Guacamole.Tunnel.html new file mode 100644 index 0000000..cec30c8 --- /dev/null +++ b/content/doc/0.8.3/guacamole-common-js/symbols/Guacamole.Tunnel.html @@ -0,0 +1,637 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta http-equiv="content-type" content="text/html; charset=utf-8" /> + <meta name="generator" content="JsDoc Toolkit" /> + + <title>JsDoc Reference - Guacamole.Tunnel</title> + + <style type="text/css"> + /* default.css */ +body +{ + font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif; + width: 800px; +} + +.header +{ + clear: both; + background-color: #ccc; + padding: 8px; +} + +h1 +{ + font-size: 150%; + font-weight: bold; + padding: 0; + margin: 1em 0 0 .3em; +} + +hr +{ + border: none 0; + border-top: 1px solid #7F8FB1; + height: 1px; +} + +pre.code +{ + display: block; + padding: 8px; + border: 1px dashed #ccc; +} + +#index +{ + margin-top: 24px; + float: left; + width: 160px; + position: absolute; + left: 8px; + background-color: #F3F3F3; + padding: 8px; +} + +#content +{ + margin-left: 190px; + width: 600px; +} + +.classList +{ + list-style-type: none; + padding: 0; + margin: 0 0 0 8px; + font-family: arial, sans-serif; + font-size: 1em; + overflow: auto; +} + +.classList li +{ + padding: 0; + margin: 0 0 8px 0; +} + +.summaryTable { width: 100%; } + +h1.classTitle +{ + font-size:170%; + line-height:130%; +} + +h2 { font-size: 110%; } +caption, div.sectionTitle +{ + background-color: #7F8FB1; + color: #fff; + font-size:130%; + text-align: left; + padding: 2px 6px 2px 6px; + border: 1px #7F8FB1 solid; +} + +div.sectionTitle { margin-bottom: 8px; } +.summaryTable thead { display: none; } + +.summaryTable td +{ + vertical-align: top; + padding: 4px; + border-bottom: 1px #7F8FB1 solid; + border-right: 1px #7F8FB1 solid; +} + +/*col#summaryAttributes {}*/ +.summaryTable td.attributes +{ + border-left: 1px #7F8FB1 solid; + width: 140px; + text-align: right; +} + +td.attributes, .fixedFont +{ + line-height: 15px; + color: #002EBE; + font-family: "Courier New",Courier,monospace; + font-size: 13px; +} + +.summaryTable td.nameDescription +{ + text-align: left; + font-size: 13px; + line-height: 15px; +} + +.summaryTable td.nameDescription, .description +{ + line-height: 15px; + padding: 4px; + padding-left: 4px; +} + +.summaryTable { margin-bottom: 8px; } + +ul.inheritsList +{ + list-style: square; + margin-left: 20px; + padding-left: 0; +} + +.detailList { + margin-left: 20px; + line-height: 15px; +} +.detailList dt { margin-left: 20px; } + +.detailList .heading +{ + font-weight: bold; + padding-bottom: 6px; + margin-left: 0; +} + +.light, td.attributes, .light a:link, .light a:visited +{ + color: #777; + font-style: italic; +} + +.fineprint +{ + text-align: right; + font-size: 10px; +} + </style> + </head> + + <body> +<!-- ============================== header ================================= --> + <!-- begin static/header.html --> + <div id="header"> +</div> + <!-- end static/header.html --> + +<!-- ============================== classes index ============================ --> + <div id="index"> + <!-- begin publish.classesIndex --> + <div align="center"><a href="../index.html">Class Index</a> +| <a href="../files.html">File Index</a></div> +<hr /> +<h2>Classes</h2> +<ul class="classList"> + + <li><i><a href="../symbols/_global_.html">_global_</a></i></li> + + <li><a href="../symbols/Guacamole.html">Guacamole</a></li> + + <li><a href="../symbols/Guacamole.AudioChannel.html">Guacamole.AudioChannel</a></li> + + <li><a href="../symbols/Guacamole.AudioChannel.Packet.html">Guacamole.AudioChannel.Packet</a></li> + + <li><a href="../symbols/Guacamole.Blob.html">Guacamole.Blob</a></li> + + <li><a href="../symbols/Guacamole.ChainedTunnel.html">Guacamole.ChainedTunnel</a></li> + + <li><a href="../symbols/Guacamole.Client.html">Guacamole.Client</a></li> + + <li><a href="../symbols/Guacamole.Client.LayerContainer.html">Guacamole.Client.LayerContainer</a></li> + + <li><a href="../symbols/Guacamole.HTTPTunnel.html">Guacamole.HTTPTunnel</a></li> + + <li><a href="../symbols/Guacamole.Keyboard.html">Guacamole.Keyboard</a></li> + + <li><a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a></li> + + <li><a href="../symbols/Guacamole.Layer.Pixel.html">Guacamole.Layer.Pixel</a></li> + + <li><a href="../symbols/Guacamole.Mouse.html">Guacamole.Mouse</a></li> + + <li><a href="../symbols/Guacamole.Mouse.State.html">Guacamole.Mouse.State</a></li> + + <li><a href="../symbols/Guacamole.Mouse.Touchpad.html">Guacamole.Mouse.Touchpad</a></li> + + <li><a href="../symbols/Guacamole.Mouse.Touchscreen.html">Guacamole.Mouse.Touchscreen</a></li> + + <li><a href="../symbols/Guacamole.OnScreenKeyboard.html">Guacamole.OnScreenKeyboard</a></li> + + <li><a href="../symbols/Guacamole.OnScreenKeyboard.Cap.html">Guacamole.OnScreenKeyboard.Cap</a></li> + + <li><a href="../symbols/Guacamole.OnScreenKeyboard.Key.html">Guacamole.OnScreenKeyboard.Key</a></li> + + <li><a href="../symbols/Guacamole.Parser.html">Guacamole.Parser</a></li> + + <li><a href="../symbols/Guacamole.Tunnel.html">Guacamole.Tunnel</a></li> + + <li><a href="../symbols/Guacamole.WebSocketTunnel.html">Guacamole.WebSocketTunnel</a></li> + +</ul> +<hr /> + <!-- end publish.classesIndex --> + </div> + + <div id="content"> +<!-- ============================== class title ============================ --> + <h1 class="classTitle"> + + Class Guacamole.Tunnel + </h1> + +<!-- ============================== class summary ========================== --> + <p class="description"> + + + + + + + <br /><i>Defined in: </i> <a href="../symbols/src/src_main_resources_tunnel.js.html">tunnel.js</a>. + + </p> + +<!-- ============================== constructor summary ==================== --> + + <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class Guacamole.Tunnel."> + <caption>Class Summary</caption> + <thead> + <tr> + <th scope="col">Constructor Attributes</th> + <th scope="col">Constructor Name and Description</th> + </tr> + </thead> + <tbody> + <tr> + <td class="attributes"> </td> + <td class="nameDescription" > + <div class="fixedFont"> + <b><a href="../symbols/Guacamole.Tunnel.html#constructor">Guacamole.Tunnel</a></b>() + </div> + <div class="description">Core object providing abstract communication for Guacamole.</div> + </td> + </tr> + </tbody> + </table> + + +<!-- ============================== properties summary ===================== --> + + +<!-- ============================== methods summary ======================== --> + + + + <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class Guacamole.Tunnel."> + <caption>Method Summary</caption> + <thead> + <tr> + <th scope="col">Method Attributes</th> + <th scope="col">Method Name and Description</th> + </tr> + </thead> + <tbody> + + <tr> + <td class="attributes"> </td> + <td class="nameDescription"> + <div class="fixedFont"><b><a href="../symbols/Guacamole.Tunnel.html#connect">connect</a></b>(data) + </div> + <div class="description">Connect to the tunnel with the given optional data.</div> + </td> + </tr> + + <tr> + <td class="attributes"> </td> + <td class="nameDescription"> + <div class="fixedFont"><b><a href="../symbols/Guacamole.Tunnel.html#disconnect">disconnect</a></b>() + </div> + <div class="description">Disconnect from the tunnel.</div> + </td> + </tr> + + <tr> + <td class="attributes"> </td> + <td class="nameDescription"> + <div class="fixedFont"><b><a href="../symbols/Guacamole.Tunnel.html#sendMessage">sendMessage</a></b>(elements) + </div> + <div class="description">Send the given message through the tunnel to the service on the other +side.</div> + </td> + </tr> + + </tbody> + </table> + + + + +<!-- ============================== events summary ======================== --> + + + + <table class="summaryTable" cellspacing="0" summary="A summary of the events documented in the class Guacamole.Tunnel."> + <caption>Event Summary</caption> + <thead> + <tr> + <th scope="col">Event Attributes</th> + <th scope="col">Event Name and Description</th> + </tr> + </thead> + <tbody> + + <tr> + <td class="attributes"> </td> + <td class="nameDescription"> + <div class="fixedFont"><b><a href="../symbols/Guacamole.Tunnel.html#event:onerror">onerror</a></b>(message) + </div> + <div class="description">Fired whenever an error is encountered by the tunnel.</div> + </td> + </tr> + + <tr> + <td class="attributes"> </td> + <td class="nameDescription"> + <div class="fixedFont"><b><a href="../symbols/Guacamole.Tunnel.html#event:oninstruction">oninstruction</a></b>(opcode, parameters) + </div> + <div class="description">Fired once for every complete Guacamole instruction received, in order.</div> + </td> + </tr> + + </tbody> + </table> + + + + + +<!-- ============================== constructor details ==================== --> + + <div class="details"><a name="constructor"> </a> + <div class="sectionTitle"> + Class Detail + </div> + + <div class="fixedFont"> + <b>Guacamole.Tunnel</b>() + </div> + + <div class="description"> + Core object providing abstract communication for Guacamole. This object +is a null implementation whose functions do nothing. Guacamole applications +should use <a href="../symbols/Guacamole.HTTPTunnel.html">Guacamole.HTTPTunnel</a> instead, or implement their own tunnel based +on this one. + + </div> + + + + + + + + + + + + <dl class="detailList"> + <dt class="heading">See:</dt> + + <dd><a href="../symbols/Guacamole.HTTPTunnel.html">Guacamole.HTTPTunnel</a></dd> + + </dl> + + + </div> + + +<!-- ============================== field details ========================== --> + + +<!-- ============================== method details ========================= --> + + <div class="sectionTitle"> + Method Detail + </div> + + <a name="connect"> </a> + <div class="fixedFont"> + + + <b>connect</b>(data) + + </div> + <div class="description"> + Connect to the tunnel with the given optional data. This data is +typically used for authentication. The format of data accepted is +up to the tunnel implementation. + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{String}</span> <b>data</b> + + </dt> + <dd>The data to send to the tunnel when connecting.</dd> + + </dl> + + + + + + + + + <hr /> + + <a name="disconnect"> </a> + <div class="fixedFont"> + + + <b>disconnect</b>() + + </div> + <div class="description"> + Disconnect from the tunnel. + + + </div> + + + + + + + + + + + + <hr /> + + <a name="sendMessage"> </a> + <div class="fixedFont"> + + + <b>sendMessage</b>(elements) + + </div> + <div class="description"> + Send the given message through the tunnel to the service on the other +side. All messages are guaranteed to be received in the order sent. + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{...}</span> <b>elements</b> + + </dt> + <dd>The elements of the message to send to the + service on the other side of the tunnel.</dd> + + </dl> + + + + + + + + + + + + +<!-- ============================== event details ========================= --> + + <div class="sectionTitle"> + Event Detail + </div> + + <a name="event:onerror"> </a> + <div class="fixedFont"> + + + <b>onerror</b>(message) + + </div> + <div class="description"> + Fired whenever an error is encountered by the tunnel. + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{String}</span> <b>message</b> + + </dt> + <dd>A human-readable description of the error that + occurred.</dd> + + </dl> + + + + + + + + + <hr /> + + <a name="event:oninstruction"> </a> + <div class="fixedFont"> + + + <b>oninstruction</b>(opcode, parameters) + + </div> + <div class="description"> + Fired once for every complete Guacamole instruction received, in order. + + + </div> + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{String}</span> <b>opcode</b> + + </dt> + <dd>The Guacamole instruction opcode.</dd> + + <dt> + <span class="light fixedFont">{Array}</span> <b>parameters</b> + + </dt> + <dd>The parameters provided for the instruction, + if any.</dd> + + </dl> + + + + + + + + + + + + + <hr /> + </div> + + +<!-- ============================== footer ================================= --> + <div class="fineprint" style="clear:both"> + + Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/"; target="_blank">JsDoc Toolkit</a> 2.4.0 on Fri Mar 28 2014 21:41:25 GMT-0700 (PDT) + </div> + +<!-- 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> +<!-- End Google Analytics --> + </body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/af9b9c05/content/doc/0.8.3/guacamole-common-js/symbols/Guacamole.WebSocketTunnel.html ---------------------------------------------------------------------- diff --git a/content/doc/0.8.3/guacamole-common-js/symbols/Guacamole.WebSocketTunnel.html b/content/doc/0.8.3/guacamole-common-js/symbols/Guacamole.WebSocketTunnel.html new file mode 100644 index 0000000..6d5fef6 --- /dev/null +++ b/content/doc/0.8.3/guacamole-common-js/symbols/Guacamole.WebSocketTunnel.html @@ -0,0 +1,385 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta http-equiv="content-type" content="text/html; charset=utf-8" /> + <meta name="generator" content="JsDoc Toolkit" /> + + <title>JsDoc Reference - Guacamole.WebSocketTunnel</title> + + <style type="text/css"> + /* default.css */ +body +{ + font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif; + width: 800px; +} + +.header +{ + clear: both; + background-color: #ccc; + padding: 8px; +} + +h1 +{ + font-size: 150%; + font-weight: bold; + padding: 0; + margin: 1em 0 0 .3em; +} + +hr +{ + border: none 0; + border-top: 1px solid #7F8FB1; + height: 1px; +} + +pre.code +{ + display: block; + padding: 8px; + border: 1px dashed #ccc; +} + +#index +{ + margin-top: 24px; + float: left; + width: 160px; + position: absolute; + left: 8px; + background-color: #F3F3F3; + padding: 8px; +} + +#content +{ + margin-left: 190px; + width: 600px; +} + +.classList +{ + list-style-type: none; + padding: 0; + margin: 0 0 0 8px; + font-family: arial, sans-serif; + font-size: 1em; + overflow: auto; +} + +.classList li +{ + padding: 0; + margin: 0 0 8px 0; +} + +.summaryTable { width: 100%; } + +h1.classTitle +{ + font-size:170%; + line-height:130%; +} + +h2 { font-size: 110%; } +caption, div.sectionTitle +{ + background-color: #7F8FB1; + color: #fff; + font-size:130%; + text-align: left; + padding: 2px 6px 2px 6px; + border: 1px #7F8FB1 solid; +} + +div.sectionTitle { margin-bottom: 8px; } +.summaryTable thead { display: none; } + +.summaryTable td +{ + vertical-align: top; + padding: 4px; + border-bottom: 1px #7F8FB1 solid; + border-right: 1px #7F8FB1 solid; +} + +/*col#summaryAttributes {}*/ +.summaryTable td.attributes +{ + border-left: 1px #7F8FB1 solid; + width: 140px; + text-align: right; +} + +td.attributes, .fixedFont +{ + line-height: 15px; + color: #002EBE; + font-family: "Courier New",Courier,monospace; + font-size: 13px; +} + +.summaryTable td.nameDescription +{ + text-align: left; + font-size: 13px; + line-height: 15px; +} + +.summaryTable td.nameDescription, .description +{ + line-height: 15px; + padding: 4px; + padding-left: 4px; +} + +.summaryTable { margin-bottom: 8px; } + +ul.inheritsList +{ + list-style: square; + margin-left: 20px; + padding-left: 0; +} + +.detailList { + margin-left: 20px; + line-height: 15px; +} +.detailList dt { margin-left: 20px; } + +.detailList .heading +{ + font-weight: bold; + padding-bottom: 6px; + margin-left: 0; +} + +.light, td.attributes, .light a:link, .light a:visited +{ + color: #777; + font-style: italic; +} + +.fineprint +{ + text-align: right; + font-size: 10px; +} + </style> + </head> + + <body> +<!-- ============================== header ================================= --> + <!-- begin static/header.html --> + <div id="header"> +</div> + <!-- end static/header.html --> + +<!-- ============================== classes index ============================ --> + <div id="index"> + <!-- begin publish.classesIndex --> + <div align="center"><a href="../index.html">Class Index</a> +| <a href="../files.html">File Index</a></div> +<hr /> +<h2>Classes</h2> +<ul class="classList"> + + <li><i><a href="../symbols/_global_.html">_global_</a></i></li> + + <li><a href="../symbols/Guacamole.html">Guacamole</a></li> + + <li><a href="../symbols/Guacamole.AudioChannel.html">Guacamole.AudioChannel</a></li> + + <li><a href="../symbols/Guacamole.AudioChannel.Packet.html">Guacamole.AudioChannel.Packet</a></li> + + <li><a href="../symbols/Guacamole.Blob.html">Guacamole.Blob</a></li> + + <li><a href="../symbols/Guacamole.ChainedTunnel.html">Guacamole.ChainedTunnel</a></li> + + <li><a href="../symbols/Guacamole.Client.html">Guacamole.Client</a></li> + + <li><a href="../symbols/Guacamole.Client.LayerContainer.html">Guacamole.Client.LayerContainer</a></li> + + <li><a href="../symbols/Guacamole.HTTPTunnel.html">Guacamole.HTTPTunnel</a></li> + + <li><a href="../symbols/Guacamole.Keyboard.html">Guacamole.Keyboard</a></li> + + <li><a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a></li> + + <li><a href="../symbols/Guacamole.Layer.Pixel.html">Guacamole.Layer.Pixel</a></li> + + <li><a href="../symbols/Guacamole.Mouse.html">Guacamole.Mouse</a></li> + + <li><a href="../symbols/Guacamole.Mouse.State.html">Guacamole.Mouse.State</a></li> + + <li><a href="../symbols/Guacamole.Mouse.Touchpad.html">Guacamole.Mouse.Touchpad</a></li> + + <li><a href="../symbols/Guacamole.Mouse.Touchscreen.html">Guacamole.Mouse.Touchscreen</a></li> + + <li><a href="../symbols/Guacamole.OnScreenKeyboard.html">Guacamole.OnScreenKeyboard</a></li> + + <li><a href="../symbols/Guacamole.OnScreenKeyboard.Cap.html">Guacamole.OnScreenKeyboard.Cap</a></li> + + <li><a href="../symbols/Guacamole.OnScreenKeyboard.Key.html">Guacamole.OnScreenKeyboard.Key</a></li> + + <li><a href="../symbols/Guacamole.Parser.html">Guacamole.Parser</a></li> + + <li><a href="../symbols/Guacamole.Tunnel.html">Guacamole.Tunnel</a></li> + + <li><a href="../symbols/Guacamole.WebSocketTunnel.html">Guacamole.WebSocketTunnel</a></li> + +</ul> +<hr /> + <!-- end publish.classesIndex --> + </div> + + <div id="content"> +<!-- ============================== class title ============================ --> + <h1 class="classTitle"> + + Class Guacamole.WebSocketTunnel + </h1> + +<!-- ============================== class summary ========================== --> + <p class="description"> + + <br />Extends + <a href="../symbols/Guacamole.Tunnel.html">Guacamole.Tunnel</a>.<br /> + + + + + + <br /><i>Defined in: </i> <a href="../symbols/src/src_main_resources_tunnel.js.html">tunnel.js</a>. + + </p> + +<!-- ============================== constructor summary ==================== --> + + <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class Guacamole.WebSocketTunnel."> + <caption>Class Summary</caption> + <thead> + <tr> + <th scope="col">Constructor Attributes</th> + <th scope="col">Constructor Name and Description</th> + </tr> + </thead> + <tbody> + <tr> + <td class="attributes"> </td> + <td class="nameDescription" > + <div class="fixedFont"> + <b><a href="../symbols/Guacamole.WebSocketTunnel.html#constructor">Guacamole.WebSocketTunnel</a></b>(tunnelURL) + </div> + <div class="description">Guacamole Tunnel implemented over WebSocket via XMLHttpRequest.</div> + </td> + </tr> + </tbody> + </table> + + +<!-- ============================== properties summary ===================== --> + + +<!-- ============================== methods summary ======================== --> + + + + + + <dl class="inheritsList"> + <dt>Methods borrowed from class <a href="../symbols/Guacamole.Tunnel.html">Guacamole.Tunnel</a>: </dt><dd><a href="../symbols/Guacamole.Tunnel.html#connect">connect</a>, <a href="../symbols/Guacamole.Tunnel.html#disconnect">disconnect</a>, <a href="../symbols/Guacamole.Tunnel.html#sendMessage">sendMessage</a></dd> + </dl> + + +<!-- ============================== events summary ======================== --> + + + + + + <dl class="inheritsList"> + <dt>Events borrowed from class <a href="../symbols/Guacamole.Tunnel.html">Guacamole.Tunnel</a>: </dt><dd><a href="../symbols/Guacamole.Tunnel.html#event:onerror">onerror</a>, <a href="../symbols/Guacamole.Tunnel.html#event:oninstruction">oninstruction</a></dd> + </dl> + + + +<!-- ============================== constructor details ==================== --> + + <div class="details"><a name="constructor"> </a> + <div class="sectionTitle"> + Class Detail + </div> + + <div class="fixedFont"> + <b>Guacamole.WebSocketTunnel</b>(tunnelURL) + </div> + + <div class="description"> + Guacamole Tunnel implemented over WebSocket via XMLHttpRequest. + + </div> + + + + + + <dl class="detailList"> + <dt class="heading">Parameters:</dt> + + <dt> + <span class="light fixedFont">{String}</span> <b>tunnelURL</b> + + </dt> + <dd>The URL of the WebSocket tunneling service.</dd> + + </dl> + + + + + + + + + </div> + + +<!-- ============================== field details ========================== --> + + +<!-- ============================== method details ========================= --> + + +<!-- ============================== event details ========================= --> + + + <hr /> + </div> + + +<!-- ============================== footer ================================= --> + <div class="fineprint" style="clear:both"> + + Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/"; target="_blank">JsDoc Toolkit</a> 2.4.0 on Fri Mar 28 2014 21:41:25 GMT-0700 (PDT) + </div> + +<!-- 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> +<!-- End Google Analytics --> + </body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/af9b9c05/content/doc/0.8.3/guacamole-common-js/symbols/Guacamole.html ---------------------------------------------------------------------- diff --git a/content/doc/0.8.3/guacamole-common-js/symbols/Guacamole.html b/content/doc/0.8.3/guacamole-common-js/symbols/Guacamole.html new file mode 100644 index 0000000..c207d4f --- /dev/null +++ b/content/doc/0.8.3/guacamole-common-js/symbols/Guacamole.html @@ -0,0 +1,354 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta http-equiv="content-type" content="text/html; charset=utf-8" /> + <meta name="generator" content="JsDoc Toolkit" /> + + <title>JsDoc Reference - Guacamole</title> + + <style type="text/css"> + /* default.css */ +body +{ + font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif; + width: 800px; +} + +.header +{ + clear: both; + background-color: #ccc; + padding: 8px; +} + +h1 +{ + font-size: 150%; + font-weight: bold; + padding: 0; + margin: 1em 0 0 .3em; +} + +hr +{ + border: none 0; + border-top: 1px solid #7F8FB1; + height: 1px; +} + +pre.code +{ + display: block; + padding: 8px; + border: 1px dashed #ccc; +} + +#index +{ + margin-top: 24px; + float: left; + width: 160px; + position: absolute; + left: 8px; + background-color: #F3F3F3; + padding: 8px; +} + +#content +{ + margin-left: 190px; + width: 600px; +} + +.classList +{ + list-style-type: none; + padding: 0; + margin: 0 0 0 8px; + font-family: arial, sans-serif; + font-size: 1em; + overflow: auto; +} + +.classList li +{ + padding: 0; + margin: 0 0 8px 0; +} + +.summaryTable { width: 100%; } + +h1.classTitle +{ + font-size:170%; + line-height:130%; +} + +h2 { font-size: 110%; } +caption, div.sectionTitle +{ + background-color: #7F8FB1; + color: #fff; + font-size:130%; + text-align: left; + padding: 2px 6px 2px 6px; + border: 1px #7F8FB1 solid; +} + +div.sectionTitle { margin-bottom: 8px; } +.summaryTable thead { display: none; } + +.summaryTable td +{ + vertical-align: top; + padding: 4px; + border-bottom: 1px #7F8FB1 solid; + border-right: 1px #7F8FB1 solid; +} + +/*col#summaryAttributes {}*/ +.summaryTable td.attributes +{ + border-left: 1px #7F8FB1 solid; + width: 140px; + text-align: right; +} + +td.attributes, .fixedFont +{ + line-height: 15px; + color: #002EBE; + font-family: "Courier New",Courier,monospace; + font-size: 13px; +} + +.summaryTable td.nameDescription +{ + text-align: left; + font-size: 13px; + line-height: 15px; +} + +.summaryTable td.nameDescription, .description +{ + line-height: 15px; + padding: 4px; + padding-left: 4px; +} + +.summaryTable { margin-bottom: 8px; } + +ul.inheritsList +{ + list-style: square; + margin-left: 20px; + padding-left: 0; +} + +.detailList { + margin-left: 20px; + line-height: 15px; +} +.detailList dt { margin-left: 20px; } + +.detailList .heading +{ + font-weight: bold; + padding-bottom: 6px; + margin-left: 0; +} + +.light, td.attributes, .light a:link, .light a:visited +{ + color: #777; + font-style: italic; +} + +.fineprint +{ + text-align: right; + font-size: 10px; +} + </style> + </head> + + <body> +<!-- ============================== header ================================= --> + <!-- begin static/header.html --> + <div id="header"> +</div> + <!-- end static/header.html --> + +<!-- ============================== classes index ============================ --> + <div id="index"> + <!-- begin publish.classesIndex --> + <div align="center"><a href="../index.html">Class Index</a> +| <a href="../files.html">File Index</a></div> +<hr /> +<h2>Classes</h2> +<ul class="classList"> + + <li><i><a href="../symbols/_global_.html">_global_</a></i></li> + + <li><a href="../symbols/Guacamole.html">Guacamole</a></li> + + <li><a href="../symbols/Guacamole.AudioChannel.html">Guacamole.AudioChannel</a></li> + + <li><a href="../symbols/Guacamole.AudioChannel.Packet.html">Guacamole.AudioChannel.Packet</a></li> + + <li><a href="../symbols/Guacamole.Blob.html">Guacamole.Blob</a></li> + + <li><a href="../symbols/Guacamole.ChainedTunnel.html">Guacamole.ChainedTunnel</a></li> + + <li><a href="../symbols/Guacamole.Client.html">Guacamole.Client</a></li> + + <li><a href="../symbols/Guacamole.Client.LayerContainer.html">Guacamole.Client.LayerContainer</a></li> + + <li><a href="../symbols/Guacamole.HTTPTunnel.html">Guacamole.HTTPTunnel</a></li> + + <li><a href="../symbols/Guacamole.Keyboard.html">Guacamole.Keyboard</a></li> + + <li><a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a></li> + + <li><a href="../symbols/Guacamole.Layer.Pixel.html">Guacamole.Layer.Pixel</a></li> + + <li><a href="../symbols/Guacamole.Mouse.html">Guacamole.Mouse</a></li> + + <li><a href="../symbols/Guacamole.Mouse.State.html">Guacamole.Mouse.State</a></li> + + <li><a href="../symbols/Guacamole.Mouse.Touchpad.html">Guacamole.Mouse.Touchpad</a></li> + + <li><a href="../symbols/Guacamole.Mouse.Touchscreen.html">Guacamole.Mouse.Touchscreen</a></li> + + <li><a href="../symbols/Guacamole.OnScreenKeyboard.html">Guacamole.OnScreenKeyboard</a></li> + + <li><a href="../symbols/Guacamole.OnScreenKeyboard.Cap.html">Guacamole.OnScreenKeyboard.Cap</a></li> + + <li><a href="../symbols/Guacamole.OnScreenKeyboard.Key.html">Guacamole.OnScreenKeyboard.Key</a></li> + + <li><a href="../symbols/Guacamole.Parser.html">Guacamole.Parser</a></li> + + <li><a href="../symbols/Guacamole.Tunnel.html">Guacamole.Tunnel</a></li> + + <li><a href="../symbols/Guacamole.WebSocketTunnel.html">Guacamole.WebSocketTunnel</a></li> + +</ul> +<hr /> + <!-- end publish.classesIndex --> + </div> + + <div id="content"> +<!-- ============================== class title ============================ --> + <h1 class="classTitle"> + + Namespace Guacamole + </h1> + +<!-- ============================== class summary ========================== --> + <p class="description"> + + + + + + + <br /><i>Defined in: </i> <a href="../symbols/src/src_main_resources_audio.js.html">audio.js</a>. + + </p> + +<!-- ============================== constructor summary ==================== --> + + <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class Guacamole."> + <caption>Namespace Summary</caption> + <thead> + <tr> + <th scope="col">Constructor Attributes</th> + <th scope="col">Constructor Name and Description</th> + </tr> + </thead> + <tbody> + <tr> + <td class="attributes"> </td> + <td class="nameDescription" > + <div class="fixedFont"> + <b><a href="../symbols/Guacamole.html#constructor">Guacamole</a></b> + </div> + <div class="description">Namespace for all Guacamole JavaScript objects.</div> + </td> + </tr> + </tbody> + </table> + + +<!-- ============================== properties summary ===================== --> + + +<!-- ============================== methods summary ======================== --> + +<!-- ============================== events summary ======================== --> + + +<!-- ============================== constructor details ==================== --> + + <div class="details"><a name="constructor"> </a> + <div class="sectionTitle"> + Namespace Detail + </div> + + <div class="fixedFont"> + <b>Guacamole</b> + </div> + + <div class="description"> + Namespace for all Guacamole JavaScript objects. + + </div> + + + + + + + + + + + + + </div> + + +<!-- ============================== field details ========================== --> + + +<!-- ============================== method details ========================= --> + + +<!-- ============================== event details ========================= --> + + + <hr /> + </div> + + +<!-- ============================== footer ================================= --> + <div class="fineprint" style="clear:both"> + + Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/"; target="_blank">JsDoc Toolkit</a> 2.4.0 on Fri Mar 28 2014 21:41:23 GMT-0700 (PDT) + </div> + +<!-- 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> +<!-- End Google Analytics --> + </body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/af9b9c05/content/doc/0.8.3/guacamole-common-js/symbols/_global_.html ---------------------------------------------------------------------- diff --git a/content/doc/0.8.3/guacamole-common-js/symbols/_global_.html b/content/doc/0.8.3/guacamole-common-js/symbols/_global_.html new file mode 100644 index 0000000..27c0473 --- /dev/null +++ b/content/doc/0.8.3/guacamole-common-js/symbols/_global_.html @@ -0,0 +1,304 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en"> + <head> + <meta http-equiv="content-type" content="text/html; charset=utf-8" /> + <meta name="generator" content="JsDoc Toolkit" /> + + <title>JsDoc Reference - _global_</title> + + <style type="text/css"> + /* default.css */ +body +{ + font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif; + width: 800px; +} + +.header +{ + clear: both; + background-color: #ccc; + padding: 8px; +} + +h1 +{ + font-size: 150%; + font-weight: bold; + padding: 0; + margin: 1em 0 0 .3em; +} + +hr +{ + border: none 0; + border-top: 1px solid #7F8FB1; + height: 1px; +} + +pre.code +{ + display: block; + padding: 8px; + border: 1px dashed #ccc; +} + +#index +{ + margin-top: 24px; + float: left; + width: 160px; + position: absolute; + left: 8px; + background-color: #F3F3F3; + padding: 8px; +} + +#content +{ + margin-left: 190px; + width: 600px; +} + +.classList +{ + list-style-type: none; + padding: 0; + margin: 0 0 0 8px; + font-family: arial, sans-serif; + font-size: 1em; + overflow: auto; +} + +.classList li +{ + padding: 0; + margin: 0 0 8px 0; +} + +.summaryTable { width: 100%; } + +h1.classTitle +{ + font-size:170%; + line-height:130%; +} + +h2 { font-size: 110%; } +caption, div.sectionTitle +{ + background-color: #7F8FB1; + color: #fff; + font-size:130%; + text-align: left; + padding: 2px 6px 2px 6px; + border: 1px #7F8FB1 solid; +} + +div.sectionTitle { margin-bottom: 8px; } +.summaryTable thead { display: none; } + +.summaryTable td +{ + vertical-align: top; + padding: 4px; + border-bottom: 1px #7F8FB1 solid; + border-right: 1px #7F8FB1 solid; +} + +/*col#summaryAttributes {}*/ +.summaryTable td.attributes +{ + border-left: 1px #7F8FB1 solid; + width: 140px; + text-align: right; +} + +td.attributes, .fixedFont +{ + line-height: 15px; + color: #002EBE; + font-family: "Courier New",Courier,monospace; + font-size: 13px; +} + +.summaryTable td.nameDescription +{ + text-align: left; + font-size: 13px; + line-height: 15px; +} + +.summaryTable td.nameDescription, .description +{ + line-height: 15px; + padding: 4px; + padding-left: 4px; +} + +.summaryTable { margin-bottom: 8px; } + +ul.inheritsList +{ + list-style: square; + margin-left: 20px; + padding-left: 0; +} + +.detailList { + margin-left: 20px; + line-height: 15px; +} +.detailList dt { margin-left: 20px; } + +.detailList .heading +{ + font-weight: bold; + padding-bottom: 6px; + margin-left: 0; +} + +.light, td.attributes, .light a:link, .light a:visited +{ + color: #777; + font-style: italic; +} + +.fineprint +{ + text-align: right; + font-size: 10px; +} + </style> + </head> + + <body> +<!-- ============================== header ================================= --> + <!-- begin static/header.html --> + <div id="header"> +</div> + <!-- end static/header.html --> + +<!-- ============================== classes index ============================ --> + <div id="index"> + <!-- begin publish.classesIndex --> + <div align="center"><a href="../index.html">Class Index</a> +| <a href="../files.html">File Index</a></div> +<hr /> +<h2>Classes</h2> +<ul class="classList"> + + <li><i><a href="../symbols/_global_.html">_global_</a></i></li> + + <li><a href="../symbols/Guacamole.html">Guacamole</a></li> + + <li><a href="../symbols/Guacamole.AudioChannel.html">Guacamole.AudioChannel</a></li> + + <li><a href="../symbols/Guacamole.AudioChannel.Packet.html">Guacamole.AudioChannel.Packet</a></li> + + <li><a href="../symbols/Guacamole.Blob.html">Guacamole.Blob</a></li> + + <li><a href="../symbols/Guacamole.ChainedTunnel.html">Guacamole.ChainedTunnel</a></li> + + <li><a href="../symbols/Guacamole.Client.html">Guacamole.Client</a></li> + + <li><a href="../symbols/Guacamole.Client.LayerContainer.html">Guacamole.Client.LayerContainer</a></li> + + <li><a href="../symbols/Guacamole.HTTPTunnel.html">Guacamole.HTTPTunnel</a></li> + + <li><a href="../symbols/Guacamole.Keyboard.html">Guacamole.Keyboard</a></li> + + <li><a href="../symbols/Guacamole.Layer.html">Guacamole.Layer</a></li> + + <li><a href="../symbols/Guacamole.Layer.Pixel.html">Guacamole.Layer.Pixel</a></li> + + <li><a href="../symbols/Guacamole.Mouse.html">Guacamole.Mouse</a></li> + + <li><a href="../symbols/Guacamole.Mouse.State.html">Guacamole.Mouse.State</a></li> + + <li><a href="../symbols/Guacamole.Mouse.Touchpad.html">Guacamole.Mouse.Touchpad</a></li> + + <li><a href="../symbols/Guacamole.Mouse.Touchscreen.html">Guacamole.Mouse.Touchscreen</a></li> + + <li><a href="../symbols/Guacamole.OnScreenKeyboard.html">Guacamole.OnScreenKeyboard</a></li> + + <li><a href="../symbols/Guacamole.OnScreenKeyboard.Cap.html">Guacamole.OnScreenKeyboard.Cap</a></li> + + <li><a href="../symbols/Guacamole.OnScreenKeyboard.Key.html">Guacamole.OnScreenKeyboard.Key</a></li> + + <li><a href="../symbols/Guacamole.Parser.html">Guacamole.Parser</a></li> + + <li><a href="../symbols/Guacamole.Tunnel.html">Guacamole.Tunnel</a></li> + + <li><a href="../symbols/Guacamole.WebSocketTunnel.html">Guacamole.WebSocketTunnel</a></li> + +</ul> +<hr /> + <!-- end publish.classesIndex --> + </div> + + <div id="content"> +<!-- ============================== class title ============================ --> + <h1 class="classTitle"> + + Built-In Namespace _global_ + </h1> + +<!-- ============================== class summary ========================== --> + <p class="description"> + + + + + + + </p> + +<!-- ============================== constructor summary ==================== --> + + +<!-- ============================== properties summary ===================== --> + + +<!-- ============================== methods summary ======================== --> + +<!-- ============================== events summary ======================== --> + + +<!-- ============================== constructor details ==================== --> + + +<!-- ============================== field details ========================== --> + + +<!-- ============================== method details ========================= --> + + +<!-- ============================== event details ========================= --> + + + <hr /> + </div> + + +<!-- ============================== footer ================================= --> + <div class="fineprint" style="clear:both"> + + Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/"; target="_blank">JsDoc Toolkit</a> 2.4.0 on Fri Mar 28 2014 21:41:23 GMT-0700 (PDT) + </div> + +<!-- 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> +<!-- End Google Analytics --> + </body> +</html>
