webgui/www/extras/yui/docs/YAHOO.widget.ButtonGroup.html
JT Smith 20f8df1291 upgrading to YUI 2.6
data tables are going to need some work yet, but the other stuff seems to be working 100%
2008-10-22 23:53:29 +00:00

1896 lines
97 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>API: button YAHOO.widget.ButtonGroup (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>Button&nbsp; <span class="subtitle">2.6.0</span></h3>
<p>
<a href="./index.html">Yahoo! UI Library</a>
&gt; <a href="./module_button.html">button</a>
&gt; YAHOO.widget.ButtonGroup
</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" /> <label for="showprivate">Show Private</label></span>
<span id="classopts"><input type="checkbox" name="showprotected" id="showprotected" /> <label for="showprotected">Show Protected</label></span>
<span id="classopts"><input type="checkbox" name="showdeprecated" id="showdeprecated" /> <label for="showdeprecated">Show Deprecated</label></span>
</form>
<h2>
Class <b>YAHOO.widget.ButtonGroup</b>
<span class="extends">
- extends <a href="YAHOO.util.Element.html">YAHOO.util.Element</a>
</span>
<span class="extends">
</span>
</code>
</h2>
<!-- class tree goes here -->
<div class="summary description">
The ButtonGroup class creates a set of buttons that are mutually
exclusive; checking one button in the set will uncheck all others in the
button group.
</div>
<div class="section constructor details">
<h3 id="constructor">Constructor</h3>
<div class="content">
<div class="detail">
<strong>YAHOO.widget.ButtonGroup</strong>
<code>
(
p_oElement
,
p_oAttributes
)
</code>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_oElement
&lt;String&gt;
</code>
String specifying the id attribute of the
<code>&#60;div&#62;</code> element of the button group.
</dd>
<dd>
<code>p_oElement
&lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-22445964">HTMLDivElement</a>&gt;
</code>
Object
specifying the <code>&#60;div&#62;</code> element of the button group.
</dd>
<dd>
<code>p_oElement
&lt;Object&gt;
</code>
Object literal specifying a set of
configuration attributes used to create the button group.
</dd>
<dd>
<code>p_oAttributes
&lt;Object&gt;
</code>
Optional. Object literal specifying a set
of configuration attributes used to create the button group.
</dd>
</dl>
</div>
</div>
</div>
</div>
<div class="section field details">
<h3 id="properties">Properties</h3>
<div class="content">
<div class="protected">
<h4><a name="property__buttons">_buttons</a>
<code>- protected Array</code>
</h4>
<div class="detail">
<div class="description">
Array of buttons in the button group.
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
</div>
<div class="">
<h4><a name="property_CSS_CLASS_NAME">CSS_CLASS_NAME</a>
<code>- final String</code>
</h4>
<div class="detail">
<div class="description">
String representing the CSS class(es) to be applied
to the button group's element.
</div>
</div>
<div class="default">
Default Value: "yui-buttongroup"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_NODE_NAME">NODE_NAME</a>
<code>- final String</code>
</h4>
<div class="detail">
<div class="description">
The name of the tag to be used for the button
group's element.
</div>
</div>
<div class="default">
Default Value: "DIV"
</div>
<hr />
</div>
</div>
</div>
<div class="section field inheritance">
<h4>Properties inherited from <a href="YAHOO.util.Element.html">YAHOO.util.Element</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.util.Element.html#property_DOM_EVENTS">DOM_EVENTS</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Properties inherited from <a href="YAHOO.util.AttributeProvider.html">YAHOO.util.AttributeProvider</a>:</h4>
<div class="content">
<code>
<a class="private" href="YAHOO.util.AttributeProvider.html#property__configs">_configs</a>
</code>
</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#property___yui_events">__yui_events</a><span class="private">,</span>
<a class="private" href="YAHOO.util.EventProvider.html#property___yui_subscribers">__yui_subscribers</a>
</code>
</div>
</div>
<div class="section method details">
<h3 id="methods">Methods</h3>
<div class="content">
<div class="protected">
<h4>
<a name="method__createGroupElement">_createGroupElement</a></h4>
<div class="detail">
<code>
protected
<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-22445964">HTMLDivElement</a>
<strong>_createGroupElement</strong>
(
)
</code>
<div class="description">
Creates the button group's element.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-22445964">HTMLDivElement</a>
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="protected">
<h4>
<a name="method__onAppendTo">_onAppendTo</a></h4>
<div class="detail">
<code>
protected
void
<strong>_onAppendTo</strong>
(
p_oEvent
)
</code>
<div class="description">
"appendTo" event handler for the button group.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_oEvent &lt;Event&gt;</code>
Object representing the event that was fired.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="protected">
<h4>
<a name="method__onButtonCheckedChange">_onButtonCheckedChange</a></h4>
<div class="detail">
<code>
protected
void
<strong>_onButtonCheckedChange</strong>
(
p_oEvent
,
p_oButton
)
</code>
<div class="description">
"checkedChange" event handler for each button in the
button group.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_oEvent &lt;Event&gt;</code>
Object representing the event that was fired.
</dd>
<dd>
<code>p_oButton &lt;<a href="YAHOO.widget.Button.html">YAHOO.widget.Button</a>&gt;</code>
Object representing the button that fired the event.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="protected">
<h4>
<a name="method__onKeyDown">_onKeyDown</a></h4>
<div class="detail">
<code>
protected
void
<strong>_onKeyDown</strong>
(
p_oEvent
)
</code>
<div class="description">
"keydown" event handler for the button group.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_oEvent &lt;Event&gt;</code>
Object representing the DOM event object
passed back by the event utility (YAHOO.util.Event).
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="protected">
<h4>
<a name="method__setDisabled">_setDisabled</a></h4>
<div class="detail">
<code>
protected
void
<strong>_setDisabled</strong>
(
p_bDisabled
)
</code>
<div class="description">
Sets the value of the button groups's
"disabled" attribute.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_bDisabled &lt;Boolean&gt;</code>
Boolean indicating the value for
the button group's "disabled" attribute.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_addButton">addButton</a></h4>
<div class="detail">
<code>
<a href="YAHOO.widget.Button.html">YAHOO.widget.Button</a>
<strong>addButton</strong>
(
p_oButton
)
</code>
<div class="description">
Adds the button to the button group.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_oButton &lt;<a href="YAHOO.widget.Button.html">YAHOO.widget.Button</a>&gt;</code>
Object reference for the <a href="YAHOO.widget.Button.html">
YAHOO.widget.Button</a> instance to be added to the button group.
</dd>
<dd>
<code>p_oButton &lt;String&gt;</code>
String specifying the id attribute of the
<code>&#60;input&#62;</code> or <code>&#60;span&#62;</code> element
to be used to create the button to be added to the button group.
</dd>
<dd>
<code>p_oButton &lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-6043025">HTMLInputElement</a>|<a href="
http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.html#
ID-33759296">HTMLElement</a>&gt;</code>
Object reference for the
<code>&#60;input&#62;</code> or <code>&#60;span&#62;</code> element
to be used to create the button to be added to the button group.
</dd>
<dd>
<code>p_oButton &lt;Object&gt;</code>
Object literal specifying a set of
<a href="YAHOO.widget.Button.html">YAHOO.widget.Button</a>
configuration attributes used to configure the button to be added to
the button group.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
<a href="YAHOO.widget.Button.html">YAHOO.widget.Button</a>
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_addButtons">addButtons</a></h4>
<div class="detail">
<code>
Array
<strong>addButtons</strong>
(
p_aButtons
)
</code>
<div class="description">
Adds the array of buttons to the button group.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_aButtons &lt;Array&gt;</code>
Array of <a href="YAHOO.widget.Button.html">
YAHOO.widget.Button</a> instances to be added
to the button group.
</dd>
<dd>
<code>p_aButtons &lt;Array&gt;</code>
Array of strings specifying the id
attribute of the <code>&#60;input&#62;</code> or <code>&#60;span&#62;
</code> elements to be used to create the buttons to be added to the
button group.
</dd>
<dd>
<code>p_aButtons &lt;Array&gt;</code>
Array of object references for the
<code>&#60;input&#62;</code> or <code>&#60;span&#62;</code> elements
to be used to create the buttons to be added to the button group.
</dd>
<dd>
<code>p_aButtons &lt;Array&gt;</code>
Array of object literals, each containing
a set of <a href="YAHOO.widget.Button.html">YAHOO.widget.Button</a>
configuration attributes used to configure each button to be added
to the button group.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Array
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_check">check</a></h4>
<div class="detail">
<code>
void
<strong>check</strong>
(
p_nIndex
)
</code>
<div class="description">
Checks the button at the specified index.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_nIndex &lt;Number&gt;</code>
Number indicating the index of the button
to check.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_destroy">destroy</a></h4>
<div class="detail">
<code>
void
<strong>destroy</strong>
(
)
</code>
<div class="description">
Removes the button group's element from its parent
element and removes all event handlers.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_focus">focus</a></h4>
<div class="detail">
<code>
void
<strong>focus</strong>
(
p_nIndex
)
</code>
<div class="description">
Sets focus to the button at the specified index.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_nIndex &lt;Number&gt;</code>
Number indicating the index of the button
to focus.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getButton">getButton</a></h4>
<div class="detail">
<code>
<a href="YAHOO.widget.Button.html">YAHOO.widget.Button</a>
<strong>getButton</strong>
(
p_nIndex
)
</code>
<div class="description">
Returns the button at the specified index.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_nIndex &lt;Number&gt;</code>
The index of the button to retrieve from the
button group.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
<a href="YAHOO.widget.Button.html">YAHOO.widget.Button</a>
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getButtons">getButtons</a></h4>
<div class="detail">
<code>
Array
<strong>getButtons</strong>
(
)
</code>
<div class="description">
Returns an array of the buttons in the button group.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
Array
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getCount">getCount</a></h4>
<div class="detail">
<code>
Number
<strong>getCount</strong>
(
)
</code>
<div class="description">
Returns the number of buttons in the button group.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
Number
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_init">init</a></h4>
<div class="detail">
<code>
void
<strong>init</strong>
(
p_oElement
,
p_oAttributes
)
</code>
<div class="description">
The ButtonGroup class's initialization method.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_oElement &lt;String&gt;</code>
String specifying the id attribute of the
<code>&#60;div&#62;</code> element of the button group.
</dd>
<dd>
<code>p_oElement &lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-22445964">HTMLDivElement</a>&gt;</code>
Object
specifying the <code>&#60;div&#62;</code> element of the button group.
</dd>
<dd>
<code>p_oElement &lt;Object&gt;</code>
Object literal specifying a set of
configuration attributes used to create the button group.
</dd>
<dd>
<code>p_oAttributes &lt;Object&gt;</code>
Optional. Object literal specifying a
set of configuration attributes used to create the button group.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_initAttributes">initAttributes</a></h4>
<div class="detail">
<code>
void
<strong>initAttributes</strong>
(
p_oAttributes
)
</code>
<div class="description">
Initializes all of the configuration attributes used to
create the button group.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_oAttributes &lt;Object&gt;</code>
Object literal specifying a set of
configuration attributes used to create the button group.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_removeButton">removeButton</a></h4>
<div class="detail">
<code>
void
<strong>removeButton</strong>
(
p_nIndex
)
</code>
<div class="description">
Removes the button at the specified index from the
button group.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_nIndex &lt;Number&gt;</code>
Number specifying the index of the button
to be removed from the button group.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_toString">toString</a></h4>
<div class="detail">
<code>
String
<strong>toString</strong>
(
)
</code>
<div class="description">
Returns a string representing the button group.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
String
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section field inheritance">
<h4>Methods inherited from <a href="YAHOO.util.Element.html">YAHOO.util.Element</a>:</h4>
<div class="content">
<code>
<a class="private" href="YAHOO.util.Element.html#method__registerHTMLAttr">_registerHTMLAttr</a><span class="private">,</span> <a class="" href="YAHOO.util.Element.html#method_addClass">addClass</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_addListener">addListener</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_appendChild">appendChild</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_appendTo">appendTo</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_fireQueue">fireQueue</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_getElementsByClassName">getElementsByClassName</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_getElementsByTagName">getElementsByTagName</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_getStyle">getStyle</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_hasChildNodes">hasChildNodes</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_hasClass">hasClass</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_initAttributes">initAttributes</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_insertBefore">insertBefore</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_on">on</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_removeChild">removeChild</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_removeClass">removeClass</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_removeListener">removeListener</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_replaceChild">replaceChild</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_replaceClass">replaceClass</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_setStyle">setStyle</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_subscribe">subscribe</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Methods inherited from <a href="YAHOO.util.AttributeProvider.html">YAHOO.util.AttributeProvider</a>:</h4>
<div class="content">
<code>
<a class=" deprecated" href="YAHOO.util.AttributeProvider.html#method_configureAttribute">configureAttribute</a><span class=" deprecated">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_fireBeforeChangeEvent">fireBeforeChangeEvent</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_fireChangeEvent">fireChangeEvent</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_get">get</a><span class="">,</span> <a class="private" href="YAHOO.util.AttributeProvider.html#method_getAttributeConfig">getAttributeConfig</a><span class="private">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_getAttributeKeys">getAttributeKeys</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_refresh">refresh</a><span class="">,</span> <a class=" deprecated" href="YAHOO.util.AttributeProvider.html#method_register">register</a><span class=" deprecated">,</span> <a class="private" href="YAHOO.util.AttributeProvider.html#method_resetAttributeConfig">resetAttributeConfig</a><span class="private">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_resetValue">resetValue</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_set">set</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_setAttributeConfig">setAttributeConfig</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_setAttributes">setAttributes</a>
</code>
</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#method_createEvent">createEvent</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_fireEvent">fireEvent</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_hasEvent">hasEvent</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_subscribe">subscribe</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_unsubscribe">unsubscribe</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_unsubscribeAll">unsubscribeAll</a>
</code>
</div>
</div>
<div class="section method details">
<h3 id="events">Events</h3>
<div class="content">
<div class="">
<h4>
<a name="event_beforeCheckedButtonChange">beforeCheckedButtonChange</a></h4>
<div class="detail">
<code>
<strong>beforeCheckedButtonChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'checkedButton' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeContainerChange">beforeContainerChange</a></h4>
<div class="detail">
<code>
<strong>beforeContainerChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'container' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeDisabledChange">beforeDisabledChange</a></h4>
<div class="detail">
<code>
<strong>beforeDisabledChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'disabled' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeNameChange">beforeNameChange</a></h4>
<div class="detail">
<code>
<strong>beforeNameChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'name' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_beforeValueChange">beforeValueChange</a></h4>
<div class="detail">
<code>
<strong>beforeValueChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'value' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_checkedButtonChange">checkedButtonChange</a></h4>
<div class="detail">
<code>
<strong>checkedButtonChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'checkedButton' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_containerChange">containerChange</a></h4>
<div class="detail">
<code>
<strong>containerChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'container' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_disabledChange">disabledChange</a></h4>
<div class="detail">
<code>
<strong>disabledChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'disabled' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_nameChange">nameChange</a></h4>
<div class="detail">
<code>
<strong>nameChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'name' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_valueChange">valueChange</a></h4>
<div class="detail">
<code>
<strong>valueChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'value' changes.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>event &lt;{oldValue: any, newValue: any}&gt;</code>
An object containing the previous attribute value and the new value.
</dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section field inheritance">
<h4>Events inherited from <a href="YAHOO.util.Element.html">YAHOO.util.Element</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.util.Element.html#event_appendTo">appendTo</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#event_available">available</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#event_beforeAppendTo">beforeAppendTo</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#event_beforeElementChange">beforeElementChange</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#event_contentReady">contentReady</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#event_elementChange">elementChange</a><span class="">,</span>
</code>
</div>
</div>
<div class="section field details">
<h3 id="configattributes">Configuration Attributes</h3>
<div class="content">
<div class="">
<h4><a name="config_checkedButton">checkedButton</a>
<code>- {<a href="YAHOO.widget.Button.html">YAHOO.widget.Button</a>}</code>
</h4>
<div class="detail">
<div class="description">
Reference for the button in the button group that
is checked.
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
</div>
<div class="">
<h4><a name="config_container">container</a>
<code>- <a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-58190037">HTMLElement</a>|String</code>
</h4>
<div class="detail">
<div class="description">
HTML element reference or string specifying the id
attribute of the HTML element that the button group's markup
should be rendered into.
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
</div>
<div class="">
<h4><a name="config_disabled">disabled</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
Boolean indicating if the button group should be
disabled. Disabling the button group will disable each button
in the button group. Disabled buttons are dimmed and will not
respond to user input or fire events.
</div>
</div>
<div class="default">
Default Value: false
</div>
<hr />
</div>
<div class="">
<h4><a name="config_name">name</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
String specifying the name for the button group.
This name will be applied to each button in the button group.
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
</div>
<div class="">
<h4><a name="config_value">value</a>
<code>- Object</code>
</h4>
<div class="detail">
<div class="description">
Object specifying the value for the button group.
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
</div>
</div>
</div>
<div class="section field inheritance">
<h4>Configuration attributes inherited from <a href="YAHOO.util.Element.html">YAHOO.util.Element</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.util.Element.html#config_element">element</a><span class="">,</span>
</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="selected"><a href="module_button.html">button</a></li>
<li class=""><a href="module_calendar.html">calendar</a></li>
<li class=""><a href="module_carousel.html">carousel</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=""><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_paginator.html">paginator</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.widget.Button.html">YAHOO.widget.Button</a></li>
<li class="selected"><a href="YAHOO.widget.ButtonGroup.html">YAHOO.widget.ButtonGroup</a></li>
</ul>
</div>
<div class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="button.js.html">button.js</a></li>
<li class=""><a href="buttongroup.js.html">buttongroup.js</a></li>
</ul>
</div>
<div class="module">
<h4>Properties</h4>
<ul class="content">
<li class="protected"><a href="#property__buttons">_buttons</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_CSS_CLASS_NAME">CSS_CLASS_NAME</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_NODE_NAME">NODE_NAME</a>
<!--<code>&lt;String&gt;</code>-->
</li>
</ul>
</div>
<div class="module">
<h4>Methods</h4>
<ul class="content">
<li class="protected"><!--<code><a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-22445964">HTMLDivElement</a></code>-->
<a href="#method__createGroupElement">_createGroupElement</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__onAppendTo">_onAppendTo</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__onButtonCheckedChange">_onButtonCheckedChange</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__onKeyDown">_onKeyDown</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__setDisabled">_setDisabled</a>
</li>
<li class=""><!--<code><a href="YAHOO.widget.Button.html">YAHOO.widget.Button</a></code>-->
<a href="#method_addButton">addButton</a>
</li>
<li class=""><!--<code>Array</code>-->
<a href="#method_addButtons">addButtons</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_check">check</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_destroy">destroy</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_focus">focus</a>
</li>
<li class=""><!--<code><a href="YAHOO.widget.Button.html">YAHOO.widget.Button</a></code>-->
<a href="#method_getButton">getButton</a>
</li>
<li class=""><!--<code>Array</code>-->
<a href="#method_getButtons">getButtons</a>
</li>
<li class=""><!--<code>Number</code>-->
<a href="#method_getCount">getCount</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_init">init</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_initAttributes">initAttributes</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_removeButton">removeButton</a>
</li>
<li class=""><!--<code>String</code>-->
<a href="#method_toString">toString</a>
</li>
</ul>
</div>
<div class="module">
<h4>Events</h4>
<ul class="content">
<li class="">
<a href="#event_beforeCheckedButtonChange">beforeCheckedButtonChange</a>
</li>
<li class="">
<a href="#event_beforeContainerChange">beforeContainerChange</a>
</li>
<li class="">
<a href="#event_beforeDisabledChange">beforeDisabledChange</a>
</li>
<li class="">
<a href="#event_beforeNameChange">beforeNameChange</a>
</li>
<li class="">
<a href="#event_beforeValueChange">beforeValueChange</a>
</li>
<li class="">
<a href="#event_checkedButtonChange">checkedButtonChange</a>
</li>
<li class="">
<a href="#event_containerChange">containerChange</a>
</li>
<li class="">
<a href="#event_disabledChange">disabledChange</a>
</li>
<li class="">
<a href="#event_nameChange">nameChange</a>
</li>
<li class="">
<a href="#event_valueChange">valueChange</a>
</li>
</ul>
</div>
<div class="module">
<h4>Configuration Attributes</h4>
<ul class="content">
<li class="">
<a href="#config_checkedButton">checkedButton</a>
</li>
<li class="">
<a href="#config_container">container</a>
</li>
<li class="">
<a href="#config_disabled">disabled</a>
</li>
<li class="">
<a href="#config_name">name</a>
</li>
<li class="">
<a href="#config_value">value</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright &copy; 2008 Yahoo! Inc. All rights reserved.
</div>
</div>
</body>
</html>