519 lines
No EOL
30 KiB
HTML
519 lines
No EOL
30 KiB
HTML
<!doctype html public "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<html>
|
|
<head>
|
|
<title>YAHOO.ext.GridPanel</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.GridPanel.html" target="_blank">Print Friendly</a></div>
|
|
<h1>Class YAHOO.ext.GridPanel</h1>
|
|
<table cellspacing="0">
|
|
<tr><td class="label">Package:</td><td>YAHOO.ext</td></tr>
|
|
<tr><td class="label">Class:</td><td>GridPanel</td></tr>
|
|
<tr><td class="label">Extends:</td><td><a href="YAHOO.ext.ContentPanel.html">ContentPanel</a></td></tr>
|
|
<tr><td class="label">Defined In:</td><td><a href="ContentPanels.js.html">ContentPanels.js</a></td></tr>
|
|
</table>
|
|
<div class="description">
|
|
</div>
|
|
<hr />
|
|
<a name="properties"></a>
|
|
<h2>Public Properties</h2>
|
|
<div class="no-members">This class has no public properties.</div> <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="#GridPanel">GridPanel</a>(<code>YAHOO.ext.grid.Grid grid</code>, <code>String/Object config</code>)</td>
|
|
<td class="msource" rowspan="2">GridPanel</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Create a new GridPanel.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#addListener">addListener</a>(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>boolean override</code>]</span>) : void</td>
|
|
<td class="msource" rowspan="2"><a href="YAHOO.ext.util.Observable.html#addListener">Observable</a></td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Appends an event handler to this element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#delayedListener">delayedListener</a>(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Number delay</code>]</span>) : Function</td>
|
|
<td class="msource" rowspan="2"><a href="YAHOO.ext.util.Observable.html#delayedListener">Observable</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Appends an event handler to this element that is delayed the specified number of milliseconds.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#destroy">destroy</a>() : void</td>
|
|
<td class="msource" rowspan="2"><a href="YAHOO.ext.ContentPanel.html#destroy">ContentPanel</a></td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Destroys this panel</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#fireEvent">fireEvent</a>(<code>String eventName</code>, <code>Object... args</code>) : Boolean</td>
|
|
<td class="msource" rowspan="2"><a href="YAHOO.ext.util.Observable.html#fireEvent">Observable</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Fires the specified event with the passed parameters (minus the event name).</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getEl">getEl</a>() : YAHOO.ext.Element</td>
|
|
<td class="msource" rowspan="2"><a href="YAHOO.ext.ContentPanel.html#getEl">ContentPanel</a></td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Returns this panel's element</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getGrid">getGrid</a>() : YAHOO.ext.grid.Grid</td>
|
|
<td class="msource" rowspan="2">GridPanel</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Returns the grid for this panel</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getId">getId</a>() : String</td>
|
|
<td class="msource" rowspan="2"><a href="YAHOO.ext.ContentPanel.html#getId">ContentPanel</a></td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Returns this panel's id</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getTitle">getTitle</a>() : String</td>
|
|
<td class="msource" rowspan="2"><a href="YAHOO.ext.ContentPanel.html#getTitle">ContentPanel</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Returns this panel's title</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getToolbar">getToolbar</a>() : YAHOO.ext.Toolbar</td>
|
|
<td class="msource" rowspan="2"><a href="YAHOO.ext.ContentPanel.html#getToolbar">ContentPanel</a></td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Returns the toolbar for this Panel if one was configured</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#getUpdateManager">getUpdateManager</a>() : YAHOO.ext.UpdateManager</td>
|
|
<td class="msource" rowspan="2"><a href="YAHOO.ext.ContentPanel.html#getUpdateManager">ContentPanel</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Get the <a href="YAHOO.ext.UpdateManager.html">YAHOO.ext.UpdateManager</a> for this panel. Enables you to perform Ajax updates.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#isClosable">isClosable</a>() : Boolean</td>
|
|
<td class="msource" rowspan="2"><a href="YAHOO.ext.ContentPanel.html#isClosable">ContentPanel</a></td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Returns true is this panel was configured to be closable</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#purgeListeners">purgeListeners</a>() : void</td>
|
|
<td class="msource" rowspan="2"><a href="YAHOO.ext.util.Observable.html#purgeListeners">Observable</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Removes all listeners for this object</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#removeListener">removeListener</a>(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>) : void</td>
|
|
<td class="msource" rowspan="2"><a href="YAHOO.ext.util.Observable.html#removeListener">Observable</a></td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Removes a listener</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setContent">setContent</a>(<code>String content</code>, <span class="optional" title="Optional">[<code>Boolean loadScripts</code>]</span>) : void</td>
|
|
<td class="msource" rowspan="2"><a href="YAHOO.ext.ContentPanel.html#setContent">ContentPanel</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Updates this panel's element</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setTitle">setTitle</a>(<code>String title</code>) : void</td>
|
|
<td class="msource" rowspan="2"><a href="YAHOO.ext.ContentPanel.html#setTitle">ContentPanel</a></td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Set this panel's title</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#setUrl">setUrl</a>(<code>String/Function url</code>, <span class="optional" title="Optional">[<code>String/Object params</code>]</span>, <span class="optional" title="Optional">[<code>Boolean loadOnce</code>]</span>) : YAHOO.ext.UpdateManager</td>
|
|
<td class="msource" rowspan="2"><a href="YAHOO.ext.ContentPanel.html#setUrl">ContentPanel</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Set a URL to be used to load the content for this panel.</td>
|
|
</tr>
|
|
</table>
|
|
<a name="events"></a>
|
|
<h2>Public Events</h2>
|
|
<table cellspacing="0" class="member-table">
|
|
<tr>
|
|
<th class="sig-header" colspan="2">Event</th>
|
|
<th class="msource-header">Defined By</th>
|
|
</tr>
|
|
<tr>
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#event-activate">activate</a> : (<code>YAHOO.ext.ContentPanel this</code>)</td>
|
|
<td class="msource" rowspan="2"><a href="YAHOO.ext.ContentPanel.html#event-activate">ContentPanel</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="mdesc">Fires when this panel is activated.</td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="micon inherited" title="Inherited" rowspan="2"> </td>
|
|
<td class="sig"><a class="mlink" href="#event-deactivate">deactivate</a> : (<code>YAHOO.ext.ContentPanel this</code>)</td>
|
|
<td class="msource" rowspan="2"><a href="YAHOO.ext.ContentPanel.html#event-deactivate">ContentPanel</a></td>
|
|
</tr>
|
|
<tr class="alt">
|
|
<td class="mdesc">Fires when this panel is activated.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<a name="GridPanel"></a>
|
|
<h2 class="mdetail-head">Constructor Details</h2>
|
|
<div class="detail-wrap">
|
|
<div class="mdetail">
|
|
<h3>GridPanel</i></h3>
|
|
<code>public function GridPanel(<code>YAHOO.ext.grid.Grid grid</code>, <code>String/Object config</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Create a new GridPanel. <div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>grid</code> : YAHOO.ext.grid.Grid<div class="sub-desc">The grid for this panel</div></li><li><code>config</code> : String/Object<div class="sub-desc">A string to set only the title or a config object</div></li> </ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<h2 class="mdetail-head">Method Details</h2>
|
|
<div class="detail-wrap">
|
|
<a name="addListener"></a>
|
|
<div class="mdetail">
|
|
<h3>addListener</i></h3>
|
|
<code>public function addListener(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>boolean override</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Appends an event handler to this element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li><li><code>override</code> : boolean<div class="sub-desc">(optional) If true, scope becomes the scope</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="YAHOO.ext.util.Observable.html#addListener">Observable</a>.</div>
|
|
</div>
|
|
<a name="delayedListener"></a>
|
|
<div class="mdetail alt">
|
|
<h3>delayedListener</i></h3>
|
|
<code>public function delayedListener(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>, <span class="optional" title="Optional">[<code>Number delay</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Appends an event handler to this element that is delayed the specified number of milliseconds.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The method the event invokes</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li><li><code>delay</code> : Number<div class="sub-desc">(optional) The number of milliseconds to delay</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Function</code><div class="sub-desc">The wrapped function that was created (can be used to remove the listener)</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="YAHOO.ext.util.Observable.html#delayedListener">Observable</a>.</div>
|
|
</div>
|
|
<a name="destroy"></a>
|
|
<div class="mdetail">
|
|
<h3>destroy</i></h3>
|
|
<code>public function destroy()</code>
|
|
<div class="mdetail-desc">
|
|
Destroys this panel
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="YAHOO.ext.ContentPanel.html#destroy">ContentPanel</a>.</div>
|
|
</div>
|
|
<a name="fireEvent"></a>
|
|
<div class="mdetail alt">
|
|
<h3>fireEvent</i></h3>
|
|
<code>public function fireEvent(<code>String eventName</code>, <code>Object... args</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Fires the specified event with the passed parameters (minus the event name).
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>eventName</code> : String<div class="sub-desc"></div></li><li><code>args</code> : Object...<div class="sub-desc">Variable number of parameters are passed to handlers</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Boolean</code><div class="sub-desc">returns false if any of the handlers return false otherwise it returns true</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="YAHOO.ext.util.Observable.html#fireEvent">Observable</a>.</div>
|
|
</div>
|
|
<a name="getEl"></a>
|
|
<div class="mdetail">
|
|
<h3>getEl</i></h3>
|
|
<code>public function getEl()</code>
|
|
<div class="mdetail-desc">
|
|
Returns this panel's element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Element</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="YAHOO.ext.ContentPanel.html#getEl">ContentPanel</a>.</div>
|
|
</div>
|
|
<a name="getGrid"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getGrid</i></h3>
|
|
<code>public function getGrid()</code>
|
|
<div class="mdetail-desc">
|
|
Returns the grid for this panel
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.grid.Grid</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by GridPanel.</div>
|
|
</div>
|
|
<a name="getId"></a>
|
|
<div class="mdetail">
|
|
<h3>getId</i></h3>
|
|
<code>public function getId()</code>
|
|
<div class="mdetail-desc">
|
|
Returns this panel's id
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>String</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="YAHOO.ext.ContentPanel.html#getId">ContentPanel</a>.</div>
|
|
</div>
|
|
<a name="getTitle"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getTitle</i></h3>
|
|
<code>public function getTitle()</code>
|
|
<div class="mdetail-desc">
|
|
Returns this panel's title
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>String</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="YAHOO.ext.ContentPanel.html#getTitle">ContentPanel</a>.</div>
|
|
</div>
|
|
<a name="getToolbar"></a>
|
|
<div class="mdetail">
|
|
<h3>getToolbar</i></h3>
|
|
<code>public function getToolbar()</code>
|
|
<div class="mdetail-desc">
|
|
Returns the toolbar for this Panel if one was configured
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.Toolbar</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="YAHOO.ext.ContentPanel.html#getToolbar">ContentPanel</a>.</div>
|
|
</div>
|
|
<a name="getUpdateManager"></a>
|
|
<div class="mdetail alt">
|
|
<h3>getUpdateManager</i></h3>
|
|
<code>public function getUpdateManager()</code>
|
|
<div class="mdetail-desc">
|
|
Get the <a href="YAHOO.ext.UpdateManager.html">YAHOO.ext.UpdateManager</a> for this panel. Enables you to perform Ajax updates.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.UpdateManager</code><div class="sub-desc">The UpdateManager</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="YAHOO.ext.ContentPanel.html#getUpdateManager">ContentPanel</a>.</div>
|
|
</div>
|
|
<a name="isClosable"></a>
|
|
<div class="mdetail">
|
|
<h3>isClosable</i></h3>
|
|
<code>public function isClosable()</code>
|
|
<div class="mdetail-desc">
|
|
Returns true is this panel was configured to be closable
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>Boolean</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="YAHOO.ext.ContentPanel.html#isClosable">ContentPanel</a>.</div>
|
|
</div>
|
|
<a name="purgeListeners"></a>
|
|
<div class="mdetail alt">
|
|
<h3>purgeListeners</i></h3>
|
|
<code>public function purgeListeners()</code>
|
|
<div class="mdetail-desc">
|
|
Removes all listeners for this object
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li>None.</li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="YAHOO.ext.util.Observable.html#purgeListeners">Observable</a>.</div>
|
|
</div>
|
|
<a name="removeListener"></a>
|
|
<div class="mdetail">
|
|
<h3>removeListener</i></h3>
|
|
<code>public function removeListener(<code>String eventName</code>, <code>Function handler</code>, <span class="optional" title="Optional">[<code>Object scope</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Removes a listener
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>eventName</code> : String<div class="sub-desc">The type of event to listen for</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove</div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope (this object) for the handler</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="YAHOO.ext.util.Observable.html#removeListener">Observable</a>.</div>
|
|
</div>
|
|
<a name="setContent"></a>
|
|
<div class="mdetail alt">
|
|
<h3>setContent</i></h3>
|
|
<code>public function setContent(<code>String content</code>, <span class="optional" title="Optional">[<code>Boolean loadScripts</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Updates this panel's element
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>content</code> : String<div class="sub-desc">The new content</div></li><li><code>loadScripts</code> : Boolean<div class="sub-desc">(optional) true to look for and process scripts</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="YAHOO.ext.ContentPanel.html#setContent">ContentPanel</a>.</div>
|
|
</div>
|
|
<a name="setTitle"></a>
|
|
<div class="mdetail">
|
|
<h3>setTitle</i></h3>
|
|
<code>public function setTitle(<code>String title</code>)</code>
|
|
<div class="mdetail-desc">
|
|
Set this panel's title
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>title</code> : String<div class="sub-desc"></div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>void</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="YAHOO.ext.ContentPanel.html#setTitle">ContentPanel</a>.</div>
|
|
</div>
|
|
<a name="setUrl"></a>
|
|
<div class="mdetail alt">
|
|
<h3>setUrl</i></h3>
|
|
<code>public function setUrl(<code>String/Function url</code>, <span class="optional" title="Optional">[<code>String/Object params</code>]</span>, <span class="optional" title="Optional">[<code>Boolean loadOnce</code>]</span>)</code>
|
|
<div class="mdetail-desc">
|
|
Set a URL to be used to load the content for this panel.
|
|
<div class="mdetail-params">
|
|
<strong>Parameters:</strong>
|
|
<ul><li><code>url</code> : String/Function<div class="sub-desc">The url to load the content from or a function to call to get the url</div></li><li><code>params</code> : String/Object<div class="sub-desc">(optional) The string params for the update call or an object of the params. See <a href="YAHOO.ext.UpdateManager.html#update">YAHOO.ext.UpdateManager.update</a> for more details. (Defaults to null)</div></li><li><code>loadOnce</code> : Boolean<div class="sub-desc">(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)</div></li> </ul>
|
|
<strong>Returns:</strong>
|
|
<ul>
|
|
<li><code>YAHOO.ext.UpdateManager</code><div class="sub-desc">The UpdateManager</div></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This method is defined by <a href="YAHOO.ext.ContentPanel.html#setUrl">ContentPanel</a>.</div>
|
|
</div>
|
|
</div>
|
|
|
|
<h2 class="mdetail-head">Event Details</h2>
|
|
<div class="detail-wrap">
|
|
<a name="event-activate"></a>
|
|
<div class="mdetail">
|
|
<h3>activate</i></h3>
|
|
<code>public event activate</code>
|
|
<div class="mdetail-desc">
|
|
Fires when this panel is activated.
|
|
<div class="mdetail-params">
|
|
<strong style="font-weight:normal;">Subscribers will be called with the following parameters:</strong>
|
|
<ul><li><code>this</code> : YAHOO.ext.ContentPanel<div class="sub-desc"></div></li> </ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This event is defined by <a href="YAHOO.ext.ContentPanel.html#event-activate">ContentPanel</a>.</div>
|
|
</div>
|
|
<a name="event-deactivate"></a>
|
|
<div class="mdetail alt">
|
|
<h3>deactivate</i></h3>
|
|
<code>public event deactivate</code>
|
|
<div class="mdetail-desc">
|
|
Fires when this panel is activated.
|
|
<div class="mdetail-params">
|
|
<strong style="font-weight:normal;">Subscribers will be called with the following parameters:</strong>
|
|
<ul><li><code>this</code> : YAHOO.ext.ContentPanel<div class="sub-desc"></div></li> </ul>
|
|
</div>
|
|
</div>
|
|
<div class="mdetail-def">This event is defined by <a href="YAHOO.ext.ContentPanel.html#event-deactivate">ContentPanel</a>.</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<hr>
|
|
Copyright © 2006 Jack Slocum. All rights reserved.
|
|
</body>
|
|
</html>
|
|
|