oqapi/webgui
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
webgui/www/extras/yui/docs/YAHOO.widget.Button.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

6777 lines
333 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>API: button YAHOO.widget.Button (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.Button
</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.Button</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 Button class creates a rich, graphical button.
</div>
<div class="section constructor details">
<h3 id="constructor">Constructor</h3>
<div class="content">
<div class="detail">
<strong>YAHOO.widget.Button</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;input&#62;</code>, <code>&#60;button&#62;</code>,
<code>&#60;a&#62;</code>, or <code>&#60;span&#62;</code> element to
be used to create the button.
</dd>
<dd>
<code>p_oElement
&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-34812697">
HTMLButtonElement</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>, <code>&#60;button&#62;</code>,
<code>&#60;a&#62;</code>, or <code>&#60;span&#62;</code> element to be
used to create the button.
</dd>
<dd>
<code>p_oElement
&lt;Object&gt;
</code>
Object literal specifying a set of
configuration attributes used to create the button.
</dd>
<dd>
<code>p_oAttributes
&lt;Object&gt;
</code>
Optional. Object literal specifying a set
of configuration attributes used to create the button.
</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__activationButtonPressed">_activationButtonPressed</a>
<code>- protected Boolean</code>
</h4>
<div class="detail">
<div class="description">
Boolean indicating if the mouse button that toggles
the button's "active" state has been pressed.
</div>
</div>
<div class="default">
Default Value: false
</div>
<hr />
</div>
<div class="protected">
<h4><a name="property__activationKeyPressed">_activationKeyPressed</a>
<code>- protected Boolean</code>
</h4>
<div class="detail">
<div class="description">
Boolean indicating if the key(s) that toggle the button's
"active" state have been pressed.
</div>
</div>
<div class="default">
Default Value: false
</div>
<hr />
</div>
<div class="protected">
<h4><a name="property__button">_button</a>
<code>- protected <a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-48250443">HTMLAnchorElement</a>|<a href="
http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.html
#ID-34812697">HTMLButtonElement</a></code>
</h4>
<div class="detail">
<div class="description">
Object reference to the button's internal
<code>&#60;a&#62;</code> or <code>&#60;button&#62;</code> element.
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
</div>
<div class="protected">
<h4><a name="property__hasKeyEventHandlers">_hasKeyEventHandlers</a>
<code>- protected Boolean</code>
</h4>
<div class="detail">
<div class="description">
Boolean indicating if the button's "blur", "keydown" and
"keyup" event handlers are assigned
</div>
</div>
<div class="default">
Default Value: false
</div>
<hr />
</div>
<div class="protected">
<h4><a name="property__hasMouseEventHandlers">_hasMouseEventHandlers</a>
<code>- protected Boolean</code>
</h4>
<div class="detail">
<div class="description">
Boolean indicating if the button's "mouseout,"
"mousedown," and "mouseup" event handlers are assigned
</div>
</div>
<div class="default">
Default Value: false
</div>
<hr />
</div>
<div class="protected">
<h4><a name="property__hiddenFields">_hiddenFields</a>
<code>- protected <a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-6043025">HTMLInputElement</a>|Array</code>
</h4>
<div class="detail">
<div class="description">
Object reference to the <code>&#60;input&#62;</code>
element, or array of HTML form elements used to represent the button
when its parent form is submitted.
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
</div>
<div class="protected">
<h4><a name="property__menu">_menu</a>
<code>- protected {<a href="YAHOO.widget.Overlay.html">YAHOO.widget.Overlay</a>|
<a href="YAHOO.widget.Menu.html">YAHOO.widget.Menu</a>}</code>
</h4>
<div class="detail">
<div class="description">
Object reference to the button's menu.
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
</div>
<div class="protected">
<h4><a name="property__nOptionRegionX">_nOptionRegionX</a>
<code>- protected Number</code>
</h4>
<div class="detail">
<div class="description">
Number representing the X coordinate of the leftmost edge of the Button's
option region. Applies only to Buttons of type "split".
</div>
</div>
<div class="default">
Default Value: 0
</div>
<hr />
</div>
<div class="protected">
<h4><a name="property__onclickAttributeValue">_onclickAttributeValue</a>
<code>- protected Object</code>
</h4>
<div class="detail">
<div class="description">
Object reference to the button's current value for the
"onclick" configuration attribute.
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
</div>
<div class="">
<h4><a name="property_ACTIVATION_KEYS">ACTIVATION_KEYS</a>
<code>- final Array</code>
</h4>
<div class="detail">
<div class="description">
Array of numbers representing keys that (when presed)
toggle the button's "active" state.
</div>
</div>
<div class="default">
Default Value: [13, 32]
</div>
<hr />
</div>
<div class="">
<h4><a name="property_CHECK_ACTIVATION_KEYS">CHECK_ACTIVATION_KEYS</a>
<code>- final Array</code>
</h4>
<div class="detail">
<div class="description">
Array of numbers representing keys that (when pressed)
toggle the button's "checked" attribute.
</div>
</div>
<div class="default">
Default Value: [32]
</div>
<hr />
</div>
<div class="">
<h4><a name="property_CHECKBOX_CHECKED_TITLE">CHECKBOX_CHECKED_TITLE</a>
<code>- final String</code>
</h4>
<div class="detail">
<div class="description">
String representing the title applied to buttons of type
"checkbox" when checked.
</div>
</div>
<div class="default">
Default Value: "Checked. Click to uncheck."
</div>
<hr />
</div>
<div class="">
<h4><a name="property_CHECKBOX_DEFAULT_TITLE">CHECKBOX_DEFAULT_TITLE</a>
<code>- final String</code>
</h4>
<div class="detail">
<div class="description">
String representing the default title applied to
buttons of type "checkbox."
</div>
</div>
<div class="default">
Default Value: "Unchecked. Click to check."
</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's root element.
</div>
</div>
<div class="default">
Default Value: "yui-button"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_MENUBUTTON_DEFAULT_TITLE">MENUBUTTON_DEFAULT_TITLE</a>
<code>- final String</code>
</h4>
<div class="detail">
<div class="description">
String representing the default title applied to
buttons of type "menu."
</div>
</div>
<div class="default">
Default Value: "Menu collapsed. Click to expand."
</div>
<hr />
</div>
<div class="">
<h4><a name="property_MENUBUTTON_MENU_VISIBLE_TITLE">MENUBUTTON_MENU_VISIBLE_TITLE</a>
<code>- final String</code>
</h4>
<div class="detail">
<div class="description">
String representing the title applied to buttons of type
"menu" when the button's menu is visible.
</div>
</div>
<div class="default">
Default Value: "Menu expanded. Click or press Esc to collapse."
</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 node to be used for the button's
root element.
</div>
</div>
<div class="default">
Default Value: "SPAN"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_OPTION_AREA_WIDTH">OPTION_AREA_WIDTH</a>
<code>- final Number</code>
</h4>
<div class="detail">
<div class="description">
Width (in pixels) of the area of a split button that
when pressed will display a menu.
</div>
</div>
<div class="default">
Default Value: 20
</div>
<hr />
</div>
<div class="">
<h4><a name="property_RADIO_CHECKED_TITLE">RADIO_CHECKED_TITLE</a>
<code>- final String</code>
</h4>
<div class="detail">
<div class="description">
String representing the title applied to buttons of
type "radio" when checked.
</div>
</div>
<div class="default">
Default Value: "Checked. Click another button to uncheck"
</div>
<hr />
</div>
<div class="">
<h4><a name="property_RADIO_DEFAULT_TITLE">RADIO_DEFAULT_TITLE</a>
<code>- final String</code>
</h4>
<div class="detail">
<div class="description">
String representing the default title applied to buttons
of type "radio."
</div>
</div>
<div class="default">
Default Value: "Unchecked. Click to check."
</div>
<hr />
</div>
<div class="">
<h4><a name="property_SPLITBUTTON_DEFAULT_TITLE">SPLITBUTTON_DEFAULT_TITLE</a>
<code>- final String</code>
</h4>
<div class="detail">
<div class="description">
String representing the default title applied to
buttons of type "split."
</div>
</div>
<div class="default">
Default Value: "Menu collapsed. Click inside option region or press
Ctrl + Shift + M to show the menu."
</div>
<hr />
</div>
<div class="">
<h4><a name="property_SPLITBUTTON_OPTION_VISIBLE_TITLE">SPLITBUTTON_OPTION_VISIBLE_TITLE</a>
<code>- final String</code>
</h4>
<div class="detail">
<div class="description">
String representing the title applied to buttons of type
"split" when the button's menu is visible.
</div>
</div>
<div class="default">
Default Value: "Menu expanded. Press Esc or Ctrl + Shift + M to hide
the menu."
</div>
<hr />
</div>
<div class="">
<h4><a name="property_SUBMIT_TITLE">SUBMIT_TITLE</a>
<code>- final String</code>
</h4>
<div class="detail">
<div class="description">
String representing the title applied to buttons of
type "submit."
</div>
</div>
<div class="default">
Default Value: "Click to submit form."
</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__addListenersToForm">_addListenersToForm</a></h4>
<div class="detail">
<code>
protected
void
<strong>_addListenersToForm</strong>
(
)
</code>
<div class="description">
Adds event handlers to the button's form.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="protected">
<h4>
<a name="method__hideMenu">_hideMenu</a></h4>
<div class="detail">
<code>
protected
void
<strong>_hideMenu</strong>
(
)
</code>
<div class="description">
Hides the button's menu.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="protected">
<h4>
<a name="method__isActivationKey">_isActivationKey</a></h4>
<div class="detail">
<code>
protected
Boolean
<strong>_isActivationKey</strong>
(
p_nKeyCode
)
</code>
<div class="description">
Determines if the specified keycode is one that toggles
the button's "active" state.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_nKeyCode &lt;Number&gt;</code>
Number representing the keycode to
be evaluated.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Boolean
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="protected">
<h4>
<a name="method__isSplitButtonOptionKey">_isSplitButtonOptionKey</a></h4>
<div class="detail">
<code>
protected
Boolean
<strong>_isSplitButtonOptionKey</strong>
(
p_oEvent
)
</code>
<div class="description">
Determines if the specified keycode is one that toggles
the display of the split button's menu.
</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>
Boolean
</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.
</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__onBlur">_onBlur</a></h4>
<div class="detail">
<code>
protected
void
<strong>_onBlur</strong>
(
p_oEvent
)
</code>
<div class="description">
"blur" event handler for the button.
</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__onClick">_onClick</a></h4>
<div class="detail">
<code>
protected
void
<strong>_onClick</strong>
(
p_oEvent
)
</code>
<div class="description">
"click" event handler for the button.
</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__onDblClick">_onDblClick</a></h4>
<div class="detail">
<code>
protected
void
<strong>_onDblClick</strong>
(
p_oEvent
)
</code>
<div class="description">
"dblclick" event handler for the button.
</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__onDocumentKeyUp">_onDocumentKeyUp</a></h4>
<div class="detail">
<code>
protected
void
<strong>_onDocumentKeyUp</strong>
(
p_oEvent
)
</code>
<div class="description">
"keyup" event handler for the document.
</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__onDocumentMouseDown">_onDocumentMouseDown</a></h4>
<div class="detail">
<code>
protected
void
<strong>_onDocumentMouseDown</strong>
(
p_oEvent
)
</code>
<div class="description">
"mousedown" event handler for the document.
</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__onDocumentMouseUp">_onDocumentMouseUp</a></h4>
<div class="detail">
<code>
protected
void
<strong>_onDocumentMouseUp</strong>
(
p_oEvent
)
</code>
<div class="description">
"mouseup" event handler for the button.
</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__onFocus">_onFocus</a></h4>
<div class="detail">
<code>
protected
void
<strong>_onFocus</strong>
(
p_oEvent
)
</code>
<div class="description">
"focus" event handler for the button.
</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__onFormReset">_onFormReset</a></h4>
<div class="detail">
<code>
protected
void
<strong>_onFormReset</strong>
(
p_oEvent
)
</code>
<div class="description">
"reset" event handler for the button's form.
</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__onFormSubmit">_onFormSubmit</a></h4>
<div class="detail">
<code>
protected
void
<strong>_onFormSubmit</strong>
(
p_oEvent
)
</code>
<div class="description">
"submit" event handler for the button's form.
</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__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.
</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__onKeyUp">_onKeyUp</a></h4>
<div class="detail">
<code>
protected
void
<strong>_onKeyUp</strong>
(
p_oEvent
)
</code>
<div class="description">
"keyup" event handler for the button.
</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="private">
<h4>
<a name="method__onMenuClick">_onMenuClick</a></h4>
<div class="detail">
<code>
private
void
<strong>_onMenuClick</strong>
(
p_sType
,
p_aArgs
)
</code>
<div class="description">
"click" event handler for the button's menu.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String representing the name of the event
that was fired.
</dd>
<dd>
<code>p_aArgs &lt;Array&gt;</code>
Array of arguments sent when the event
was fired.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onMenuHide">_onMenuHide</a></h4>
<div class="detail">
<code>
private
void
<strong>_onMenuHide</strong>
(
p_sType
)
</code>
<div class="description">
"hide" event handler for the button's menu.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String representing the name of the event
that was fired.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onMenuItemAdded">_onMenuItemAdded</a></h4>
<div class="detail">
<code>
private
void
<strong>_onMenuItemAdded</strong>
(
p_sType
,
p_aArgs
,
p_oItem
)
</code>
<div class="description">
"itemadded" event handler for the button's menu.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String representing the name of the event
that was fired.
</dd>
<dd>
<code>p_aArgs &lt;Array&gt;</code>
Array of arguments sent when the event
was fired.
</dd>
<dd>
<code>p_oItem &lt;<a href="YAHOO.widget.MenuItem.html">
YAHOO.widget.MenuItem</a>&gt;</code>
Object representing the menu
item that subscribed to the event.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onMenuItemSelected">_onMenuItemSelected</a></h4>
<div class="detail">
<code>
private
void
<strong>_onMenuItemSelected</strong>
(
p_sType
,
p_aArgs
,
p_oItem
)
</code>
<div class="description">
"selectedchange" event handler for each item in the
button's menu.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String representing the name of the event
that was fired.
</dd>
<dd>
<code>p_aArgs &lt;Array&gt;</code>
Array of arguments sent when the event
was fired.
</dd>
<dd>
<code>p_oItem &lt;MenuItem&gt;</code>
Object representing the menu item that
subscribed to the event.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onMenuKeyDown">_onMenuKeyDown</a></h4>
<div class="detail">
<code>
private
void
<strong>_onMenuKeyDown</strong>
(
p_sType
,
p_aArgs
)
</code>
<div class="description">
"keydown" event handler for the button's menu.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String representing the name of the event
that was fired.
</dd>
<dd>
<code>p_aArgs &lt;Array&gt;</code>
Array of arguments sent when the event
was fired.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onMenuRender">_onMenuRender</a></h4>
<div class="detail">
<code>
private
void
<strong>_onMenuRender</strong>
(
p_sType
)
</code>
<div class="description">
"render" event handler for the button's menu.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String representing the name of the
event thatwas fired.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method__onMenuShow">_onMenuShow</a></h4>
<div class="detail">
<code>
private
void
<strong>_onMenuShow</strong>
(
p_sType
)
</code>
<div class="description">
"show" event handler for the button's menu.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String representing the name of 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__onMouseDown">_onMouseDown</a></h4>
<div class="detail">
<code>
protected
void
<strong>_onMouseDown</strong>
(
p_oEvent
)
</code>
<div class="description">
"mousedown" event handler for the button.
</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__onMouseMove">_onMouseMove</a></h4>
<div class="detail">
<code>
protected
void
<strong>_onMouseMove</strong>
(
p_oEvent
)
</code>
<div class="description">
"mousemove" event handler for the button.
</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__onMouseOut">_onMouseOut</a></h4>
<div class="detail">
<code>
protected
void
<strong>_onMouseOut</strong>
(
p_oEvent
)
</code>
<div class="description">
"mouseout" event handler for the button.
</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__onMouseOver">_onMouseOver</a></h4>
<div class="detail">
<code>
protected
void
<strong>_onMouseOver</strong>
(
p_oEvent
)
</code>
<div class="description">
"mouseover" event handler for the button.
</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__onMouseUp">_onMouseUp</a></h4>
<div class="detail">
<code>
protected
void
<strong>_onMouseUp</strong>
(
p_oEvent
)
</code>
<div class="description">
"mouseup" event handler for the button.
</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__onOption">_onOption</a></h4>
<div class="detail">
<code>
protected
void
<strong>_onOption</strong>
(
p_oEvent
)
</code>
<div class="description">
"option" event handler for the button.
</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__setChecked">_setChecked</a></h4>
<div class="detail">
<code>
protected
void
<strong>_setChecked</strong>
(
p_bChecked
)
</code>
<div class="description">
Sets the value of the button's "target" attribute.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_bChecked &lt;Boolean&gt;</code>
Boolean indicating the value for
the button's "checked" attribute.
</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'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's "disabled" attribute.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="protected">
<h4>
<a name="method__setHref">_setHref</a></h4>
<div class="detail">
<code>
protected
void
<strong>_setHref</strong>
(
p_sHref
)
</code>
<div class="description">
Sets the value of the button's "href" attribute.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sHref &lt;String&gt;</code>
String indicating the value for the button's
"href" attribute.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="protected">
<h4>
<a name="method__setLabel">_setLabel</a></h4>
<div class="detail">
<code>
protected
void
<strong>_setLabel</strong>
(
p_sLabel
)
</code>
<div class="description">
Sets the value of the button's "label" attribute.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sLabel &lt;String&gt;</code>
String indicating the value for the button's
"label" attribute.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="protected">
<h4>
<a name="method__setMenu">_setMenu</a></h4>
<div class="detail">
<code>
protected
void
<strong>_setMenu</strong>
(
p_oMenu
)
</code>
<div class="description">
Sets the value of the button's "menu" attribute.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_oMenu &lt;Object&gt;</code>
Object indicating the value for the button's
"menu" attribute.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="protected">
<h4>
<a name="method__setOnClick">_setOnClick</a></h4>
<div class="detail">
<code>
protected
void
<strong>_setOnClick</strong>
(
p_oObject
)
</code>
<div class="description">
Sets the value of the button's "onclick" attribute.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_oObject &lt;Object&gt;</code>
Object indicating the value for the button's
"onclick" attribute.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="protected">
<h4>
<a name="method__setSelectedMenuItem">_setSelectedMenuItem</a></h4>
<div class="detail">
<code>
protected
void
<strong>_setSelectedMenuItem</strong>
(
p_nIndex
)
</code>
<div class="description">
Sets the value of the button's
"selectedMenuItem" attribute.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_nIndex &lt;Number&gt;</code>
Number representing the index of the item
in the button's menu that is currently selected.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="protected">
<h4>
<a name="method__setTabIndex">_setTabIndex</a></h4>
<div class="detail">
<code>
protected
void
<strong>_setTabIndex</strong>
(
p_nTabIndex
)
</code>
<div class="description">
Sets the value of the button's "tabindex" attribute.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_nTabIndex &lt;Number&gt;</code>
Number indicating the value for the
button's "tabindex" attribute.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="protected">
<h4>
<a name="method__setTarget">_setTarget</a></h4>
<div class="detail">
<code>
protected
void
<strong>_setTarget</strong>
(
p_sTarget
)
</code>
<div class="description">
Sets the value of the button's "target" attribute.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sTarget &lt;String&gt;</code>
String indicating the value for the button's
"target" attribute.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="protected">
<h4>
<a name="method__setTitle">_setTitle</a></h4>
<div class="detail">
<code>
protected
void
<strong>_setTitle</strong>
(
p_nTabIndex
)
</code>
<div class="description">
Sets the value of the button's "title" attribute.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_nTabIndex &lt;String&gt;</code>
Number indicating the value for
the button's "title" attribute.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="protected">
<h4>
<a name="method__setType">_setType</a></h4>
<div class="detail">
<code>
protected
void
<strong>_setType</strong>
(
p_sType
)
</code>
<div class="description">
Sets the value of the button's "type" attribute.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String indicating the value for the button's
"type" attribute.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="protected">
<h4>
<a name="method__showMenu">_showMenu</a></h4>
<div class="detail">
<code>
protected
void
<strong>_showMenu</strong>
(
p_oEvent
)
</code>
<div class="description">
Shows the button's menu.
</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) that triggered
the display of the menu.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_addStateCSSClasses">addStateCSSClasses</a></h4>
<div class="detail">
<code>
void
<strong>addStateCSSClasses</strong>
(
)
</code>
<div class="description">
Appends state-specific CSS classes to the button's root
DOM element.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_blur">blur</a></h4>
<div class="detail">
<code>
void
<strong>blur</strong>
(
)
</code>
<div class="description">
Causes the button to lose focus and fires the button's
"blur" event.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_createButtonElement">createButtonElement</a></h4>
<div class="detail">
<code>
<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-58190037">HTMLElement</a>
<strong>createButtonElement</strong>
(
p_sType
)
</code>
<div class="description">
Creates the button's HTML elements.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String indicating the type of element
to create.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-58190037">HTMLElement</a>
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_createHiddenFields">createHiddenFields</a></h4>
<div class="detail">
<code>
<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-6043025">HTMLInputElement</a>|Array
<strong>createHiddenFields</strong>
(
)
</code>
<div class="description">
Creates the button's hidden form field and appends it
to its parent form.
</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-6043025">HTMLInputElement</a>|Array
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_createInputElement">createInputElement</a></h4>
<div class="detail">
<code>
private
<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
one-html.html#ID-6043025">HTMLInputElement</a>
<strong>createInputElement</strong>
(
p_sType
,
p_sName
,
p_sValue
,
p_bChecked
)
</code>
<div class="description">
Creates an <code>&#60;input&#62;</code> element of the
specified type.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String specifying the type of
<code>&#60;input&#62;</code> element to create.
</dd>
<dd>
<code>p_sName &lt;String&gt;</code>
String specifying the name of
<code>&#60;input&#62;</code> element to create.
</dd>
<dd>
<code>p_sValue &lt;String&gt;</code>
String specifying the value of
<code>&#60;input&#62;</code> element to create.
</dd>
<dd>
<code>p_bChecked &lt;String&gt;</code>
Boolean specifying if the
<code>&#60;input&#62;</code> element is to be checked.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
one-html.html#ID-6043025">HTMLInputElement</a>
</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'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>
(
)
</code>
<div class="description">
Causes the button to receive the focus and fires the
button's "focus" event.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getForm">getForm</a></h4>
<div class="detail">
<code>
<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-
20000929/level-one-html.html#ID-40002357">HTMLFormElement</a>
<strong>getForm</strong>
(
)
</code>
<div class="description">
Returns a reference to the button's parent form.
</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-40002357">HTMLFormElement</a>
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getHiddenFields">getHiddenFields</a></h4>
<div class="detail">
<code>
<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-6043025">HTMLInputElement</a>|Array
<strong>getHiddenFields</strong>
(
)
</code>
<div class="description">
Returns an <code>&#60;input&#62;</code> element or
array of form elements used to represent the button when its parent
form is submitted.
</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-6043025">HTMLInputElement</a>|Array
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_getMenu">getMenu</a></h4>
<div class="detail">
<code>
<a href="YAHOO.widget.Overlay.html">
YAHOO.widget.Overlay</a>|<a
href="YAHOO.widget.Menu.html">YAHOO.widget.Menu</a>
<strong>getMenu</strong>
(
)
</code>
<div class="description">
Returns a reference to the button's menu.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
<a href="YAHOO.widget.Overlay.html">
YAHOO.widget.Overlay</a>|<a
href="YAHOO.widget.Menu.html">YAHOO.widget.Menu</a>
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_hasFocus">hasFocus</a></h4>
<div class="detail">
<code>
Boolean
<strong>hasFocus</strong>
(
)
</code>
<div class="description">
Returns a boolean indicating whether or not the button
has focus.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
Boolean
</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 Button 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;input&#62;</code>, <code>&#60;button&#62;</code>,
<code>&#60;a&#62;</code>, or <code>&#60;span&#62;</code> element to
be used to create the button.
</dd>
<dd>
<code>p_oElement &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-34812697">HTMLButtonElement</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>, <code>&#60;button&#62;</code>,
<code>&#60;a&#62;</code>, or <code>&#60;span&#62;</code> element to be
used to create the button.
</dd>
<dd>
<code>p_oElement &lt;Object&gt;</code>
Object literal specifying a set of
configuration attributes used to create the button.
</dd>
<dd>
<code>p_oAttributes &lt;Object&gt;</code>
Optional. Object literal specifying a
set of configuration attributes used to create the button.
</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.
</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.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_initConfig">initConfig</a></h4>
<div class="detail">
<code>
private
void
<strong>initConfig</strong>
(
Object
)
</code>
<div class="description">
Initializes the set of configuration attributes that are
used to instantiate the button.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>Object &lt;Object&gt;</code>
representing the button's set of
configuration attributes.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_isActive">isActive</a></h4>
<div class="detail">
<code>
Boolean
<strong>isActive</strong>
(
)
</code>
<div class="description">
Returns a boolean indicating whether or not the button
is active.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
Boolean
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_removeHiddenFields">removeHiddenFields</a></h4>
<div class="detail">
<code>
void
<strong>removeHiddenFields</strong>
(
)
</code>
<div class="description">
Removes the button's hidden form field(s) from its
parent form.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_removeStateCSSClasses">removeStateCSSClasses</a></h4>
<div class="detail">
<code>
void
<strong>removeStateCSSClasses</strong>
(
)
</code>
<div class="description">
Removes state-specific CSS classes to the button's root
DOM element.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_setAttributeFromDOMAttribute">setAttributeFromDOMAttribute</a></h4>
<div class="detail">
<code>
private
void
<strong>setAttributeFromDOMAttribute</strong>
(
p_sAttribute
)
</code>
<div class="description">
Gets the value of the specified DOM attribute and sets it
into the collection of configuration attributes used to configure
the button.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sAttribute &lt;String&gt;</code>
String representing the name of the
attribute to retrieve from the DOM element.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_setAttributesFromSrcElement">setAttributesFromSrcElement</a></h4>
<div class="detail">
<code>
private
void
<strong>setAttributesFromSrcElement</strong>
(
p_oElement
,
p_oAttributes
)
</code>
<div class="description">
Gets the values for all the attributes of the source element
(either <code>&#60;input&#62;</code> or <code>&#60;a&#62;</code>) that
map to Button configuration attributes and sets them into a collection
that is passed to the Button constructor.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_oElement &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-
48250443">HTMLAnchorElement</a>&gt;</code>
Object reference to the HTML
element (either <code>&#60;input&#62;</code> or <code>&#60;span&#62;
</code>) used to create the button.
</dd>
<dd>
<code>p_oAttributes &lt;Object&gt;</code>
Object reference for the collection of
configuration attributes used to create the button.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private">
<h4>
<a name="method_setFormElementProperties">setFormElementProperties</a></h4>
<div class="detail">
<code>
private
void
<strong>setFormElementProperties</strong>
(
)
</code>
<div class="description">
Gets the value of the attributes from the form element
and sets them into the collection of configuration attributes used to
configure the button.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="protected">
<h4>
<a name="method_submitForm">submitForm</a></h4>
<div class="detail">
<code>
protected
Boolean
<strong>submitForm</strong>
(
)
</code>
<div class="description">
Submits the form to which the button belongs. Returns
true if the form was submitted successfully, false if the submission
was cancelled.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
Boolean
</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.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
String
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_YAHOO.widget.Button.addHiddenFieldsToForm">YAHOO.widget.Button.addHiddenFieldsToForm</a></h4>
<div class="detail">
<code>
void
<strong>YAHOO.widget.Button.addHiddenFieldsToForm</strong>
(
p_oForm
)
</code>
<div class="description">
Searches the specified form and adds hidden fields for
instances of YAHOO.widget.Button that are of type "radio," "checkbox,"
"menu," and "split."
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_oForm &lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
one-html.html#ID-40002357">HTMLFormElement</a>&gt;</code>
Object reference
for the form to search.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_YAHOO.widget.Button.getButton">YAHOO.widget.Button.getButton</a></h4>
<div class="detail">
<code>
YAHOO.widget.Button
<strong>YAHOO.widget.Button.getButton</strong>
(
p_sId
)
</code>
<div class="description">
Returns a button with the specified id.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sId &lt;String&gt;</code>
String specifying the id of the root node of the
HTML element representing the button to be retrieved.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
YAHOO.widget.Button
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_YAHOO.widget.Button.onFormKeyPress">YAHOO.widget.Button.onFormKeyPress</a></h4>
<div class="detail">
<code>
void
<strong>YAHOO.widget.Button.onFormKeyPress</strong>
(
p_oEvent
)
</code>
<div class="description">
"keypress" event handler for the button's form.
</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>
</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_beforeCheckedChange">beforeCheckedChange</a></h4>
<div class="detail">
<code>
<strong>beforeCheckedChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'checked' 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_beforeFocusmenuChange">beforeFocusmenuChange</a></h4>
<div class="detail">
<code>
<strong>beforeFocusmenuChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'focusmenu' 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_beforeHrefChange">beforeHrefChange</a></h4>
<div class="detail">
<code>
<strong>beforeHrefChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'href' 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_beforeLabelChange">beforeLabelChange</a></h4>
<div class="detail">
<code>
<strong>beforeLabelChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'label' 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_beforeLazyloadmenuChange">beforeLazyloadmenuChange</a></h4>
<div class="detail">
<code>
<strong>beforeLazyloadmenuChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'lazyloadmenu' 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_beforeMenualignmentChange">beforeMenualignmentChange</a></h4>
<div class="detail">
<code>
<strong>beforeMenualignmentChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'menualignment' 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_beforeMenuChange">beforeMenuChange</a></h4>
<div class="detail">
<code>
<strong>beforeMenuChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'menu' 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_beforeMenuclassnameChange">beforeMenuclassnameChange</a></h4>
<div class="detail">
<code>
<strong>beforeMenuclassnameChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'menuclassname' 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_beforeMenumaxheightChange">beforeMenumaxheightChange</a></h4>
<div class="detail">
<code>
<strong>beforeMenumaxheightChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'menumaxheight' 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_beforeMenuminscrollheightChange">beforeMenuminscrollheightChange</a></h4>
<div class="detail">
<code>
<strong>beforeMenuminscrollheightChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'menuminscrollheight' 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_beforeOnclickChange">beforeOnclickChange</a></h4>
<div class="detail">
<code>
<strong>beforeOnclickChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'onclick' 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_beforeSelectedMenuItemChange">beforeSelectedMenuItemChange</a></h4>
<div class="detail">
<code>
<strong>beforeSelectedMenuItemChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'selectedMenuItem' 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_beforeSrcelementChange">beforeSrcelementChange</a></h4>
<div class="detail">
<code>
<strong>beforeSrcelementChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'srcelement' 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_beforeTabindexChange">beforeTabindexChange</a></h4>
<div class="detail">
<code>
<strong>beforeTabindexChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'tabindex' 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_beforeTargetChange">beforeTargetChange</a></h4>
<div class="detail">
<code>
<strong>beforeTargetChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'target' 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_beforeTitleChange">beforeTitleChange</a></h4>
<div class="detail">
<code>
<strong>beforeTitleChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'title' 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_beforeTypeChange">beforeTypeChange</a></h4>
<div class="detail">
<code>
<strong>beforeTypeChange</strong>
(
event
)
</code>
<div class="description">
Fires before the value for the configuration attribute 'type' 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_blur">blur</a></h4>
<div class="detail">
<code>
<strong>blur</strong>
(
)
</code>
<div class="description">
Fires when the menu item loses the input focus. Passes back
a single object representing the original DOM event object passed back by
the event utility (YAHOO.util.Event) when the event was fired. See
<a href="YAHOO.util.Element.html#addListener">Element.addListener</a> for
more information on listening for this event.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_checkedChange">checkedChange</a></h4>
<div class="detail">
<code>
<strong>checkedChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'checked' 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_focus">focus</a></h4>
<div class="detail">
<code>
<strong>focus</strong>
(
)
</code>
<div class="description">
Fires when the menu item receives focus. Passes back a
single object representing the original DOM event object passed back by
the event utility (YAHOO.util.Event) when the event was fired. See
<a href="YAHOO.util.Element.html#addListener">Element.addListener</a>
for more information on listening for this event.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_focusmenuChange">focusmenuChange</a></h4>
<div class="detail">
<code>
<strong>focusmenuChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'focusmenu' 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_hrefChange">hrefChange</a></h4>
<div class="detail">
<code>
<strong>hrefChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'href' 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_labelChange">labelChange</a></h4>
<div class="detail">
<code>
<strong>labelChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'label' 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_lazyloadmenuChange">lazyloadmenuChange</a></h4>
<div class="detail">
<code>
<strong>lazyloadmenuChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'lazyloadmenu' 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_menualignmentChange">menualignmentChange</a></h4>
<div class="detail">
<code>
<strong>menualignmentChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'menualignment' 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_menuChange">menuChange</a></h4>
<div class="detail">
<code>
<strong>menuChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'menu' 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_menuclassnameChange">menuclassnameChange</a></h4>
<div class="detail">
<code>
<strong>menuclassnameChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'menuclassname' 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_menumaxheightChange">menumaxheightChange</a></h4>
<div class="detail">
<code>
<strong>menumaxheightChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'menumaxheight' 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_menuminscrollheightChange">menuminscrollheightChange</a></h4>
<div class="detail">
<code>
<strong>menuminscrollheightChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'menuminscrollheight' 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_onclickChange">onclickChange</a></h4>
<div class="detail">
<code>
<strong>onclickChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'onclick' 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_option">option</a></h4>
<div class="detail">
<code>
<strong>option</strong>
(
)
</code>
<div class="description">
Fires when the user invokes the button's option. Passes
back a single object representing the original DOM event (either
"mousedown" or "keydown") that caused the "option" event to fire. See
<a href="YAHOO.util.Element.html#addListener">Element.addListener</a>
for more information on listening for this event.
</div>
<div class="description">
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_selectedMenuItemChange">selectedMenuItemChange</a></h4>
<div class="detail">
<code>
<strong>selectedMenuItemChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'selectedMenuItem' 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_srcelementChange">srcelementChange</a></h4>
<div class="detail">
<code>
<strong>srcelementChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'srcelement' 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_tabindexChange">tabindexChange</a></h4>
<div class="detail">
<code>
<strong>tabindexChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'tabindex' 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_targetChange">targetChange</a></h4>
<div class="detail">
<code>
<strong>targetChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'target' 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_titleChange">titleChange</a></h4>
<div class="detail">
<code>
<strong>titleChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'title' 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_typeChange">typeChange</a></h4>
<div class="detail">
<code>
<strong>typeChange</strong>
(
event
)
</code>
<div class="description">
Fires when the value for the configuration attribute 'type' 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_checked">checked</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
Boolean indicating if the button is checked.
Applies only to buttons of type "radio" and "checkbox."
</div>
</div>
<div class="default">
Default Value: false
</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'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 should be disabled.
(Disabled buttons are dimmed and will not respond to user input
or fire events. Does not apply to button's of type "link.")
</div>
</div>
<div class="default">
Default Value: false
</div>
<hr />
</div>
<div class="">
<h4><a name="config_focusmenu">focusmenu</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
Boolean indicating whether or not the button's menu
should be focused when it is made visible.
</div>
</div>
<div class="default">
Default Value: true
</div>
<hr />
</div>
<div class="">
<h4><a name="config_href">href</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
String specifying the href for the button. Applies
only to buttons of type "link."
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="config_label">label</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
String specifying the button's text label
or innerHTML.
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
</div>
<div class="">
<h4><a name="config_lazyloadmenu">lazyloadmenu</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
Boolean indicating the value to set for the
<a href="YAHOO.widget.Menu.html#lazyLoad">"lazyload"</a>
configuration property of the button's menu. Setting
"lazyloadmenu" to <code>true </code> will defer rendering of
the button's menu until the first time it is made visible.
If "lazyloadmenu" is set to <code>false</code>, the button's
menu will be rendered immediately if the button is in the
document, or in response to the button's "appendTo" event if
the button is not yet in the document. In either case, the
menu is rendered into the button's parent HTML element.
<em>This attribute does not apply if a
<a href="YAHOO.widget.Menu.html">YAHOO.widget.Menu</a> or
<a href="YAHOO.widget.Overlay.html">YAHOO.widget.Overlay</a>
instance is passed as the value of the button's "menu"
configuration attribute. <a href="YAHOO.widget.Menu.html">
YAHOO.widget.Menu</a> or <a href="YAHOO.widget.Overlay.html">
YAHOO.widget.Overlay</a> instances should be rendered before
being set as the value for the "menu" configuration
attribute.</em>
</div>
</div>
<div class="default">
Default Value: true
</div>
<hr />
</div>
<div class="">
<h4><a name="config_menu">menu</a>
<code>- <a href="YAHOO.widget.Menu.html">YAHOO.widget.Menu</a>|<a
href="YAHOO.widget.Overlay.html">YAHOO.widget.Overlay</a>|<a
href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
one-html.html#ID-58190037">HTMLElement</a>|String|Array</code>
</h4>
<div class="detail">
<div class="description">
Object specifying the menu for the button.
The value can be one of the following:
<ul>
<li>Object specifying a <a href="YAHOO.widget.Menu.html">
YAHOO.widget.Menu</a> instance.</li>
<li>Object specifying a <a href="YAHOO.widget.Overlay.html">
YAHOO.widget.Overlay</a> instance.</li>
<li>String specifying the id attribute of the <code>&#60;div&#62;
</code> element used to create the menu. By default the menu
will be created as an instance of
<a href="YAHOO.widget.Overlay.html">YAHOO.widget.Overlay</a>.
If the <a href="YAHOO.widget.Menu.html#CSS_CLASS_NAME">
default CSS class name for YAHOO.widget.Menu</a> is applied to
the <code>&#60;div&#62;</code> element, it will be created as an
instance of <a href="YAHOO.widget.Menu.html">YAHOO.widget.Menu
</a>.</li><li>String specifying the id attribute of the
<code>&#60;select&#62;</code> element used to create the menu.
</li><li>Object specifying the <code>&#60;div&#62;</code> element
used to create the menu.</li>
<li>Object specifying the <code>&#60;select&#62;</code> element
used to create the menu.</li>
<li>Array of object literals, each representing a set of
<a href="YAHOO.widget.MenuItem.html">YAHOO.widget.MenuItem</a>
configuration attributes.</li>
<li>Array of strings representing the text labels for each menu
item in the menu.</li>
</ul>
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
</div>
<div class="">
<h4><a name="config_menualignment">menualignment</a>
<code>- Array</code>
</h4>
<div class="detail">
<div class="description">
Array defining how the Button's Menu is aligned to the Button.
The default value of ["tl", "bl"] aligns the Menu's top left corner to the Button's
bottom left corner.
</div>
</div>
<div class="default">
Default Value: ["tl", "bl"]
</div>
<hr />
</div>
<div class="">
<h4><a name="config_menuclassname">menuclassname</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
String representing the CSS class name to be
applied to the root element of the button's menu.
</div>
</div>
<div class="default">
Default Value: "yui-button-menu"
</div>
<hr />
</div>
<div class="">
<h4><a name="config_menumaxheight">menumaxheight</a>
<code>- Number</code>
</h4>
<div class="detail">
<div class="description">
Number defining the maximum height (in pixels) for a menu's
body element (<code>&#60;div class="bd"&#60;</code>). Once a menu's body
exceeds this height, the contents of the body are scrolled to maintain
this value. This value cannot be set lower than the value of the
"minscrollheight" configuration property.
</div>
</div>
<div class="default">
Default Value: 0
</div>
<hr />
</div>
<div class="">
<h4><a name="config_menuminscrollheight">menuminscrollheight</a>
<code>- Number</code>
</h4>
<div class="detail">
<div class="description">
Number defining the minimum threshold for the "menumaxheight"
configuration attribute. When set this attribute is automatically applied
to all submenus.
</div>
</div>
<div class="default">
Default Value: 90
</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.
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
</div>
<div class="">
<h4><a name="config_onclick">onclick</a>
<code>- Object</code>
</h4>
<div class="detail">
<div class="description">
Object literal representing the code to be executed
when the button is clicked. Format:<br> <code> {<br>
<strong>fn:</strong> Function, &#47;&#47; The handler to call
when the event fires.<br> <strong>obj:</strong> Object,
&#47;&#47; An object to pass back to the handler.<br>
<strong>scope:</strong> Object &#47;&#47; The object to use
for the scope of the handler.<br> } </code>
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
</div>
<div class="">
<h4><a name="config_selectedMenuItem">selectedMenuItem</a>
<code>- Number</code>
</h4>
<div class="detail">
<div class="description">
Object representing the item in the button's menu
that is currently selected.
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
</div>
<div class="">
<h4><a name="config_srcelement">srcelement</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">
Object reference to the HTML element (either
<code>&#60;input&#62;</code> or <code>&#60;span&#62;</code>)
used to create the button.
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
</div>
<div class="">
<h4><a name="config_tabindex">tabindex</a>
<code>- Number</code>
</h4>
<div class="detail">
<div class="description">
Number specifying the tabindex for the button.
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
</div>
<div class="">
<h4><a name="config_target">target</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
String specifying the target for the button.
Applies only to buttons of type "link."
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="config_title">title</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
String specifying the title for the button.
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
</div>
<div class="">
<h4><a name="config_type">type</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
String specifying the button's type. Possible
values are: "push," "link," "submit," "reset," "checkbox,"
"radio," "menu," and "split."
</div>
</div>
<div class="default">
Default Value: "push"
</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.
</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="selected"><a href="YAHOO.widget.Button.html">YAHOO.widget.Button</a></li>
<li class=""><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__activationButtonPressed">_activationButtonPressed</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="protected"><a href="#property__activationKeyPressed">_activationKeyPressed</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="protected"><a href="#property__button">_button</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="protected"><a href="#property__hasKeyEventHandlers">_hasKeyEventHandlers</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="protected"><a href="#property__hasMouseEventHandlers">_hasMouseEventHandlers</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="protected"><a href="#property__hiddenFields">_hiddenFields</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="protected"><a href="#property__menu">_menu</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="protected"><a href="#property__nOptionRegionX">_nOptionRegionX</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="protected"><a href="#property__onclickAttributeValue">_onclickAttributeValue</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_ACTIVATION_KEYS">ACTIVATION_KEYS</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_CHECK_ACTIVATION_KEYS">CHECK_ACTIVATION_KEYS</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_CHECKBOX_CHECKED_TITLE">CHECKBOX_CHECKED_TITLE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_CHECKBOX_DEFAULT_TITLE">CHECKBOX_DEFAULT_TITLE</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_MENUBUTTON_DEFAULT_TITLE">MENUBUTTON_DEFAULT_TITLE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_MENUBUTTON_MENU_VISIBLE_TITLE">MENUBUTTON_MENU_VISIBLE_TITLE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_NODE_NAME">NODE_NAME</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_OPTION_AREA_WIDTH">OPTION_AREA_WIDTH</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_RADIO_CHECKED_TITLE">RADIO_CHECKED_TITLE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_RADIO_DEFAULT_TITLE">RADIO_DEFAULT_TITLE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_SPLITBUTTON_DEFAULT_TITLE">SPLITBUTTON_DEFAULT_TITLE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_SPLITBUTTON_OPTION_VISIBLE_TITLE">SPLITBUTTON_OPTION_VISIBLE_TITLE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_SUBMIT_TITLE">SUBMIT_TITLE</a>
<!--<code>&lt;String&gt;</code>-->
</li>
</ul>
</div>
<div class="module">
<h4>Methods</h4>
<ul class="content">
<li class="protected"><!--<code>void</code>-->
<a href="#method__addListenersToForm">_addListenersToForm</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__hideMenu">_hideMenu</a>
</li>
<li class="protected"><!--<code>Boolean</code>-->
<a href="#method__isActivationKey">_isActivationKey</a>
</li>
<li class="protected"><!--<code>Boolean</code>-->
<a href="#method__isSplitButtonOptionKey">_isSplitButtonOptionKey</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__onAppendTo">_onAppendTo</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__onBlur">_onBlur</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__onClick">_onClick</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__onDblClick">_onDblClick</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__onDocumentKeyUp">_onDocumentKeyUp</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__onDocumentMouseDown">_onDocumentMouseDown</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__onDocumentMouseUp">_onDocumentMouseUp</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__onFocus">_onFocus</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__onFormReset">_onFormReset</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__onFormSubmit">_onFormSubmit</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__onKeyDown">_onKeyDown</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__onKeyUp">_onKeyUp</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onMenuClick">_onMenuClick</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onMenuHide">_onMenuHide</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onMenuItemAdded">_onMenuItemAdded</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onMenuItemSelected">_onMenuItemSelected</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onMenuKeyDown">_onMenuKeyDown</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onMenuRender">_onMenuRender</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method__onMenuShow">_onMenuShow</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__onMouseDown">_onMouseDown</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__onMouseMove">_onMouseMove</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__onMouseOut">_onMouseOut</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__onMouseOver">_onMouseOver</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__onMouseUp">_onMouseUp</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__onOption">_onOption</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__setChecked">_setChecked</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__setDisabled">_setDisabled</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__setHref">_setHref</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__setLabel">_setLabel</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__setMenu">_setMenu</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__setOnClick">_setOnClick</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__setSelectedMenuItem">_setSelectedMenuItem</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__setTabIndex">_setTabIndex</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__setTarget">_setTarget</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__setTitle">_setTitle</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__setType">_setType</a>
</li>
<li class="protected"><!--<code>void</code>-->
<a href="#method__showMenu">_showMenu</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_addStateCSSClasses">addStateCSSClasses</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_blur">blur</a>
</li>
<li class=""><!--<code><a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-58190037">HTMLElement</a></code>-->
<a href="#method_createButtonElement">createButtonElement</a>
</li>
<li class=""><!--<code><a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-6043025">HTMLInputElement</a>|Array</code>-->
<a href="#method_createHiddenFields">createHiddenFields</a>
</li>
<li class="private"><!--<code><a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
one-html.html#ID-6043025">HTMLInputElement</a></code>-->
<a href="#method_createInputElement">createInputElement</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="http://www.w3.org/TR/2000/WD-DOM-Level-1-
20000929/level-one-html.html#ID-40002357">HTMLFormElement</a></code>-->
<a href="#method_getForm">getForm</a>
</li>
<li class=""><!--<code><a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
level-one-html.html#ID-6043025">HTMLInputElement</a>|Array</code>-->
<a href="#method_getHiddenFields">getHiddenFields</a>
</li>
<li class=""><!--<code><a href="YAHOO.widget.Overlay.html">
YAHOO.widget.Overlay</a>|<a
href="YAHOO.widget.Menu.html">YAHOO.widget.Menu</a></code>-->
<a href="#method_getMenu">getMenu</a>
</li>
<li class=""><!--<code>Boolean</code>-->
<a href="#method_hasFocus">hasFocus</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="private"><!--<code>void</code>-->
<a href="#method_initConfig">initConfig</a>
</li>
<li class=""><!--<code>Boolean</code>-->
<a href="#method_isActive">isActive</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_removeHiddenFields">removeHiddenFields</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_removeStateCSSClasses">removeStateCSSClasses</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method_setAttributeFromDOMAttribute">setAttributeFromDOMAttribute</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method_setAttributesFromSrcElement">setAttributesFromSrcElement</a>
</li>
<li class="private"><!--<code>void</code>-->
<a href="#method_setFormElementProperties">setFormElementProperties</a>
</li>
<li class="protected"><!--<code>Boolean</code>-->
<a href="#method_submitForm">submitForm</a>
</li>
<li class=""><!--<code>String</code>-->
<a href="#method_toString">toString</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_YAHOO.widget.Button.addHiddenFieldsToForm">YAHOO.widget.Button.addHiddenFieldsToForm</a>
</li>
<li class=""><!--<code>YAHOO.widget.Button</code>-->
<a href="#method_YAHOO.widget.Button.getButton">YAHOO.widget.Button.getButton</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_YAHOO.widget.Button.onFormKeyPress">YAHOO.widget.Button.onFormKeyPress</a>
</li>
</ul>
</div>
<div class="module">
<h4>Events</h4>
<ul class="content">
<li class="">
<a href="#event_beforeCheckedChange">beforeCheckedChange</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_beforeFocusmenuChange">beforeFocusmenuChange</a>
</li>
<li class="">
<a href="#event_beforeHrefChange">beforeHrefChange</a>
</li>
<li class="">
<a href="#event_beforeLabelChange">beforeLabelChange</a>
</li>
<li class="">
<a href="#event_beforeLazyloadmenuChange">beforeLazyloadmenuChange</a>
</li>
<li class="">
<a href="#event_beforeMenualignmentChange">beforeMenualignmentChange</a>
</li>
<li class="">
<a href="#event_beforeMenuChange">beforeMenuChange</a>
</li>
<li class="">
<a href="#event_beforeMenuclassnameChange">beforeMenuclassnameChange</a>
</li>
<li class="">
<a href="#event_beforeMenumaxheightChange">beforeMenumaxheightChange</a>
</li>
<li class="">
<a href="#event_beforeMenuminscrollheightChange">beforeMenuminscrollheightChange</a>
</li>
<li class="">
<a href="#event_beforeNameChange">beforeNameChange</a>
</li>
<li class="">
<a href="#event_beforeOnclickChange">beforeOnclickChange</a>
</li>
<li class="">
<a href="#event_beforeSelectedMenuItemChange">beforeSelectedMenuItemChange</a>
</li>
<li class="">
<a href="#event_beforeSrcelementChange">beforeSrcelementChange</a>
</li>
<li class="">
<a href="#event_beforeTabindexChange">beforeTabindexChange</a>
</li>
<li class="">
<a href="#event_beforeTargetChange">beforeTargetChange</a>
</li>
<li class="">
<a href="#event_beforeTitleChange">beforeTitleChange</a>
</li>
<li class="">
<a href="#event_beforeTypeChange">beforeTypeChange</a>
</li>
<li class="">
<a href="#event_beforeValueChange">beforeValueChange</a>
</li>
<li class="">
<a href="#event_blur">blur</a>
</li>
<li class="">
<a href="#event_checkedChange">checkedChange</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_focus">focus</a>
</li>
<li class="">
<a href="#event_focusmenuChange">focusmenuChange</a>
</li>
<li class="">
<a href="#event_hrefChange">hrefChange</a>
</li>
<li class="">
<a href="#event_labelChange">labelChange</a>
</li>
<li class="">
<a href="#event_lazyloadmenuChange">lazyloadmenuChange</a>
</li>
<li class="">
<a href="#event_menualignmentChange">menualignmentChange</a>
</li>
<li class="">
<a href="#event_menuChange">menuChange</a>
</li>
<li class="">
<a href="#event_menuclassnameChange">menuclassnameChange</a>
</li>
<li class="">
<a href="#event_menumaxheightChange">menumaxheightChange</a>
</li>
<li class="">
<a href="#event_menuminscrollheightChange">menuminscrollheightChange</a>
</li>
<li class="">
<a href="#event_nameChange">nameChange</a>
</li>
<li class="">
<a href="#event_onclickChange">onclickChange</a>
</li>
<li class="">
<a href="#event_option">option</a>
</li>
<li class="">
<a href="#event_selectedMenuItemChange">selectedMenuItemChange</a>
</li>
<li class="">
<a href="#event_srcelementChange">srcelementChange</a>
</li>
<li class="">
<a href="#event_tabindexChange">tabindexChange</a>
</li>
<li class="">
<a href="#event_targetChange">targetChange</a>
</li>
<li class="">
<a href="#event_titleChange">titleChange</a>
</li>
<li class="">
<a href="#event_typeChange">typeChange</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_checked">checked</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_focusmenu">focusmenu</a>
</li>
<li class="">
<a href="#config_href">href</a>
</li>
<li class="">
<a href="#config_label">label</a>
</li>
<li class="">
<a href="#config_lazyloadmenu">lazyloadmenu</a>
</li>
<li class="">
<a href="#config_menu">menu</a>
</li>
<li class="">
<a href="#config_menualignment">menualignment</a>
</li>
<li class="">
<a href="#config_menuclassname">menuclassname</a>
</li>
<li class="">
<a href="#config_menumaxheight">menumaxheight</a>
</li>
<li class="">
<a href="#config_menuminscrollheight">menuminscrollheight</a>
</li>
<li class="">
<a href="#config_name">name</a>
</li>
<li class="">
<a href="#config_onclick">onclick</a>
</li>
<li class="">
<a href="#config_selectedMenuItem">selectedMenuItem</a>
</li>
<li class="">
<a href="#config_srcelement">srcelement</a>
</li>
<li class="">
<a href="#config_tabindex">tabindex</a>
</li>
<li class="">
<a href="#config_target">target</a>
</li>
<li class="">
<a href="#config_title">title</a>
</li>
<li class="">
<a href="#config_type">type</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>
Reference in a new issue View git blame Copy permalink