121 lines
No EOL
7.1 KiB
HTML
121 lines
No EOL
7.1 KiB
HTML
<!doctype html public "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<html>
|
|
<head>
|
|
<title>YAHOO.ext.util.Config</title>
|
|
<link rel="stylesheet" type="text/css" href="../resources/reset.css"/>
|
|
<link rel="stylesheet" type="text/css" href="../resources/style.css" media="screen"/>
|
|
<link rel="stylesheet" type="text/css" href="../resources/print.css" media="print">
|
|
</head>
|
|
<body>
|
|
<div class="body-wrap">
|
|
<div class="top-tools"><img src="../resources/print.gif" width="16" height="16" align="absmiddle"> <a href="YAHOO.ext.util.Config.html" target="_blank">Print Friendly</a></div>
|
|
<h1>Class YAHOO.ext.util.Config</h1>
|
|
<table cellspacing="0">
|
|
<tr><td class="label">Package:</td><td>YAHOO.ext.util</td></tr>
|
|
<tr><td class="label">Class:</td><td>Config</td></tr>
|
|
<tr><td class="label">Extends:</td><td>Object</td></tr>
|
|
<tr><td class="label">Defined In:</td><td><a href="yutil.js.html">yutil.js</a></td></tr>
|
|
</table>
|
|
<div class="description">
|
|
Class with one useful method<br><br><i>This class is a singleton and cannot be created directly.</i> </div>
|
|
<hr />
|
|
<a name="properties"></a>
|
|
<h2>Public Properties</h2>
|
|
<table cellspacing="0" class="member-table">
|
|
<tr>
|
|
<th class="sig-header" colspan="2">Property</th>
|
|
<th class="msource-header">Defined By</th>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#left">left</a> : Object</td>
|
|
<td class="msource" rowspan="2">Config</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Provides default constraint padding to "constrainTo" elements (defaults to {left: 0, right:0, top:0, bottom:0}).</td>
|
|
</tr>
|
|
</table>
|
|
<a name="methods"></a>
|
|
<h2>Public Methods</h2>
|
|
<table cellspacing="0" class="member-table">
|
|
<tr>
|
|
<th class="sig-header" colspan="2">Method</th>
|
|
<th class="msource-header">Defined By</th>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#apply">apply</a>(<code>Object obj</code>, <code>Object config</code>, <code>Object defaults</code>) : Object</td>
|
|
<td class="msource" rowspan="2">Config</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Copies all the properties of config to obj.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#constrainTo">constrainTo</a>(<code>String/HTMLElement/Element constrainTo</code>, <span class="optional" title="Optional">[<code>Object/Number pad</code>]</span>, <span class="optional" title="Optional">[<code>Boolean inContent</code>]</span>) : void</td>
|
|
<td class="msource" rowspan="2">Config</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Initializes the drag drop object's constraints to restrict movement to a certain element.</td>
|
|
</tr>
|
|
</table>
|
|
<a name="events"></a>
|
|
<h2>Public Events</h2>
|
|
<div class="no-members">This class has no public events.</div>
|
|
<h2 class="mdetail-head">Property Details</h2>
|
|
<div class="detail-wrap">
|
|
<a name="left"></a>
|
|
<div class="mdetail">
|
|
<h3>left</i></h3>
|
|
<code>public Object left</code>
|
|
<div class="mdetail-desc">
|
|
Provides default constraint padding to "constrainTo" elements (defaults to {left: 0, right:0, top:0, bottom:0}). </div>
|
|
<div class="mdetail-def">This property is defined by Config.</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<h2 class="mdetail-head">Method Details</h2>
|
|
<div class="detail-wrap">
|
|
<a name="apply"></a>
|
|
<div class="mdetail">
|
|
<h3>apply</i></h3>
|
|
<code>public function apply(<code>Object obj</code>, <code>Object config</code>, <code>Object defaults</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Copies all the properties of config to obj.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>obj</code> : Object<div class="sub-desc">The receiver of the properties</div></li><li><code>config</code> : Object<div class="sub-desc">The source of the properties</div></li><li><code>defaults</code> : Object<div class="sub-desc">A different object that will also be applied for default values</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Object</code><div class="sub-desc">returns obj</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Config.</div>
|
|
</div>
|
|
<a name="constrainTo"></a>
|
|
<div class="mdetail alt">
|
|
<h3>constrainTo</i></h3>
|
|
<code>public function constrainTo(<code>String/HTMLElement/Element constrainTo</code>, <span class="optional" title="Optional">[<code>Object/Number pad</code>]</span>, <span class="optional" title="Optional">[<code>Boolean inContent</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Initializes the drag drop object's constraints to restrict movement to a certain element.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>constrainTo</code> : String/HTMLElement/Element<div class="sub-desc">The element to constrain to.</div></li><li><code>pad</code> : Object/Number<div class="sub-desc">(optional) Pad provides a way to specify "padding" of the constraints, and can be either a number for symmetrical padding (4 would be equal to {left:4, right:4, top:4, bottom:4}) or an object containing the sides to pad. For example: {right:10, bottom:10}</div></li><li><code>inContent</code> : Boolean<div class="sub-desc">(optional) Constrain the draggable in the content box of the element (inside padding and borders)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by Config.</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<hr>
|
|
Copyright © 2006 Jack Slocum. All rights reserved.
|
|
</body>
|
|
</html>
|
|
|