blob: e3d0f88b2db758f04110719890b8a030504d6453 [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 - $</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><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/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/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 $
</h1>
<!-- ============================== class summary ========================== -->
<p class="description">
An JQuery-like object which allows manipulation of HTML elements.
</p>
<!-- ============================== constructor summary ==================== -->
<!-- ============================== properties summary ===================== -->
<!-- ============================== methods summary ======================== -->
<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class $.">
<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">&nbsp;</td>
<td class="nameDescription">
<div class="fixedFont"><b><a href="../symbols/%24.html#attr">attr</a></b>(attribute, value)
</div>
<div class="description">A method to either set or get the value of an HTML-attribute.</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">&lt;private&gt;
<b>$</b>(target)
</div>
<div class="description">
The constructor is not public. Instances can currently only be obtained from
<a href="../symbols/Widget.html#$el">Widget#$el</a>.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<b>target</b>
</dt>
<dd></dd>
</dl>
<dl class="detailList">
<dt class="heading">Since:</dt>
<dd>2.3</dd>
</dl>
</div>
<!-- ============================== field details ========================== -->
<!-- ============================== method details ========================= -->
<div class="sectionTitle">
Method Detail
</div>
<a name="attr"> </a>
<div class="fixedFont">
<span class="light">{string|<a href="../symbols/%24.html">$</a>}</span>
<b>attr</b>(attribute, value)
</div>
<div class="description">
A method to either set or get the value of an HTML-attribute.
Note that the attributes "id" and "class" can not be set this way.
</div>
<dl class="detailList">
<dt class="heading">Parameters:</dt>
<dt>
<span class="light fixedFont">{string|Object}</span> <b>attribute</b>
</dt>
<dd>The name of the attribute to return or modify. Alternatively
a plain object with key-value pairs to set.</dd>
<dt>
<span class="light fixedFont">{string}</span> <b>value</b>
<i>Optional</i>
</dt>
<dd>The value to set the attribute to.</dd>
</dl>
<dl class="detailList">
<dt class="heading">Returns:</dt>
<dd><span class="light fixedFont">{string|<a href="../symbols/%24.html">$</a>}</span> The the value of the given attribute, if the function is called with a
string only. Otherwise a reference to this object.</dd>
</dl>
<!-- ============================== event details ========================= -->
<hr />
</div>
<!-- ============================== footer ================================= -->
<div class="fineprint" style="clear:both">
Copyright (c) EclipseSource and others 2013. All rights reserved.
</div>
</body>
</html>