oqapi/webgui
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

merging new yui

Browse source
This commit is contained in:
JT Smith 2008-03-15 17:21:21 +00:00
parent 214a9673f9
commit 728eccc3cb
1638 changed files with 815363 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

701
www/extras/yui/docs/YAHOO.widget.ColumnSet.html Normal file
View file

@ -0,0 +1,701 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>API: datatable YAHOO.widget.ColumnSet (YUI Library)</title>
<link rel="stylesheet" type="text/css" href="assets/api.css">
<script type="text/javascript" src="assets/api-js"></script>
<script type="text/javascript" src="assets/ac-js"></script>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<a href="http://developer.yahoo.com/yui/"><h1>Yahoo! UI Library</h1></a>
<h3>DataTable Widget&nbsp; <span class="subtitle">2.5.0</span></h3>
<p>
<a href="./index.html">Yahoo! UI Library</a>
&gt; <a href="./module_datatable.html">datatable</a>
&gt; YAHOO.widget.ColumnSet
</p>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<form name="yui-classopts-form">
<span id="classopts"><input type="checkbox" name="showprivate" id="showprivate" /> Show Private</span>
<span id="classopts"><input type="checkbox" name="showprotected" id="showprotected" /> Show Protected</span>
</form>
<h2>
Class <b>YAHOO.widget.ColumnSet</b>
<span class="extends">
</span>
<span class="extends">
- uses
<a href="YAHOO.util.EventProvider.html">YAHOO.util.EventProvider</a>
</span>
</code>
</h2>
<!-- class tree goes here -->
<div class="summary description">
The ColumnSet class defines and manages a DataTable's Columns,
including nested hierarchies and access to individual Column instances.
</div>
<div class="section constructor details">
<h3 id="constructor">Constructor</h3>
<div class="content">
<div class="detail">
<strong>YAHOO.widget.ColumnSet</strong>
<code>
(
aDefinitions
)
</code>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>aDefinitions
&lt;Object[]&gt;
</code>
Array of object literals that define cells in
the THEAD.
</dd>
</dl>
</div>
</div>
</div>
</div>
<div class="section field details">
<h3 id="properties">Properties</h3>
<div class="content">
<div class="private">
<h4><a name="_aDefinitions">_aDefinitions</a>
<code>- private Object[]</code>
</h4>
<div class="detail">
<div class="description">
Array of object literal Column definitions passed to the constructor.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="_sId">_sId</a>
<code>- private String</code>
</h4>
<div class="detail">
<div class="description">
Unique instance name.
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="ColumnSet._nCount">ColumnSet._nCount</a>
<code>- private static Number</code>
</h4>
<div class="detail">
<div class="description">
Internal class variable to index multiple ColumnSet instances.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="flat">flat</a>
<code>- YAHOO.widget.Column[]</code>
</h4>
<div class="detail">
<div class="description">
Flattened representation of all Columns.
</div>
</div>
<div class="default">
Default Value: []
</div>
<hr />
</div>
<div class="">
<h4><a name="headers">headers</a>
<code>- String[]</code>
</h4>
<div class="detail">
<div class="description">
ID index of nested parent hierarchies for HEADERS accessibility attribute.
</div>
</div>
<div class="default">
Default Value: []
</div>
<hr />
</div>
<div class="">
<h4><a name="keys">keys</a>
<code>- YAHOO.widget.Column[]</code>
</h4>
<div class="detail">
<div class="description">
Array of Columns that map one-to-one to a table column.
</div>
</div>
<div class="default">
Default Value: []
</div>
<hr />
</div>
<div class="">
<h4><a name="tree">tree</a>
<code>- YAHOO.widget.Column[]</code>
</h4>
<div class="detail">
<div class="description">
Top-down tree representation of Column hierarchy.
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section field inheritance">
<h4>Properties inherited from <a href="YAHOO.util.EventProvider.html">YAHOO.util.EventProvider</a>:</h4>
<div class="content">
<code>
<a class="private" href="YAHOO.util.EventProvider.html#__yui_events">__yui_events</a><span class="private">,</span>
<a class="private" href="YAHOO.util.EventProvider.html#__yui_subscribers">__yui_subscribers</a>
</code>
</div>
</div>
<div class="section method details">
<h3 id="methods">Methods</h3>
<div class="content">
<div class="private">
<h4>
<a name="_init">_init</a></h4>
<div class="detail">
<code>
private
void
<strong>_init</strong>
(
aDefinitions
)
</code>
<div class="description">
Initializes ColumnSet instance with data from Column definitions.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>aDefinitions &lt;Object[]&gt;</code>
Array of object literals that define cells in
the THEAD .
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="getColumn">getColumn</a></h4>
<div class="detail">
<code>
YAHOO.widget.Column
<strong>getColumn</strong>
(
column
)
</code>
<div class="description">
Returns Column instance with given key or ColumnSet key index.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>column &lt;String | Number&gt;</code>
Column key or ColumnSet key index.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
YAHOO.widget.Column
</code></dt>
<dd>Column instance.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="getColumnById">getColumnById</a></h4>
<div class="detail">
<code>
YAHOO.widget.Column
<strong>getColumnById</strong>
(
column
)
</code>
<div class="description">
Returns Column instance with given ID.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>column &lt;String&gt;</code>
Column ID.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
YAHOO.widget.Column
</code></dt>
<dd>Column instance.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="getDefinitions">getDefinitions</a></h4>
<div class="detail">
<code>
Object[]
<strong>getDefinitions</strong>
(
)
</code>
<div class="description">
Public accessor to the definitions array.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
Object[]
</code></dt>
<dd>Array of object literal Column definitions.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="getDescendants">getDescendants</a></h4>
<div class="detail">
<code>
Array
<strong>getDescendants</strong>
(
)
</code>
<div class="description">
Public accessor returns array of given Column's desendants (if any), including itself.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
Array
</code></dt>
<dd>Array including the Column itself and all descendants (if any).</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="getId">getId</a></h4>
<div class="detail">
<code>
String
<strong>getId</strong>
(
)
</code>
<div class="description">
Returns unique name of the ColumnSet instance.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
String
</code></dt>
<dd>Unique name of the ColumnSet instance.</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="toString">toString</a></h4>
<div class="detail">
<code>
String
<strong>toString</strong>
(
)
</code>
<div class="description">
ColumnSet instance name, for logging.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
String
</code></dt>
<dd>Unique name of the ColumnSet instance.</dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section field inheritance">
<h4>Methods inherited from <a href="YAHOO.util.EventProvider.html">YAHOO.util.EventProvider</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.util.EventProvider.html#createEvent">createEvent</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#fireEvent">fireEvent</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#hasEvent">hasEvent</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#subscribe">subscribe</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#unsubscribe">unsubscribe</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#unsubscribeAll">unsubscribeAll</a>
</code>
</div>
</div>
</div>
</div>
<div class="yui-b">
<div class="nav">
<div class="module">
<h4>Modules</h4>
<ul class="content">
<li class=""><a href="module_animation.html">animation</a></li>
<li class=""><a href="module_autocomplete.html">autocomplete</a></li>
<li class=""><a href="module_button.html">button</a></li>
<li class=""><a href="module_calendar.html">calendar</a></li>
<li class=""><a href="module_charts.html">charts</a></li>
<li class=""><a href="module_colorpicker.html">colorpicker</a></li>
<li class=""><a href="module_connection.html">connection</a></li>
<li class=""><a href="module_container.html">container</a></li>
<li class=""><a href="module_cookie.html">cookie</a></li>
<li class=""><a href="module_datasource.html">datasource</a></li>
<li class="selected"><a href="module_datatable.html">datatable</a></li>
<li class=""><a href="module_dom.html">dom</a></li>
<li class=""><a href="module_dragdrop.html">dragdrop</a></li>
<li class=""><a href="module_editor.html">editor</a></li>
<li class=""><a href="module_element.html">element</a></li>
<li class=""><a href="module_event.html">event</a></li>
<li class=""><a href="module_get.html">get</a></li>
<li class=""><a href="module_history.html">history</a></li>
<li class=""><a href="module_imagecropper.html">imagecropper</a></li>
<li class=""><a href="module_imageloader.html">imageloader</a></li>
<li class=""><a href="module_json.html">json</a></li>
<li class=""><a href="module_layout.html">layout</a></li>
<li class=""><a href="module_logger.html">logger</a></li>
<li class=""><a href="module_menu.html">menu</a></li>
<li class=""><a href="module_profiler.html">profiler</a></li>
<li class=""><a href="module_profilerviewer.html">profilerviewer</a></li>
<li class=""><a href="module_resize.html">resize</a></li>
<li class=""><a href="module_selector.html">selector</a></li>
<li class=""><a href="module_slider.html">slider</a></li>
<li class=""><a href="module_tabview.html">tabview</a></li>
<li class=""><a href="module_treeview.html">treeview</a></li>
<li class=""><a href="module_uploader.html">uploader</a></li>
<li class=""><a href="module_yahoo.html">yahoo</a></li>
<li class=""><a href="module_yuiloader.html">yuiloader</a></li>
<li class=""><a href="module_yuitest.html">yuitest</a></li>
</ul>
</div>
<div class="module">
<h4>Classes</h4>
<ul class="content">
<li class=""><a href="YAHOO.util.Chain.html">YAHOO.util.Chain</a></li>
<li class=""><a href="YAHOO.util.ColumnDD.html">YAHOO.util.ColumnDD</a></li>
<li class=""><a href="YAHOO.util.ColumnResizer.html">YAHOO.util.ColumnResizer</a></li>
<li class=""><a href="YAHOO.util.Sort.html">YAHOO.util.Sort</a></li>
<li class=""><a href="YAHOO.widget.Column.html">YAHOO.widget.Column</a></li>
<li class="selected"><a href="YAHOO.widget.ColumnSet.html">YAHOO.widget.ColumnSet</a></li>
<li class=""><a href="YAHOO.widget.DataTable.html">YAHOO.widget.DataTable</a></li>
<li class=""><a href="YAHOO.widget.Paginator.html">YAHOO.widget.Paginator</a></li>
<li class=""><a href="YAHOO.widget.Paginator.ui.CurrentPageReport.html">YAHOO.widget.Paginator.ui.CurrentPageReport</a></li>
<li class=""><a href="YAHOO.widget.Paginator.ui.FirstPageLink.html">YAHOO.widget.Paginator.ui.FirstPageLink</a></li>
<li class=""><a href="YAHOO.widget.Paginator.ui.LastPageLink.html">YAHOO.widget.Paginator.ui.LastPageLink</a></li>
<li class=""><a href="YAHOO.widget.Paginator.ui.NextPageLink.html">YAHOO.widget.Paginator.ui.NextPageLink</a></li>
<li class=""><a href="YAHOO.widget.Paginator.ui.PageLinks.html">YAHOO.widget.Paginator.ui.PageLinks</a></li>
<li class=""><a href="YAHOO.widget.Paginator.ui.PreviousPageLink.html">YAHOO.widget.Paginator.ui.PreviousPageLink</a></li>
<li class=""><a href="YAHOO.widget.Paginator.ui.RowsPerPageDropdown.html">YAHOO.widget.Paginator.ui.RowsPerPageDropdown</a></li>
<li class=""><a href="YAHOO.widget.Record.html">YAHOO.widget.Record</a></li>
<li class=""><a href="YAHOO.widget.RecordSet.html">YAHOO.widget.RecordSet</a></li>
</ul>
</div>
<div class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="Chain.js.html">Chain.js</a></li>
<li class=""><a href="ColumnSet.js.html">ColumnSet.js</a></li>
<li class=""><a href="DataTable.js.html">DataTable.js</a></li>
<li class=""><a href="Paginator.js.html">Paginator.js</a></li>
<li class=""><a href="RecordSet.js.html">RecordSet.js</a></li>
</ul>
</div>
<div class="module">
<h4>Properties</h4>
<ul class="content">
<li class="private"><a href="#_aDefinitions">_aDefinitions</a>
<!--<code>&lt;YAHOO.widget.Column[]&gt;</code>-->
</li>
<li class="private"><a href="#_sId">_sId</a>
<!--<code>&lt;YAHOO.widget.Column[]&gt;</code>-->
</li>
<li class="private"><a href="#ColumnSet._nCount">ColumnSet._nCount</a>
<!--<code>&lt;YAHOO.widget.Column[]&gt;</code>-->
</li>
<li class=""><a href="#flat">flat</a>
<!--<code>&lt;YAHOO.widget.Column[]&gt;</code>-->
</li>
<li class=""><a href="#headers">headers</a>
<!--<code>&lt;YAHOO.widget.Column[]&gt;</code>-->
</li>
<li class=""><a href="#keys">keys</a>
<!--<code>&lt;YAHOO.widget.Column[]&gt;</code>-->
</li>
<li class=""><a href="#tree">tree</a>
<!--<code>&lt;YAHOO.widget.Column[]&gt;</code>-->
</li>
</ul>
</div>
<div class="module">
<h4>Methods</h4>
<ul class="content">
<li class="private"><!--<code>void</code>-->
<a href="#_init">_init</a>
</li>
<li class=""><!--<code>YAHOO.widget.Column</code>-->
<a href="#getColumn">getColumn</a>
</li>
<li class=""><!--<code>YAHOO.widget.Column</code>-->
<a href="#getColumnById">getColumnById</a>
</li>
<li class=""><!--<code>Object[]</code>-->
<a href="#getDefinitions">getDefinitions</a>
</li>
<li class=""><!--<code>Array</code>-->
<a href="#getDescendants">getDescendants</a>
</li>
<li class=""><!--<code>String</code>-->
<a href="#getId">getId</a>
</li>
<li class=""><!--<code>String</code>-->
<a href="#toString">toString</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright &copy; 2007 Yahoo! Inc. All rights reserved.
</div>
</div>
</body>
</html>