4125 lines
208 KiB
HTML
4125 lines
208 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<html>
|
|
<head>
|
|
<title>API: button YAHOO.widget.Button (YUI Library)</title>
|
|
<link rel="stylesheet" type="text/css" href="assets/api.css">
|
|
</head>
|
|
|
|
<body id="yahoo-com">
|
|
<div id="doc3" class="yui-t2">
|
|
|
|
<div id="hd">
|
|
<h1>Yahoo! UI Library</h1>
|
|
<h3>Button <span class="subtitle">2.2.2</span></h3>
|
|
<p>
|
|
<a href="./index.html">Yahoo! UI Library</a>
|
|
> <a href="./module_button.html">button</a>
|
|
> YAHOO.widget.Button
|
|
|
|
</p>
|
|
</div>
|
|
|
|
<div id="bd">
|
|
<div id="yui-main">
|
|
<div class="yui-b">
|
|
|
|
|
|
<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><a name="constructor_detail">Constructor</a></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
|
|
<String>
|
|
</code>
|
|
String specifying the id attribute of the
|
|
<code><input></code>, <code><a></code> or
|
|
<code><span></code> element to be used to create the button.
|
|
</dd>
|
|
<dd>
|
|
<code>p_oElement
|
|
<<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
|
|
one-html.html#ID-6043025">HTMLInputElement</a>|<a href="
|
|
http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.html#
|
|
ID-33759296">HTMLElement</a>>
|
|
</code>
|
|
Object reference for the
|
|
<code><input></code>, <code><a></code> or
|
|
<code><span></code> element to be used to create the button.
|
|
</dd>
|
|
<dd>
|
|
<code>p_oElement
|
|
<Object>
|
|
</code>
|
|
Object literal specifying a set of configuration
|
|
attributes used to create the button.
|
|
</dd>
|
|
<dd>
|
|
<code>p_oAttributes
|
|
<Object>
|
|
</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><a name="field_detail">Properties</a></h3>
|
|
<div class="content">
|
|
<h4><a name="_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 />
|
|
<h4><a name="_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 />
|
|
<h4><a name="_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><a></code> or <code><button></code> element.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: null
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
<h4><a name="_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 />
|
|
<h4><a name="_hasMouseEventHandlers">_hasMouseEventHandlers</a>
|
|
<code>- protected Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Boolean indicating if the button's "mouseout" and "mousedown"
|
|
and "mouseup" event handlers are assigned
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: false
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
<h4><a name="_hiddenField">_hiddenField</a>
|
|
<code>- protected <a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
|
|
one-html.html#ID-6043025">HTMLInputElement</a></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Object reference to the <code><input></code> element
|
|
used when the button's parent form is submitted.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: null
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
<h4><a name="_menu">_menu</a>
|
|
<code>- protected <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 />
|
|
<h4><a name="_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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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: "yuibutton"
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
<h4><a name="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 "menubutton."
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: "Menu collapsed. Click to expand."
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
<h4><a name="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
|
|
"menubutton" when the button's menu is visible.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: "Menu expanded. Click or press Esc to collapse."
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 to uncheck."
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 "splitebutton."
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: "Menu collapsed. Click inside option region or press
|
|
Ctrl + Shift + M to show the menu."
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
<h4><a name="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
|
|
"splitbutton" 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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="TAG_NAME">TAG_NAME</a>
|
|
<code>- final String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
The name of the tag to be used for the button's root element.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: "SPAN"
|
|
</div>
|
|
|
|
|
|
<hr />
|
|
|
|
|
|
</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 href="YAHOO.util.Element.html#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 href="YAHOO.util.AttributeProvider.html#_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 href="YAHOO.util.EventProvider.html#__yui_events">__yui_events</a>,
|
|
<a href="YAHOO.util.EventProvider.html#__yui_subscribers">__yui_subscribers</a>
|
|
</code>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section method details">
|
|
<h3><a name="methodDetails">Methods</a></h3>
|
|
<div class="content">
|
|
<h4>
|
|
<a name="_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 />
|
|
<h4>
|
|
<a name="_createButtonElement">_createButtonElement</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
protected
|
|
|
|
|
|
<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
|
|
level-one-html.html#ID-58190037">HTMLElement</a>
|
|
<strong>_createButtonElement</strong>
|
|
(
|
|
|
|
|
|
p_sType
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Creates the button's element.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>p_sType <String></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 />
|
|
<h4>
|
|
<a name="_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 />
|
|
<h4>
|
|
<a name="_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 <Number></code>
|
|
Number representing the keycode to be evaluated.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Boolean
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="_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 <Event></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 />
|
|
<h4>
|
|
<a name="_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 <Event></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 />
|
|
<h4>
|
|
<a name="_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 <Event></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 />
|
|
<h4>
|
|
<a name="_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 <Event></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 />
|
|
<h4>
|
|
<a name="_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 <Event></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 />
|
|
<h4>
|
|
<a name="_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 <Event></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 />
|
|
<h4>
|
|
<a name="_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 <Event></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 />
|
|
<h4>
|
|
<a name="_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 <Event></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 />
|
|
<h4>
|
|
<a name="_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 <Event></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 />
|
|
<h4>
|
|
<a name="_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 <Event></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 />
|
|
<h4>
|
|
<a name="_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 <Event></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 />
|
|
<h4>
|
|
<a name="_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 <Event></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 />
|
|
<h4>
|
|
<a name="_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 <String></code>
|
|
String representing the name of the event that
|
|
was fired.
|
|
</dd>
|
|
<dd>
|
|
<code>p_aArgs <Array></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 />
|
|
<h4>
|
|
<a name="_onMenuHide">_onMenuHide</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_onMenuHide</strong>
|
|
(
|
|
|
|
|
|
p_sType
|
|
|
|
|
|
,
|
|
p_aArgs
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
"hide" event handler for the button's menu.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>p_sType <String></code>
|
|
String representing the name of the event that
|
|
was fired.
|
|
</dd>
|
|
<dd>
|
|
<code>p_aArgs <Array></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 />
|
|
<h4>
|
|
<a name="_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 <String></code>
|
|
String representing the name of the event that
|
|
was fired.
|
|
</dd>
|
|
<dd>
|
|
<code>p_aArgs <Array></code>
|
|
Array of arguments sent when the event was fired.
|
|
</dd>
|
|
<dd>
|
|
<code>p_oItem <<a href="YAHOO.widget.MenuItem.html">YAHOO.widget.MenuItem</a>></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 />
|
|
<h4>
|
|
<a name="_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 <String></code>
|
|
String representing the name of the event that
|
|
was fired.
|
|
</dd>
|
|
<dd>
|
|
<code>p_aArgs <Array></code>
|
|
Array of arguments sent when the event was fired.
|
|
</dd>
|
|
<dd>
|
|
<code>p_oItem <<a href="YAHOO.widget.MenuItem.html">YAHOO.widget.MenuItem</a>></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 />
|
|
<h4>
|
|
<a name="_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 <String></code>
|
|
String representing the name of the event that
|
|
was fired.
|
|
</dd>
|
|
<dd>
|
|
<code>p_aArgs <Array></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 />
|
|
<h4>
|
|
<a name="_onMenuRender">_onMenuRender</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_onMenuRender</strong>
|
|
(
|
|
|
|
|
|
p_sType
|
|
|
|
|
|
,
|
|
p_aArgs
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
"render" event handler for the button's menu.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>p_sType <String></code>
|
|
String representing the name of the event that
|
|
was fired.
|
|
</dd>
|
|
<dd>
|
|
<code>p_aArgs <Array></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 />
|
|
<h4>
|
|
<a name="_onMenuShow">_onMenuShow</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_onMenuShow</strong>
|
|
(
|
|
|
|
|
|
p_sType
|
|
|
|
|
|
,
|
|
p_aArgs
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
"show" event handler for the button's menu.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>p_sType <String></code>
|
|
String representing the name of the event that
|
|
was fired.
|
|
</dd>
|
|
<dd>
|
|
<code>p_aArgs <Array></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 />
|
|
<h4>
|
|
<a name="_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 <Event></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 />
|
|
<h4>
|
|
<a name="_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 <Event></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 />
|
|
<h4>
|
|
<a name="_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 <Event></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 />
|
|
<h4>
|
|
<a name="_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 <Event></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 />
|
|
<h4>
|
|
<a name="_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 <Event></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 />
|
|
<h4>
|
|
<a name="_setAccessKey">_setAccessKey</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
protected
|
|
|
|
|
|
void
|
|
<strong>_setAccessKey</strong>
|
|
(
|
|
|
|
|
|
p_sAccessKey
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Sets the value of the button's "accesskey" attribute.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>p_sAccessKey <String></code>
|
|
String indicating the value for the button's
|
|
"accesskey" attribute.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="_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 <Boolean></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 />
|
|
<h4>
|
|
<a name="_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 <Boolean></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 />
|
|
<h4>
|
|
<a name="_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 <String></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 />
|
|
<h4>
|
|
<a name="_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 <String></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 />
|
|
<h4>
|
|
<a name="_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 <Object></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 />
|
|
<h4>
|
|
<a name="_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 <Object></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 />
|
|
<h4>
|
|
<a name="_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 <Number></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 />
|
|
<h4>
|
|
<a name="_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 <String></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 />
|
|
<h4>
|
|
<a name="_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 <String></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 />
|
|
<h4>
|
|
<a name="_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 <String></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 />
|
|
<h4>
|
|
<a name="_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 <Event></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 />
|
|
<h4>
|
|
<a name="addHiddenFieldsToForm">addHiddenFieldsToForm</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>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," "menubutton,"
|
|
and "splitbutton."
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>p_oForm <<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
|
|
one-html.html#ID-40002357">HTMLFormElement</a>></code>
|
|
Object reference
|
|
for the form to search.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="createHiddenField">createHiddenField</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>
|
|
<strong>createHiddenField</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>
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="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><input></code> element of the
|
|
specified type.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>p_sType <String></code>
|
|
String specifying the type of
|
|
<code><input></code> element to create.
|
|
</dd>
|
|
<dd>
|
|
<code>p_sName <String></code>
|
|
String specifying the name of
|
|
<code><input></code> element to create.
|
|
</dd>
|
|
<dd>
|
|
<code>p_sValue <String></code>
|
|
String specifying the value of
|
|
<code><input></code> element to create.
|
|
</dd>
|
|
<dd>
|
|
<code>p_bChecked <String></code>
|
|
Boolean specifying if the
|
|
<code><input></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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="getFirstElement">getFirstElement</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-58190037">HTMLElement</a>
|
|
<strong>getFirstElement</strong>
|
|
(
|
|
|
|
|
|
p_oElement
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Returns an HTML element's first HTML element node.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>p_oElement <<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
|
|
level-one-html.html#ID-58190037">HTMLElement</a>></code>
|
|
Object
|
|
reference specifying the element to be evaluated.
|
|
</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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="getHiddenField">getHiddenField</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>
|
|
<strong>getHiddenField</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Returns a reference to the <code><input></code> element
|
|
used when the button's 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>
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="getMenu">getMenu</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<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.Menu.html">YAHOO.widget.Menu</a>
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 <String></code>
|
|
String specifying the id attribute of the
|
|
<code><input></code>, <code><a></code> or
|
|
<code><span></code> element to be used to create the button.
|
|
</dd>
|
|
<dd>
|
|
<code>p_oElement <<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
|
|
one-html.html#ID-6043025">HTMLInputElement</a>|<a href="
|
|
http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.html#
|
|
ID-33759296">HTMLElement</a>></code>
|
|
Object reference for the
|
|
<code><input></code>, <code><a></code> or
|
|
<code><span></code> element to be used to create the button.
|
|
</dd>
|
|
<dd>
|
|
<code>p_oElement <Object></code>
|
|
Object literal specifying a set of configuration
|
|
attributes used to create the button.
|
|
</dd>
|
|
<dd>
|
|
<code>p_oAttributes <Object></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 />
|
|
<h4>
|
|
<a name="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 <Object></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 />
|
|
<h4>
|
|
<a name="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 <Object></code>
|
|
representing the button's set of
|
|
configuration attributes.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="onFormKeyDown">onFormKeyDown</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>onFormKeyDown</strong>
|
|
(
|
|
|
|
|
|
p_oEvent
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
"keydown" event handler for the button's form.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>p_oEvent <Event></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 />
|
|
<h4>
|
|
<a name="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 <String></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 />
|
|
<h4>
|
|
<a name="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><input></code> or <code><a></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 <<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>></code>
|
|
Object reference to the HTML
|
|
element (either <code><input></code> or <code><span></code>)
|
|
used to create the button.
|
|
</dd>
|
|
<dd>
|
|
<code>p_oAttributes <Object></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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="submitForm">submitForm</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
protected
|
|
|
|
|
|
void
|
|
<strong>submitForm</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Submits the form to which the button belongs.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
<h4>
|
|
<a name="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>
|
|
|
|
<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 href="YAHOO.util.Element.html#_registerHTMLAttr">_registerHTMLAttr</a>,
|
|
<a href="YAHOO.util.Element.html#addClass">addClass</a>,
|
|
<a href="YAHOO.util.Element.html#addListener">addListener</a>,
|
|
<a href="YAHOO.util.Element.html#appendChild">appendChild</a>,
|
|
<a href="YAHOO.util.Element.html#appendTo">appendTo</a>,
|
|
<a href="YAHOO.util.Element.html#fireQueue">fireQueue</a>,
|
|
<a href="YAHOO.util.Element.html#getElementsByClassName">getElementsByClassName</a>,
|
|
<a href="YAHOO.util.Element.html#getElementsByTagName">getElementsByTagName</a>,
|
|
<a href="YAHOO.util.Element.html#getStyle">getStyle</a>,
|
|
<a href="YAHOO.util.Element.html#hasChildNodes">hasChildNodes</a>,
|
|
<a href="YAHOO.util.Element.html#hasClass">hasClass</a>,
|
|
<a href="YAHOO.util.Element.html#initAttributes">initAttributes</a>,
|
|
<a href="YAHOO.util.Element.html#insertBefore">insertBefore</a>,
|
|
<a href="YAHOO.util.Element.html#on">on</a>,
|
|
<a href="YAHOO.util.Element.html#removeChild">removeChild</a>,
|
|
<a href="YAHOO.util.Element.html#removeClass">removeClass</a>,
|
|
<a href="YAHOO.util.Element.html#removeListener">removeListener</a>,
|
|
<a href="YAHOO.util.Element.html#replaceChild">replaceChild</a>,
|
|
<a href="YAHOO.util.Element.html#replaceClass">replaceClass</a>,
|
|
<a href="YAHOO.util.Element.html#setStyle">setStyle</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 href="YAHOO.util.AttributeProvider.html#configureAttribute">configureAttribute</a>,
|
|
<a href="YAHOO.util.AttributeProvider.html#fireBeforeChangeEvent">fireBeforeChangeEvent</a>,
|
|
<a href="YAHOO.util.AttributeProvider.html#fireChangeEvent">fireChangeEvent</a>,
|
|
<a href="YAHOO.util.AttributeProvider.html#get">get</a>,
|
|
<a href="YAHOO.util.AttributeProvider.html#getAttributeConfig">getAttributeConfig</a>,
|
|
<a href="YAHOO.util.AttributeProvider.html#getAttributeKeys">getAttributeKeys</a>,
|
|
<a href="YAHOO.util.AttributeProvider.html#refresh">refresh</a>,
|
|
<a href="YAHOO.util.AttributeProvider.html#register">register</a>,
|
|
<a href="YAHOO.util.AttributeProvider.html#resetAttributeConfig">resetAttributeConfig</a>,
|
|
<a href="YAHOO.util.AttributeProvider.html#resetValue">resetValue</a>,
|
|
<a href="YAHOO.util.AttributeProvider.html#set">set</a>,
|
|
<a href="YAHOO.util.AttributeProvider.html#setAttributeConfig">setAttributeConfig</a>,
|
|
<a href="YAHOO.util.AttributeProvider.html#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 href="YAHOO.util.EventProvider.html#createEvent">createEvent</a>,
|
|
<a href="YAHOO.util.EventProvider.html#fireEvent">fireEvent</a>,
|
|
<a href="YAHOO.util.EventProvider.html#hasEvent">hasEvent</a>,
|
|
<a href="YAHOO.util.EventProvider.html#subscribe">subscribe</a>,
|
|
<a href="YAHOO.util.EventProvider.html#unsubscribe">unsubscribe</a>,
|
|
<a href="YAHOO.util.EventProvider.html#unsubscribeAll">unsubscribeAll</a>
|
|
</code>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section method details">
|
|
<h3><a name="methodDetails">Events</a></h3>
|
|
<div class="content">
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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 />
|
|
<h4>
|
|
<a name="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>
|
|
|
|
|
|
<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 href="YAHOO.util.Element.html#available">available</a>,
|
|
<a href="YAHOO.util.Element.html#contentReady">contentReady</a>
|
|
</code>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section field details">
|
|
<h3><a name="field_detail">Configuration Attributes</a></h3>
|
|
<div class="content">
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="menu">menu</a>
|
|
<code>- <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>String specifying the id attribute of the <code><div></code>
|
|
element used to create the menu.</li>
|
|
<li>String specifying the id attribute of the
|
|
<code><select></code> element used to create the menu.</li>
|
|
<li>Object specifying the <code><div></code> element used to
|
|
create the menu.</li>
|
|
<li>Object specifying the <code><select></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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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, // The handler to call when the
|
|
event fires.<br> <strong>obj:</strong> Object, // An object to
|
|
pass back to the handler.<br> <strong>scope:</strong> Object //
|
|
The object to use for the scope of the handler.<br> } </code>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: null
|
|
</div>
|
|
|
|
<hr />
|
|
<h4><a name="selectedMenuItem">selectedMenuItem</a>
|
|
<code>- <a href="YAHOO.widget.MenuItem.html">YAHOO.widget.MenuItem</a></code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Reference to the item in the button's menu that is
|
|
currently selected.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: null
|
|
</div>
|
|
|
|
<hr />
|
|
<h4><a name="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><input></code> or <code><span></code>) used to
|
|
create the button.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: null
|
|
</div>
|
|
|
|
<hr />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="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 />
|
|
<h4><a name="type">type</a>
|
|
<code>- String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
String specifying the button's type. Possible values are:
|
|
"button," "link," "submit," "reset," "checkbox," "radio," "menubutton,"
|
|
and "splitbutton."
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: "button"
|
|
</div>
|
|
|
|
<hr />
|
|
<h4><a name="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 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 href="YAHOO.util.Element.html#element">element</a>
|
|
</code>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="yui-b">
|
|
<div class="nav">
|
|
|
|
<div class="module">
|
|
<h4>Modules</h4>
|
|
<ul class="content">
|
|
|
|
<li class=""><a href="module_animation.html">animation</a></li>
|
|
|
|
<li class=""><a href="module_autocomplete.html">autocomplete</a></li>
|
|
|
|
<li class="selected"><a href="module_button.html">button</a></li>
|
|
|
|
<li class=""><a href="module_calendar.html">calendar</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_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_element.html">element</a></li>
|
|
|
|
<li class=""><a href="module_event.html">event</a></li>
|
|
|
|
<li class=""><a href="module_history.html">history</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_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_yahoo.html">yahoo</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><a href="#_activationButtonPressed">_activationButtonPressed</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#_activationKeyPressed">_activationKeyPressed</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#_button">_button</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#_hasKeyEventHandlers">_hasKeyEventHandlers</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#_hasMouseEventHandlers">_hasMouseEventHandlers</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#_hiddenField">_hiddenField</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#_menu">_menu</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#_onclickAttributeValue">_onclickAttributeValue</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#ACTIVATION_KEYS">ACTIVATION_KEYS</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#CHECK_ACTIVATION_KEYS">CHECK_ACTIVATION_KEYS</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#CHECKBOX_CHECKED_TITLE">CHECKBOX_CHECKED_TITLE</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#CHECKBOX_DEFAULT_TITLE">CHECKBOX_DEFAULT_TITLE</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#CSS_CLASS_NAME">CSS_CLASS_NAME</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#MENUBUTTON_DEFAULT_TITLE">MENUBUTTON_DEFAULT_TITLE</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#MENUBUTTON_MENU_VISIBLE_TITLE">MENUBUTTON_MENU_VISIBLE_TITLE</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#OPTION_AREA_WIDTH">OPTION_AREA_WIDTH</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#RADIO_CHECKED_TITLE">RADIO_CHECKED_TITLE</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#RADIO_DEFAULT_TITLE">RADIO_DEFAULT_TITLE</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#SPLITBUTTON_DEFAULT_TITLE">SPLITBUTTON_DEFAULT_TITLE</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#SPLITBUTTON_OPTION_VISIBLE_TITLE">SPLITBUTTON_OPTION_VISIBLE_TITLE</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#SUBMIT_TITLE">SUBMIT_TITLE</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li><a href="#TAG_NAME">TAG_NAME</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Methods</h4>
|
|
<ul class="content">
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_addListenersToForm">_addListenersToForm</a>
|
|
</li>
|
|
<li><!--<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="#_createButtonElement">_createButtonElement</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_hideMenu">_hideMenu</a>
|
|
</li>
|
|
<li><!--<code>Boolean</code>-->
|
|
<a href="#_isActivationKey">_isActivationKey</a>
|
|
</li>
|
|
<li><!--<code>Boolean</code>-->
|
|
<a href="#_isSplitButtonOptionKey">_isSplitButtonOptionKey</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_onAppendTo">_onAppendTo</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_onBlur">_onBlur</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_onClick">_onClick</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_onDocumentKeyUp">_onDocumentKeyUp</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_onDocumentMouseDown">_onDocumentMouseDown</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_onDocumentMouseUp">_onDocumentMouseUp</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_onFocus">_onFocus</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_onFormReset">_onFormReset</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_onFormSubmit">_onFormSubmit</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_onKeyDown">_onKeyDown</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_onKeyUp">_onKeyUp</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_onMenuClick">_onMenuClick</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_onMenuHide">_onMenuHide</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_onMenuItemAdded">_onMenuItemAdded</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_onMenuItemSelected">_onMenuItemSelected</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_onMenuKeyDown">_onMenuKeyDown</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_onMenuRender">_onMenuRender</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_onMenuShow">_onMenuShow</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_onMouseDown">_onMouseDown</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_onMouseOut">_onMouseOut</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_onMouseOver">_onMouseOver</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_onMouseUp">_onMouseUp</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_onOption">_onOption</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_setAccessKey">_setAccessKey</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_setChecked">_setChecked</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_setDisabled">_setDisabled</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_setHref">_setHref</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_setLabel">_setLabel</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_setMenu">_setMenu</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_setOnClick">_setOnClick</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_setTabIndex">_setTabIndex</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_setTarget">_setTarget</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_setTitle">_setTitle</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_setType">_setType</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#_showMenu">_showMenu</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#addHiddenFieldsToForm">addHiddenFieldsToForm</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#blur">blur</a>
|
|
</li>
|
|
<li><!--<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="#createHiddenField">createHiddenField</a>
|
|
</li>
|
|
<li><!--<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="#createInputElement">createInputElement</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#destroy">destroy</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#focus">focus</a>
|
|
</li>
|
|
<li><!--<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="#getFirstElement">getFirstElement</a>
|
|
</li>
|
|
<li><!--<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="#getForm">getForm</a>
|
|
</li>
|
|
<li><!--<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="#getHiddenField">getHiddenField</a>
|
|
</li>
|
|
<li><!--<code><a href="YAHOO.widget.Menu.html">YAHOO.widget.Menu</a></code>-->
|
|
<a href="#getMenu">getMenu</a>
|
|
</li>
|
|
<li><!--<code>Boolean</code>-->
|
|
<a href="#hasFocus">hasFocus</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#init">init</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#initAttributes">initAttributes</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#initConfig">initConfig</a>
|
|
</li>
|
|
<li><!--<code>Boolean</code>-->
|
|
<a href="#isActive">isActive</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#onFormKeyDown">onFormKeyDown</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#setAttributeFromDOMAttribute">setAttributeFromDOMAttribute</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#setAttributesFromSrcElement">setAttributesFromSrcElement</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#setFormElementProperties">setFormElementProperties</a>
|
|
</li>
|
|
<li><!--<code>void</code>-->
|
|
<a href="#submitForm">submitForm</a>
|
|
</li>
|
|
<li><!--<code>String</code>-->
|
|
<a href="#toString">toString</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Events</h4>
|
|
<ul class="content">
|
|
<li>
|
|
<a href="#blur">blur</a>
|
|
</li>
|
|
<li>
|
|
<a href="#focus">focus</a>
|
|
</li>
|
|
<li>
|
|
<a href="#option">option</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Configuration Attributes</h4>
|
|
<ul class="content">
|
|
<li>
|
|
<a href="#checked">checked</a>
|
|
</li>
|
|
<li>
|
|
<a href="#container">container</a>
|
|
</li>
|
|
<li>
|
|
<a href="#disabled">disabled</a>
|
|
</li>
|
|
<li>
|
|
<a href="#href">href</a>
|
|
</li>
|
|
<li>
|
|
<a href="#label">label</a>
|
|
</li>
|
|
<li>
|
|
<a href="#menu">menu</a>
|
|
</li>
|
|
<li>
|
|
<a href="#name">name</a>
|
|
</li>
|
|
<li>
|
|
<a href="#onclick">onclick</a>
|
|
</li>
|
|
<li>
|
|
<a href="#selectedMenuItem">selectedMenuItem</a>
|
|
</li>
|
|
<li>
|
|
<a href="#srcelement">srcelement</a>
|
|
</li>
|
|
<li>
|
|
<a href="#tabindex">tabindex</a>
|
|
</li>
|
|
<li>
|
|
<a href="#target">target</a>
|
|
</li>
|
|
<li>
|
|
<a href="#title">title</a>
|
|
</li>
|
|
<li>
|
|
<a href="#type">type</a>
|
|
</li>
|
|
<li>
|
|
<a href="#value">value</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="ft">
|
|
<hr />
|
|
Copyright © 2007 Yahoo! Inc. All rights reserved.
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|