webgui/www/extras/yui/docs/YAHOO.widget.Toolbar.html
2009-09-21 13:13:24 -05:00

3372 lines
210 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>API: editor YAHOO.widget.Toolbar (YUI Library)</title>
<link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" />
<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">
<h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1>
<h3>editor&nbsp; <span class="subtitle">2.8.0r4</span></h3>
<a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a>
&gt; <a href="./module_editor.html" title="editor">editor</a>
&gt; YAHOO.widget.Toolbar
<form onsubmit="return false">
<div id="propertysearch">
Search: <input autocomplete="off" id="searchinput" />
<div id="searchresults">
&nbsp;
</div>
</div>
</form>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form">
<fieldset>
<legend>Filters</legend>
<span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span>
<span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span>
<span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span>
</fieldset>
</form>
<h2>
Class <b property="yui:name">YAHOO.widget.Toolbar</b>
<span class="extends">
- extends <a href="YAHOO.util.Element.html" title="YAHOO.util.Element">YAHOO.util.Element</a>
</span>
</h2>
<!-- class tree goes here -->
<div class="summary description" property="yui:description">
Provides a rich toolbar widget based on the button and menu widgets
</div>
<div class="section constructor details" rel="yui:constructor" resource="#constructor">
<h3 id="constructor">Constructor</h3>
<div class="content">
<div class="detail">
<strong property="yui:name">YAHOO.widget.Toolbar</strong>
<code>
(
el
,
attrs
)
</code>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">el</span>
&lt;<span property="yui:type">String/HTMLElement</span>&gt;
</code>
<span property="yui:description"> The element to turn into a toolbar.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">attrs</span>
&lt;<span property="yui:type">Object</span>&gt;
</code>
<span property="yui:description"> Object liternal containing configuration parameters.</span>
</dd>
</dl>
</div>
</div>
</div>
</div>
<div rel="yui:properties" resource="#properties">
<div class="section field details">
<h3 id="properties">Properties</h3>
<div class="content">
<div class="protected" rel="yui:property" resource="#property__buttonGroupList">
<h4><a name="property__buttonGroupList" property="yui:name">_buttonGroupList</a>
- <code>protected <span property="yui:type">Array</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Internal property list of current button groups in the toolbar
</div>
</div>
<hr />
</div>
<div class="protected" rel="yui:property" resource="#property__buttonList">
<h4><a name="property__buttonList" property="yui:name">_buttonList</a>
- <code>protected <span property="yui:type">Array</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Internal property list of current buttons in the toolbar
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property__colorData">
<h4><a name="property__colorData" property="yui:name">_colorData</a>
- <code><span property="yui:type">Object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Object reference containing colors hex and text values.
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property__colorPicker">
<h4><a name="property__colorPicker" property="yui:name">_colorPicker</a>
- <code><span property="yui:type">HTMLElement</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The HTML Element containing the colorPicker
</div>
</div>
<hr />
</div>
<div class="protected" rel="yui:property" resource="#property__configuredButtons">
<h4><a name="property__configuredButtons" property="yui:name">_configuredButtons</a>
- <code>protected <span property="yui:type">Array</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:property" resource="#property__keyNav">
<h4><a name="property__keyNav" property="yui:name">_keyNav</a>
- <code>private <span property="yui:type">Boolean</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Flag to determine if the arrow nav listeners have been attached
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:property" resource="#property__navCounter">
<h4><a name="property__navCounter" property="yui:name">_navCounter</a>
- <code>private <span property="yui:type">Number</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Internal counter for walking the buttons in the toolbar with the arrow keys
</div>
</div>
<hr />
</div>
<div class="protected" rel="yui:property" resource="#property__sep">
<h4><a name="property__sep" property="yui:name">_sep</a>
- <code>protected <span property="yui:type">HTMLElement</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Internal reference to the separator HTML Element for cloning
</div>
</div>
<hr />
</div>
<div class="protected" rel="yui:property" resource="#property__sepCount">
<h4><a name="property__sepCount" property="yui:name">_sepCount</a>
- <code>protected <span property="yui:type">Number</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Internal refernce for counting separators, so we can give them a useful class name for styling
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property__titlebar">
<h4><a name="property__titlebar" property="yui:name">_titlebar</a>
- <code><span property="yui:type">HTMLElement</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Object reference to the titlebar
</div>
</div>
<hr />
</div>
<div class="protected" rel="yui:property" resource="#property__toolbarConfigs">
<h4><a name="property__toolbarConfigs" property="yui:name">_toolbarConfigs</a>
- <code>protected <span property="yui:type">Object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_browser">
<h4><a name="property_browser" property="yui:name">browser</a>
- <code><span property="yui:type">Object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Standard browser detection
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_buttonType">
<h4><a name="property_buttonType" property="yui:name">buttonType</a>
- <code><span property="yui:type">Object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The default button to use
</div>
</div>
<hr />
</div>
<div class="protected" rel="yui:property" resource="#property_CLASS_CONTAINER">
<h4><a name="property_CLASS_CONTAINER" property="yui:name">CLASS_CONTAINER</a>
- <code>protected <span property="yui:type">String</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Default CSS class to apply to the toolbar container element
</div>
</div>
<hr />
</div>
<div class="protected" rel="yui:property" resource="#property_CLASS_DISABLED">
<h4><a name="property_CLASS_DISABLED" property="yui:name">CLASS_DISABLED</a>
- <code>protected <span property="yui:type">String</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Default CSS class to apply when the toolbar is disabled
</div>
</div>
<hr />
</div>
<div class="protected" rel="yui:property" resource="#property_CLASS_DRAGHANDLE">
<h4><a name="property_CLASS_DRAGHANDLE" property="yui:name">CLASS_DRAGHANDLE</a>
- <code>protected <span property="yui:type">String</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Default CSS class to apply to the toolbar's drag handle element
</div>
</div>
<hr />
</div>
<div class="protected" rel="yui:property" resource="#property_CLASS_PREFIX">
<h4><a name="property_CLASS_PREFIX" property="yui:name">CLASS_PREFIX</a>
- <code>protected <span property="yui:type">String</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Default prefix for dynamically created class names
</div>
</div>
<hr />
</div>
<div class="protected" rel="yui:property" resource="#property_CLASS_SEPARATOR">
<h4><a name="property_CLASS_SEPARATOR" property="yui:name">CLASS_SEPARATOR</a>
- <code>protected <span property="yui:type">String</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Default CSS class to apply to all separators in the toolbar
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_dd">
<h4><a name="property_dd" property="yui:name">dd</a>
- <code><span property="yui:type">Object</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The DragDrop instance associated with the Toolbar
</div>
</div>
<hr />
</div>
<div class="protected" rel="yui:property" resource="#property_draghandle">
<h4><a name="property_draghandle" property="yui:name">draghandle</a>
- <code>protected <span property="yui:type">HTMLElement</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_STR_COLLAPSE">
<h4><a name="property_STR_COLLAPSE" property="yui:name">STR_COLLAPSE</a>
- <code><span property="yui:type">String</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
String for Toolbar Collapse Button
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_STR_EXPAND">
<h4><a name="property_STR_EXPAND" property="yui:name">STR_EXPAND</a>
- <code><span property="yui:type">String</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
String for Toolbar Collapse Button - Expand
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_STR_SPIN_DOWN">
<h4><a name="property_STR_SPIN_DOWN" property="yui:name">STR_SPIN_DOWN</a>
- <code><span property="yui:type">String</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
String for spinbutton down
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_STR_SPIN_LABEL">
<h4><a name="property_STR_SPIN_LABEL" property="yui:name">STR_SPIN_LABEL</a>
- <code><span property="yui:type">String</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
String for spinbutton dynamic label. Note the {VALUE} will be replaced with YAHOO.lang.substitute
</div>
</div>
<hr />
</div>
<div class="" rel="yui:property" resource="#property_STR_SPIN_UP">
<h4><a name="property_STR_SPIN_UP" property="yui:name">STR_SPIN_UP</a>
- <code><span property="yui:type">String</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
String for spinbutton up
</div>
</div>
<hr />
</div>
</div>
</div>
<div rel="yui:inheritance">
<div class="section field inheritance" rel="yui:superclass" resource="YAHOO.util.Element.html">
<h4>Properties inherited from <a href="YAHOO.util.Element.html" property="yui:name" title="YAHOO.util.Element">YAHOO.util.Element</a>:</h4>
<div class="content" rel="yui:properties">
<code>
<span rel="yui:property" resource="YAHOO.util.Element.html#property_DOM_EVENTS">
<a class="" href="YAHOO.util.Element.html#property_DOM_EVENTS" property="yui:name" title="DOM_EVENTS">DOM_EVENTS</a>
</span>
</code>
</div>
</div>
<div class="section field inheritance" rel="yui:superclass" resource="YAHOO.util.AttributeProvider.html">
<h4>Properties inherited from <a href="YAHOO.util.AttributeProvider.html" property="yui:name" title="YAHOO.util.AttributeProvider">YAHOO.util.AttributeProvider</a>:</h4>
<div class="content" rel="yui:properties">
<code>
<span rel="yui:property" resource="YAHOO.util.AttributeProvider.html#property__configs">
<a class="private" href="YAHOO.util.AttributeProvider.html#property__configs" property="yui:name" title="_configs">_configs</a>
</span>
</code>
</div>
</div>
</div>
</div>
<div rel="yui:methods" resource="#methods">
<div class="section method details">
<h3 id="methods">Methods</h3>
<div class="content">
<div class="private" rel="yui:method" resource="#method__addMenuClasses">
<h4>
<a name="method__addMenuClasses">_addMenuClasses</a></h4>
<div class="detail" >
<code>
private
void
<strong property="yui:name">_addMenuClasses</strong>
(
ev
,
na
,
o
)
</code>
<div class="description" property="yui:description">
This method is called from Menu's renderEvent to add a few more classes to the menu items
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">ev</span>
&lt;<span property="yui:type">String</span>&gt;
</code>
<span property="yui:description"> The event that fired.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">na</span>
&lt;<span property="yui:type">Array</span>&gt;
</code>
<span property="yui:description"> Array of event information.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">o</span>
&lt;<span property="yui:type">Object</span>&gt;
</code>
<span property="yui:description"> Button config object.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
void
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="protected" rel="yui:method" resource="#method__buttonClick">
<h4>
<a name="method__buttonClick">_buttonClick</a></h4>
<div class="detail" >
<code>
protected
void
<strong property="yui:name">_buttonClick</strong>
(
ev
,
info
)
</code>
<div class="description" property="yui:description">
Click handler for all buttons in the toolbar.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">ev</span>
&lt;<span property="yui:type">String</span>&gt;
</code>
<span property="yui:description"> The event that was passed in.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">info</span>
&lt;<span property="yui:type">Object</span>&gt;
</code>
<span property="yui:description"> Object literal of information about the button that was clicked.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
void
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__createColorPicker">
<h4>
<a name="method__createColorPicker">_createColorPicker</a></h4>
<div class="detail" >
<code>
private
void
<strong property="yui:name">_createColorPicker</strong>
(
id
)
</code>
<div class="description" property="yui:description">
Creates the core DOM reference to the color picker menu item.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">id</span>
&lt;<span property="yui:type">String</span>&gt;
</code>
<span property="yui:description"> the id of the toolbar to prefix this DOM container with.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
void
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__handleFocus">
<h4>
<a name="method__handleFocus">_handleFocus</a></h4>
<div class="detail" >
<code>
private
void
<strong property="yui:name">_handleFocus</strong>
(
)
</code>
<div class="description" property="yui:description">
Sets up the listeners for the arrow key navigation
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
void
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__makeColorButton">
<h4>
<a name="method__makeColorButton">_makeColorButton</a></h4>
<div class="detail" >
<code>
private
void
<strong property="yui:name">_makeColorButton</strong>
(
_oButton
)
</code>
<div class="description" property="yui:description">
Called to turn a "color" button into a menu button with an Overlay for the menu.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">_oButton</span>
&lt;<span property="yui:type">Object</span>&gt;
</code>
<span property="yui:description"> <a href="YAHOO.widget.ToolbarButton.html">YAHOO.widget.ToolbarButton</a> reference</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
void
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__makeSpinButton">
<h4>
<a name="method__makeSpinButton">_makeSpinButton</a></h4>
<div class="detail" >
<code>
private
void
<strong property="yui:name">_makeSpinButton</strong>
(
_button
,
oButton
)
</code>
<div class="description" property="yui:description">
Create a button similar to an OS Spin button.. It has an up/down arrow combo to scroll through a range of int values.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">_button</span>
&lt;<span property="yui:type">Object</span>&gt;
</code>
<span property="yui:description"> <a href="YAHOO.widget.ToolbarButton.html">YAHOO.widget.ToolbarButton</a> reference</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">oButton</span>
&lt;<span property="yui:type">Object</span>&gt;
</code>
<span property="yui:description"> Object literal containing the buttons initial config</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
void
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__navigateButtons">
<h4>
<a name="method__navigateButtons">_navigateButtons</a></h4>
<div class="detail" >
<code>
private
void
<strong property="yui:name">_navigateButtons</strong>
(
ev
)
</code>
<div class="description" property="yui:description">
Handles the navigation/focus of toolbar buttons with the Arrow Keys
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">ev</span>
&lt;<span property="yui:type">Event</span>&gt;
</code>
<span property="yui:description"> The Key Event</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
void
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="private" rel="yui:method" resource="#method__resetColorPicker">
<h4>
<a name="method__resetColorPicker">_resetColorPicker</a></h4>
<div class="detail" >
<code>
private
void
<strong property="yui:name">_resetColorPicker</strong>
(
)
</code>
<div class="description" property="yui:description">
Clears the currently selected color or mouseover color in the color picker.
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
void
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_addButton">
<h4>
<a name="method_addButton">addButton</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">addButton</strong>
(
oButton
,
after
)
</code>
<div class="description" property="yui:description">
Add a new button to the toolbar. Buttons supported:
push, split, menu, select, color, spin
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">oButton</span>
&lt;<span property="yui:type">Object</span>&gt;
</code>
<span property="yui:description"> Object literal reference to the Button's Config</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">after</span>
&lt;<span property="yui:type">HTMLElement</span>&gt;
</code>
<span property="yui:description"> Optional HTML element to insert this button after in the DOM.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
void
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_addButtonGroup">
<h4>
<a name="method_addButtonGroup">addButtonGroup</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">addButtonGroup</strong>
(
oGroup
)
</code>
<div class="description" property="yui:description">
Add a new button group to the toolbar. (uses addButton)
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">oGroup</span>
&lt;<span property="yui:type">Object</span>&gt;
</code>
<span property="yui:description"> Object literal reference to the Groups Config (contains an array of button configs as well as the group label)</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
void
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_addButtonToGroup">
<h4>
<a name="method_addButtonToGroup">addButtonToGroup</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">addButtonToGroup</strong>
(
oButton
,
group
,
after
)
</code>
<div class="description" property="yui:description">
Add a new button to a toolbar group. Buttons supported:
push, split, menu, select, color, spin
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">oButton</span>
&lt;<span property="yui:type">Object</span>&gt;
</code>
<span property="yui:description"> Object literal reference to the Button's Config</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">group</span>
&lt;<span property="yui:type">String</span>&gt;
</code>
<span property="yui:description"> The Group identifier passed into the initial config</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">after</span>
&lt;<span property="yui:type">HTMLElement</span>&gt;
</code>
<span property="yui:description"> Optional HTML element to insert this button after in the DOM.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
void
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_addSeparator">
<h4>
<a name="method_addSeparator">addSeparator</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">addSeparator</strong>
(
cont
,
after
)
</code>
<div class="description" property="yui:description">
Add a new button separator to the toolbar.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">cont</span>
&lt;<span property="yui:type">HTMLElement</span>&gt;
</code>
<span property="yui:description"> Optional HTML element to insert this button into.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">after</span>
&lt;<span property="yui:type">HTMLElement</span>&gt;
</code>
<span property="yui:description"> Optional HTML element to insert this button after in the DOM.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
void
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_collapse">
<h4>
<a name="method_collapse">collapse</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">collapse</strong>
(
collapse
)
</code>
<div class="description" property="yui:description">
Programatically collapse the toolbar.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">collapse</span>
&lt;<span property="yui:type">Boolean</span>&gt;
</code>
<span property="yui:description"> True to collapse, false to expand.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
void
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_deselectAllButtons">
<h4>
<a name="method_deselectAllButtons">deselectAllButtons</a></h4>
<div class="detail" >
<code>
Boolean
<strong property="yui:name">deselectAllButtons</strong>
(
)
</code>
<div class="description" property="yui:description">
Deselects all buttons in the toolbar.
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
Boolean
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_deselectButton">
<h4>
<a name="method_deselectButton">deselectButton</a></h4>
<div class="detail" >
<code>
Boolean
<strong property="yui:name">deselectButton</strong>
(
id
)
</code>
<div class="description" property="yui:description">
Deselects a button in the toolbar.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">id</span>
&lt;<span property="yui:type">String/Number</span>&gt;
</code>
<span property="yui:description"> Deselect a button by it's id, index or value.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
Boolean
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_destroy">
<h4>
<a name="method_destroy">destroy</a></h4>
<div class="detail" >
<code>
Boolean
<strong property="yui:name">destroy</strong>
(
)
</code>
<div class="description" property="yui:description">
Destroys the toolbar, all of it's elements and objects.
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
Boolean
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_destroyButton">
<h4>
<a name="method_destroyButton">destroyButton</a></h4>
<div class="detail" >
<code>
Boolean
<strong property="yui:name">destroyButton</strong>
(
id
)
</code>
<div class="description" property="yui:description">
Destroy a button in the toolbar.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">id</span>
&lt;<span property="yui:type">String/Number</span>&gt;
</code>
<span property="yui:description"> Destroy a button by it's id or index.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
Boolean
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_disableAllButtons">
<h4>
<a name="method_disableAllButtons">disableAllButtons</a></h4>
<div class="detail" >
<code>
Boolean
<strong property="yui:name">disableAllButtons</strong>
(
)
</code>
<div class="description" property="yui:description">
Disables all buttons in the toolbar.
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
Boolean
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_disableButton">
<h4>
<a name="method_disableButton">disableButton</a></h4>
<div class="detail" >
<code>
Boolean
<strong property="yui:name">disableButton</strong>
(
id
)
</code>
<div class="description" property="yui:description">
Disables a button in the toolbar.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">id</span>
&lt;<span property="yui:type">String/Number</span>&gt;
</code>
<span property="yui:description"> Disable a button by it's id, index or value.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
Boolean
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_enableAllButtons">
<h4>
<a name="method_enableAllButtons">enableAllButtons</a></h4>
<div class="detail" >
<code>
Boolean
<strong property="yui:name">enableAllButtons</strong>
(
)
</code>
<div class="description" property="yui:description">
Enables all buttons in the toolbar.
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
Boolean
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_enableButton">
<h4>
<a name="method_enableButton">enableButton</a></h4>
<div class="detail" >
<code>
Boolean
<strong property="yui:name">enableButton</strong>
(
id
)
</code>
<div class="description" property="yui:description">
Enables a button in the toolbar.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">id</span>
&lt;<span property="yui:type">String/Number</span>&gt;
</code>
<span property="yui:description"> Enable a button by it's id, index or value.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
Boolean
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_getButtonById">
<h4>
<a name="method_getButtonById">getButtonById</a></h4>
<div class="detail" >
<code>
<a href="YAHOO.widget.ToolbarButton.html">YAHOO.widget.ToolbarButton</a>
<strong property="yui:name">getButtonById</strong>
(
id
)
</code>
<div class="description" property="yui:description">
Gets a button instance from the toolbar by is Dom id.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">id</span>
&lt;<span property="yui:type">String</span>&gt;
</code>
<span property="yui:description"> The Dom id to query for.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
<a href="YAHOO.widget.ToolbarButton.html">YAHOO.widget.ToolbarButton</a>
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_getButtonByIndex">
<h4>
<a name="method_getButtonByIndex">getButtonByIndex</a></h4>
<div class="detail" >
<code>
<a href="YAHOO.widget.ToolbarButton.html">YAHOO.widget.ToolbarButton</a>
<strong property="yui:name">getButtonByIndex</strong>
(
index
)
</code>
<div class="description" property="yui:description">
Gets a button instance from the toolbar by is index in _buttonList.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">index</span>
&lt;<span property="yui:type">Number</span>&gt;
</code>
<span property="yui:description"> The index of the button in _buttonList.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
<a href="YAHOO.widget.ToolbarButton.html">YAHOO.widget.ToolbarButton</a>
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_getButtonByValue">
<h4>
<a name="method_getButtonByValue">getButtonByValue</a></h4>
<div class="detail" >
<code>
<a href="YAHOO.widget.ToolbarButton.html">YAHOO.widget.ToolbarButton</a> or <a href="YAHOO.widget.MenuItem.html">YAHOO.widget.MenuItem</a>
<strong property="yui:name">getButtonByValue</strong>
(
value
)
</code>
<div class="description" property="yui:description">
Gets a button instance or a menuitem instance from the toolbar by it's value.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">value</span>
&lt;<span property="yui:type">String</span>&gt;
</code>
<span property="yui:description"> The button value to query for.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
<a href="YAHOO.widget.ToolbarButton.html">YAHOO.widget.ToolbarButton</a> or <a href="YAHOO.widget.MenuItem.html">YAHOO.widget.MenuItem</a>
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_getButtons">
<h4>
<a name="method_getButtons">getButtons</a></h4>
<div class="detail" >
<code>
Array
<strong property="yui:name">getButtons</strong>
(
)
</code>
<div class="description" property="yui:description">
Returns an array of buttons in the current toolbar
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
Array
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_init">
<h4>
<a name="method_init">init</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">init</strong>
(
)
</code>
<div class="description" property="yui:description">
The Toolbar class's initialization method
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
void
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_initAttributes">
<h4>
<a name="method_initAttributes">initAttributes</a></h4>
<div class="detail" >
<code>
void
<strong property="yui:name">initAttributes</strong>
(
attr
)
</code>
<div class="description" property="yui:description">
Initializes all of the configuration attributes used to create
the toolbar.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">attr</span>
&lt;<span property="yui:type">Object</span>&gt;
</code>
<span property="yui:description"> Object literal specifying a set of
configuration attributes used to create the toolbar.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
void
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_isSelected">
<h4>
<a name="method_isSelected">isSelected</a></h4>
<div class="detail" >
<code>
Boolean
<strong property="yui:name">isSelected</strong>
(
id
)
</code>
<div class="description" property="yui:description">
Tells if a button is selected or not.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">id</span>
&lt;<span property="yui:type">String/Number</span>&gt;
</code>
<span property="yui:description"> A button by it's id, index or value.</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
Boolean
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_resetAllButtons">
<h4>
<a name="method_resetAllButtons">resetAllButtons</a></h4>
<div class="detail" >
<code>
Boolean
<strong property="yui:name">resetAllButtons</strong>
(
_ex
)
</code>
<div class="description" property="yui:description">
Resets all buttons to their initial state.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">_ex</span>
&lt;<span property="yui:type">Object</span>&gt;
</code>
<span property="yui:description"> Except these buttons</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
Boolean
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_selectButton">
<h4>
<a name="method_selectButton">selectButton</a></h4>
<div class="detail" >
<code>
Boolean
<strong property="yui:name">selectButton</strong>
(
id
,
value
)
</code>
<div class="description" property="yui:description">
Selects a button in the toolbar.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">id</span>
&lt;<span property="yui:type">String/Number</span>&gt;
</code>
<span property="yui:description"> Select a button by it's id, index or value.</span>
</dd>
<dd rel="yui:parameter">
<code><span property="yui:name">value</span>
&lt;<span property="yui:type">String</span>&gt;
</code>
<span property="yui:description"> If this is a Menu Button, check this item in the menu</span>
</dd>
</dl>
<dl>
<dt>Returns:
<code property="yui:return">
Boolean
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:method" resource="#method_toString">
<h4>
<a name="method_toString">toString</a></h4>
<div class="detail" >
<code>
String
<strong property="yui:name">toString</strong>
(
)
</code>
<div class="description" property="yui:description">
Returns a string representing the toolbar.
</div>
<div class="description">
<dl>
<dt>Returns:
<code property="yui:return">
String
</code></dt>
<dd property="yui:returnInfo"></dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
<div rel="yui:inheritance">
<div class="section field inheritance" rel="yui:superclass" resource="YAHOO.util.Element.html">
<h4>Methods inherited from <a href="YAHOO.util.Element.html" property="yui:name" title="YAHOO.util.Element">YAHOO.util.Element</a>:</h4>
<div class="content" rel="yui:methods">
<code>
<span rel="yui:method" resource="YAHOO.util.Element.html#method__setHTMLAttrConfig">
<a class="private" href="YAHOO.util.Element.html#method__setHTMLAttrConfig" property="yui:name" title="_setHTMLAttrConfig">_setHTMLAttrConfig</a><span class="private">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_addClass">
<a class="" href="YAHOO.util.Element.html#method_addClass" property="yui:name" title="addClass">addClass</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_addListener">
<a class="" href="YAHOO.util.Element.html#method_addListener" property="yui:name" title="addListener">addListener</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_appendChild">
<a class="" href="YAHOO.util.Element.html#method_appendChild" property="yui:name" title="appendChild">appendChild</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_appendTo">
<a class="" href="YAHOO.util.Element.html#method_appendTo" property="yui:name" title="appendTo">appendTo</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_delegate">
<a class="" href="YAHOO.util.Element.html#method_delegate" property="yui:name" title="delegate">delegate</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_fireQueue">
<a class="" href="YAHOO.util.Element.html#method_fireQueue" property="yui:name" title="fireQueue">fireQueue</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_getElementsByClassName">
<a class="" href="YAHOO.util.Element.html#method_getElementsByClassName" property="yui:name" title="getElementsByClassName">getElementsByClassName</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_getElementsByTagName">
<a class="" href="YAHOO.util.Element.html#method_getElementsByTagName" property="yui:name" title="getElementsByTagName">getElementsByTagName</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_getStyle">
<a class="" href="YAHOO.util.Element.html#method_getStyle" property="yui:name" title="getStyle">getStyle</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_hasChildNodes">
<a class="" href="YAHOO.util.Element.html#method_hasChildNodes" property="yui:name" title="hasChildNodes">hasChildNodes</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_hasClass">
<a class="" href="YAHOO.util.Element.html#method_hasClass" property="yui:name" title="hasClass">hasClass</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_initAttributes">
<a class="" href="YAHOO.util.Element.html#method_initAttributes" property="yui:name" title="initAttributes">initAttributes</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_insertBefore">
<a class="" href="YAHOO.util.Element.html#method_insertBefore" property="yui:name" title="insertBefore">insertBefore</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_on">
<a class="" href="YAHOO.util.Element.html#method_on" property="yui:name" title="on">on</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_removeChild">
<a class="" href="YAHOO.util.Element.html#method_removeChild" property="yui:name" title="removeChild">removeChild</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_removeClass">
<a class="" href="YAHOO.util.Element.html#method_removeClass" property="yui:name" title="removeClass">removeClass</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_removeDelegate">
<a class="" href="YAHOO.util.Element.html#method_removeDelegate" property="yui:name" title="removeDelegate">removeDelegate</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_removeListener">
<a class="" href="YAHOO.util.Element.html#method_removeListener" property="yui:name" title="removeListener">removeListener</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_replaceChild">
<a class="" href="YAHOO.util.Element.html#method_replaceChild" property="yui:name" title="replaceChild">replaceChild</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_replaceClass">
<a class="" href="YAHOO.util.Element.html#method_replaceClass" property="yui:name" title="replaceClass">replaceClass</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_setStyle">
<a class="" href="YAHOO.util.Element.html#method_setStyle" property="yui:name" title="setStyle">setStyle</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.Element.html#method_subscribe">
<a class="" href="YAHOO.util.Element.html#method_subscribe" property="yui:name" title="subscribe">subscribe</a>
</span>
</code>
</div>
</div>
<div class="section field inheritance" rel="yui:superclass" resource="YAHOO.util.AttributeProvider.html">
<h4>Methods inherited from <a href="YAHOO.util.AttributeProvider.html" property="yui:name" title="YAHOO.util.AttributeProvider">YAHOO.util.AttributeProvider</a>:</h4>
<div class="content" rel="yui:methods">
<code>
<span rel="yui:method" resource="YAHOO.util.AttributeProvider.html#method_configureAttribute">
<a class=" deprecated" href="YAHOO.util.AttributeProvider.html#method_configureAttribute" property="yui:name" title="configureAttribute">configureAttribute</a><span class=" deprecated">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.AttributeProvider.html#method_fireBeforeChangeEvent">
<a class="" href="YAHOO.util.AttributeProvider.html#method_fireBeforeChangeEvent" property="yui:name" title="fireBeforeChangeEvent">fireBeforeChangeEvent</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.AttributeProvider.html#method_fireChangeEvent">
<a class="" href="YAHOO.util.AttributeProvider.html#method_fireChangeEvent" property="yui:name" title="fireChangeEvent">fireChangeEvent</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.AttributeProvider.html#method_get">
<a class="" href="YAHOO.util.AttributeProvider.html#method_get" property="yui:name" title="get">get</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.AttributeProvider.html#method_getAttributeConfig">
<a class="private" href="YAHOO.util.AttributeProvider.html#method_getAttributeConfig" property="yui:name" title="getAttributeConfig">getAttributeConfig</a><span class="private">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.AttributeProvider.html#method_getAttributeKeys">
<a class="" href="YAHOO.util.AttributeProvider.html#method_getAttributeKeys" property="yui:name" title="getAttributeKeys">getAttributeKeys</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.AttributeProvider.html#method_refresh">
<a class="" href="YAHOO.util.AttributeProvider.html#method_refresh" property="yui:name" title="refresh">refresh</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.AttributeProvider.html#method_register">
<a class=" deprecated" href="YAHOO.util.AttributeProvider.html#method_register" property="yui:name" title="register">register</a><span class=" deprecated">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.AttributeProvider.html#method_resetAttributeConfig">
<a class="private" href="YAHOO.util.AttributeProvider.html#method_resetAttributeConfig" property="yui:name" title="resetAttributeConfig">resetAttributeConfig</a><span class="private">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.AttributeProvider.html#method_resetValue">
<a class="" href="YAHOO.util.AttributeProvider.html#method_resetValue" property="yui:name" title="resetValue">resetValue</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.AttributeProvider.html#method_set">
<a class="" href="YAHOO.util.AttributeProvider.html#method_set" property="yui:name" title="set">set</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.AttributeProvider.html#method_setAttributeConfig">
<a class="" href="YAHOO.util.AttributeProvider.html#method_setAttributeConfig" property="yui:name" title="setAttributeConfig">setAttributeConfig</a><span class="">,</span>
</span>
<span rel="yui:method" resource="YAHOO.util.AttributeProvider.html#method_setAttributes">
<a class="" href="YAHOO.util.AttributeProvider.html#method_setAttributes" property="yui:name" title="setAttributes">setAttributes</a>
</span>
</code>
</div>
</div>
</div>
</div>
<div rel="yui:events" resource="#events">
<div class="section method details">
<h3 id="events">Events</h3>
<div class="content">
<div class="" rel="yui:event" resource="#event_beforeButtonsChange">
<h4>
<a name="event_beforeButtonsChange">beforeButtonsChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">beforeButtonsChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires before the value for the configuration attribute 'buttons' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_beforeButtonTypeChange">
<h4>
<a name="event_beforeButtonTypeChange">beforeButtonTypeChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">beforeButtonTypeChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires before the value for the configuration attribute 'buttonType' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_beforeCollapseChange">
<h4>
<a name="event_beforeCollapseChange">beforeCollapseChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">beforeCollapseChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires before the value for the configuration attribute 'collapse' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_beforeDisabledChange">
<h4>
<a name="event_beforeDisabledChange">beforeDisabledChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">beforeDisabledChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires before the value for the configuration attribute 'disabled' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_beforeDraggableChange">
<h4>
<a name="event_beforeDraggableChange">beforeDraggableChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">beforeDraggableChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires before the value for the configuration attribute 'draggable' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_beforeGrouplabelsChange">
<h4>
<a name="event_beforeGrouplabelsChange">beforeGrouplabelsChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">beforeGrouplabelsChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires before the value for the configuration attribute 'grouplabels' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_beforeTitlebarChange">
<h4>
<a name="event_beforeTitlebarChange">beforeTitlebarChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">beforeTitlebarChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires before the value for the configuration attribute 'titlebar' changes. Return false to cancel the attribute change.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_buttonClick">
<h4>
<a name="event_buttonClick">buttonClick</a></h4>
<div class="detail">
<code>
<strong property="yui:name">buttonClick</strong>
(
o
)
</code>
<div class="description" property="yui:description">
Fires when any botton receives a click event. Passes back a single object representing the buttons config object. See <a href="YAHOO.util.Element.html#addListener">Element.addListener</a> for more information on listening for this event.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">o</span>
&lt;<span property="yui:type">Object</span>&gt;
</code>
<span property="yui:description"> The object passed to this handler is the button config used to create the button.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_buttonsChange">
<h4>
<a name="event_buttonsChange">buttonsChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">buttonsChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires when the value for the configuration attribute 'buttons' changes.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_buttonTypeChange">
<h4>
<a name="event_buttonTypeChange">buttonTypeChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">buttonTypeChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires when the value for the configuration attribute 'buttonType' changes.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_collapseChange">
<h4>
<a name="event_collapseChange">collapseChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">collapseChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires when the value for the configuration attribute 'collapse' changes.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_disabledChange">
<h4>
<a name="event_disabledChange">disabledChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">disabledChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires when the value for the configuration attribute 'disabled' changes.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_draggableChange">
<h4>
<a name="event_draggableChange">draggableChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">draggableChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires when the value for the configuration attribute 'draggable' changes.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_grouplabelsChange">
<h4>
<a name="event_grouplabelsChange">grouplabelsChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">grouplabelsChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires when the value for the configuration attribute 'grouplabels' changes.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_titlebarChange">
<h4>
<a name="event_titlebarChange">titlebarChange</a></h4>
<div class="detail">
<code>
<strong property="yui:name">titlebarChange</strong>
(
event
)
</code>
<div class="description" property="yui:description">
Fires when the value for the configuration attribute 'titlebar' changes.
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">event</span>
&lt;<span property="yui:type">{oldValue: any, newValue: any}</span>&gt;
</code>
<span property="yui:description">An object containing the previous attribute value and the new value.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:event" resource="#event_toolbarCollapsed">
<h4>
<a name="event_toolbarCollapsed">toolbarCollapsed</a></h4>
<div class="detail">
<code>
<strong property="yui:name">toolbarCollapsed</strong>
(
)
</code>
<div class="description" property="yui:description">
Fires when the toolbar is collapsed via the collapse button. 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="" rel="yui:event" resource="#event_toolbarExpanded">
<h4>
<a name="event_toolbarExpanded">toolbarExpanded</a></h4>
<div class="detail">
<code>
<strong property="yui:name">toolbarExpanded</strong>
(
)
</code>
<div class="description" property="yui:description">
Fires when the toolbar is expanded via the collapse button. 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="" rel="yui:event" resource="#event_valueClick">
<h4>
<a name="event_valueClick">valueClick</a></h4>
<div class="detail">
<code>
<strong property="yui:name">valueClick</strong>
(
o
)
</code>
<div class="description" property="yui:description">
This is a special dynamic event that is created and dispatched based on the value property
of the button config. See <a href="YAHOO.util.Element.html#addListener">Element.addListener</a> for more information on listening for this event.
Example:
<code><pre>
buttons : [
{ type: 'button', value: 'test', value: 'testButton' }
]</pre>
</code>
With the valueClick event you could subscribe to this buttons click event with this:
tbar.in('testButtonClick', function() { alert('test button clicked'); })
</div>
<div class="description">
<dl rel="yui:parameters">
<dt>Parameters:</dt>
<dd rel="yui:parameter">
<code><span property="yui:name">o</span>
&lt;<span property="yui:type">Object</span>&gt;
</code>
<span property="yui:description"> The object passed to this handler is the button config used to create the button.</span>
</dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
<div rel="yui:inheritance">
<div class="section field inheritance" rel="yui:superclass" resource="YAHOO.util.Element.html">
<h4>Events inherited from <a href="YAHOO.util.Element.html" property="yui:name" title="YAHOO.util.Element">YAHOO.util.Element</a>:</h4>
<div class="content" rel="yui:events">
<code>
<span rel="yui:event" resource="YAHOO.util.Element.html#event_appendTo">
<a class="" href="YAHOO.util.Element.html#event_appendTo" property="yui:name" title="appendTo">appendTo</a><span class="">,</span>
</span>
<span rel="yui:event" resource="YAHOO.util.Element.html#event_available">
<a class="" href="YAHOO.util.Element.html#event_available" property="yui:name" title="available">available</a><span class="">,</span>
</span>
<span rel="yui:event" resource="YAHOO.util.Element.html#event_beforeAppendTo">
<a class="" href="YAHOO.util.Element.html#event_beforeAppendTo" property="yui:name" title="beforeAppendTo">beforeAppendTo</a><span class="">,</span>
</span>
<span rel="yui:event" resource="YAHOO.util.Element.html#event_beforeElementChange">
<a class="" href="YAHOO.util.Element.html#event_beforeElementChange" property="yui:name" title="beforeElementChange">beforeElementChange</a><span class="">,</span>
</span>
<span rel="yui:event" resource="YAHOO.util.Element.html#event_contentReady">
<a class="" href="YAHOO.util.Element.html#event_contentReady" property="yui:name" title="contentReady">contentReady</a><span class="">,</span>
</span>
<span rel="yui:event" resource="YAHOO.util.Element.html#event_elementChange">
<a class="" href="YAHOO.util.Element.html#event_elementChange" property="yui:name" title="elementChange">elementChange</a><span class="">,</span>
</span>
</code>
</div>
</div>
</div>
</div>
<div rel="yui:attributes" resource="#configattributes">
<div class="section field details">
<h3 id="configattributes">Configuration Attributes</h3>
<div class="content">
<div class="" rel="yui:attribute" resource="#config_buttons">
<h4><a name="config_buttons">buttons</a>
<code>- <span property="yui:type">Array</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Object specifying the buttons to include in the toolbar
Example:
<code><pre>
{
{ id: 'b3', type: 'button', label: 'Underline', value: 'underline' },
{ type: 'separator' },
{ id: 'b4', type: 'menu', label: 'Align', value: 'align',
menu: [
{ text: "Left", value: 'alignleft' },
{ text: "Center", value: 'aligncenter' },
{ text: "Right", value: 'alignright' }
]
}
}
</pre></code>
</div>
</div>
<hr />
</div>
<div class="" rel="yui:attribute" resource="#config_buttonType">
<h4><a name="config_buttonType">buttonType</a>
<code>- <span property="yui:type">String</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The buttonType to use (advanced or basic)
</div>
</div>
<hr />
</div>
<div class="" rel="yui:attribute" resource="#config_collapse">
<h4><a name="config_collapse">collapse</a>
<code>- <span property="yui:type">Boolean</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Boolean indicating if the the titlebar should have a collapse button.
The collapse button will not remove the toolbar, it will minimize it to the titlebar
</div>
</div>
<div class="default">
Default Value: false
</div>
<hr />
</div>
<div class="" rel="yui:attribute" resource="#config_cont">
<h4><a name="config_cont">cont</a>
<code>- <span property="yui:type">HTMLElement</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
The container for the toolbar.
</div>
</div>
<hr />
</div>
<div class="" rel="yui:attribute" resource="#config_disabled">
<h4><a name="config_disabled">disabled</a>
<code>- <span property="yui:type">Boolean</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Boolean indicating if the toolbar should be disabled. It will also disable the draggable attribute if it is on.
</div>
</div>
<div class="default">
Default Value: false
</div>
<hr />
</div>
<div class="" rel="yui:attribute" resource="#config_draggable">
<h4><a name="config_draggable">draggable</a>
<code>- <span property="yui:type">Boolean</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Boolean indicating if the toolbar should be draggable.
</div>
</div>
<div class="default">
Default Value: false
</div>
<hr />
</div>
<div class="" rel="yui:attribute" resource="#config_grouplabels">
<h4><a name="config_grouplabels">grouplabels</a>
<code>- <span property="yui:type">Boolean</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Boolean indicating if the toolbar should show the group label's text string.
</div>
</div>
<div class="default">
Default Value: true
</div>
<hr />
</div>
<div class="" rel="yui:attribute" resource="#config_titlebar">
<h4><a name="config_titlebar">titlebar</a>
<code>- <span property="yui:type">Boolean or String</span></code>
</h4>
<div class="detail">
<div class="description" property="yui:description">
Boolean indicating if the toolbar should have a titlebar. If
passed a string, it will use that as the titlebar text
</div>
</div>
<div class="default">
Default Value: false
</div>
<hr />
</div>
</div>
</div>
<div rel="yui:inheritance">
<div class="section field inheritance" rel="yui:superclass" resource="YAHOO.util.Element.html">
<h4>Configuration attributes inherited from <a href="YAHOO.util.Element.html" property="yui:name" title="YAHOO.util.Element">YAHOO.util.Element</a>:</h4>
<div class="content" rel="yui:attributes">
<code>
<span rel="yui:attribute" resource="YAHOO.util.Element.html#config_element">
<a class="" href="YAHOO.util.Element.html#config_element" property="yui:name" title="element">element</a><span class="">,</span>
</span>
</code>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="yui-b">
<div class="nav">
<div id="moduleList" class="module">
<h4>Modules</h4>
<ul class="content">
<li class=""><a href="module_animation.html" title="animation">animation</a></li>
<li class=""><a href="module_autocomplete.html" title="autocomplete">autocomplete</a></li>
<li class=""><a href="module_button.html" title="button">button</a></li>
<li class=""><a href="module_calendar.html" title="calendar">calendar</a></li>
<li class=""><a href="module_carousel.html" title="carousel">carousel</a></li>
<li class=""><a href="module_charts.html" title="charts">charts</a></li>
<li class=""><a href="module_colorpicker.html" title="colorpicker">colorpicker</a></li>
<li class=""><a href="module_connection.html" title="connection">connection</a></li>
<li class=""><a href="module_container.html" title="container">container</a></li>
<li class=""><a href="module_cookie.html" title="cookie">cookie</a></li>
<li class=""><a href="module_datasource.html" title="datasource">datasource</a></li>
<li class=""><a href="module_datatable.html" title="datatable">datatable</a></li>
<li class=""><a href="module_datemath.html" title="datemath">datemath</a></li>
<li class=""><a href="module_dom.html" title="dom">dom</a></li>
<li class=""><a href="module_dragdrop.html" title="dragdrop">dragdrop</a></li>
<li class="selected"><a href="module_editor.html" title="editor">editor</a></li>
<li class=""><a href="module_element.html" title="element">element</a></li>
<li class=""><a href="module_element-delegate.html" title="element-delegate">element-delegate</a></li>
<li class=""><a href="module_event.html" title="event">event</a></li>
<li class=""><a href="module_event-delegate.html" title="event-delegate">event-delegate</a></li>
<li class=""><a href="module_event-mouseenter.html" title="event-mouseenter">event-mouseenter</a></li>
<li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li>
<li class=""><a href="module_get.html" title="get">get</a></li>
<li class=""><a href="module_history.html" title="history">history</a></li>
<li class=""><a href="module_imagecropper.html" title="imagecropper">imagecropper</a></li>
<li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li>
<li class=""><a href="module_json.html" title="json">json</a></li>
<li class=""><a href="module_layout.html" title="layout">layout</a></li>
<li class=""><a href="module_logger.html" title="logger">logger</a></li>
<li class=""><a href="module_menu.html" title="menu">menu</a></li>
<li class=""><a href="module_paginator.html" title="paginator">paginator</a></li>
<li class=""><a href="module_profiler.html" title="profiler">profiler</a></li>
<li class=""><a href="module_profilerviewer.html" title="profilerviewer">profilerviewer</a></li>
<li class=""><a href="module_progressbar.html" title="progressbar">progressbar</a></li>
<li class=""><a href="module_resize.html" title="resize">resize</a></li>
<li class=""><a href="module_selector.html" title="selector">selector</a></li>
<li class=""><a href="module_slider.html" title="slider">slider</a></li>
<li class=""><a href="module_storage.html" title="Storage">Storage</a></li>
<li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li>
<li class=""><a href="module_swf.html" title="swf">swf</a></li>
<li class=""><a href="module_swfdetect.html" title="swfdetect">swfdetect</a></li>
<li class=""><a href="module_swfstore.html" title="swfstore">swfstore</a></li>
<li class=""><a href="module_tabview.html" title="tabview">tabview</a></li>
<li class=""><a href="module_treeview.html" title="treeview">treeview</a></li>
<li class=""><a href="module_uploader.html" title="uploader">uploader</a></li>
<li class=""><a href="module_yahoo.html" title="yahoo">yahoo</a></li>
<li class=""><a href="module_yuiloader.html" title="yuiloader">yuiloader</a></li>
<li class=""><a href="module_yuitest.html" title="yuitest">yuitest</a></li>
</ul>
</div>
<div id="classList" class="module">
<h4>Classes</h4>
<ul class="content">
<li class=""><a href="YAHOO.widget.Editor.html" title="YAHOO.widget.Editor">YAHOO.widget.Editor</a></li>
<li class=""><a href="YAHOO.widget.EditorInfo.html" title="YAHOO.widget.EditorInfo">YAHOO.widget.EditorInfo</a></li>
<li class=""><a href="YAHOO.widget.EditorWindow.html" title="YAHOO.widget.EditorWindow">YAHOO.widget.EditorWindow</a></li>
<li class=""><a href="YAHOO.widget.SimpleEditor.html" title="YAHOO.widget.SimpleEditor">YAHOO.widget.SimpleEditor</a></li>
<li class="selected"><a href="YAHOO.widget.Toolbar.html" title="YAHOO.widget.Toolbar">YAHOO.widget.Toolbar</a></li>
<li class=""><a href="YAHOO.widget.ToolbarButton.html" title="YAHOO.widget.ToolbarButton">YAHOO.widget.ToolbarButton</a></li>
<li class=""><a href="YAHOO.widget.ToolbarButtonAdvanced.html" title="YAHOO.widget.ToolbarButtonAdvanced">YAHOO.widget.ToolbarButtonAdvanced</a></li>
</ul>
</div>
<div id="fileList" class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="editor.js.html" title="editor.js">editor.js</a></li>
<li class=""><a href="simple-editor.js.html" title="simple-editor.js">simple-editor.js</a></li>
<li class=""><a href="toolbar-button.js.html" title="toolbar-button.js">toolbar-button.js</a></li>
<li class=""><a href="toolbar.js.html" title="toolbar.js">toolbar.js</a></li>
</ul>
</div>
<div id="propertyList" class="module">
<h4>Properties</h4>
<ul class="content">
<li class="protected"><a href="#property__buttonGroupList" title="_buttonGroupList">_buttonGroupList</a></li>
<li class="protected"><a href="#property__buttonList" title="_buttonList">_buttonList</a></li>
<li class=""><a href="#property__colorData" title="_colorData">_colorData</a></li>
<li class=""><a href="#property__colorPicker" title="_colorPicker">_colorPicker</a></li>
<li class="protected"><a href="#property__configuredButtons" title="_configuredButtons">_configuredButtons</a></li>
<li class="private"><a href="#property__keyNav" title="_keyNav">_keyNav</a></li>
<li class="private"><a href="#property__navCounter" title="_navCounter">_navCounter</a></li>
<li class="protected"><a href="#property__sep" title="_sep">_sep</a></li>
<li class="protected"><a href="#property__sepCount" title="_sepCount">_sepCount</a></li>
<li class=""><a href="#property__titlebar" title="_titlebar">_titlebar</a></li>
<li class="protected"><a href="#property__toolbarConfigs" title="_toolbarConfigs">_toolbarConfigs</a></li>
<li class=""><a href="#property_browser" title="browser">browser</a></li>
<li class=""><a href="#property_buttonType" title="buttonType">buttonType</a></li>
<li class="protected"><a href="#property_CLASS_CONTAINER" title="CLASS_CONTAINER">CLASS_CONTAINER</a></li>
<li class="protected"><a href="#property_CLASS_DISABLED" title="CLASS_DISABLED">CLASS_DISABLED</a></li>
<li class="protected"><a href="#property_CLASS_DRAGHANDLE" title="CLASS_DRAGHANDLE">CLASS_DRAGHANDLE</a></li>
<li class="protected"><a href="#property_CLASS_PREFIX" title="CLASS_PREFIX">CLASS_PREFIX</a></li>
<li class="protected"><a href="#property_CLASS_SEPARATOR" title="CLASS_SEPARATOR">CLASS_SEPARATOR</a></li>
<li class=""><a href="#property_dd" title="dd">dd</a></li>
<li class="protected"><a href="#property_draghandle" title="draghandle">draghandle</a></li>
<li class=""><a href="#property_STR_COLLAPSE" title="STR_COLLAPSE">STR_COLLAPSE</a></li>
<li class=""><a href="#property_STR_EXPAND" title="STR_EXPAND">STR_EXPAND</a></li>
<li class=""><a href="#property_STR_SPIN_DOWN" title="STR_SPIN_DOWN">STR_SPIN_DOWN</a></li>
<li class=""><a href="#property_STR_SPIN_LABEL" title="STR_SPIN_LABEL">STR_SPIN_LABEL</a></li>
<li class=""><a href="#property_STR_SPIN_UP" title="STR_SPIN_UP">STR_SPIN_UP</a></li>
</ul>
</div>
<div id="methodsList" class="module">
<h4>Methods</h4>
<ul class="content">
<li class="private"><a href="#method__addMenuClasses" title="_addMenuClasses">_addMenuClasses</a></li>
<li class="protected"><a href="#method__buttonClick" title="_buttonClick">_buttonClick</a></li>
<li class="private"><a href="#method__createColorPicker" title="_createColorPicker">_createColorPicker</a></li>
<li class="private"><a href="#method__handleFocus" title="_handleFocus">_handleFocus</a></li>
<li class="private"><a href="#method__makeColorButton" title="_makeColorButton">_makeColorButton</a></li>
<li class="private"><a href="#method__makeSpinButton" title="_makeSpinButton">_makeSpinButton</a></li>
<li class="private"><a href="#method__navigateButtons" title="_navigateButtons">_navigateButtons</a></li>
<li class="private"><a href="#method__resetColorPicker" title="_resetColorPicker">_resetColorPicker</a></li>
<li class=""><a href="#method_addButton" title="addButton">addButton</a></li>
<li class=""><a href="#method_addButtonGroup" title="addButtonGroup">addButtonGroup</a></li>
<li class=""><a href="#method_addButtonToGroup" title="addButtonToGroup">addButtonToGroup</a></li>
<li class=""><a href="#method_addSeparator" title="addSeparator">addSeparator</a></li>
<li class=""><a href="#method_collapse" title="collapse">collapse</a></li>
<li class=""><a href="#method_deselectAllButtons" title="deselectAllButtons">deselectAllButtons</a></li>
<li class=""><a href="#method_deselectButton" title="deselectButton">deselectButton</a></li>
<li class=""><a href="#method_destroy" title="destroy">destroy</a></li>
<li class=""><a href="#method_destroyButton" title="destroyButton">destroyButton</a></li>
<li class=""><a href="#method_disableAllButtons" title="disableAllButtons">disableAllButtons</a></li>
<li class=""><a href="#method_disableButton" title="disableButton">disableButton</a></li>
<li class=""><a href="#method_enableAllButtons" title="enableAllButtons">enableAllButtons</a></li>
<li class=""><a href="#method_enableButton" title="enableButton">enableButton</a></li>
<li class=""><a href="#method_getButtonById" title="getButtonById">getButtonById</a></li>
<li class=""><a href="#method_getButtonByIndex" title="getButtonByIndex">getButtonByIndex</a></li>
<li class=""><a href="#method_getButtonByValue" title="getButtonByValue">getButtonByValue</a></li>
<li class=""><a href="#method_getButtons" title="getButtons">getButtons</a></li>
<li class=""><a href="#method_init" title="init">init</a></li>
<li class=""><a href="#method_initAttributes" title="initAttributes">initAttributes</a></li>
<li class=""><a href="#method_isSelected" title="isSelected">isSelected</a></li>
<li class=""><a href="#method_resetAllButtons" title="resetAllButtons">resetAllButtons</a></li>
<li class=""><a href="#method_selectButton" title="selectButton">selectButton</a></li>
<li class=""><a href="#method_toString" title="toString">toString</a></li>
</ul>
</div>
<div id="eventsList" class="module">
<h4>Events</h4>
<ul class="content">
<li class=""><a href="#event_beforeButtonsChange" title="beforeButtonsChange">beforeButtonsChange</a></li>
<li class=""><a href="#event_beforeButtonTypeChange" title="beforeButtonTypeChange">beforeButtonTypeChange</a></li>
<li class=""><a href="#event_beforeCollapseChange" title="beforeCollapseChange">beforeCollapseChange</a></li>
<li class=""><a href="#event_beforeDisabledChange" title="beforeDisabledChange">beforeDisabledChange</a></li>
<li class=""><a href="#event_beforeDraggableChange" title="beforeDraggableChange">beforeDraggableChange</a></li>
<li class=""><a href="#event_beforeGrouplabelsChange" title="beforeGrouplabelsChange">beforeGrouplabelsChange</a></li>
<li class=""><a href="#event_beforeTitlebarChange" title="beforeTitlebarChange">beforeTitlebarChange</a></li>
<li class=""><a href="#event_buttonClick" title="buttonClick">buttonClick</a></li>
<li class=""><a href="#event_buttonsChange" title="buttonsChange">buttonsChange</a></li>
<li class=""><a href="#event_buttonTypeChange" title="buttonTypeChange">buttonTypeChange</a></li>
<li class=""><a href="#event_collapseChange" title="collapseChange">collapseChange</a></li>
<li class=""><a href="#event_disabledChange" title="disabledChange">disabledChange</a></li>
<li class=""><a href="#event_draggableChange" title="draggableChange">draggableChange</a></li>
<li class=""><a href="#event_grouplabelsChange" title="grouplabelsChange">grouplabelsChange</a></li>
<li class=""><a href="#event_titlebarChange" title="titlebarChange">titlebarChange</a></li>
<li class=""><a href="#event_toolbarCollapsed" title="toolbarCollapsed">toolbarCollapsed</a></li>
<li class=""><a href="#event_toolbarExpanded" title="toolbarExpanded">toolbarExpanded</a></li>
<li class=""><a href="#event_valueClick" title="valueClick">valueClick</a></li>
</ul>
</div>
<div id="configList" class="module">
<h4>Configuration Attributes</h4>
<ul class="content">
<li class=""><a href="#config_buttons" title="buttons">buttons</a></li>
<li class=""><a href="#config_buttonType" title="buttonType">buttonType</a></li>
<li class=""><a href="#config_collapse" title="collapse">collapse</a></li>
<li class=""><a href="#config_cont" title="cont">cont</a></li>
<li class=""><a href="#config_disabled" title="disabled">disabled</a></li>
<li class=""><a href="#config_draggable" title="draggable">draggable</a></li>
<li class=""><a href="#config_grouplabels" title="grouplabels">grouplabels</a></li>
<li class=""><a href="#config_titlebar" title="titlebar">titlebar</a></li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright &copy; 2009 Yahoo! Inc. All rights reserved.
</div>
</div>
<script type="text/javascript">
ALL_YUI_PROPS = [{"access": "", "host": "YAHOO.widget.Toolbar", "name": "addButton", "url": "YAHOO.widget.Toolbar.html#method_addButton", "type": "method"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "addButtonGroup", "url": "YAHOO.widget.Toolbar.html#method_addButtonGroup", "type": "method"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "addButtonToGroup", "url": "YAHOO.widget.Toolbar.html#method_addButtonToGroup", "type": "method"}, {"access": "private", "host": "YAHOO.widget.Toolbar", "name": "_addMenuClasses", "url": "YAHOO.widget.Toolbar.html#method__addMenuClasses", "type": "method"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "addSeparator", "url": "YAHOO.widget.Toolbar.html#method_addSeparator", "type": "method"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "beforeButtonsChange", "url": "YAHOO.widget.Toolbar.html#event_beforeButtonsChange", "type": "event"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "beforeButtonTypeChange", "url": "YAHOO.widget.Toolbar.html#event_beforeButtonTypeChange", "type": "event"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "beforeCollapseChange", "url": "YAHOO.widget.Toolbar.html#event_beforeCollapseChange", "type": "event"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "beforeDisabledChange", "url": "YAHOO.widget.Toolbar.html#event_beforeDisabledChange", "type": "event"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "beforeDraggableChange", "url": "YAHOO.widget.Toolbar.html#event_beforeDraggableChange", "type": "event"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "beforeGrouplabelsChange", "url": "YAHOO.widget.Toolbar.html#event_beforeGrouplabelsChange", "type": "event"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "beforeTitlebarChange", "url": "YAHOO.widget.Toolbar.html#event_beforeTitlebarChange", "type": "event"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "browser", "url": "YAHOO.widget.Toolbar.html#property_browser", "type": "property"}, {"access": "protected", "host": "YAHOO.widget.Toolbar", "name": "_buttonClick", "url": "YAHOO.widget.Toolbar.html#method__buttonClick", "type": "method"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "buttonClick", "url": "YAHOO.widget.Toolbar.html#event_buttonClick", "type": "event"}, {"access": "protected", "host": "YAHOO.widget.Toolbar", "name": "_buttonGroupList", "url": "YAHOO.widget.Toolbar.html#property__buttonGroupList", "type": "property"}, {"access": "protected", "host": "YAHOO.widget.Toolbar", "name": "_buttonList", "url": "YAHOO.widget.Toolbar.html#property__buttonList", "type": "property"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "buttons", "url": "YAHOO.widget.Toolbar.html#config_buttons", "type": "config"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "buttonsChange", "url": "YAHOO.widget.Toolbar.html#event_buttonsChange", "type": "event"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "buttonType", "url": "YAHOO.widget.Toolbar.html#property_buttonType", "type": "property"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "buttonType", "url": "YAHOO.widget.Toolbar.html#config_buttonType", "type": "config"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "buttonTypeChange", "url": "YAHOO.widget.Toolbar.html#event_buttonTypeChange", "type": "event"}, {"access": "protected", "host": "YAHOO.widget.Toolbar", "name": "CLASS_CONTAINER", "url": "YAHOO.widget.Toolbar.html#property_CLASS_CONTAINER", "type": "property"}, {"access": "protected", "host": "YAHOO.widget.Toolbar", "name": "CLASS_DISABLED", "url": "YAHOO.widget.Toolbar.html#property_CLASS_DISABLED", "type": "property"}, {"access": "protected", "host": "YAHOO.widget.Toolbar", "name": "CLASS_DRAGHANDLE", "url": "YAHOO.widget.Toolbar.html#property_CLASS_DRAGHANDLE", "type": "property"}, {"access": "protected", "host": "YAHOO.widget.Toolbar", "name": "CLASS_PREFIX", "url": "YAHOO.widget.Toolbar.html#property_CLASS_PREFIX", "type": "property"}, {"access": "protected", "host": "YAHOO.widget.Toolbar", "name": "CLASS_SEPARATOR", "url": "YAHOO.widget.Toolbar.html#property_CLASS_SEPARATOR", "type": "property"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "collapse", "url": "YAHOO.widget.Toolbar.html#method_collapse", "type": "method"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "collapse", "url": "YAHOO.widget.Toolbar.html#config_collapse", "type": "config"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "collapseChange", "url": "YAHOO.widget.Toolbar.html#event_collapseChange", "type": "event"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "_colorData", "url": "YAHOO.widget.Toolbar.html#property__colorData", "type": "property"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "_colorPicker", "url": "YAHOO.widget.Toolbar.html#property__colorPicker", "type": "property"}, {"access": "protected", "host": "YAHOO.widget.Toolbar", "name": "_configuredButtons", "url": "YAHOO.widget.Toolbar.html#property__configuredButtons", "type": "property"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "cont", "url": "YAHOO.widget.Toolbar.html#config_cont", "type": "config"}, {"access": "private", "host": "YAHOO.widget.Toolbar", "name": "_createColorPicker", "url": "YAHOO.widget.Toolbar.html#method__createColorPicker", "type": "method"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "dd", "url": "YAHOO.widget.Toolbar.html#property_dd", "type": "property"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "deselectAllButtons", "url": "YAHOO.widget.Toolbar.html#method_deselectAllButtons", "type": "method"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "deselectButton", "url": "YAHOO.widget.Toolbar.html#method_deselectButton", "type": "method"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "destroy", "url": "YAHOO.widget.Toolbar.html#method_destroy", "type": "method"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "destroyButton", "url": "YAHOO.widget.Toolbar.html#method_destroyButton", "type": "method"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "disableAllButtons", "url": "YAHOO.widget.Toolbar.html#method_disableAllButtons", "type": "method"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "disableButton", "url": "YAHOO.widget.Toolbar.html#method_disableButton", "type": "method"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "disabled", "url": "YAHOO.widget.Toolbar.html#config_disabled", "type": "config"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "disabledChange", "url": "YAHOO.widget.Toolbar.html#event_disabledChange", "type": "event"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "draggable", "url": "YAHOO.widget.Toolbar.html#config_draggable", "type": "config"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "draggableChange", "url": "YAHOO.widget.Toolbar.html#event_draggableChange", "type": "event"}, {"access": "protected", "host": "YAHOO.widget.Toolbar", "name": "draghandle", "url": "YAHOO.widget.Toolbar.html#property_draghandle", "type": "property"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "enableAllButtons", "url": "YAHOO.widget.Toolbar.html#method_enableAllButtons", "type": "method"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "enableButton", "url": "YAHOO.widget.Toolbar.html#method_enableButton", "type": "method"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "getButtonById", "url": "YAHOO.widget.Toolbar.html#method_getButtonById", "type": "method"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "getButtonByIndex", "url": "YAHOO.widget.Toolbar.html#method_getButtonByIndex", "type": "method"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "getButtonByValue", "url": "YAHOO.widget.Toolbar.html#method_getButtonByValue", "type": "method"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "getButtons", "url": "YAHOO.widget.Toolbar.html#method_getButtons", "type": "method"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "grouplabels", "url": "YAHOO.widget.Toolbar.html#config_grouplabels", "type": "config"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "grouplabelsChange", "url": "YAHOO.widget.Toolbar.html#event_grouplabelsChange", "type": "event"}, {"access": "private", "host": "YAHOO.widget.Toolbar", "name": "_handleFocus", "url": "YAHOO.widget.Toolbar.html#method__handleFocus", "type": "method"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "init", "url": "YAHOO.widget.Toolbar.html#method_init", "type": "method"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "initAttributes", "url": "YAHOO.widget.Toolbar.html#method_initAttributes", "type": "method"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "isSelected", "url": "YAHOO.widget.Toolbar.html#method_isSelected", "type": "method"}, {"access": "private", "host": "YAHOO.widget.Toolbar", "name": "_keyNav", "url": "YAHOO.widget.Toolbar.html#property__keyNav", "type": "property"}, {"access": "private", "host": "YAHOO.widget.Toolbar", "name": "_makeColorButton", "url": "YAHOO.widget.Toolbar.html#method__makeColorButton", "type": "method"}, {"access": "private", "host": "YAHOO.widget.Toolbar", "name": "_makeSpinButton", "url": "YAHOO.widget.Toolbar.html#method__makeSpinButton", "type": "method"}, {"access": "private", "host": "YAHOO.widget.Toolbar", "name": "_navCounter", "url": "YAHOO.widget.Toolbar.html#property__navCounter", "type": "property"}, {"access": "private", "host": "YAHOO.widget.Toolbar", "name": "_navigateButtons", "url": "YAHOO.widget.Toolbar.html#method__navigateButtons", "type": "method"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "resetAllButtons", "url": "YAHOO.widget.Toolbar.html#method_resetAllButtons", "type": "method"}, {"access": "private", "host": "YAHOO.widget.Toolbar", "name": "_resetColorPicker", "url": "YAHOO.widget.Toolbar.html#method__resetColorPicker", "type": "method"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "selectButton", "url": "YAHOO.widget.Toolbar.html#method_selectButton", "type": "method"}, {"access": "protected", "host": "YAHOO.widget.Toolbar", "name": "_sep", "url": "YAHOO.widget.Toolbar.html#property__sep", "type": "property"}, {"access": "protected", "host": "YAHOO.widget.Toolbar", "name": "_sepCount", "url": "YAHOO.widget.Toolbar.html#property__sepCount", "type": "property"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "STR_COLLAPSE", "url": "YAHOO.widget.Toolbar.html#property_STR_COLLAPSE", "type": "property"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "STR_EXPAND", "url": "YAHOO.widget.Toolbar.html#property_STR_EXPAND", "type": "property"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "STR_SPIN_DOWN", "url": "YAHOO.widget.Toolbar.html#property_STR_SPIN_DOWN", "type": "property"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "STR_SPIN_LABEL", "url": "YAHOO.widget.Toolbar.html#property_STR_SPIN_LABEL", "type": "property"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "STR_SPIN_UP", "url": "YAHOO.widget.Toolbar.html#property_STR_SPIN_UP", "type": "property"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "_titlebar", "url": "YAHOO.widget.Toolbar.html#property__titlebar", "type": "property"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "titlebar", "url": "YAHOO.widget.Toolbar.html#config_titlebar", "type": "config"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "titlebarChange", "url": "YAHOO.widget.Toolbar.html#event_titlebarChange", "type": "event"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "toolbarCollapsed", "url": "YAHOO.widget.Toolbar.html#event_toolbarCollapsed", "type": "event"}, {"access": "protected", "host": "YAHOO.widget.Toolbar", "name": "_toolbarConfigs", "url": "YAHOO.widget.Toolbar.html#property__toolbarConfigs", "type": "property"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "toolbarExpanded", "url": "YAHOO.widget.Toolbar.html#event_toolbarExpanded", "type": "event"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "toString", "url": "YAHOO.widget.Toolbar.html#method_toString", "type": "method"}, {"access": "", "host": "YAHOO.widget.Toolbar", "name": "valueClick", "url": "YAHOO.widget.Toolbar.html#event_valueClick", "type": "event"}];
</script>
</body>
</html>