blob: 6634dab82bb38cf3c268958b1c5e6cf1df071a8e [file] [log] [blame]
<!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 - Client</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">Index</a></div>
<hr />
<h2>Global Objects</h2>
<ul class="classList">
<li></li>
<li></li>
<li></li>
<li></li>
<li></li>
<li></li>
<li></li>
<li></li>
<li></li>
<li></li>
<li></li>
<li></li>
<li></li>
<li></li>
<li></li>
<li></li>
<li></li>
<li><a href="../symbols/rap.html">rap</a></li>
<li><a href="../symbols/SWT.html">SWT</a></li>
</ul>
<h2>Types</h2>
<ul class="classList">
<li><a href="../symbols/%24.html">$</a></li>
<li><a href="../symbols/Button.html">Button</a></li>
<li><a href="../symbols/Canvas.html">Canvas</a></li>
<li><a href="../symbols/Client.html">Client</a></li>
<li><a href="../symbols/Combo.html">Combo</a></li>
<li><a href="../symbols/Composite.html">Composite</a></li>
<li><a href="../symbols/Control.html">Control</a></li>
<li><a href="../symbols/Event.html">Event</a></li>
<li><a href="../symbols/Label.html">Label</a></li>
<li><a href="../symbols/ProgressBar.html">ProgressBar</a></li>
<li><a href="../symbols/RemoteObject.html">RemoteObject</a></li>
<li><a href="../symbols/Scale.html">Scale</a></li>
<li><a href="../symbols/ScrolledComposite.html">ScrolledComposite</a></li>
<li><a href="../symbols/Slider.html">Slider</a></li>
<li><a href="../symbols/Spinner.html">Spinner</a></li>
<li><a href="../symbols/Text.html">Text</a></li>
<li><a href="../symbols/Widget.html">Widget</a></li>
<li></li>
<li></li>
</ul>
<hr />
<!-- end publish.classesIndex -->
</div>
<div id="content">
<!-- ============================== class title ============================ -->
<h1 class="classTitle">
Type Client
</h1>
<!-- ============================== class summary ========================== -->
<p class="description">
Basic client detection implementation.
</p>
<!-- ============================== constructor summary ==================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class Client.">
<caption>Type 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">&nbsp;</td>
<td class="nameDescription" >
<div class="fixedFont">
<b><a href="../symbols/Client.html#constructor">Client</a></b>()
</div>
<div class="description">Version names follow the wikipedia scheme: major.minor[.revision[.build]] at
http://en.wikipedia.org/wiki/Software_version
Object can be obtained from <a href="../symbols/rap.html#.getClient">rap.getClient</a>.</div>
</td>
</tr>
</tbody>
</table>
<!-- ============================== properties summary ===================== -->
<!-- ============================== methods summary ======================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class Client.">
<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">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">Client.<b><a href="../symbols/Client.html#.getBasePath">getBasePath</a></b>()
</div>
<div class="description">Returns application base path.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">Client.<b><a href="../symbols/Client.html#.getBrowser">getBrowser</a></b>()
</div>
<div class="description">Returns the name of the browser, "chrome" or "firefox" for example.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">Client.<b><a href="../symbols/Client.html#.getBuild">getBuild</a></b>()
</div>
<div class="description">Returns the build number of browser engine version.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">Client.<b><a href="../symbols/Client.html#.getDefaultLocale">getDefaultLocale</a></b>()
</div>
<div class="description">Returns the browser default locale.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">Client.<b><a href="../symbols/Client.html#.getEngine">getEngine</a></b>()
</div>
<div class="description">Returns the name of the browser engine - "trident", "gecko", "webkit" or "blink".</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">Client.<b><a href="../symbols/Client.html#.getLanguage">getLanguage</a></b>()
</div>
<div class="description">Returns the language part from the browser locale.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">Client.<b><a href="../symbols/Client.html#.getLocale">getLocale</a></b>()
</div>
<div class="description">Returns the browser locale as defined in http://www.ietf.org/rfc/bcp/bcp47.txt.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">Client.<b><a href="../symbols/Client.html#.getMajor">getMajor</a></b>()
</div>
<div class="description">Returns the major number of browser engine version.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">Client.<b><a href="../symbols/Client.html#.getMinor">getMinor</a></b>()
</div>
<div class="description">Returns the minor number of browser engine version.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">Client.<b><a href="../symbols/Client.html#.getPlatform">getPlatform</a></b>()
</div>
<div class="description">Returns client platform like Windows, Android for example.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">Client.<b><a href="../symbols/Client.html#.getRevision">getRevision</a></b>()
</div>
<div class="description">Returns the revision number of browser engine version.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">Client.<b><a href="../symbols/Client.html#.getTerritory">getTerritory</a></b>()
</div>
<div class="description">Returns the region part from the browser locale.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">Client.<b><a href="../symbols/Client.html#.getTimezoneOffset">getTimezoneOffset</a></b>()
</div>
<div class="description">Returns the client timezone.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">Client.<b><a href="../symbols/Client.html#.getVersion">getVersion</a></b>()
</div>
<div class="description">Returns the browser engine version.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">Client.<b><a href="../symbols/Client.html#.isAndroidBrowser">isAndroidBrowser</a></b>()
</div>
<div class="description">Returns true if the browser is default Android browser, false otherwise.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">Client.<b><a href="../symbols/Client.html#.isBlink">isBlink</a></b>()
</div>
<div class="description">Returns true is browser engine is "blink" (Chrome/Opera), false otherwise.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">Client.<b><a href="../symbols/Client.html#.isGecko">isGecko</a></b>()
</div>
<div class="description">Returns true is browser engine is "gecko" (Firefox), false otherwise.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">Client.<b><a href="../symbols/Client.html#.isMobileChrome">isMobileChrome</a></b>()
</div>
<div class="description">Returns true if the browser is mobile Chrome, false otherwise.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">Client.<b><a href="../symbols/Client.html#.isMobileFirefox">isMobileFirefox</a></b>()
</div>
<div class="description">Returns true if the browser is mobile Firefox, false otherwise.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">Client.<b><a href="../symbols/Client.html#.isMobileSafari">isMobileSafari</a></b>()
</div>
<div class="description">Returns true if the browser is mobile Safari, false otherwise.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">Client.<b><a href="../symbols/Client.html#.isTrident">isTrident</a></b>()
</div>
<div class="description">Returns true is browser engine is "trident" (IE/Edge), false otherwise.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">Client.<b><a href="../symbols/Client.html#.isWebkit">isWebkit</a></b>()
</div>
<div class="description">Returns true is browser engine is "webkit" (Safari), false otherwise.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">Client.<b><a href="../symbols/Client.html#.supportsCss3">supportsCss3</a></b>()
</div>
<div class="description">Returns true if the browser supports CSS3, false otherwise.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">Client.<b><a href="../symbols/Client.html#.supportsFileDrop">supportsFileDrop</a></b>()
</div>
<div class="description">Returns true if the browser supports file drop, false otherwise.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">Client.<b><a href="../symbols/Client.html#.supportsTouch">supportsTouch</a></b>()
</div>
<div class="description">Returns true if the browser supports touch events, false otherwise.</div>
</td>
</tr>
<tr>
<td class="attributes">&lt;static&gt; &nbsp;</td>
<td class="nameDescription">
<div class="fixedFont">Client.<b><a href="../symbols/Client.html#.usesDefaultLocale">usesDefaultLocale</a></b>()
</div>
<div class="description">Returns true if the current browser locale is the default one, false otherwise.</div>
</td>
</tr>
</tbody>
</table>
<!-- ============================== events summary ======================== -->
<!-- ============================== constructor details ==================== -->
<div class="details"><a name="constructor"> </a>
<div class="sectionTitle">
Type Detail
</div>
<div class="fixedFont">
<b>Client</b>()
</div>
<div class="description">
Version names follow the wikipedia scheme: major.minor[.revision[.build]] at
http://en.wikipedia.org/wiki/Software_version
Object can be obtained from <a href="../symbols/rap.html#.getClient">rap.getClient</a>.
</div>
<dl class="detailList">
<dt class="heading">Since:</dt>
<dd>3.2</dd>
</dl>
</div>
<!-- ============================== field details ========================== -->
<!-- ============================== method details ========================= -->
<div class="sectionTitle">
Method Detail
</div>
<a name=".getBasePath"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">Client.</span><b>getBasePath</b>()
</div>
<div class="description">
Returns application base path.
</div>
<hr />
<a name=".getBrowser"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">Client.</span><b>getBrowser</b>()
</div>
<div class="description">
Returns the name of the browser, "chrome" or "firefox" for example.
If the browser name can't be detected this function returns "unknown".
</div>
<hr />
<a name=".getBuild"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">Client.</span><b>getBuild</b>()
</div>
<div class="description">
Returns the build number of browser engine version.
</div>
<hr />
<a name=".getDefaultLocale"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">Client.</span><b>getDefaultLocale</b>()
</div>
<div class="description">
Returns the browser default locale.
</div>
<hr />
<a name=".getEngine"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">Client.</span><b>getEngine</b>()
</div>
<div class="description">
Returns the name of the browser engine - "trident", "gecko", "webkit" or "blink".
If the browser engine name can't be detected this function returns "unknown".
</div>
<hr />
<a name=".getLanguage"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">Client.</span><b>getLanguage</b>()
</div>
<div class="description">
Returns the language part from the browser locale.
</div>
<hr />
<a name=".getLocale"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">Client.</span><b>getLocale</b>()
</div>
<div class="description">
Returns the browser locale as defined in http://www.ietf.org/rfc/bcp/bcp47.txt.
</div>
<hr />
<a name=".getMajor"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">Client.</span><b>getMajor</b>()
</div>
<div class="description">
Returns the major number of browser engine version.
</div>
<hr />
<a name=".getMinor"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">Client.</span><b>getMinor</b>()
</div>
<div class="description">
Returns the minor number of browser engine version.
</div>
<hr />
<a name=".getPlatform"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">Client.</span><b>getPlatform</b>()
</div>
<div class="description">
Returns client platform like Windows, Android for example.
</div>
<hr />
<a name=".getRevision"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">Client.</span><b>getRevision</b>()
</div>
<div class="description">
Returns the revision number of browser engine version.
</div>
<hr />
<a name=".getTerritory"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">Client.</span><b>getTerritory</b>()
</div>
<div class="description">
Returns the region part from the browser locale.
</div>
<hr />
<a name=".getTimezoneOffset"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">Client.</span><b>getTimezoneOffset</b>()
</div>
<div class="description">
Returns the client timezone.
</div>
<hr />
<a name=".getVersion"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">Client.</span><b>getVersion</b>()
</div>
<div class="description">
Returns the browser engine version.
</div>
<hr />
<a name=".isAndroidBrowser"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">Client.</span><b>isAndroidBrowser</b>()
</div>
<div class="description">
Returns true if the browser is default Android browser, false otherwise.
</div>
<hr />
<a name=".isBlink"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">Client.</span><b>isBlink</b>()
</div>
<div class="description">
Returns true is browser engine is "blink" (Chrome/Opera), false otherwise.
</div>
<hr />
<a name=".isGecko"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">Client.</span><b>isGecko</b>()
</div>
<div class="description">
Returns true is browser engine is "gecko" (Firefox), false otherwise.
</div>
<hr />
<a name=".isMobileChrome"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">Client.</span><b>isMobileChrome</b>()
</div>
<div class="description">
Returns true if the browser is mobile Chrome, false otherwise.
</div>
<hr />
<a name=".isMobileFirefox"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">Client.</span><b>isMobileFirefox</b>()
</div>
<div class="description">
Returns true if the browser is mobile Firefox, false otherwise.
</div>
<hr />
<a name=".isMobileSafari"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">Client.</span><b>isMobileSafari</b>()
</div>
<div class="description">
Returns true if the browser is mobile Safari, false otherwise.
</div>
<hr />
<a name=".isTrident"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">Client.</span><b>isTrident</b>()
</div>
<div class="description">
Returns true is browser engine is "trident" (IE/Edge), false otherwise.
</div>
<hr />
<a name=".isWebkit"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">Client.</span><b>isWebkit</b>()
</div>
<div class="description">
Returns true is browser engine is "webkit" (Safari), false otherwise.
</div>
<hr />
<a name=".supportsCss3"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">Client.</span><b>supportsCss3</b>()
</div>
<div class="description">
Returns true if the browser supports CSS3, false otherwise.
NOTE: This returns true if the browser sufficiently implements border-radius,
drop-shadow and linear-gradient.
</div>
<hr />
<a name=".supportsFileDrop"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">Client.</span><b>supportsFileDrop</b>()
</div>
<div class="description">
Returns true if the browser supports file drop, false otherwise.
</div>
<hr />
<a name=".supportsTouch"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">Client.</span><b>supportsTouch</b>()
</div>
<div class="description">
Returns true if the browser supports touch events, false otherwise.
</div>
<hr />
<a name=".usesDefaultLocale"> </a>
<div class="fixedFont">&lt;static&gt;
<span class="light">Client.</span><b>usesDefaultLocale</b>()
</div>
<div class="description">
Returns true if the current browser locale is the default one, false otherwise.
</div>
<!-- ============================== event details ========================= -->
<hr />
</div>
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
Copyright (c) EclipseSource and others 2013, 2019. All rights reserved.
</div>
</body>
</html>