3179 lines
164 KiB
HTML
3179 lines
164 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
|
|
<html>
|
|
<head>
|
|
<title>API: editor YAHOO.widget.Toolbar (YUI Library)</title>
|
|
<link rel="stylesheet" type="text/css" href="assets/api.css">
|
|
<script type="text/javascript" src="assets/api-js"></script>
|
|
<script type="text/javascript" src="assets/ac-js"></script>
|
|
</head>
|
|
|
|
<body id="yahoo-com">
|
|
|
|
<div id="doc3" class="yui-t2">
|
|
|
|
<div id="hd">
|
|
<a href="http://developer.yahoo.com/yui/"><h1>Yahoo! UI Library</h1></a>
|
|
<h3>editor <span class="subtitle">2.5.1</span></h3>
|
|
<p>
|
|
<a href="./index.html">Yahoo! UI Library</a>
|
|
> <a href="./module_editor.html">editor</a>
|
|
> YAHOO.widget.Toolbar
|
|
|
|
</p>
|
|
|
|
</div>
|
|
|
|
<div id="bd">
|
|
<div id="yui-main">
|
|
<div class="yui-b">
|
|
<form name="yui-classopts-form">
|
|
<span id="classopts"><input type="checkbox" name="showprivate" id="showprivate" /> Show Private</span>
|
|
<span id="classopts"><input type="checkbox" name="showprotected" id="showprotected" /> Show Protected</span>
|
|
</form>
|
|
|
|
<h2>
|
|
|
|
|
|
|
|
|
|
Class <b>YAHOO.widget.Toolbar</b>
|
|
<span class="extends">
|
|
- extends <a href="YAHOO.util.Element.html">YAHOO.util.Element</a>
|
|
</span>
|
|
|
|
<span class="extends">
|
|
</span>
|
|
|
|
</code>
|
|
</h2>
|
|
<!-- class tree goes here -->
|
|
|
|
|
|
|
|
|
|
<div class="summary description">
|
|
Provides a rich toolbar widget based on the button and menu widgets
|
|
</div>
|
|
|
|
<div class="section constructor details">
|
|
<h3 id="constructor">Constructor</h3>
|
|
<div class="content">
|
|
<div class="detail">
|
|
<strong>YAHOO.widget.Toolbar</strong>
|
|
<code>
|
|
(
|
|
|
|
|
|
|
|
el
|
|
|
|
,
|
|
attrs
|
|
)
|
|
</code>
|
|
<div class="description">
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>el
|
|
<String/HTMLElement>
|
|
</code>
|
|
The element to turn into a toolbar.
|
|
</dd>
|
|
<dd>
|
|
<code>attrs
|
|
<Object>
|
|
</code>
|
|
Object liternal containing configuration parameters.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section field details">
|
|
<h3 id="properties">Properties</h3>
|
|
<div class="content">
|
|
<div class="protected">
|
|
<h4><a name="property__buttonGroupList">_buttonGroupList</a>
|
|
<code>- protected Array</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Internal property list of current button groups in the toolbar
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="protected">
|
|
<h4><a name="property__buttonList">_buttonList</a>
|
|
<code>- protected Array</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Internal property list of current buttons in the toolbar
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property__colorData">_colorData</a>
|
|
<code>- Object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Object reference containing colors hex and text values.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property__colorPicker">_colorPicker</a>
|
|
<code>- HTMLElement</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
The HTML Element containing the colorPicker
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property__keyNav">_keyNav</a>
|
|
<code>- private Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Flag to determine if the arrow nav listeners have been attached
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4><a name="property__navCounter">_navCounter</a>
|
|
<code>- private Number</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Internal counter for walking the buttons in the toolbar with the arrow keys
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="protected">
|
|
<h4><a name="property__sep">_sep</a>
|
|
<code>- protected HTMLElement</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Internal reference to the separator HTML Element for cloning
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="protected">
|
|
<h4><a name="property__sepCount">_sepCount</a>
|
|
<code>- protected Number</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Internal refernce for counting separators, so we can give them a useful class name for styling
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property__titlebar">_titlebar</a>
|
|
<code>- HTMLElement</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Object reference to the titlebar
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="protected">
|
|
<h4><a name="property__toolbarConfigs">_toolbarConfigs</a>
|
|
<code>- protected Object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_browser">browser</a>
|
|
<code>- Object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Standard browser detection
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_buttonType">buttonType</a>
|
|
<code>- Object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
The default button to use
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="protected">
|
|
<h4><a name="property_CLASS_CONTAINER">CLASS_CONTAINER</a>
|
|
<code>- protected String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Default CSS class to apply to the toolbar container element
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="protected">
|
|
<h4><a name="property_CLASS_DISABLED">CLASS_DISABLED</a>
|
|
<code>- protected String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Default CSS class to apply when the toolbar is disabled
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="protected">
|
|
<h4><a name="property_CLASS_DRAGHANDLE">CLASS_DRAGHANDLE</a>
|
|
<code>- protected String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Default CSS class to apply to the toolbar's drag handle element
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="protected">
|
|
<h4><a name="property_CLASS_PREFIX">CLASS_PREFIX</a>
|
|
<code>- protected String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Default prefix for dynamically created class names
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="protected">
|
|
<h4><a name="property_CLASS_SEPARATOR">CLASS_SEPARATOR</a>
|
|
<code>- protected String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Default CSS class to apply to all separators in the toolbar
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_dd">dd</a>
|
|
<code>- Object</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
The DragDrop instance associated with the Toolbar
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="protected">
|
|
<h4><a name="property_draghandle">draghandle</a>
|
|
<code>- protected HTMLElement</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_STR_COLLAPSE">STR_COLLAPSE</a>
|
|
<code>- String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
String for Toolbar Collapse Button
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_STR_SPIN_DOWN">STR_SPIN_DOWN</a>
|
|
<code>- String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
String for spinbutton down
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_STR_SPIN_LABEL">STR_SPIN_LABEL</a>
|
|
<code>- String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
String for spinbutton dynamic label. Note the {VALUE} will be replaced with YAHOO.lang.substitute
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="property_STR_SPIN_UP">STR_SPIN_UP</a>
|
|
<code>- String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
String for spinbutton up
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section field inheritance">
|
|
<h4>Properties inherited from <a href="YAHOO.util.Element.html">YAHOO.util.Element</a>:</h4>
|
|
<div class="content">
|
|
<code>
|
|
|
|
<a class="" href="YAHOO.util.Element.html#property_DOM_EVENTS">DOM_EVENTS</a>
|
|
</code>
|
|
</div>
|
|
</div>
|
|
<div class="section field inheritance">
|
|
<h4>Properties inherited from <a href="YAHOO.util.AttributeProvider.html">YAHOO.util.AttributeProvider</a>:</h4>
|
|
<div class="content">
|
|
<code>
|
|
|
|
<a class="private" href="YAHOO.util.AttributeProvider.html#property__configs">_configs</a>
|
|
</code>
|
|
</div>
|
|
</div>
|
|
<div class="section field inheritance">
|
|
<h4>Properties inherited from <a href="YAHOO.util.EventProvider.html">YAHOO.util.EventProvider</a>:</h4>
|
|
<div class="content">
|
|
<code>
|
|
|
|
<a class="private" href="YAHOO.util.EventProvider.html#property___yui_events">__yui_events</a><span class="private">,</span>
|
|
<a class="private" href="YAHOO.util.EventProvider.html#property___yui_subscribers">__yui_subscribers</a>
|
|
</code>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section method details">
|
|
<h3 id="methods">Methods</h3>
|
|
<div class="content">
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__addMenuClasses">_addMenuClasses</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_addMenuClasses</strong>
|
|
(
|
|
|
|
|
|
ev
|
|
|
|
|
|
,
|
|
na
|
|
|
|
|
|
,
|
|
o
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
This method is called from Menu's renderEvent to add a few more classes to the menu items
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>ev <String></code>
|
|
The event that fired.
|
|
</dd>
|
|
<dd>
|
|
<code>na <Array></code>
|
|
Array of event information.
|
|
</dd>
|
|
<dd>
|
|
<code>o <Object></code>
|
|
Button config object.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="protected">
|
|
<h4>
|
|
<a name="method__buttonClick">_buttonClick</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
protected
|
|
|
|
|
|
void
|
|
<strong>_buttonClick</strong>
|
|
(
|
|
|
|
|
|
ev
|
|
|
|
|
|
,
|
|
info
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Click handler for all buttons in the toolbar.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>ev <String></code>
|
|
The event that was passed in.
|
|
</dd>
|
|
<dd>
|
|
<code>info <Object></code>
|
|
Object literal of information about the button that was clicked.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__createColorPicker">_createColorPicker</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_createColorPicker</strong>
|
|
(
|
|
|
|
|
|
id
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Creates the core DOM reference to the color picker menu item.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>id <String></code>
|
|
the id of the toolbar to prefix this DOM container with.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__handleFocus">_handleFocus</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_handleFocus</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Sets up the listeners for the arrow key navigation
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__makeColorButton">_makeColorButton</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_makeColorButton</strong>
|
|
(
|
|
|
|
|
|
_oButton
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Called to turn a "color" button into a menu button with an Overlay for the menu.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>_oButton <Object></code>
|
|
<a href="YAHOO.widget.ToolbarButton.html">YAHOO.widget.ToolbarButton</a> reference
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__makeSpinButton">_makeSpinButton</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_makeSpinButton</strong>
|
|
(
|
|
|
|
|
|
_button
|
|
|
|
|
|
,
|
|
oButton
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="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>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>_button <Object></code>
|
|
<a href="YAHOO.widget.ToolbarButton.html">YAHOO.widget.ToolbarButton</a> reference
|
|
</dd>
|
|
<dd>
|
|
<code>oButton <Object></code>
|
|
Object literal containing the buttons initial config
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__navigateButtons">_navigateButtons</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_navigateButtons</strong>
|
|
(
|
|
|
|
|
|
ev
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Handles the navigation/focus of toolbar buttons with the Arrow Keys
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>ev <Event></code>
|
|
The Key Event
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="private">
|
|
<h4>
|
|
<a name="method__resetColorPicker">_resetColorPicker</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
private
|
|
|
|
|
|
void
|
|
<strong>_resetColorPicker</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Clears the currently selected color or mouseover color in the color picker.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_addButton">addButton</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>addButton</strong>
|
|
(
|
|
|
|
|
|
oButton
|
|
|
|
|
|
,
|
|
after
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Add a new button to the toolbar. Buttons supported:
|
|
push, split, menu, select, color, spin
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oButton <Object></code>
|
|
Object literal reference to the Button's Config
|
|
</dd>
|
|
<dd>
|
|
<code>after <HTMLElement></code>
|
|
Optional HTML element to insert this button after in the DOM.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_addButtonGroup">addButtonGroup</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>addButtonGroup</strong>
|
|
(
|
|
|
|
|
|
oGroup
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Add a new button group to the toolbar. (uses addButton)
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oGroup <Object></code>
|
|
Object literal reference to the Groups Config (contains an array of button configs as well as the group label)
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_addButtonToGroup">addButtonToGroup</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>addButtonToGroup</strong>
|
|
(
|
|
|
|
|
|
oButton
|
|
|
|
|
|
,
|
|
group
|
|
|
|
|
|
,
|
|
after
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Add a new button to a toolbar group. Buttons supported:
|
|
push, split, menu, select, color, spin
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>oButton <Object></code>
|
|
Object literal reference to the Button's Config
|
|
</dd>
|
|
<dd>
|
|
<code>group <String></code>
|
|
The Group identifier passed into the initial config
|
|
</dd>
|
|
<dd>
|
|
<code>after <HTMLElement></code>
|
|
Optional HTML element to insert this button after in the DOM.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_addSeparator">addSeparator</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>addSeparator</strong>
|
|
(
|
|
|
|
|
|
cont
|
|
|
|
|
|
,
|
|
after
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Add a new button separator to the toolbar.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>cont <HTMLElement></code>
|
|
Optional HTML element to insert this button into.
|
|
</dd>
|
|
<dd>
|
|
<code>after <HTMLElement></code>
|
|
Optional HTML element to insert this button after in the DOM.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_collapse">collapse</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>collapse</strong>
|
|
(
|
|
|
|
|
|
collapse
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Programatically collapse the toolbar.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>collapse <Boolean></code>
|
|
True to collapse, false to expand.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_deselectAllButtons">deselectAllButtons</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
Boolean
|
|
<strong>deselectAllButtons</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Deselects all buttons in the toolbar.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Boolean
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_deselectButton">deselectButton</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
Boolean
|
|
<strong>deselectButton</strong>
|
|
(
|
|
|
|
|
|
id
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Deselects a button in the toolbar.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>id <String/Number></code>
|
|
Deselect a button by it's id, index or value.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Boolean
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_destroy">destroy</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
Boolean
|
|
<strong>destroy</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Destroys the toolbar, all of it's elements and objects.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Boolean
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_destroyButton">destroyButton</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
Boolean
|
|
<strong>destroyButton</strong>
|
|
(
|
|
|
|
|
|
id
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Destroy a button in the toolbar.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>id <String/Number></code>
|
|
Destroy a button by it's id or index.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Boolean
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_disableAllButtons">disableAllButtons</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
Boolean
|
|
<strong>disableAllButtons</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Disables all buttons in the toolbar.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Boolean
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_disableButton">disableButton</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
Boolean
|
|
<strong>disableButton</strong>
|
|
(
|
|
|
|
|
|
id
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Disables a button in the toolbar.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>id <String/Number></code>
|
|
Disable a button by it's id, index or value.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Boolean
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_enableAllButtons">enableAllButtons</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
Boolean
|
|
<strong>enableAllButtons</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Enables all buttons in the toolbar.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Boolean
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_enableButton">enableButton</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
Boolean
|
|
<strong>enableButton</strong>
|
|
(
|
|
|
|
|
|
id
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Enables a button in the toolbar.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>id <String/Number></code>
|
|
Enable a button by it's id, index or value.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Boolean
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_getButtonById">getButtonById</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<a href="YAHOO.widget.ToolbarButton.html">YAHOO.widget.ToolbarButton</a>
|
|
<strong>getButtonById</strong>
|
|
(
|
|
|
|
|
|
id
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Gets a button instance from the toolbar by is Dom id.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>id <String></code>
|
|
The Dom id to query for.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
<a href="YAHOO.widget.ToolbarButton.html">YAHOO.widget.ToolbarButton</a>
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_getButtonByIndex">getButtonByIndex</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<a href="YAHOO.widget.ToolbarButton.html">YAHOO.widget.ToolbarButton</a>
|
|
<strong>getButtonByIndex</strong>
|
|
(
|
|
|
|
|
|
index
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Gets a button instance from the toolbar by is index in _buttonList.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>index <Number></code>
|
|
The index of the button in _buttonList.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
<a href="YAHOO.widget.ToolbarButton.html">YAHOO.widget.ToolbarButton</a>
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<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>getButtonByValue</strong>
|
|
(
|
|
|
|
|
|
value
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Gets a button instance or a menuitem instance from the toolbar by it's value.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>value <String></code>
|
|
The button value to query for.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
<a href="YAHOO.widget.ToolbarButton.html">YAHOO.widget.ToolbarButton</a> or <a href="YAHOO.widget.MenuItem.html">YAHOO.widget.MenuItem</a>
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_getButtons">getButtons</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
Array
|
|
<strong>getButtons</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Returns an array of buttons in the current toolbar
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Array
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_init">init</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>init</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
The Toolbar class's initialization method
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_initAttributes">initAttributes</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
void
|
|
<strong>initAttributes</strong>
|
|
(
|
|
|
|
|
|
attr
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Initializes all of the configuration attributes used to create
|
|
the toolbar.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>attr <Object></code>
|
|
Object literal specifying a set of
|
|
configuration attributes used to create the toolbar.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
void
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_isSelected">isSelected</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
Boolean
|
|
<strong>isSelected</strong>
|
|
(
|
|
|
|
|
|
id
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Tells if a button is selected or not.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>id <String/Number></code>
|
|
A button by it's id, index or value.
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Boolean
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_resetAllButtons">resetAllButtons</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
Boolean
|
|
<strong>resetAllButtons</strong>
|
|
(
|
|
|
|
|
|
_ex
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Resets all buttons to their initial state.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>_ex <Object></code>
|
|
Except these buttons
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Boolean
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_selectButton">selectButton</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
Boolean
|
|
<strong>selectButton</strong>
|
|
(
|
|
|
|
|
|
id
|
|
|
|
|
|
,
|
|
value
|
|
|
|
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Selects a button in the toolbar.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>id <String/Number></code>
|
|
Select a button by it's id, index or value.
|
|
</dd>
|
|
<dd>
|
|
<code>value <String></code>
|
|
If this is a Menu Button, check this item in the menu
|
|
</dd>
|
|
</dl>
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
Boolean
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="method_toString">toString</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
String
|
|
<strong>toString</strong>
|
|
(
|
|
)
|
|
</code>
|
|
|
|
<div class="description">
|
|
Returns a string representing the toolbar.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Returns:
|
|
<code>
|
|
String
|
|
</code></dt>
|
|
<dd></dd>
|
|
</dl>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section field inheritance">
|
|
<h4>Methods inherited from <a href="YAHOO.util.Element.html">YAHOO.util.Element</a>:</h4>
|
|
<div class="content">
|
|
<code>
|
|
<a class="private" href="YAHOO.util.Element.html#method__registerHTMLAttr">_registerHTMLAttr</a><span class="private">,</span> <a class="" href="YAHOO.util.Element.html#method_addClass">addClass</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_addListener">addListener</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_appendChild">appendChild</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_appendTo">appendTo</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_fireQueue">fireQueue</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_getElementsByClassName">getElementsByClassName</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_getElementsByTagName">getElementsByTagName</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_getStyle">getStyle</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_hasChildNodes">hasChildNodes</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_hasClass">hasClass</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_initAttributes">initAttributes</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_insertBefore">insertBefore</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_on">on</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_removeChild">removeChild</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_removeClass">removeClass</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_removeListener">removeListener</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_replaceChild">replaceChild</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_replaceClass">replaceClass</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_setStyle">setStyle</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#method_subscribe">subscribe</a>
|
|
</code>
|
|
</div>
|
|
</div>
|
|
<div class="section field inheritance">
|
|
<h4>Methods inherited from <a href="YAHOO.util.AttributeProvider.html">YAHOO.util.AttributeProvider</a>:</h4>
|
|
<div class="content">
|
|
<code>
|
|
<a class="" href="YAHOO.util.AttributeProvider.html#method_configureAttribute">configureAttribute</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_fireBeforeChangeEvent">fireBeforeChangeEvent</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_fireChangeEvent">fireChangeEvent</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_get">get</a><span class="">,</span> <a class="private" href="YAHOO.util.AttributeProvider.html#method_getAttributeConfig">getAttributeConfig</a><span class="private">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_getAttributeKeys">getAttributeKeys</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_refresh">refresh</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_register">register</a><span class="">,</span> <a class="private" href="YAHOO.util.AttributeProvider.html#method_resetAttributeConfig">resetAttributeConfig</a><span class="private">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_resetValue">resetValue</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_set">set</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_setAttributeConfig">setAttributeConfig</a><span class="">,</span> <a class="" href="YAHOO.util.AttributeProvider.html#method_setAttributes">setAttributes</a>
|
|
</code>
|
|
</div>
|
|
</div>
|
|
<div class="section field inheritance">
|
|
<h4>Methods inherited from <a href="YAHOO.util.EventProvider.html">YAHOO.util.EventProvider</a>:</h4>
|
|
<div class="content">
|
|
<code>
|
|
<a class="" href="YAHOO.util.EventProvider.html#method_createEvent">createEvent</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_fireEvent">fireEvent</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_hasEvent">hasEvent</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_subscribe">subscribe</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_unsubscribe">unsubscribe</a><span class="">,</span> <a class="" href="YAHOO.util.EventProvider.html#method_unsubscribeAll">unsubscribeAll</a>
|
|
</code>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section method details">
|
|
<h3 id="events">Events</h3>
|
|
<div class="content">
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_beforeButtonsChange">beforeButtonsChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>beforeButtonsChange</strong>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires before the value for the configuration attribute 'buttons' changes. Return false to cancel the attribute change.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the current attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_beforeButtonTypeChange">beforeButtonTypeChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>beforeButtonTypeChange</strong>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires before the value for the configuration attribute 'buttonType' changes. Return false to cancel the attribute change.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the current attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_beforeCollapseChange">beforeCollapseChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>beforeCollapseChange</strong>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires before the value for the configuration attribute 'collapse' changes. Return false to cancel the attribute change.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the current attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_beforeDisabledChange">beforeDisabledChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>beforeDisabledChange</strong>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires before the value for the configuration attribute 'disabled' changes. Return false to cancel the attribute change.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the current attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_beforeDraggableChange">beforeDraggableChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>beforeDraggableChange</strong>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires before the value for the configuration attribute 'draggable' changes. Return false to cancel the attribute change.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the current attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_beforeGrouplabelsChange">beforeGrouplabelsChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>beforeGrouplabelsChange</strong>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires before the value for the configuration attribute 'grouplabels' changes. Return false to cancel the attribute change.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the current attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_beforeTitlebarChange">beforeTitlebarChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>beforeTitlebarChange</strong>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires before the value for the configuration attribute 'titlebar' changes. Return false to cancel the attribute change.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the current attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_buttonClick">buttonClick</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>buttonClick</strong>
|
|
|
|
(
|
|
|
|
|
|
o
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="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>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>o <Object></code>
|
|
The object passed to this handler is the button config used to create the button.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_buttonsChange">buttonsChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>buttonsChange</strong>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'buttons' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_buttonTypeChange">buttonTypeChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>buttonTypeChange</strong>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'buttonType' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_collapseChange">collapseChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>collapseChange</strong>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'collapse' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_disabledChange">disabledChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>disabledChange</strong>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'disabled' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_draggableChange">draggableChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>draggableChange</strong>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'draggable' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_grouplabelsChange">grouplabelsChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>grouplabelsChange</strong>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'grouplabels' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_titlebarChange">titlebarChange</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>titlebarChange</strong>
|
|
|
|
(
|
|
|
|
|
|
eventInfo
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="description">
|
|
Fires when the value for the configuration attribute 'titlebar' changes.
|
|
</div>
|
|
|
|
<div class="description">
|
|
|
|
|
|
<dl>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>eventInfo <{oldValue: any, newValue: any}></code>
|
|
An object containing the previous attribute value and the new value.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4>
|
|
<a name="event_toolbarCollapsed">toolbarCollapsed</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>toolbarCollapsed</strong>
|
|
|
|
(
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="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="">
|
|
<h4>
|
|
<a name="event_toolbarExpanded">toolbarExpanded</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>toolbarExpanded</strong>
|
|
|
|
(
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="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="">
|
|
<h4>
|
|
<a name="event_valueClick">valueClick</a></h4>
|
|
<div class="detail">
|
|
<code>
|
|
|
|
|
|
|
|
<strong>valueClick</strong>
|
|
|
|
(
|
|
|
|
|
|
o
|
|
|
|
|
|
)
|
|
|
|
</code>
|
|
|
|
<div class="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>
|
|
<dt>Parameters:</dt>
|
|
<dd>
|
|
<code>o <Object></code>
|
|
The object passed to this handler is the button config used to create the button.
|
|
</dd>
|
|
</dl>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<hr />
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="section field inheritance">
|
|
<h4>Events inherited from <a href="YAHOO.util.Element.html">YAHOO.util.Element</a>:</h4>
|
|
<div class="content">
|
|
<code>
|
|
<a class="" href="YAHOO.util.Element.html#event_appendTo">appendTo</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#event_available">available</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#event_beforeAppendTo">beforeAppendTo</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#event_beforeElementChange">beforeElementChange</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#event_contentReady">contentReady</a><span class="">,</span> <a class="" href="YAHOO.util.Element.html#event_elementChange">elementChange</a><span class="">,</span>
|
|
</code>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="section field details">
|
|
<h3 id="configattributes">Configuration Attributes</h3>
|
|
<div class="content">
|
|
<div class="">
|
|
<h4><a name="config_buttons">buttons</a>
|
|
<code>- Array</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="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="">
|
|
<h4><a name="config_buttonType">buttonType</a>
|
|
<code>- String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
The buttonType to use (advanced or basic)
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="config_collapse">collapse</a>
|
|
<code>- Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="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="">
|
|
<h4><a name="config_cont">cont</a>
|
|
<code>- HTMLElement</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
The container for the toolbar.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="config_disabled">disabled</a>
|
|
<code>- Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Boolean indicating if the 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="">
|
|
<h4><a name="config_draggable">draggable</a>
|
|
<code>- Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="description">
|
|
Boolean indicating if the toolbar should be draggable.
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="default">
|
|
Default Value: false
|
|
</div>
|
|
|
|
<hr />
|
|
</div>
|
|
<div class="">
|
|
<h4><a name="config_grouplabels">grouplabels</a>
|
|
<code>- Boolean</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="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="">
|
|
<h4><a name="config_titlebar">titlebar</a>
|
|
<code>- Boolean or String</code>
|
|
</h4>
|
|
<div class="detail">
|
|
<div class="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 class="section field inheritance">
|
|
<h4>Configuration attributes inherited from <a href="YAHOO.util.Element.html">YAHOO.util.Element</a>:</h4>
|
|
<div class="content">
|
|
<code>
|
|
<a class="" href="YAHOO.util.Element.html#config_element">element</a><span class="">,</span>
|
|
</code>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="yui-b">
|
|
<div class="nav">
|
|
|
|
<div class="module">
|
|
<h4>Modules</h4>
|
|
<ul class="content">
|
|
|
|
<li class=""><a href="module_animation.html">animation</a></li>
|
|
|
|
<li class=""><a href="module_autocomplete.html">autocomplete</a></li>
|
|
|
|
<li class=""><a href="module_button.html">button</a></li>
|
|
|
|
<li class=""><a href="module_calendar.html">calendar</a></li>
|
|
|
|
<li class=""><a href="module_charts.html">charts</a></li>
|
|
|
|
<li class=""><a href="module_colorpicker.html">colorpicker</a></li>
|
|
|
|
<li class=""><a href="module_connection.html">connection</a></li>
|
|
|
|
<li class=""><a href="module_container.html">container</a></li>
|
|
|
|
<li class=""><a href="module_cookie.html">cookie</a></li>
|
|
|
|
<li class=""><a href="module_datasource.html">datasource</a></li>
|
|
|
|
<li class=""><a href="module_datatable.html">datatable</a></li>
|
|
|
|
<li class=""><a href="module_dom.html">dom</a></li>
|
|
|
|
<li class=""><a href="module_dragdrop.html">dragdrop</a></li>
|
|
|
|
<li class="selected"><a href="module_editor.html">editor</a></li>
|
|
|
|
<li class=""><a href="module_element.html">element</a></li>
|
|
|
|
<li class=""><a href="module_event.html">event</a></li>
|
|
|
|
<li class=""><a href="module_get.html">get</a></li>
|
|
|
|
<li class=""><a href="module_history.html">history</a></li>
|
|
|
|
<li class=""><a href="module_imagecropper.html">imagecropper</a></li>
|
|
|
|
<li class=""><a href="module_imageloader.html">imageloader</a></li>
|
|
|
|
<li class=""><a href="module_json.html">json</a></li>
|
|
|
|
<li class=""><a href="module_layout.html">layout</a></li>
|
|
|
|
<li class=""><a href="module_logger.html">logger</a></li>
|
|
|
|
<li class=""><a href="module_menu.html">menu</a></li>
|
|
|
|
<li class=""><a href="module_profiler.html">profiler</a></li>
|
|
|
|
<li class=""><a href="module_profilerviewer.html">profilerviewer</a></li>
|
|
|
|
<li class=""><a href="module_resize.html">resize</a></li>
|
|
|
|
<li class=""><a href="module_selector.html">selector</a></li>
|
|
|
|
<li class=""><a href="module_slider.html">slider</a></li>
|
|
|
|
<li class=""><a href="module_tabview.html">tabview</a></li>
|
|
|
|
<li class=""><a href="module_treeview.html">treeview</a></li>
|
|
|
|
<li class=""><a href="module_uploader.html">uploader</a></li>
|
|
|
|
<li class=""><a href="module_yahoo.html">yahoo</a></li>
|
|
|
|
<li class=""><a href="module_yuiloader.html">yuiloader</a></li>
|
|
|
|
<li class=""><a href="module_yuitest.html">yuitest</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Classes</h4>
|
|
<ul class="content">
|
|
<li class=""><a href="YAHOO.widget.Editor.html">YAHOO.widget.Editor</a></li>
|
|
<li class=""><a href="YAHOO.widget.EditorInfo.html">YAHOO.widget.EditorInfo</a></li>
|
|
<li class=""><a href="YAHOO.widget.EditorWindow.html">YAHOO.widget.EditorWindow</a></li>
|
|
<li class=""><a href="YAHOO.widget.SimpleEditor.html">YAHOO.widget.SimpleEditor</a></li>
|
|
<li class="selected"><a href="YAHOO.widget.Toolbar.html">YAHOO.widget.Toolbar</a></li>
|
|
<li class=""><a href="YAHOO.widget.ToolbarButton.html">YAHOO.widget.ToolbarButton</a></li>
|
|
<li class=""><a href="YAHOO.widget.ToolbarButtonAdvanced.html">YAHOO.widget.ToolbarButtonAdvanced</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Files</h4>
|
|
<ul class="content">
|
|
<li class=""><a href="editor.js.html">editor.js</a></li>
|
|
<li class=""><a href="simple-editor.js.html">simple-editor.js</a></li>
|
|
<li class=""><a href="toolbar-button.js.html">toolbar-button.js</a></li>
|
|
<li class=""><a href="toolbar.js.html">toolbar.js</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Properties</h4>
|
|
<ul class="content">
|
|
<li class="protected"><a href="#property__buttonGroupList">_buttonGroupList</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="protected"><a href="#property__buttonList">_buttonList</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property__colorData">_colorData</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property__colorPicker">_colorPicker</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__keyNav">_keyNav</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="private"><a href="#property__navCounter">_navCounter</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="protected"><a href="#property__sep">_sep</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="protected"><a href="#property__sepCount">_sepCount</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property__titlebar">_titlebar</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="protected"><a href="#property__toolbarConfigs">_toolbarConfigs</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_browser">browser</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_buttonType">buttonType</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="protected"><a href="#property_CLASS_CONTAINER">CLASS_CONTAINER</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="protected"><a href="#property_CLASS_DISABLED">CLASS_DISABLED</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="protected"><a href="#property_CLASS_DRAGHANDLE">CLASS_DRAGHANDLE</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="protected"><a href="#property_CLASS_PREFIX">CLASS_PREFIX</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="protected"><a href="#property_CLASS_SEPARATOR">CLASS_SEPARATOR</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_dd">dd</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class="protected"><a href="#property_draghandle">draghandle</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_STR_COLLAPSE">STR_COLLAPSE</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_STR_SPIN_DOWN">STR_SPIN_DOWN</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_STR_SPIN_LABEL">STR_SPIN_LABEL</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
<li class=""><a href="#property_STR_SPIN_UP">STR_SPIN_UP</a>
|
|
<!--<code><String></code>-->
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Methods</h4>
|
|
<ul class="content">
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__addMenuClasses">_addMenuClasses</a>
|
|
</li>
|
|
<li class="protected"><!--<code>void</code>-->
|
|
<a href="#method__buttonClick">_buttonClick</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__createColorPicker">_createColorPicker</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__handleFocus">_handleFocus</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__makeColorButton">_makeColorButton</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__makeSpinButton">_makeSpinButton</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__navigateButtons">_navigateButtons</a>
|
|
</li>
|
|
<li class="private"><!--<code>void</code>-->
|
|
<a href="#method__resetColorPicker">_resetColorPicker</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_addButton">addButton</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_addButtonGroup">addButtonGroup</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_addButtonToGroup">addButtonToGroup</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_addSeparator">addSeparator</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_collapse">collapse</a>
|
|
</li>
|
|
<li class=""><!--<code>Boolean</code>-->
|
|
<a href="#method_deselectAllButtons">deselectAllButtons</a>
|
|
</li>
|
|
<li class=""><!--<code>Boolean</code>-->
|
|
<a href="#method_deselectButton">deselectButton</a>
|
|
</li>
|
|
<li class=""><!--<code>Boolean</code>-->
|
|
<a href="#method_destroy">destroy</a>
|
|
</li>
|
|
<li class=""><!--<code>Boolean</code>-->
|
|
<a href="#method_destroyButton">destroyButton</a>
|
|
</li>
|
|
<li class=""><!--<code>Boolean</code>-->
|
|
<a href="#method_disableAllButtons">disableAllButtons</a>
|
|
</li>
|
|
<li class=""><!--<code>Boolean</code>-->
|
|
<a href="#method_disableButton">disableButton</a>
|
|
</li>
|
|
<li class=""><!--<code>Boolean</code>-->
|
|
<a href="#method_enableAllButtons">enableAllButtons</a>
|
|
</li>
|
|
<li class=""><!--<code>Boolean</code>-->
|
|
<a href="#method_enableButton">enableButton</a>
|
|
</li>
|
|
<li class=""><!--<code><a href="YAHOO.widget.ToolbarButton.html">YAHOO.widget.ToolbarButton</a></code>-->
|
|
<a href="#method_getButtonById">getButtonById</a>
|
|
</li>
|
|
<li class=""><!--<code><a href="YAHOO.widget.ToolbarButton.html">YAHOO.widget.ToolbarButton</a></code>-->
|
|
<a href="#method_getButtonByIndex">getButtonByIndex</a>
|
|
</li>
|
|
<li class=""><!--<code><a href="YAHOO.widget.ToolbarButton.html">YAHOO.widget.ToolbarButton</a> or <a href="YAHOO.widget.MenuItem.html">YAHOO.widget.MenuItem</a></code>-->
|
|
<a href="#method_getButtonByValue">getButtonByValue</a>
|
|
</li>
|
|
<li class=""><!--<code>Array</code>-->
|
|
<a href="#method_getButtons">getButtons</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_init">init</a>
|
|
</li>
|
|
<li class=""><!--<code>void</code>-->
|
|
<a href="#method_initAttributes">initAttributes</a>
|
|
</li>
|
|
<li class=""><!--<code>Boolean</code>-->
|
|
<a href="#method_isSelected">isSelected</a>
|
|
</li>
|
|
<li class=""><!--<code>Boolean</code>-->
|
|
<a href="#method_resetAllButtons">resetAllButtons</a>
|
|
</li>
|
|
<li class=""><!--<code>Boolean</code>-->
|
|
<a href="#method_selectButton">selectButton</a>
|
|
</li>
|
|
<li class=""><!--<code>String</code>-->
|
|
<a href="#method_toString">toString</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Events</h4>
|
|
<ul class="content">
|
|
<li class="">
|
|
<a href="#event_beforeButtonsChange">beforeButtonsChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_beforeButtonTypeChange">beforeButtonTypeChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_beforeCollapseChange">beforeCollapseChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_beforeDisabledChange">beforeDisabledChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_beforeDraggableChange">beforeDraggableChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_beforeGrouplabelsChange">beforeGrouplabelsChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_beforeTitlebarChange">beforeTitlebarChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_buttonClick">buttonClick</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_buttonsChange">buttonsChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_buttonTypeChange">buttonTypeChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_collapseChange">collapseChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_disabledChange">disabledChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_draggableChange">draggableChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_grouplabelsChange">grouplabelsChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_titlebarChange">titlebarChange</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_toolbarCollapsed">toolbarCollapsed</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_toolbarExpanded">toolbarExpanded</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#event_valueClick">valueClick</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="module">
|
|
<h4>Configuration Attributes</h4>
|
|
<ul class="content">
|
|
<li class="">
|
|
<a href="#config_buttons">buttons</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#config_buttonType">buttonType</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#config_collapse">collapse</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#config_cont">cont</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#config_disabled">disabled</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#config_draggable">draggable</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#config_grouplabels">grouplabels</a>
|
|
</li>
|
|
<li class="">
|
|
<a href="#config_titlebar">titlebar</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="ft">
|
|
<hr />
|
|
Copyright © 2007 Yahoo! Inc. All rights reserved.
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|