Simple status box for the sidebar.
[elgg_plugins.git] / yui / docs / YAHOO.widget.Button.html
blob395f53d52c919c0f5d2c4723e437f7fb970437cb
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
2 <html>
3 <head>
4 <title>API: button YAHOO.widget.Button (YUI Library)</title>
5 <link rel="stylesheet" type="text/css" href="assets/api.css">
6 </head>
8 <body id="yahoo-com">
9 <div id="doc3" class="yui-t2">
11 <div id="hd">
12 <h1>Yahoo! UI Library</h1>
13 <h3>Button&nbsp; <span class="subtitle">2.2.0</span></h3>
14 <p>
15 <a href="./index.html">Yahoo! UI Library</a>
16 &gt; <a href="./module_button.html">button</a>
17 &gt; YAHOO.widget.Button
19 </p>
20 </div>
22 <div id="bd">
23 <div id="yui-main">
24 <div class="yui-b">
27 <h2>
32 Class <b>YAHOO.widget.Button</b>
33 <span class="extends">
34 - extends <a href="YAHOO.util.Element.html">YAHOO.util.Element</a>
35 </span>
37 <span class="extends">
38 </span>
40 </code>
41 </h2>
42 <!-- class tree goes here -->
47 <div class="summary description">
48 The Button class creates a rich, graphical button.
49 </div>
51 <div class="section constructor details">
52 <h3><a name="constructor_detail">Constructor</a></h3>
53 <div class="content">
54 <div class="detail">
55 <strong>YAHOO.widget.Button</strong>
56 <code>
61 p_oElement
66 p_oAttributes
68 </code>
69 <div class="description">
70 <dl>
71 <dt>Parameters:</dt>
72 <dd>
73 <code>p_oElement
74 &lt;String&gt;
75 </code>
76 String specifying the id attribute of the
77 <code>&#60;input&#62;</code>, <code>&#60;a&#62;</code> or
78 <code>&#60;span&#62;</code> element to be used to create the button.
79 </dd>
80 <dd>
81 <code>p_oElement
82 &lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
83 one-html.html#ID-6043025">HTMLInputElement</a>|<a href="
84 http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.html#
85 ID-33759296">HTMLElement</a>&gt;
86 </code>
87 Object reference for the
88 <code>&#60;input&#62;</code>, <code>&#60;a&#62;</code> or
89 <code>&#60;span&#62;</code> element to be used to create the button.
90 </dd>
91 <dd>
92 <code>p_oElement
93 &lt;Object&gt;
94 </code>
95 Object literal specifying a set of configuration
96 attributes used to create the button.
97 </dd>
98 <dd>
99 <code>p_oAttributes
100 &lt;Object&gt;
101 </code>
102 Optional. Object literal specifying a set of
103 configuration attributes used to create the button.
104 </dd>
105 </dl>
108 </div>
109 </div>
110 </div>
111 </div>
113 <div class="section field details">
114 <h3><a name="field_detail">Properties</a></h3>
115 <div class="content">
116 <h4><a name="_activationButtonPressed">_activationButtonPressed</a>
117 <code>- protected Boolean</code>
118 </h4>
119 <div class="detail">
120 <div class="description">
121 Boolean indicating if the mouse button that toggles the button's
122 "active" state has been pressed.
123 </div>
124 </div>
127 <div class="default">
128 Default Value: false
129 </div>
132 <hr />
133 <h4><a name="_activationKeyPressed">_activationKeyPressed</a>
134 <code>- protected Boolean</code>
135 </h4>
136 <div class="detail">
137 <div class="description">
138 Boolean indicating if the key(s) that toggle the button's
139 "active" state have been pressed.
140 </div>
141 </div>
144 <div class="default">
145 Default Value: false
146 </div>
149 <hr />
150 <h4><a name="_button">_button</a>
151 <code>- protected <a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
152 one-html.html#ID-48250443">HTMLAnchorElement</a>|<a href="
153 http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.html#ID-
154 34812697">HTMLButtonElement</a></code>
155 </h4>
156 <div class="detail">
157 <div class="description">
158 Object reference to the button's internal
159 <code>&#60;a&#62;</code> or <code>&#60;button&#62;</code> element.
160 </div>
161 </div>
164 <div class="default">
165 Default Value: null
166 </div>
169 <hr />
170 <h4><a name="_hasKeyEventHandlers">_hasKeyEventHandlers</a>
171 <code>- protected Boolean</code>
172 </h4>
173 <div class="detail">
174 <div class="description">
175 Boolean indicating if the button's "blur", "keydown" and
176 "keyup" event handlers are assigned
177 </div>
178 </div>
181 <div class="default">
182 Default Value: false
183 </div>
186 <hr />
187 <h4><a name="_hasMouseEventHandlers">_hasMouseEventHandlers</a>
188 <code>- protected Boolean</code>
189 </h4>
190 <div class="detail">
191 <div class="description">
192 Boolean indicating if the button's "mouseout" and "mousedown"
193 and "mouseup" event handlers are assigned
194 </div>
195 </div>
198 <div class="default">
199 Default Value: false
200 </div>
203 <hr />
204 <h4><a name="_menu">_menu</a>
205 <code>- protected <a href="YAHOO.widget.Menu.html">YAHOO.widget.Menu</a></code>
206 </h4>
207 <div class="detail">
208 <div class="description">
209 Object reference to the button's menu.
210 </div>
211 </div>
214 <div class="default">
215 Default Value: null
216 </div>
219 <hr />
220 <h4><a name="_onclickAttributeValue">_onclickAttributeValue</a>
221 <code>- protected Object</code>
222 </h4>
223 <div class="detail">
224 <div class="description">
225 Object reference to the button's current value for the "onclick"
226 configuration attribute.
227 </div>
228 </div>
231 <div class="default">
232 Default Value: null
233 </div>
236 <hr />
237 <h4><a name="_oninitAttributeValue">_oninitAttributeValue</a>
238 <code>- protected Object</code>
239 </h4>
240 <div class="detail">
241 <div class="description">
242 Object reference to the button's current value for the "oninit"
243 configuration attribute.
244 </div>
245 </div>
248 <div class="default">
249 Default Value: null
250 </div>
253 <hr />
254 <h4><a name="ACTIVATION_KEYS">ACTIVATION_KEYS</a>
255 <code>- final Array</code>
256 </h4>
257 <div class="detail">
258 <div class="description">
259 Array of numbers representing keys that (when presed) toggle
260 the button's "active" state.
261 </div>
262 </div>
265 <div class="default">
266 Default Value: [13, 32]
267 </div>
270 <hr />
271 <h4><a name="CHECK_ACTIVATION_KEYS">CHECK_ACTIVATION_KEYS</a>
272 <code>- final Array</code>
273 </h4>
274 <div class="detail">
275 <div class="description">
276 Array of numbers representing keys that (when pressed) toggle
277 the button's "checked" attribute.
278 </div>
279 </div>
282 <div class="default">
283 Default Value: [32]
284 </div>
287 <hr />
288 <h4><a name="CHECKBOX_CHECKED_TITLE">CHECKBOX_CHECKED_TITLE</a>
289 <code>- final String</code>
290 </h4>
291 <div class="detail">
292 <div class="description">
293 String representing the title applied to buttons of type
294 "checkbox" when checked.
295 </div>
296 </div>
299 <div class="default">
300 Default Value: "Checked. Click to uncheck."
301 </div>
304 <hr />
305 <h4><a name="CHECKBOX_DEFAULT_TITLE">CHECKBOX_DEFAULT_TITLE</a>
306 <code>- final String</code>
307 </h4>
308 <div class="detail">
309 <div class="description">
310 String representing the default title applied to buttons of
311 type "checkbox."
312 </div>
313 </div>
316 <div class="default">
317 Default Value: "Unchecked. Click to check."
318 </div>
321 <hr />
322 <h4><a name="CSS_CLASS_NAME">CSS_CLASS_NAME</a>
323 <code>- final String</code>
324 </h4>
325 <div class="detail">
326 <div class="description">
327 String representing the CSS class(es) to be applied to the
328 button's root element.
329 </div>
330 </div>
333 <div class="default">
334 Default Value: "yuibutton"
335 </div>
338 <hr />
339 <h4><a name="MENUBUTTON_DEFAULT_TITLE">MENUBUTTON_DEFAULT_TITLE</a>
340 <code>- final String</code>
341 </h4>
342 <div class="detail">
343 <div class="description">
344 String representing the default title applied to buttons of
345 type "menubutton."
346 </div>
347 </div>
350 <div class="default">
351 Default Value: "Menu collapsed. Click to expand."
352 </div>
355 <hr />
356 <h4><a name="MENUBUTTON_MENU_VISIBLE_TITLE">MENUBUTTON_MENU_VISIBLE_TITLE</a>
357 <code>- final String</code>
358 </h4>
359 <div class="detail">
360 <div class="description">
361 String representing the title applied to buttons of type
362 "menubutton" when the button's menu is visible.
363 </div>
364 </div>
367 <div class="default">
368 Default Value: "Menu expanded. Click or press Esc to collapse."
369 </div>
372 <hr />
373 <h4><a name="OPTION_AREA_WIDTH">OPTION_AREA_WIDTH</a>
374 <code>- final Number</code>
375 </h4>
376 <div class="detail">
377 <div class="description">
378 Width (in pixels) of the area of a split button that when
379 pressed will display a menu.
380 </div>
381 </div>
384 <div class="default">
385 Default Value: 20
386 </div>
389 <hr />
390 <h4><a name="RADIO_CHECKED_TITLE">RADIO_CHECKED_TITLE</a>
391 <code>- final String</code>
392 </h4>
393 <div class="detail">
394 <div class="description">
395 String representing the title applied to buttons of type "radio"
396 when checked.
397 </div>
398 </div>
401 <div class="default">
402 Default Value: "Checked. Click to uncheck."
403 </div>
406 <hr />
407 <h4><a name="RADIO_DEFAULT_TITLE">RADIO_DEFAULT_TITLE</a>
408 <code>- final String</code>
409 </h4>
410 <div class="detail">
411 <div class="description">
412 String representing the default title applied to buttons of
413 type "radio."
414 </div>
415 </div>
418 <div class="default">
419 Default Value: "Unchecked. Click to check."
420 </div>
423 <hr />
424 <h4><a name="SPLITBUTTON_DEFAULT_TITLE">SPLITBUTTON_DEFAULT_TITLE</a>
425 <code>- final String</code>
426 </h4>
427 <div class="detail">
428 <div class="description">
429 String representing the default title applied to buttons of
430 type "splitebutton."
431 </div>
432 </div>
435 <div class="default">
436 Default Value: "Menu collapsed. Click inside option region or press
437 Ctrl + Shift + M to show the menu."
438 </div>
441 <hr />
442 <h4><a name="SPLITBUTTON_OPTION_VISIBLE_TITLE">SPLITBUTTON_OPTION_VISIBLE_TITLE</a>
443 <code>- final String</code>
444 </h4>
445 <div class="detail">
446 <div class="description">
447 String representing the title applied to buttons of type
448 "splitbutton" when the button's menu is visible.
449 </div>
450 </div>
453 <div class="default">
454 Default Value: "Menu expanded. Press Esc or Ctrl + Shift + M to hide the menu."
455 </div>
458 <hr />
459 <h4><a name="SUBMIT_TITLE">SUBMIT_TITLE</a>
460 <code>- final String</code>
461 </h4>
462 <div class="detail">
463 <div class="description">
464 String representing the title applied to buttons of
465 type "submit."
466 </div>
467 </div>
470 <div class="default">
471 Default Value: "Click to submit form."
472 </div>
475 <hr />
476 <h4><a name="TAG_NAME">TAG_NAME</a>
477 <code>- final String</code>
478 </h4>
479 <div class="detail">
480 <div class="description">
481 The name of the tag to be used for the button's root element.
482 </div>
483 </div>
486 <div class="default">
487 Default Value: "SPAN"
488 </div>
491 <hr />
494 </div>
495 </div>
497 <div class="section field inheritance">
498 <h4>Properties inherited from <a href="YAHOO.util.Element.html">YAHOO.util.Element</a>:</h4>
499 <div class="content">
500 <code>
502 <a href="YAHOO.util.Element.html#DOM_EVENTS">DOM_EVENTS</a>
503 </code>
504 </div>
505 </div>
506 <div class="section field inheritance">
507 <h4>Properties inherited from <a href="YAHOO.util.AttributeProvider.html">YAHOO.util.AttributeProvider</a>:</h4>
508 <div class="content">
509 <code>
511 <a href="YAHOO.util.AttributeProvider.html#_configs">_configs</a>
512 </code>
513 </div>
514 </div>
515 <div class="section field inheritance">
516 <h4>Properties inherited from <a href="YAHOO.util.EventProvider.html">YAHOO.util.EventProvider</a>:</h4>
517 <div class="content">
518 <code>
520 <a href="YAHOO.util.EventProvider.html#__yui_events">__yui_events</a>,
521 <a href="YAHOO.util.EventProvider.html#__yui_subscribers">__yui_subscribers</a>
522 </code>
523 </div>
524 </div>
526 <div class="section method details">
527 <h3><a name="methodDetails">Methods</a></h3>
528 <div class="content">
529 <h4>
530 <a name="_createButtonElement">_createButtonElement</a></h4>
531 <div class="detail">
532 <code>
533 protected
536 <a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
537 level-one-html.html#ID-58190037">HTMLElement</a>
538 <strong>_createButtonElement</strong>
542 p_sType
546 </code>
548 <div class="description">
549 Creates the button's element.
550 </div>
552 <div class="description">
554 <dl>
555 <dt>Parameters:</dt>
556 <dd>
557 <code>p_sType &lt;String&gt;</code>
558 String indicating the type of element to create.
559 </dd>
560 </dl>
562 <dl>
563 <dt>Returns:
564 <code>
565 <a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
566 level-one-html.html#ID-58190037">HTMLElement</a>
567 </code></dt>
568 <dd></dd>
569 </dl>
571 </div>
573 </div>
574 <hr />
575 <h4>
576 <a name="_hideMenu">_hideMenu</a></h4>
577 <div class="detail">
578 <code>
579 protected
582 void
583 <strong>_hideMenu</strong>
586 </code>
588 <div class="description">
589 Hides the button's menu.
590 </div>
592 <div class="description">
595 <dl>
596 <dt>Returns:
597 <code>
598 void
599 </code></dt>
600 <dd></dd>
601 </dl>
603 </div>
605 </div>
606 <hr />
607 <h4>
608 <a name="_isActivationKey">_isActivationKey</a></h4>
609 <div class="detail">
610 <code>
611 protected
614 Boolean
615 <strong>_isActivationKey</strong>
619 p_nKeyCode
623 </code>
625 <div class="description">
626 Determines if the specified keycode is one that toggles the
627 button's "active" state.
628 </div>
630 <div class="description">
632 <dl>
633 <dt>Parameters:</dt>
634 <dd>
635 <code>p_nKeyCode &lt;Number&gt;</code>
636 Number representing the keycode to be evaluated.
637 </dd>
638 </dl>
640 <dl>
641 <dt>Returns:
642 <code>
643 Boolean
644 </code></dt>
645 <dd></dd>
646 </dl>
648 </div>
650 </div>
651 <hr />
652 <h4>
653 <a name="_isSplitButtonOptionKey">_isSplitButtonOptionKey</a></h4>
654 <div class="detail">
655 <code>
659 Boolean
660 <strong>_isSplitButtonOptionKey</strong>
664 p_oEvent
668 </code>
670 <div class="description">
671 Determines if the specified keycode is one that toggles the
672 display of the split button's menu.
673 </div>
675 <div class="description">
677 <dl>
678 <dt>Parameters:</dt>
679 <dd>
680 <code>p_oEvent &lt;Event&gt;</code>
681 Object representing the DOM event object passed
682 back by the event utility (YAHOO.util.Event).
683 </dd>
684 </dl>
686 <dl>
687 <dt>Returns:
688 <code>
689 Boolean
690 </code></dt>
691 <dd></dd>
692 </dl>
694 </div>
696 </div>
697 <hr />
698 <h4>
699 <a name="_onAppendTo">_onAppendTo</a></h4>
700 <div class="detail">
701 <code>
702 protected
705 void
706 <strong>_onAppendTo</strong>
710 p_oEvent
714 </code>
716 <div class="description">
717 "appendTo" event handler for the button.
718 </div>
720 <div class="description">
722 <dl>
723 <dt>Parameters:</dt>
724 <dd>
725 <code>p_oEvent &lt;Event&gt;</code>
726 Object representing the DOM event object passed
727 back by the event utility (YAHOO.util.Event).
728 </dd>
729 </dl>
731 <dl>
732 <dt>Returns:
733 <code>
734 void
735 </code></dt>
736 <dd></dd>
737 </dl>
739 </div>
741 </div>
742 <hr />
743 <h4>
744 <a name="_onBlur">_onBlur</a></h4>
745 <div class="detail">
746 <code>
747 protected
750 void
751 <strong>_onBlur</strong>
755 p_oEvent
759 p_oButton
763 </code>
765 <div class="description">
766 "blur" event handler for the button.
767 </div>
769 <div class="description">
771 <dl>
772 <dt>Parameters:</dt>
773 <dd>
774 <code>p_oEvent &lt;Event&gt;</code>
775 Object representing the DOM event object passed
776 back by the event utility (YAHOO.util.Event).
777 </dd>
778 <dd>
779 <code>p_oButton &lt;YAHOO.widget.Button&gt;</code>
780 Object representing the button.
781 </dd>
782 </dl>
784 <dl>
785 <dt>Returns:
786 <code>
787 void
788 </code></dt>
789 <dd></dd>
790 </dl>
792 </div>
794 </div>
795 <hr />
796 <h4>
797 <a name="_onClick">_onClick</a></h4>
798 <div class="detail">
799 <code>
800 protected
803 void
804 <strong>_onClick</strong>
808 p_oEvent
812 </code>
814 <div class="description">
815 "click" event handler for the button.
816 </div>
818 <div class="description">
820 <dl>
821 <dt>Parameters:</dt>
822 <dd>
823 <code>p_oEvent &lt;Event&gt;</code>
824 Object representing the DOM event object passed
825 back by the event utility (YAHOO.util.Event).
826 </dd>
827 </dl>
829 <dl>
830 <dt>Returns:
831 <code>
832 void
833 </code></dt>
834 <dd></dd>
835 </dl>
837 </div>
839 </div>
840 <hr />
841 <h4>
842 <a name="_onDocumentKeyUp">_onDocumentKeyUp</a></h4>
843 <div class="detail">
844 <code>
845 protected
848 void
849 <strong>_onDocumentKeyUp</strong>
853 p_oEvent
857 p_oButton
861 </code>
863 <div class="description">
864 "keyup" event handler for the document.
865 </div>
867 <div class="description">
869 <dl>
870 <dt>Parameters:</dt>
871 <dd>
872 <code>p_oEvent &lt;Event&gt;</code>
873 Object representing the DOM event object passed
874 back by the event utility (YAHOO.util.Event).
875 </dd>
876 <dd>
877 <code>p_oButton &lt;YAHOO.widget.Button&gt;</code>
878 Object representing the button.
879 </dd>
880 </dl>
882 <dl>
883 <dt>Returns:
884 <code>
885 void
886 </code></dt>
887 <dd></dd>
888 </dl>
890 </div>
892 </div>
893 <hr />
894 <h4>
895 <a name="_onDocumentMouseDown">_onDocumentMouseDown</a></h4>
896 <div class="detail">
897 <code>
898 protected
901 void
902 <strong>_onDocumentMouseDown</strong>
906 p_oEvent
910 p_oButton
914 </code>
916 <div class="description">
917 "mousedown" event handler for the document.
918 </div>
920 <div class="description">
922 <dl>
923 <dt>Parameters:</dt>
924 <dd>
925 <code>p_oEvent &lt;Event&gt;</code>
926 Object representing the DOM event object passed
927 back by the event utility (YAHOO.util.Event).
928 </dd>
929 <dd>
930 <code>p_oButton &lt;YAHOO.widget.Button&gt;</code>
931 Object representing the button.
932 </dd>
933 </dl>
935 <dl>
936 <dt>Returns:
937 <code>
938 void
939 </code></dt>
940 <dd></dd>
941 </dl>
943 </div>
945 </div>
946 <hr />
947 <h4>
948 <a name="_onDocumentMouseUp">_onDocumentMouseUp</a></h4>
949 <div class="detail">
950 <code>
951 protected
954 void
955 <strong>_onDocumentMouseUp</strong>
959 p_oEvent
963 p_oButton
967 </code>
969 <div class="description">
970 "mouseup" event handler for the button.
971 </div>
973 <div class="description">
975 <dl>
976 <dt>Parameters:</dt>
977 <dd>
978 <code>p_oEvent &lt;Event&gt;</code>
979 Object representing the DOM event object passed
980 back by the event utility (YAHOO.util.Event).
981 </dd>
982 <dd>
983 <code>p_oButton &lt;YAHOO.widget.Button&gt;</code>
984 Object representing the button.
985 </dd>
986 </dl>
988 <dl>
989 <dt>Returns:
990 <code>
991 void
992 </code></dt>
993 <dd></dd>
994 </dl>
996 </div>
998 </div>
999 <hr />
1000 <h4>
1001 <a name="_onFocus">_onFocus</a></h4>
1002 <div class="detail">
1003 <code>
1004 protected
1007 void
1008 <strong>_onFocus</strong>
1012 p_oEvent
1016 p_oButton
1020 </code>
1022 <div class="description">
1023 "focus" event handler for the button.
1024 </div>
1026 <div class="description">
1028 <dl>
1029 <dt>Parameters:</dt>
1030 <dd>
1031 <code>p_oEvent &lt;Event&gt;</code>
1032 Object representing the DOM event object passed
1033 back by the event utility (YAHOO.util.Event).
1034 </dd>
1035 <dd>
1036 <code>p_oButton &lt;YAHOO.widget.Button&gt;</code>
1037 Object representing the button that
1038 fired the event.
1039 </dd>
1040 </dl>
1042 <dl>
1043 <dt>Returns:
1044 <code>
1045 void
1046 </code></dt>
1047 <dd></dd>
1048 </dl>
1050 </div>
1052 </div>
1053 <hr />
1054 <h4>
1055 <a name="_onFormReset">_onFormReset</a></h4>
1056 <div class="detail">
1057 <code>
1058 protected
1061 void
1062 <strong>_onFormReset</strong>
1066 p_oEvent
1070 p_oButton
1074 </code>
1076 <div class="description">
1077 "reset" event handler for the button's form.
1078 </div>
1080 <div class="description">
1082 <dl>
1083 <dt>Parameters:</dt>
1084 <dd>
1085 <code>p_oEvent &lt;Event&gt;</code>
1086 Object representing the DOM event object passed
1087 back by the event utility (YAHOO.util.Event).
1088 </dd>
1089 <dd>
1090 <code>p_oButton &lt;YAHOO.widget.Button&gt;</code>
1091 Object representing the button.
1092 </dd>
1093 </dl>
1095 <dl>
1096 <dt>Returns:
1097 <code>
1098 void
1099 </code></dt>
1100 <dd></dd>
1101 </dl>
1103 </div>
1105 </div>
1106 <hr />
1107 <h4>
1108 <a name="_onFormSubmit">_onFormSubmit</a></h4>
1109 <div class="detail">
1110 <code>
1111 protected
1114 void
1115 <strong>_onFormSubmit</strong>
1119 p_oEvent
1123 p_oButton
1127 </code>
1129 <div class="description">
1130 "submit" event handler for the button's form.
1131 </div>
1133 <div class="description">
1135 <dl>
1136 <dt>Parameters:</dt>
1137 <dd>
1138 <code>p_oEvent &lt;Event&gt;</code>
1139 Object representing the DOM event object passed
1140 back by the event utility (YAHOO.util.Event).
1141 </dd>
1142 <dd>
1143 <code>p_oButton &lt;YAHOO.widget.Button&gt;</code>
1144 Object representing the button.
1145 </dd>
1146 </dl>
1148 <dl>
1149 <dt>Returns:
1150 <code>
1151 void
1152 </code></dt>
1153 <dd></dd>
1154 </dl>
1156 </div>
1158 </div>
1159 <hr />
1160 <h4>
1161 <a name="_onKeyDown">_onKeyDown</a></h4>
1162 <div class="detail">
1163 <code>
1164 protected
1167 void
1168 <strong>_onKeyDown</strong>
1172 p_oEvent
1176 p_oButton
1180 </code>
1182 <div class="description">
1183 "keydown" event handler for the button.
1184 </div>
1186 <div class="description">
1188 <dl>
1189 <dt>Parameters:</dt>
1190 <dd>
1191 <code>p_oEvent &lt;Event&gt;</code>
1192 Object representing the DOM event object passed
1193 back by the event utility (YAHOO.util.Event).
1194 </dd>
1195 <dd>
1196 <code>p_oButton &lt;YAHOO.widget.Button&gt;</code>
1197 Object representing the button.
1198 </dd>
1199 </dl>
1201 <dl>
1202 <dt>Returns:
1203 <code>
1204 void
1205 </code></dt>
1206 <dd></dd>
1207 </dl>
1209 </div>
1211 </div>
1212 <hr />
1213 <h4>
1214 <a name="_onKeyUp">_onKeyUp</a></h4>
1215 <div class="detail">
1216 <code>
1217 protected
1220 void
1221 <strong>_onKeyUp</strong>
1225 p_oEvent
1229 p_oButton
1233 </code>
1235 <div class="description">
1236 "keyup" event handler for the button.
1237 </div>
1239 <div class="description">
1241 <dl>
1242 <dt>Parameters:</dt>
1243 <dd>
1244 <code>p_oEvent &lt;Event&gt;</code>
1245 Object representing the DOM event object passed
1246 back by the event utility (YAHOO.util.Event).
1247 </dd>
1248 <dd>
1249 <code>p_oButton &lt;YAHOO.widget.Button&gt;</code>
1250 Object representing the button.
1251 </dd>
1252 </dl>
1254 <dl>
1255 <dt>Returns:
1256 <code>
1257 void
1258 </code></dt>
1259 <dd></dd>
1260 </dl>
1262 </div>
1264 </div>
1265 <hr />
1266 <h4>
1267 <a name="_onMenuClick">_onMenuClick</a></h4>
1268 <div class="detail">
1269 <code>
1270 private
1273 void
1274 <strong>_onMenuClick</strong>
1278 p_sType
1282 p_aArgs
1286 p_oButton
1290 </code>
1292 <div class="description">
1293 "click" event handler for the button's menu.
1294 </div>
1296 <div class="description">
1298 <dl>
1299 <dt>Parameters:</dt>
1300 <dd>
1301 <code>p_sType &lt;String&gt;</code>
1302 String representing the name of the event that
1303 was fired.
1304 </dd>
1305 <dd>
1306 <code>p_aArgs &lt;Array&gt;</code>
1307 Array of arguments sent when the event was fired.
1308 </dd>
1309 <dd>
1310 <code>p_oButton &lt;YAHOO.widget.Button&gt;</code>
1311 Object representing the menu's button.
1312 </dd>
1313 </dl>
1315 <dl>
1316 <dt>Returns:
1317 <code>
1318 void
1319 </code></dt>
1320 <dd></dd>
1321 </dl>
1323 </div>
1325 </div>
1326 <hr />
1327 <h4>
1328 <a name="_onMenuHide">_onMenuHide</a></h4>
1329 <div class="detail">
1330 <code>
1331 private
1334 void
1335 <strong>_onMenuHide</strong>
1339 p_sType
1343 p_aArgs
1347 p_oButton
1351 </code>
1353 <div class="description">
1354 "hide" event handler for the button's menu.
1355 </div>
1357 <div class="description">
1359 <dl>
1360 <dt>Parameters:</dt>
1361 <dd>
1362 <code>p_sType &lt;String&gt;</code>
1363 String representing the name of the event that
1364 was fired.
1365 </dd>
1366 <dd>
1367 <code>p_aArgs &lt;Array&gt;</code>
1368 Array of arguments sent when the event was fired.
1369 </dd>
1370 <dd>
1371 <code>p_oButton &lt;YAHOO.widget.Button&gt;</code>
1372 Object representing the button.
1373 </dd>
1374 </dl>
1376 <dl>
1377 <dt>Returns:
1378 <code>
1379 void
1380 </code></dt>
1381 <dd></dd>
1382 </dl>
1384 </div>
1386 </div>
1387 <hr />
1388 <h4>
1389 <a name="_onMenuItemAdded">_onMenuItemAdded</a></h4>
1390 <div class="detail">
1391 <code>
1392 private
1395 void
1396 <strong>_onMenuItemAdded</strong>
1400 p_sType
1404 p_aArgs
1408 p_oItem
1412 </code>
1414 <div class="description">
1415 "itemadded" event handler for the button's menu.
1416 </div>
1418 <div class="description">
1420 <dl>
1421 <dt>Parameters:</dt>
1422 <dd>
1423 <code>p_sType &lt;String&gt;</code>
1424 String representing the name of the event that
1425 was fired.
1426 </dd>
1427 <dd>
1428 <code>p_aArgs &lt;Array&gt;</code>
1429 Array of arguments sent when the event was fired.
1430 </dd>
1431 <dd>
1432 <code>p_oItem &lt;<a href="YAHOO.widget.MenuItem.html">YAHOO.widget.MenuItem</a>&gt;</code>
1433 Object representing the menu item that subscribed to the event.
1434 </dd>
1435 </dl>
1437 <dl>
1438 <dt>Returns:
1439 <code>
1440 void
1441 </code></dt>
1442 <dd></dd>
1443 </dl>
1445 </div>
1447 </div>
1448 <hr />
1449 <h4>
1450 <a name="_onMenuItemSelected">_onMenuItemSelected</a></h4>
1451 <div class="detail">
1452 <code>
1453 private
1456 void
1457 <strong>_onMenuItemSelected</strong>
1461 p_sType
1465 p_aArgs
1469 p_oItem
1473 </code>
1475 <div class="description">
1476 "selectedchange" event handler for each item in the
1477 button's menu.
1478 </div>
1480 <div class="description">
1482 <dl>
1483 <dt>Parameters:</dt>
1484 <dd>
1485 <code>p_sType &lt;String&gt;</code>
1486 String representing the name of the event that
1487 was fired.
1488 </dd>
1489 <dd>
1490 <code>p_aArgs &lt;Array&gt;</code>
1491 Array of arguments sent when the event was fired.
1492 </dd>
1493 <dd>
1494 <code>p_oItem &lt;<a href="YAHOO.widget.MenuItem.html">YAHOO.widget.MenuItem</a>&gt;</code>
1495 Object representing the menu item that subscribed to the event.
1496 </dd>
1497 </dl>
1499 <dl>
1500 <dt>Returns:
1501 <code>
1502 void
1503 </code></dt>
1504 <dd></dd>
1505 </dl>
1507 </div>
1509 </div>
1510 <hr />
1511 <h4>
1512 <a name="_onMenuKeyDown">_onMenuKeyDown</a></h4>
1513 <div class="detail">
1514 <code>
1515 private
1518 void
1519 <strong>_onMenuKeyDown</strong>
1523 p_sType
1527 p_aArgs
1531 p_oButton
1535 </code>
1537 <div class="description">
1538 "keydown" event handler for the button's menu.
1539 </div>
1541 <div class="description">
1543 <dl>
1544 <dt>Parameters:</dt>
1545 <dd>
1546 <code>p_sType &lt;String&gt;</code>
1547 String representing the name of the event that
1548 was fired.
1549 </dd>
1550 <dd>
1551 <code>p_aArgs &lt;Array&gt;</code>
1552 Array of arguments sent when the event was fired.
1553 </dd>
1554 <dd>
1555 <code>p_oButton &lt;YAHOO.widget.Button&gt;</code>
1556 Object representing the button.
1557 </dd>
1558 </dl>
1560 <dl>
1561 <dt>Returns:
1562 <code>
1563 void
1564 </code></dt>
1565 <dd></dd>
1566 </dl>
1568 </div>
1570 </div>
1571 <hr />
1572 <h4>
1573 <a name="_onMenuRender">_onMenuRender</a></h4>
1574 <div class="detail">
1575 <code>
1576 private
1579 void
1580 <strong>_onMenuRender</strong>
1584 p_sType
1588 p_aArgs
1592 p_oButton
1596 </code>
1598 <div class="description">
1599 "render" event handler for the button's menu.
1600 </div>
1602 <div class="description">
1604 <dl>
1605 <dt>Parameters:</dt>
1606 <dd>
1607 <code>p_sType &lt;String&gt;</code>
1608 String representing the name of the event that
1609 was fired.
1610 </dd>
1611 <dd>
1612 <code>p_aArgs &lt;Array&gt;</code>
1613 Array of arguments sent when the event was fired.
1614 </dd>
1615 <dd>
1616 <code>p_oButton &lt;YAHOO.widget.Button&gt;</code>
1617 Object representing the button.
1618 </dd>
1619 </dl>
1621 <dl>
1622 <dt>Returns:
1623 <code>
1624 void
1625 </code></dt>
1626 <dd></dd>
1627 </dl>
1629 </div>
1631 </div>
1632 <hr />
1633 <h4>
1634 <a name="_onMenuShow">_onMenuShow</a></h4>
1635 <div class="detail">
1636 <code>
1637 private
1640 void
1641 <strong>_onMenuShow</strong>
1645 p_sType
1649 p_aArgs
1653 p_oButton
1657 </code>
1659 <div class="description">
1660 "show" event handler for the button's menu.
1661 </div>
1663 <div class="description">
1665 <dl>
1666 <dt>Parameters:</dt>
1667 <dd>
1668 <code>p_sType &lt;String&gt;</code>
1669 String representing the name of the event that
1670 was fired.
1671 </dd>
1672 <dd>
1673 <code>p_aArgs &lt;Array&gt;</code>
1674 Array of arguments sent when the event was fired.
1675 </dd>
1676 <dd>
1677 <code>p_oButton &lt;YAHOO.widget.Button&gt;</code>
1678 Object representing the button.
1679 </dd>
1680 </dl>
1682 <dl>
1683 <dt>Returns:
1684 <code>
1685 void
1686 </code></dt>
1687 <dd></dd>
1688 </dl>
1690 </div>
1692 </div>
1693 <hr />
1694 <h4>
1695 <a name="_onMouseDown">_onMouseDown</a></h4>
1696 <div class="detail">
1697 <code>
1698 protected
1701 void
1702 <strong>_onMouseDown</strong>
1706 p_oEvent
1710 </code>
1712 <div class="description">
1713 "mousedown" event handler for the button.
1714 </div>
1716 <div class="description">
1718 <dl>
1719 <dt>Parameters:</dt>
1720 <dd>
1721 <code>p_oEvent &lt;Event&gt;</code>
1722 Object representing the DOM event object passed
1723 back by the event utility (YAHOO.util.Event).
1724 </dd>
1725 </dl>
1727 <dl>
1728 <dt>Returns:
1729 <code>
1730 void
1731 </code></dt>
1732 <dd></dd>
1733 </dl>
1735 </div>
1737 </div>
1738 <hr />
1739 <h4>
1740 <a name="_onMouseOut">_onMouseOut</a></h4>
1741 <div class="detail">
1742 <code>
1743 protected
1746 void
1747 <strong>_onMouseOut</strong>
1751 p_oEvent
1755 </code>
1757 <div class="description">
1758 "mouseout" event handler for the button.
1759 </div>
1761 <div class="description">
1763 <dl>
1764 <dt>Parameters:</dt>
1765 <dd>
1766 <code>p_oEvent &lt;Event&gt;</code>
1767 Object representing the DOM event object passed
1768 back by the event utility (YAHOO.util.Event).
1769 </dd>
1770 </dl>
1772 <dl>
1773 <dt>Returns:
1774 <code>
1775 void
1776 </code></dt>
1777 <dd></dd>
1778 </dl>
1780 </div>
1782 </div>
1783 <hr />
1784 <h4>
1785 <a name="_onMouseOver">_onMouseOver</a></h4>
1786 <div class="detail">
1787 <code>
1788 protected
1791 void
1792 <strong>_onMouseOver</strong>
1796 p_oEvent
1800 </code>
1802 <div class="description">
1803 "mouseover" event handler for the button.
1804 </div>
1806 <div class="description">
1808 <dl>
1809 <dt>Parameters:</dt>
1810 <dd>
1811 <code>p_oEvent &lt;Event&gt;</code>
1812 Object representing the DOM event object passed
1813 back by the event utility (YAHOO.util.Event).
1814 </dd>
1815 </dl>
1817 <dl>
1818 <dt>Returns:
1819 <code>
1820 void
1821 </code></dt>
1822 <dd></dd>
1823 </dl>
1825 </div>
1827 </div>
1828 <hr />
1829 <h4>
1830 <a name="_onMouseUp">_onMouseUp</a></h4>
1831 <div class="detail">
1832 <code>
1833 protected
1836 void
1837 <strong>_onMouseUp</strong>
1841 p_oEvent
1845 </code>
1847 <div class="description">
1848 "mouseup" event handler for the button.
1849 </div>
1851 <div class="description">
1853 <dl>
1854 <dt>Parameters:</dt>
1855 <dd>
1856 <code>p_oEvent &lt;Event&gt;</code>
1857 Object representing the DOM event object passed
1858 back by the event utility (YAHOO.util.Event).
1859 </dd>
1860 </dl>
1862 <dl>
1863 <dt>Returns:
1864 <code>
1865 void
1866 </code></dt>
1867 <dd></dd>
1868 </dl>
1870 </div>
1872 </div>
1873 <hr />
1874 <h4>
1875 <a name="_onOption">_onOption</a></h4>
1876 <div class="detail">
1877 <code>
1878 protected
1881 void
1882 <strong>_onOption</strong>
1886 p_oEvent
1890 </code>
1892 <div class="description">
1893 "option" event handler for the button.
1894 </div>
1896 <div class="description">
1898 <dl>
1899 <dt>Parameters:</dt>
1900 <dd>
1901 <code>p_oEvent &lt;Event&gt;</code>
1902 Object representing the DOM event object passed
1903 back by the event utility (YAHOO.util.Event).
1904 </dd>
1905 </dl>
1907 <dl>
1908 <dt>Returns:
1909 <code>
1910 void
1911 </code></dt>
1912 <dd></dd>
1913 </dl>
1915 </div>
1917 </div>
1918 <hr />
1919 <h4>
1920 <a name="_setAccessKey">_setAccessKey</a></h4>
1921 <div class="detail">
1922 <code>
1923 protected
1926 void
1927 <strong>_setAccessKey</strong>
1931 p_sAccessKey
1935 </code>
1937 <div class="description">
1938 Sets the value of the button's "accesskey" attribute.
1939 </div>
1941 <div class="description">
1943 <dl>
1944 <dt>Parameters:</dt>
1945 <dd>
1946 <code>p_sAccessKey &lt;String&gt;</code>
1947 String indicating the value for the button's
1948 "accesskey" attribute.
1949 </dd>
1950 </dl>
1952 <dl>
1953 <dt>Returns:
1954 <code>
1955 void
1956 </code></dt>
1957 <dd></dd>
1958 </dl>
1960 </div>
1962 </div>
1963 <hr />
1964 <h4>
1965 <a name="_setChecked">_setChecked</a></h4>
1966 <div class="detail">
1967 <code>
1968 protected
1971 void
1972 <strong>_setChecked</strong>
1976 p_bChecked
1980 </code>
1982 <div class="description">
1983 Sets the value of the button's "target" attribute.
1984 </div>
1986 <div class="description">
1988 <dl>
1989 <dt>Parameters:</dt>
1990 <dd>
1991 <code>p_bChecked &lt;Boolean&gt;</code>
1992 Boolean indicating the value for the button's
1993 "checked" attribute.
1994 </dd>
1995 </dl>
1997 <dl>
1998 <dt>Returns:
1999 <code>
2000 void
2001 </code></dt>
2002 <dd></dd>
2003 </dl>
2005 </div>
2007 </div>
2008 <hr />
2009 <h4>
2010 <a name="_setDisabled">_setDisabled</a></h4>
2011 <div class="detail">
2012 <code>
2013 protected
2016 void
2017 <strong>_setDisabled</strong>
2021 p_bDisabled
2025 </code>
2027 <div class="description">
2028 Sets the value of the button's "disabled" attribute.
2029 </div>
2031 <div class="description">
2033 <dl>
2034 <dt>Parameters:</dt>
2035 <dd>
2036 <code>p_bDisabled &lt;Boolean&gt;</code>
2037 Boolean indicating the value for the button's
2038 "disabled" attribute.
2039 </dd>
2040 </dl>
2042 <dl>
2043 <dt>Returns:
2044 <code>
2045 void
2046 </code></dt>
2047 <dd></dd>
2048 </dl>
2050 </div>
2052 </div>
2053 <hr />
2054 <h4>
2055 <a name="_setHref">_setHref</a></h4>
2056 <div class="detail">
2057 <code>
2058 protected
2061 void
2062 <strong>_setHref</strong>
2066 p_sHref
2070 </code>
2072 <div class="description">
2073 Sets the value of the button's "href" attribute.
2074 </div>
2076 <div class="description">
2078 <dl>
2079 <dt>Parameters:</dt>
2080 <dd>
2081 <code>p_sHref &lt;String&gt;</code>
2082 String indicating the value for the button's
2083 "href" attribute.
2084 </dd>
2085 </dl>
2087 <dl>
2088 <dt>Returns:
2089 <code>
2090 void
2091 </code></dt>
2092 <dd></dd>
2093 </dl>
2095 </div>
2097 </div>
2098 <hr />
2099 <h4>
2100 <a name="_setLabel">_setLabel</a></h4>
2101 <div class="detail">
2102 <code>
2103 protected
2106 void
2107 <strong>_setLabel</strong>
2111 p_sLabel
2115 </code>
2117 <div class="description">
2118 Sets the value of the button's "label" attribute.
2119 </div>
2121 <div class="description">
2123 <dl>
2124 <dt>Parameters:</dt>
2125 <dd>
2126 <code>p_sLabel &lt;String&gt;</code>
2127 String indicating the value for the button's
2128 "label" attribute.
2129 </dd>
2130 </dl>
2132 <dl>
2133 <dt>Returns:
2134 <code>
2135 void
2136 </code></dt>
2137 <dd></dd>
2138 </dl>
2140 </div>
2142 </div>
2143 <hr />
2144 <h4>
2145 <a name="_setMenu">_setMenu</a></h4>
2146 <div class="detail">
2147 <code>
2148 protected
2151 void
2152 <strong>_setMenu</strong>
2156 p_oMenu
2160 </code>
2162 <div class="description">
2163 Sets the value of the button's "menu" attribute.
2164 </div>
2166 <div class="description">
2168 <dl>
2169 <dt>Parameters:</dt>
2170 <dd>
2171 <code>p_oMenu &lt;Object&gt;</code>
2172 Object indicating the value for the button's
2173 "menu" attribute.
2174 </dd>
2175 </dl>
2177 <dl>
2178 <dt>Returns:
2179 <code>
2180 void
2181 </code></dt>
2182 <dd></dd>
2183 </dl>
2185 </div>
2187 </div>
2188 <hr />
2189 <h4>
2190 <a name="_setOnClick">_setOnClick</a></h4>
2191 <div class="detail">
2192 <code>
2193 protected
2196 void
2197 <strong>_setOnClick</strong>
2201 p_oObject
2205 </code>
2207 <div class="description">
2208 Sets the value of the button's "onclick" attribute.
2209 </div>
2211 <div class="description">
2213 <dl>
2214 <dt>Parameters:</dt>
2215 <dd>
2216 <code>p_oObject &lt;Object&gt;</code>
2217 Object indicating the value for the button's
2218 "onclick" attribute.
2219 </dd>
2220 </dl>
2222 <dl>
2223 <dt>Returns:
2224 <code>
2225 void
2226 </code></dt>
2227 <dd></dd>
2228 </dl>
2230 </div>
2232 </div>
2233 <hr />
2234 <h4>
2235 <a name="_setOnInit">_setOnInit</a></h4>
2236 <div class="detail">
2237 <code>
2238 protected
2241 void
2242 <strong>_setOnInit</strong>
2246 p_oObject
2250 </code>
2252 <div class="description">
2253 Sets the value of the button's "init" attribute.
2254 </div>
2256 <div class="description">
2258 <dl>
2259 <dt>Parameters:</dt>
2260 <dd>
2261 <code>p_oObject &lt;Object&gt;</code>
2262 Object indicating the value for the button's
2263 "oninit" attribute.
2264 </dd>
2265 </dl>
2267 <dl>
2268 <dt>Returns:
2269 <code>
2270 void
2271 </code></dt>
2272 <dd></dd>
2273 </dl>
2275 </div>
2277 </div>
2278 <hr />
2279 <h4>
2280 <a name="_setTabIndex">_setTabIndex</a></h4>
2281 <div class="detail">
2282 <code>
2283 protected
2286 void
2287 <strong>_setTabIndex</strong>
2291 p_nTabIndex
2295 </code>
2297 <div class="description">
2298 Sets the value of the button's "tabindex" attribute.
2299 </div>
2301 <div class="description">
2303 <dl>
2304 <dt>Parameters:</dt>
2305 <dd>
2306 <code>p_nTabIndex &lt;Number&gt;</code>
2307 Number indicating the value for the button's
2308 "tabindex" attribute.
2309 </dd>
2310 </dl>
2312 <dl>
2313 <dt>Returns:
2314 <code>
2315 void
2316 </code></dt>
2317 <dd></dd>
2318 </dl>
2320 </div>
2322 </div>
2323 <hr />
2324 <h4>
2325 <a name="_setTarget">_setTarget</a></h4>
2326 <div class="detail">
2327 <code>
2328 protected
2331 void
2332 <strong>_setTarget</strong>
2336 p_sTarget
2340 </code>
2342 <div class="description">
2343 Sets the value of the button's "target" attribute.
2344 </div>
2346 <div class="description">
2348 <dl>
2349 <dt>Parameters:</dt>
2350 <dd>
2351 <code>p_sTarget &lt;String&gt;</code>
2352 String indicating the value for the button's
2353 "target" attribute.
2354 </dd>
2355 </dl>
2357 <dl>
2358 <dt>Returns:
2359 <code>
2360 void
2361 </code></dt>
2362 <dd></dd>
2363 </dl>
2365 </div>
2367 </div>
2368 <hr />
2369 <h4>
2370 <a name="_setTitle">_setTitle</a></h4>
2371 <div class="detail">
2372 <code>
2373 protected
2376 void
2377 <strong>_setTitle</strong>
2381 p_nTabIndex
2385 </code>
2387 <div class="description">
2388 Sets the value of the button's "title" attribute.
2389 </div>
2391 <div class="description">
2393 <dl>
2394 <dt>Parameters:</dt>
2395 <dd>
2396 <code>p_nTabIndex &lt;String&gt;</code>
2397 Number indicating the value for the button's
2398 "title" attribute.
2399 </dd>
2400 </dl>
2402 <dl>
2403 <dt>Returns:
2404 <code>
2405 void
2406 </code></dt>
2407 <dd></dd>
2408 </dl>
2410 </div>
2412 </div>
2413 <hr />
2414 <h4>
2415 <a name="_setType">_setType</a></h4>
2416 <div class="detail">
2417 <code>
2418 protected
2421 void
2422 <strong>_setType</strong>
2426 p_sType
2430 </code>
2432 <div class="description">
2433 Sets the value of the button's "type" attribute.
2434 </div>
2436 <div class="description">
2438 <dl>
2439 <dt>Parameters:</dt>
2440 <dd>
2441 <code>p_sType &lt;String&gt;</code>
2442 String indicating the value for the button's
2443 "type" attribute.
2444 </dd>
2445 </dl>
2447 <dl>
2448 <dt>Returns:
2449 <code>
2450 void
2451 </code></dt>
2452 <dd></dd>
2453 </dl>
2455 </div>
2457 </div>
2458 <hr />
2459 <h4>
2460 <a name="_showMenu">_showMenu</a></h4>
2461 <div class="detail">
2462 <code>
2463 protected
2466 void
2467 <strong>_showMenu</strong>
2470 </code>
2472 <div class="description">
2473 Shows the button's menu.
2474 </div>
2476 <div class="description">
2479 <dl>
2480 <dt>Returns:
2481 <code>
2482 void
2483 </code></dt>
2484 <dd></dd>
2485 </dl>
2487 </div>
2489 </div>
2490 <hr />
2491 <h4>
2492 <a name="_submitForm">_submitForm</a></h4>
2493 <div class="detail">
2494 <code>
2495 protected
2498 void
2499 <strong>_submitForm</strong>
2502 </code>
2504 <div class="description">
2505 Submits the form to which the button belongs.
2506 </div>
2508 <div class="description">
2511 <dl>
2512 <dt>Returns:
2513 <code>
2514 void
2515 </code></dt>
2516 <dd></dd>
2517 </dl>
2519 </div>
2521 </div>
2522 <hr />
2523 <h4>
2524 <a name="addHiddenFieldsToForm">addHiddenFieldsToForm</a></h4>
2525 <div class="detail">
2526 <code>
2530 void
2531 <strong>addHiddenFieldsToForm</strong>
2535 p_oForm
2539 </code>
2541 <div class="description">
2542 Searches the specified form and adds hidden fields for instances
2543 of YAHOO.widget.Button that are of type "radio," "checkbox," "menubutton,"
2544 and "splitbutton."
2545 </div>
2547 <div class="description">
2549 <dl>
2550 <dt>Parameters:</dt>
2551 <dd>
2552 <code>p_oForm &lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
2553 one-html.html#ID-40002357">HTMLFormElement</a>&gt;</code>
2554 Object reference
2555 for the form to search.
2556 </dd>
2557 </dl>
2559 <dl>
2560 <dt>Returns:
2561 <code>
2562 void
2563 </code></dt>
2564 <dd></dd>
2565 </dl>
2567 </div>
2569 </div>
2570 <hr />
2571 <h4>
2572 <a name="blur">blur</a></h4>
2573 <div class="detail">
2574 <code>
2578 void
2579 <strong>blur</strong>
2582 </code>
2584 <div class="description">
2585 Causes the button to lose focus and fires the button's
2586 "blur" event.
2587 </div>
2589 <div class="description">
2592 <dl>
2593 <dt>Returns:
2594 <code>
2595 void
2596 </code></dt>
2597 <dd></dd>
2598 </dl>
2600 </div>
2602 </div>
2603 <hr />
2604 <h4>
2605 <a name="createHiddenField">createHiddenField</a></h4>
2606 <div class="detail">
2607 <code>
2611 <a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
2612 one-html.html#ID-6043025">HTMLInputElement</a>
2613 <strong>createHiddenField</strong>
2616 </code>
2618 <div class="description">
2619 Creates the button's hidden form field and appends it to its
2620 parent form.
2621 </div>
2623 <div class="description">
2626 <dl>
2627 <dt>Returns:
2628 <code>
2629 <a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
2630 one-html.html#ID-6043025">HTMLInputElement</a>
2631 </code></dt>
2632 <dd></dd>
2633 </dl>
2635 </div>
2637 </div>
2638 <hr />
2639 <h4>
2640 <a name="createInputElement">createInputElement</a></h4>
2641 <div class="detail">
2642 <code>
2643 private
2646 <a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
2647 one-html.html#ID-6043025">HTMLInputElement</a>
2648 <strong>createInputElement</strong>
2652 p_sType
2656 p_sName
2660 p_sValue
2664 p_bChecked
2668 </code>
2670 <div class="description">
2671 Creates an <code>&#60;input&#62;</code> element of the
2672 specified type.
2673 </div>
2675 <div class="description">
2677 <dl>
2678 <dt>Parameters:</dt>
2679 <dd>
2680 <code>p_sType &lt;String&gt;</code>
2681 String specifying the type of
2682 <code>&#60;input&#62;</code> element to create.
2683 </dd>
2684 <dd>
2685 <code>p_sName &lt;String&gt;</code>
2686 String specifying the name of
2687 <code>&#60;input&#62;</code> element to create.
2688 </dd>
2689 <dd>
2690 <code>p_sValue &lt;String&gt;</code>
2691 String specifying the value of
2692 <code>&#60;input&#62;</code> element to create.
2693 </dd>
2694 <dd>
2695 <code>p_bChecked &lt;String&gt;</code>
2696 Boolean specifying if the
2697 <code>&#60;input&#62;</code> element is to be checked.
2698 </dd>
2699 </dl>
2701 <dl>
2702 <dt>Returns:
2703 <code>
2704 <a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
2705 one-html.html#ID-6043025">HTMLInputElement</a>
2706 </code></dt>
2707 <dd></dd>
2708 </dl>
2710 </div>
2712 </div>
2713 <hr />
2714 <h4>
2715 <a name="destroy">destroy</a></h4>
2716 <div class="detail">
2717 <code>
2721 void
2722 <strong>destroy</strong>
2725 </code>
2727 <div class="description">
2728 Removes the button's element from its parent element and
2729 removes all event handlers.
2730 </div>
2732 <div class="description">
2735 <dl>
2736 <dt>Returns:
2737 <code>
2738 void
2739 </code></dt>
2740 <dd></dd>
2741 </dl>
2743 </div>
2745 </div>
2746 <hr />
2747 <h4>
2748 <a name="focus">focus</a></h4>
2749 <div class="detail">
2750 <code>
2754 void
2755 <strong>focus</strong>
2758 </code>
2760 <div class="description">
2761 Causes the button to receive the focus and fires the button's
2762 "focus" event.
2763 </div>
2765 <div class="description">
2768 <dl>
2769 <dt>Returns:
2770 <code>
2771 void
2772 </code></dt>
2773 <dd></dd>
2774 </dl>
2776 </div>
2778 </div>
2779 <hr />
2780 <h4>
2781 <a name="getFirstElement">getFirstElement</a></h4>
2782 <div class="detail">
2783 <code>
2784 private
2787 <a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
2788 level-one-html.html#ID-58190037">HTMLElement</a>
2789 <strong>getFirstElement</strong>
2793 p_oElement
2797 </code>
2799 <div class="description">
2800 Returns an HTML element's first HTML element node.
2801 </div>
2803 <div class="description">
2805 <dl>
2806 <dt>Parameters:</dt>
2807 <dd>
2808 <code>p_oElement &lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
2809 level-one-html.html#ID-58190037">HTMLElement</a>&gt;</code>
2810 Object
2811 reference specifying the element to be evaluated.
2812 </dd>
2813 </dl>
2815 <dl>
2816 <dt>Returns:
2817 <code>
2818 <a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
2819 level-one-html.html#ID-58190037">HTMLElement</a>
2820 </code></dt>
2821 <dd></dd>
2822 </dl>
2824 </div>
2826 </div>
2827 <hr />
2828 <h4>
2829 <a name="getForm">getForm</a></h4>
2830 <div class="detail">
2831 <code>
2835 <a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
2836 one-html.html#ID-40002357">HTMLFormElement</a>
2837 <strong>getForm</strong>
2840 </code>
2842 <div class="description">
2843 Returns a reference to the button's menu.
2844 </div>
2846 <div class="description">
2849 <dl>
2850 <dt>Returns:
2851 <code>
2852 <a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
2853 one-html.html#ID-40002357">HTMLFormElement</a>
2854 </code></dt>
2855 <dd></dd>
2856 </dl>
2858 </div>
2860 </div>
2861 <hr />
2862 <h4>
2863 <a name="getMenu">getMenu</a></h4>
2864 <div class="detail">
2865 <code>
2869 <a href="YAHOO.widget.Menu.html">YAHOO.widget.Menu</a>
2870 <strong>getMenu</strong>
2873 </code>
2875 <div class="description">
2876 Returns a reference to the button's menu.
2877 </div>
2879 <div class="description">
2882 <dl>
2883 <dt>Returns:
2884 <code>
2885 <a href="YAHOO.widget.Menu.html">YAHOO.widget.Menu</a>
2886 </code></dt>
2887 <dd></dd>
2888 </dl>
2890 </div>
2892 </div>
2893 <hr />
2894 <h4>
2895 <a name="hasFocus">hasFocus</a></h4>
2896 <div class="detail">
2897 <code>
2901 Boolean
2902 <strong>hasFocus</strong>
2905 </code>
2907 <div class="description">
2908 Returns a boolean indicating whether or not the button has focus.
2909 </div>
2911 <div class="description">
2914 <dl>
2915 <dt>Returns:
2916 <code>
2917 Boolean
2918 </code></dt>
2919 <dd></dd>
2920 </dl>
2922 </div>
2924 </div>
2925 <hr />
2926 <h4>
2927 <a name="init">init</a></h4>
2928 <div class="detail">
2929 <code>
2933 void
2934 <strong>init</strong>
2938 p_oElement
2946 p_oAttributes
2950 </code>
2952 <div class="description">
2953 The Button class's initialization method.
2954 </div>
2956 <div class="description">
2958 <dl>
2959 <dt>Parameters:</dt>
2960 <dd>
2961 <code>p_oElement &lt;String&gt;</code>
2962 String specifying the id attribute of the
2963 <code>&#60;input&#62;</code>, <code>&#60;a&#62;</code> or
2964 <code>&#60;span&#62;</code> element to be used to create the button.
2965 </dd>
2966 <dd>
2967 <code>p_oElement &lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
2968 one-html.html#ID-6043025">HTMLInputElement</a>|<a href="
2969 http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-one-html.html#
2970 ID-33759296">HTMLElement</a>&gt;</code>
2971 Object reference for the
2972 <code>&#60;input&#62;</code>, <code>&#60;a&#62;</code> or
2973 <code>&#60;span&#62;</code> element to be used to create the button.
2974 </dd>
2975 <dd>
2976 <code>p_oElement &lt;Object&gt;</code>
2977 Object literal specifying a set of configuration
2978 attributes used to create the button.
2979 </dd>
2980 <dd>
2981 <code>p_oAttributes &lt;Object&gt;</code>
2982 Optional. Object literal specifying a set of
2983 configuration attributes used to create the button.
2984 </dd>
2985 </dl>
2987 <dl>
2988 <dt>Returns:
2989 <code>
2990 void
2991 </code></dt>
2992 <dd></dd>
2993 </dl>
2995 </div>
2997 </div>
2998 <hr />
2999 <h4>
3000 <a name="initAttributes">initAttributes</a></h4>
3001 <div class="detail">
3002 <code>
3006 void
3007 <strong>initAttributes</strong>
3011 p_oAttributes
3015 </code>
3017 <div class="description">
3018 Initializes all of the configuration attributes used to create
3019 the button.
3020 </div>
3022 <div class="description">
3024 <dl>
3025 <dt>Parameters:</dt>
3026 <dd>
3027 <code>p_oAttributes &lt;Object&gt;</code>
3028 Object literal specifying a set of
3029 configuration attributes used to create the button.
3030 </dd>
3031 </dl>
3033 <dl>
3034 <dt>Returns:
3035 <code>
3036 void
3037 </code></dt>
3038 <dd></dd>
3039 </dl>
3041 </div>
3043 </div>
3044 <hr />
3045 <h4>
3046 <a name="initConfig">initConfig</a></h4>
3047 <div class="detail">
3048 <code>
3049 private
3052 void
3053 <strong>initConfig</strong>
3057 Object
3061 </code>
3063 <div class="description">
3064 Initializes the set of configuration attributes that are used to
3065 instantiate the button.
3066 </div>
3068 <div class="description">
3070 <dl>
3071 <dt>Parameters:</dt>
3072 <dd>
3073 <code>Object &lt;Object&gt;</code>
3074 representing the button's set of
3075 configuration attributes.
3076 </dd>
3077 </dl>
3079 <dl>
3080 <dt>Returns:
3081 <code>
3082 void
3083 </code></dt>
3084 <dd></dd>
3085 </dl>
3087 </div>
3089 </div>
3090 <hr />
3091 <h4>
3092 <a name="isActive">isActive</a></h4>
3093 <div class="detail">
3094 <code>
3098 Boolean
3099 <strong>isActive</strong>
3102 </code>
3104 <div class="description">
3105 Returns a boolean indicating whether or not the button is active.
3106 </div>
3108 <div class="description">
3111 <dl>
3112 <dt>Returns:
3113 <code>
3114 Boolean
3115 </code></dt>
3116 <dd></dd>
3117 </dl>
3119 </div>
3121 </div>
3122 <hr />
3123 <h4>
3124 <a name="setAttributeFromDOMAttribute">setAttributeFromDOMAttribute</a></h4>
3125 <div class="detail">
3126 <code>
3127 private
3130 void
3131 <strong>setAttributeFromDOMAttribute</strong>
3135 p_sAttribute
3139 </code>
3141 <div class="description">
3142 Gets the value of the specified DOM attribute and sets it
3143 into the collection of configuration attributes used to configure
3144 the button.
3145 </div>
3147 <div class="description">
3149 <dl>
3150 <dt>Parameters:</dt>
3151 <dd>
3152 <code>p_sAttribute &lt;String&gt;</code>
3153 String representing the name of the
3154 attribute to retrieve from the DOM element.
3155 </dd>
3156 </dl>
3158 <dl>
3159 <dt>Returns:
3160 <code>
3161 void
3162 </code></dt>
3163 <dd></dd>
3164 </dl>
3166 </div>
3168 </div>
3169 <hr />
3170 <h4>
3171 <a name="setAttributesFromSrcElement">setAttributesFromSrcElement</a></h4>
3172 <div class="detail">
3173 <code>
3174 private
3177 void
3178 <strong>setAttributesFromSrcElement</strong>
3182 p_oElement
3186 p_oAttributes
3190 </code>
3192 <div class="description">
3193 Gets the values for all the attributes of the source element
3194 (either <code>&#60;input&#62;</code> or <code>&#60;a&#62;</code>) that map to
3195 Button configuration attributes and sets them into a collection that is
3196 passed to the Button constructor.
3197 </div>
3199 <div class="description">
3201 <dl>
3202 <dt>Parameters:</dt>
3203 <dd>
3204 <code>p_oElement &lt;<a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
3205 one-html.html#ID-6043025">HTMLInputElement</a>|<a href="http://www.w3.org/
3206 TR/2000/WD-DOM-Level-1-20000929/level-one-html.html#ID-
3207 48250443">HTMLAnchorElement</a>&gt;</code>
3208 Object reference to the HTML
3209 element (either <code>&#60;input&#62;</code> or <code>&#60;span&#62;</code>)
3210 used to create the button.
3211 </dd>
3212 <dd>
3213 <code>p_oAttributes &lt;Object&gt;</code>
3214 Object reference for the collection of
3215 configuration attributes used to create the button.
3216 </dd>
3217 </dl>
3219 <dl>
3220 <dt>Returns:
3221 <code>
3222 void
3223 </code></dt>
3224 <dd></dd>
3225 </dl>
3227 </div>
3229 </div>
3230 <hr />
3231 <h4>
3232 <a name="setFormElementProperties">setFormElementProperties</a></h4>
3233 <div class="detail">
3234 <code>
3235 private
3238 void
3239 <strong>setFormElementProperties</strong>
3242 </code>
3244 <div class="description">
3245 Gets the value of the attributes from the form element and
3246 sets them into the collection of configuration attributes used to
3247 configure the button.
3248 </div>
3250 <div class="description">
3253 <dl>
3254 <dt>Returns:
3255 <code>
3256 void
3257 </code></dt>
3258 <dd></dd>
3259 </dl>
3261 </div>
3263 </div>
3264 <hr />
3265 <h4>
3266 <a name="toString">toString</a></h4>
3267 <div class="detail">
3268 <code>
3272 String
3273 <strong>toString</strong>
3276 </code>
3278 <div class="description">
3279 Returns a string representing the button.
3280 </div>
3282 <div class="description">
3285 <dl>
3286 <dt>Returns:
3287 <code>
3288 String
3289 </code></dt>
3290 <dd></dd>
3291 </dl>
3293 </div>
3295 </div>
3296 <hr />
3297 </div>
3298 </div>
3300 <div class="section field inheritance">
3301 <h4>Methods inherited from <a href="YAHOO.util.Element.html">YAHOO.util.Element</a>:</h4>
3302 <div class="content">
3303 <code>
3305 <a href="YAHOO.util.Element.html#_registerHTMLAttr">_registerHTMLAttr</a>,
3306 <a href="YAHOO.util.Element.html#addClass">addClass</a>,
3307 <a href="YAHOO.util.Element.html#addListener">addListener</a>,
3308 <a href="YAHOO.util.Element.html#appendChild">appendChild</a>,
3309 <a href="YAHOO.util.Element.html#appendTo">appendTo</a>,
3310 <a href="YAHOO.util.Element.html#fireQueue">fireQueue</a>,
3311 <a href="YAHOO.util.Element.html#getElementsByClassName">getElementsByClassName</a>,
3312 <a href="YAHOO.util.Element.html#getElementsByTagName">getElementsByTagName</a>,
3313 <a href="YAHOO.util.Element.html#getStyle">getStyle</a>,
3314 <a href="YAHOO.util.Element.html#hasChildNodes">hasChildNodes</a>,
3315 <a href="YAHOO.util.Element.html#hasClass">hasClass</a>,
3316 <a href="YAHOO.util.Element.html#initAttributes">initAttributes</a>,
3317 <a href="YAHOO.util.Element.html#insertBefore">insertBefore</a>,
3318 <a href="YAHOO.util.Element.html#on">on</a>,
3319 <a href="YAHOO.util.Element.html#removeChild">removeChild</a>,
3320 <a href="YAHOO.util.Element.html#removeClass">removeClass</a>,
3321 <a href="YAHOO.util.Element.html#removeListener">removeListener</a>,
3322 <a href="YAHOO.util.Element.html#replaceChild">replaceChild</a>,
3323 <a href="YAHOO.util.Element.html#replaceClass">replaceClass</a>,
3324 <a href="YAHOO.util.Element.html#setStyle">setStyle</a>
3325 </code>
3326 </div>
3327 </div>
3328 <div class="section field inheritance">
3329 <h4>Methods inherited from <a href="YAHOO.util.AttributeProvider.html">YAHOO.util.AttributeProvider</a>:</h4>
3330 <div class="content">
3331 <code>
3333 <a href="YAHOO.util.AttributeProvider.html#configureAttribute">configureAttribute</a>,
3334 <a href="YAHOO.util.AttributeProvider.html#fireBeforeChangeEvent">fireBeforeChangeEvent</a>,
3335 <a href="YAHOO.util.AttributeProvider.html#fireChangeEvent">fireChangeEvent</a>,
3336 <a href="YAHOO.util.AttributeProvider.html#get">get</a>,
3337 <a href="YAHOO.util.AttributeProvider.html#getAttributeConfig">getAttributeConfig</a>,
3338 <a href="YAHOO.util.AttributeProvider.html#getAttributeKeys">getAttributeKeys</a>,
3339 <a href="YAHOO.util.AttributeProvider.html#refresh">refresh</a>,
3340 <a href="YAHOO.util.AttributeProvider.html#register">register</a>,
3341 <a href="YAHOO.util.AttributeProvider.html#resetAttributeConfig">resetAttributeConfig</a>,
3342 <a href="YAHOO.util.AttributeProvider.html#resetValue">resetValue</a>,
3343 <a href="YAHOO.util.AttributeProvider.html#set">set</a>,
3344 <a href="YAHOO.util.AttributeProvider.html#setAttributeConfig">setAttributeConfig</a>,
3345 <a href="YAHOO.util.AttributeProvider.html#setAttributes">setAttributes</a>
3346 </code>
3347 </div>
3348 </div>
3349 <div class="section field inheritance">
3350 <h4>Methods inherited from <a href="YAHOO.util.EventProvider.html">YAHOO.util.EventProvider</a>:</h4>
3351 <div class="content">
3352 <code>
3354 <a href="YAHOO.util.EventProvider.html#createEvent">createEvent</a>,
3355 <a href="YAHOO.util.EventProvider.html#fireEvent">fireEvent</a>,
3356 <a href="YAHOO.util.EventProvider.html#hasEvent">hasEvent</a>,
3357 <a href="YAHOO.util.EventProvider.html#subscribe">subscribe</a>,
3358 <a href="YAHOO.util.EventProvider.html#unsubscribe">unsubscribe</a>,
3359 <a href="YAHOO.util.EventProvider.html#unsubscribeAll">unsubscribeAll</a>
3360 </code>
3361 </div>
3362 </div>
3364 <div class="section method details">
3365 <h3><a name="methodDetails">Events</a></h3>
3366 <div class="content">
3367 <h4>
3368 <a name="blur">blur</a></h4>
3369 <div class="detail">
3370 <code>
3374 <strong>blur</strong>
3379 </code>
3381 <div class="description">
3382 Fires when the menu item loses the input focus. Passes back a
3383 single object representing the original DOM event object passed back by the
3384 event utility (YAHOO.util.Event) when the event was fired. See <a href="
3385 YAHOO.util.Element.html#addListener">Element.addListener</a> for more
3386 information on listening for this event.
3387 </div>
3389 <div class="description">
3394 </div>
3396 </div>
3397 <hr />
3398 <h4>
3399 <a name="focus">focus</a></h4>
3400 <div class="detail">
3401 <code>
3405 <strong>focus</strong>
3410 </code>
3412 <div class="description">
3413 Fires when the menu item receives focus. Passes back a single
3414 object representing the original DOM event object passed back by the event
3415 utility (YAHOO.util.Event) when the event was fired. See <a href="
3416 YAHOO.util.Element.html#addListener">Element.addListener</a> for more
3417 information on listening for this event.
3418 </div>
3420 <div class="description">
3425 </div>
3427 </div>
3428 <hr />
3429 <h4>
3430 <a name="init">init</a></h4>
3431 <div class="detail">
3432 <code>
3436 <strong>init</strong>
3441 </code>
3443 <div class="description">
3444 Fires when the Button is initialized. Subscribe to this event
3445 by specifying a value for the "oninit" configuration attribute. Format:<br>
3446 <code> {<br> <strong>fn:</strong> Function, &#47;&#47; The handler to call
3447 when the event fires.<br> <strong>obj:</strong> Object, &#47;&#47; An object
3448 to pass back to the handler.<br> <strong>scope:</strong> Object &#47;&#47;
3449 The object to use for the scope of the handler.<br> } </code>
3450 </div>
3452 <div class="description">
3457 </div>
3459 </div>
3460 <hr />
3461 <h4>
3462 <a name="option">option</a></h4>
3463 <div class="detail">
3464 <code>
3468 <strong>option</strong>
3473 </code>
3475 <div class="description">
3476 Fires when the user invokes the button's option. Passes back a
3477 single object representing the original DOM event (either "mousedown" or
3478 "keydown") that caused the "option" event to fire. See <a href="
3479 YAHOO.util.Element.html#addListener">Element.addListener</a> for more
3480 information on listening for this event.
3481 </div>
3483 <div class="description">
3488 </div>
3490 </div>
3491 <hr />
3492 </div>
3493 </div>
3496 <div class="section field inheritance">
3497 <h4>Events inherited from <a href="YAHOO.util.Element.html">YAHOO.util.Element</a>:</h4>
3498 <div class="content">
3499 <code>
3501 <a href="YAHOO.util.Element.html#available">available</a>,
3502 <a href="YAHOO.util.Element.html#contentReady">contentReady</a>
3503 </code>
3504 </div>
3505 </div>
3507 <div class="section field details">
3508 <h3><a name="field_detail">Configuration Attributes</a></h3>
3509 <div class="content">
3510 <h4><a name="checked">checked</a>
3511 <code>- Boolean</code>
3512 </h4>
3513 <div class="detail">
3514 <div class="description">
3515 Boolean indicating if the button is checked. Applies only
3516 to buttons of type "radio" and "checkbox."
3517 </div>
3518 </div>
3521 <div class="default">
3522 Default Value: false
3523 </div>
3525 <hr />
3526 <h4><a name="container">container</a>
3527 <code>- <a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
3528 level-one-html.html#ID-58190037">HTMLElement</a>|String</code>
3529 </h4>
3530 <div class="detail">
3531 <div class="description">
3532 HTML element reference or string specifying the id
3533 attribute of the HTML element that the button's markup should be
3534 rendered into.
3535 </div>
3536 </div>
3539 <div class="default">
3540 Default Value: null
3541 </div>
3543 <hr />
3544 <h4><a name="disabled">disabled</a>
3545 <code>- Boolean</code>
3546 </h4>
3547 <div class="detail">
3548 <div class="description">
3549 Boolean indicating if the button should be disabled.
3550 (Disabled buttons are dimmed and will not respond to user input
3551 or fire events.)
3552 </div>
3553 </div>
3556 <div class="default">
3557 Default Value: false
3558 </div>
3560 <hr />
3561 <h4><a name="href">href</a>
3562 <code>- String</code>
3563 </h4>
3564 <div class="detail">
3565 <div class="description">
3566 String specifying the href for the button. Applies only to
3567 buttons of type "link."
3568 </div>
3569 </div>
3573 <hr />
3574 <h4><a name="label">label</a>
3575 <code>- String</code>
3576 </h4>
3577 <div class="detail">
3578 <div class="description">
3579 String specifying the button's text label or innerHTML.
3580 </div>
3581 </div>
3584 <div class="default">
3585 Default Value: null
3586 </div>
3588 <hr />
3589 <h4><a name="menu">menu</a>
3590 <code>- <a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
3591 level-one-html.html#ID-58190037">HTMLElement</a>|String|Array</code>
3592 </h4>
3593 <div class="detail">
3594 <div class="description">
3595 Object specifying the menu for the button. The value can be
3596 one of the following:
3597 <ul>
3598 <li>Object specifying a <a href="YAHOO.widget.Menu.html">
3599 YAHOO.widget.Menu</a> instance.</li>
3600 <li>String specifying the id attribute of the <code>&#60;div&#62;</code>
3601 element used to create the menu.</li>
3602 <li>String specifying the id attribute of the
3603 <code>&#60;select&#62;</code> element used to create the menu.</li>
3604 <li>Object specifying the <code>&#60;div&#62;</code> element used to
3605 create the menu.</li>
3606 <li>Object specifying the <code>&#60;select&#62;</code> element used to
3607 create the menu.</li>
3608 <li>Array of object literals, each representing a set of
3609 <a href="YAHOO.widget.MenuItem.html">YAHOO.widget.MenuItem</a>
3610 configuration attributes.</li>
3611 <li>Array of strings representing the text labels for each menu item in
3612 the menu.</li>
3613 </ul>
3614 </div>
3615 </div>
3618 <div class="default">
3619 Default Value: null
3620 </div>
3622 <hr />
3623 <h4><a name="name">name</a>
3624 <code>- String</code>
3625 </h4>
3626 <div class="detail">
3627 <div class="description">
3628 String specifying the name for the button.
3629 </div>
3630 </div>
3633 <div class="default">
3634 Default Value: null
3635 </div>
3637 <hr />
3638 <h4><a name="onclick">onclick</a>
3639 <code>- Object</code>
3640 </h4>
3641 <div class="detail">
3642 <div class="description">
3643 Object literal representing the code to be executed when
3644 the button is clicked. Format:<br> <code> {<br>
3645 <strong>fn:</strong> Function, &#47;&#47; The handler to call when the
3646 event fires.<br> <strong>obj:</strong> Object, &#47;&#47; An object to
3647 pass back to the handler.<br> <strong>scope:</strong> Object &#47;&#47;
3648 The object to use for the scope of the handler.<br> } </code>
3649 </div>
3650 </div>
3653 <div class="default">
3654 Default Value: null
3655 </div>
3657 <hr />
3658 <h4><a name="oninit">oninit</a>
3659 <code>- Object</code>
3660 </h4>
3661 <div class="detail">
3662 <div class="description">
3663 Object literal representing the code to be executed when
3664 the button is initialized. Format:<br> <code> {<br>
3665 <strong>fn:</strong> Function, &#47;&#47; The handler to call when the
3666 event fires.<br> <strong>obj:</strong> Object, &#47;&#47; An object to
3667 pass back to the handler.<br> <strong>scope:</strong> Object &#47;&#47;
3668 The object to use for the scope of the handler.<br> } </code>
3669 </div>
3670 </div>
3673 <div class="default">
3674 Default Value: null
3675 </div>
3677 <hr />
3678 <h4><a name="selectedMenuItem">selectedMenuItem</a>
3679 <code>- <a href="YAHOO.widget.MenuItem.html">YAHOO.widget.MenuItem</a></code>
3680 </h4>
3681 <div class="detail">
3682 <div class="description">
3683 Reference to the item in the button's menu that is
3684 currently selected.
3685 </div>
3686 </div>
3689 <div class="default">
3690 Default Value: null
3691 </div>
3693 <hr />
3694 <h4><a name="srcelement">srcelement</a>
3695 <code>- <a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
3696 level-one-html.html#ID-58190037">HTMLElement</a>|String</code>
3697 </h4>
3698 <div class="detail">
3699 <div class="description">
3700 Object reference to the HTML element (either
3701 <code>&#60;input&#62;</code> or <code>&#60;span&#62;</code>) used to
3702 create the button.
3703 </div>
3704 </div>
3707 <div class="default">
3708 Default Value: null
3709 </div>
3711 <hr />
3712 <h4><a name="tabindex">tabindex</a>
3713 <code>- Number</code>
3714 </h4>
3715 <div class="detail">
3716 <div class="description">
3717 Number specifying the tabindex for the button.
3718 </div>
3719 </div>
3722 <div class="default">
3723 Default Value: null
3724 </div>
3726 <hr />
3727 <h4><a name="target">target</a>
3728 <code>- String</code>
3729 </h4>
3730 <div class="detail">
3731 <div class="description">
3732 String specifying the target for the button. Applies only
3733 to buttons of type "link."
3734 </div>
3735 </div>
3739 <hr />
3740 <h4><a name="title">title</a>
3741 <code>- String</code>
3742 </h4>
3743 <div class="detail">
3744 <div class="description">
3745 String specifying the title for the button.
3746 </div>
3747 </div>
3750 <div class="default">
3751 Default Value: null
3752 </div>
3754 <hr />
3755 <h4><a name="type">type</a>
3756 <code>- String</code>
3757 </h4>
3758 <div class="detail">
3759 <div class="description">
3760 String specifying the button's type. Possible values are:
3761 "button," "link," "submit," "reset," "checkbox," "radio," "menubutton,"
3762 and "splitbutton."
3763 </div>
3764 </div>
3767 <div class="default">
3768 Default Value: "button"
3769 </div>
3771 <hr />
3772 <h4><a name="value">value</a>
3773 <code>- Object</code>
3774 </h4>
3775 <div class="detail">
3776 <div class="description">
3777 Object specifying the value for the button.
3778 </div>
3779 </div>
3782 <div class="default">
3783 Default Value: null
3784 </div>
3786 <hr />
3788 </div>
3789 </div>
3791 <div class="section field inheritance">
3792 <h4>Configuration attributes inherited from <a href="YAHOO.util.Element.html">YAHOO.util.Element</a>:</h4>
3793 <div class="content">
3794 <code>
3796 <a href="YAHOO.util.Element.html#element">element</a>
3797 </code>
3798 </div>
3799 </div>
3801 </div>
3802 </div>
3803 <div class="yui-b">
3804 <div class="nav">
3806 <div class="module">
3807 <h4>Modules</h4>
3808 <ul class="content">
3810 <li class=""><a href="module_animation.html">animation</a></li>
3812 <li class=""><a href="module_autocomplete.html">autocomplete</a></li>
3814 <li class="selected"><a href="module_button.html">button</a></li>
3816 <li class=""><a href="module_calendar.html">calendar</a></li>
3818 <li class=""><a href="module_connection.html">connection</a></li>
3820 <li class=""><a href="module_container.html">container</a></li>
3822 <li class=""><a href="module_datasource.html">datasource</a></li>
3824 <li class=""><a href="module_datatable.html">datatable</a></li>
3826 <li class=""><a href="module_dom.html">dom</a></li>
3828 <li class=""><a href="module_dragdrop.html">dragdrop</a></li>
3830 <li class=""><a href="module_element.html">element</a></li>
3832 <li class=""><a href="module_event.html">event</a></li>
3834 <li class=""><a href="module_history.html">history</a></li>
3836 <li class=""><a href="module_logger.html">logger</a></li>
3838 <li class=""><a href="module_menu.html">menu</a></li>
3840 <li class=""><a href="module_slider.html">slider</a></li>
3842 <li class=""><a href="module_tabview.html">tabview</a></li>
3844 <li class=""><a href="module_treeview.html">treeview</a></li>
3846 <li class=""><a href="module_yahoo.html">yahoo</a></li>
3847 </ul>
3848 </div>
3850 <div class="module">
3851 <h4>Classes</h4>
3852 <ul class="content">
3853 <li class="selected"><a href="YAHOO.widget.Button.html">YAHOO.widget.Button</a></li>
3854 <li class=""><a href="YAHOO.widget.ButtonGroup.html">YAHOO.widget.ButtonGroup</a></li>
3855 </ul>
3856 </div>
3858 <div class="module">
3859 <h4>Files</h4>
3860 <ul class="content">
3861 <li class=""><a href="button.js.html">button.js</a></li>
3862 <li class=""><a href="buttongroup.js.html">buttongroup.js</a></li>
3863 </ul>
3864 </div>
3866 <div class="module">
3867 <h4>Properties</h4>
3868 <ul class="content">
3869 <li><a href="#_activationButtonPressed">_activationButtonPressed</a>
3870 <!--<code>&lt;String&gt;</code>-->
3871 </li>
3872 <li><a href="#_activationKeyPressed">_activationKeyPressed</a>
3873 <!--<code>&lt;String&gt;</code>-->
3874 </li>
3875 <li><a href="#_button">_button</a>
3876 <!--<code>&lt;String&gt;</code>-->
3877 </li>
3878 <li><a href="#_hasKeyEventHandlers">_hasKeyEventHandlers</a>
3879 <!--<code>&lt;String&gt;</code>-->
3880 </li>
3881 <li><a href="#_hasMouseEventHandlers">_hasMouseEventHandlers</a>
3882 <!--<code>&lt;String&gt;</code>-->
3883 </li>
3884 <li><a href="#_menu">_menu</a>
3885 <!--<code>&lt;String&gt;</code>-->
3886 </li>
3887 <li><a href="#_onclickAttributeValue">_onclickAttributeValue</a>
3888 <!--<code>&lt;String&gt;</code>-->
3889 </li>
3890 <li><a href="#_oninitAttributeValue">_oninitAttributeValue</a>
3891 <!--<code>&lt;String&gt;</code>-->
3892 </li>
3893 <li><a href="#ACTIVATION_KEYS">ACTIVATION_KEYS</a>
3894 <!--<code>&lt;String&gt;</code>-->
3895 </li>
3896 <li><a href="#CHECK_ACTIVATION_KEYS">CHECK_ACTIVATION_KEYS</a>
3897 <!--<code>&lt;String&gt;</code>-->
3898 </li>
3899 <li><a href="#CHECKBOX_CHECKED_TITLE">CHECKBOX_CHECKED_TITLE</a>
3900 <!--<code>&lt;String&gt;</code>-->
3901 </li>
3902 <li><a href="#CHECKBOX_DEFAULT_TITLE">CHECKBOX_DEFAULT_TITLE</a>
3903 <!--<code>&lt;String&gt;</code>-->
3904 </li>
3905 <li><a href="#CSS_CLASS_NAME">CSS_CLASS_NAME</a>
3906 <!--<code>&lt;String&gt;</code>-->
3907 </li>
3908 <li><a href="#MENUBUTTON_DEFAULT_TITLE">MENUBUTTON_DEFAULT_TITLE</a>
3909 <!--<code>&lt;String&gt;</code>-->
3910 </li>
3911 <li><a href="#MENUBUTTON_MENU_VISIBLE_TITLE">MENUBUTTON_MENU_VISIBLE_TITLE</a>
3912 <!--<code>&lt;String&gt;</code>-->
3913 </li>
3914 <li><a href="#OPTION_AREA_WIDTH">OPTION_AREA_WIDTH</a>
3915 <!--<code>&lt;String&gt;</code>-->
3916 </li>
3917 <li><a href="#RADIO_CHECKED_TITLE">RADIO_CHECKED_TITLE</a>
3918 <!--<code>&lt;String&gt;</code>-->
3919 </li>
3920 <li><a href="#RADIO_DEFAULT_TITLE">RADIO_DEFAULT_TITLE</a>
3921 <!--<code>&lt;String&gt;</code>-->
3922 </li>
3923 <li><a href="#SPLITBUTTON_DEFAULT_TITLE">SPLITBUTTON_DEFAULT_TITLE</a>
3924 <!--<code>&lt;String&gt;</code>-->
3925 </li>
3926 <li><a href="#SPLITBUTTON_OPTION_VISIBLE_TITLE">SPLITBUTTON_OPTION_VISIBLE_TITLE</a>
3927 <!--<code>&lt;String&gt;</code>-->
3928 </li>
3929 <li><a href="#SUBMIT_TITLE">SUBMIT_TITLE</a>
3930 <!--<code>&lt;String&gt;</code>-->
3931 </li>
3932 <li><a href="#TAG_NAME">TAG_NAME</a>
3933 <!--<code>&lt;String&gt;</code>-->
3934 </li>
3935 </ul>
3936 </div>
3938 <div class="module">
3939 <h4>Methods</h4>
3940 <ul class="content">
3941 <li><!--<code><a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
3942 level-one-html.html#ID-58190037">HTMLElement</a></code>-->
3943 <a href="#_createButtonElement">_createButtonElement</a>
3944 </li>
3945 <li><!--<code>void</code>-->
3946 <a href="#_hideMenu">_hideMenu</a>
3947 </li>
3948 <li><!--<code>Boolean</code>-->
3949 <a href="#_isActivationKey">_isActivationKey</a>
3950 </li>
3951 <li><!--<code>Boolean</code>-->
3952 <a href="#_isSplitButtonOptionKey">_isSplitButtonOptionKey</a>
3953 </li>
3954 <li><!--<code>void</code>-->
3955 <a href="#_onAppendTo">_onAppendTo</a>
3956 </li>
3957 <li><!--<code>void</code>-->
3958 <a href="#_onBlur">_onBlur</a>
3959 </li>
3960 <li><!--<code>void</code>-->
3961 <a href="#_onClick">_onClick</a>
3962 </li>
3963 <li><!--<code>void</code>-->
3964 <a href="#_onDocumentKeyUp">_onDocumentKeyUp</a>
3965 </li>
3966 <li><!--<code>void</code>-->
3967 <a href="#_onDocumentMouseDown">_onDocumentMouseDown</a>
3968 </li>
3969 <li><!--<code>void</code>-->
3970 <a href="#_onDocumentMouseUp">_onDocumentMouseUp</a>
3971 </li>
3972 <li><!--<code>void</code>-->
3973 <a href="#_onFocus">_onFocus</a>
3974 </li>
3975 <li><!--<code>void</code>-->
3976 <a href="#_onFormReset">_onFormReset</a>
3977 </li>
3978 <li><!--<code>void</code>-->
3979 <a href="#_onFormSubmit">_onFormSubmit</a>
3980 </li>
3981 <li><!--<code>void</code>-->
3982 <a href="#_onKeyDown">_onKeyDown</a>
3983 </li>
3984 <li><!--<code>void</code>-->
3985 <a href="#_onKeyUp">_onKeyUp</a>
3986 </li>
3987 <li><!--<code>void</code>-->
3988 <a href="#_onMenuClick">_onMenuClick</a>
3989 </li>
3990 <li><!--<code>void</code>-->
3991 <a href="#_onMenuHide">_onMenuHide</a>
3992 </li>
3993 <li><!--<code>void</code>-->
3994 <a href="#_onMenuItemAdded">_onMenuItemAdded</a>
3995 </li>
3996 <li><!--<code>void</code>-->
3997 <a href="#_onMenuItemSelected">_onMenuItemSelected</a>
3998 </li>
3999 <li><!--<code>void</code>-->
4000 <a href="#_onMenuKeyDown">_onMenuKeyDown</a>
4001 </li>
4002 <li><!--<code>void</code>-->
4003 <a href="#_onMenuRender">_onMenuRender</a>
4004 </li>
4005 <li><!--<code>void</code>-->
4006 <a href="#_onMenuShow">_onMenuShow</a>
4007 </li>
4008 <li><!--<code>void</code>-->
4009 <a href="#_onMouseDown">_onMouseDown</a>
4010 </li>
4011 <li><!--<code>void</code>-->
4012 <a href="#_onMouseOut">_onMouseOut</a>
4013 </li>
4014 <li><!--<code>void</code>-->
4015 <a href="#_onMouseOver">_onMouseOver</a>
4016 </li>
4017 <li><!--<code>void</code>-->
4018 <a href="#_onMouseUp">_onMouseUp</a>
4019 </li>
4020 <li><!--<code>void</code>-->
4021 <a href="#_onOption">_onOption</a>
4022 </li>
4023 <li><!--<code>void</code>-->
4024 <a href="#_setAccessKey">_setAccessKey</a>
4025 </li>
4026 <li><!--<code>void</code>-->
4027 <a href="#_setChecked">_setChecked</a>
4028 </li>
4029 <li><!--<code>void</code>-->
4030 <a href="#_setDisabled">_setDisabled</a>
4031 </li>
4032 <li><!--<code>void</code>-->
4033 <a href="#_setHref">_setHref</a>
4034 </li>
4035 <li><!--<code>void</code>-->
4036 <a href="#_setLabel">_setLabel</a>
4037 </li>
4038 <li><!--<code>void</code>-->
4039 <a href="#_setMenu">_setMenu</a>
4040 </li>
4041 <li><!--<code>void</code>-->
4042 <a href="#_setOnClick">_setOnClick</a>
4043 </li>
4044 <li><!--<code>void</code>-->
4045 <a href="#_setOnInit">_setOnInit</a>
4046 </li>
4047 <li><!--<code>void</code>-->
4048 <a href="#_setTabIndex">_setTabIndex</a>
4049 </li>
4050 <li><!--<code>void</code>-->
4051 <a href="#_setTarget">_setTarget</a>
4052 </li>
4053 <li><!--<code>void</code>-->
4054 <a href="#_setTitle">_setTitle</a>
4055 </li>
4056 <li><!--<code>void</code>-->
4057 <a href="#_setType">_setType</a>
4058 </li>
4059 <li><!--<code>void</code>-->
4060 <a href="#_showMenu">_showMenu</a>
4061 </li>
4062 <li><!--<code>void</code>-->
4063 <a href="#_submitForm">_submitForm</a>
4064 </li>
4065 <li><!--<code>void</code>-->
4066 <a href="#addHiddenFieldsToForm">addHiddenFieldsToForm</a>
4067 </li>
4068 <li><!--<code>void</code>-->
4069 <a href="#blur">blur</a>
4070 </li>
4071 <li><!--<code><a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
4072 one-html.html#ID-6043025">HTMLInputElement</a></code>-->
4073 <a href="#createHiddenField">createHiddenField</a>
4074 </li>
4075 <li><!--<code><a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
4076 one-html.html#ID-6043025">HTMLInputElement</a></code>-->
4077 <a href="#createInputElement">createInputElement</a>
4078 </li>
4079 <li><!--<code>void</code>-->
4080 <a href="#destroy">destroy</a>
4081 </li>
4082 <li><!--<code>void</code>-->
4083 <a href="#focus">focus</a>
4084 </li>
4085 <li><!--<code><a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/
4086 level-one-html.html#ID-58190037">HTMLElement</a></code>-->
4087 <a href="#getFirstElement">getFirstElement</a>
4088 </li>
4089 <li><!--<code><a href="http://www.w3.org/TR/2000/WD-DOM-Level-1-20000929/level-
4090 one-html.html#ID-40002357">HTMLFormElement</a></code>-->
4091 <a href="#getForm">getForm</a>
4092 </li>
4093 <li><!--<code><a href="YAHOO.widget.Menu.html">YAHOO.widget.Menu</a></code>-->
4094 <a href="#getMenu">getMenu</a>
4095 </li>
4096 <li><!--<code>Boolean</code>-->
4097 <a href="#hasFocus">hasFocus</a>
4098 </li>
4099 <li><!--<code>void</code>-->
4100 <a href="#init">init</a>
4101 </li>
4102 <li><!--<code>void</code>-->
4103 <a href="#initAttributes">initAttributes</a>
4104 </li>
4105 <li><!--<code>void</code>-->
4106 <a href="#initConfig">initConfig</a>
4107 </li>
4108 <li><!--<code>Boolean</code>-->
4109 <a href="#isActive">isActive</a>
4110 </li>
4111 <li><!--<code>void</code>-->
4112 <a href="#setAttributeFromDOMAttribute">setAttributeFromDOMAttribute</a>
4113 </li>
4114 <li><!--<code>void</code>-->
4115 <a href="#setAttributesFromSrcElement">setAttributesFromSrcElement</a>
4116 </li>
4117 <li><!--<code>void</code>-->
4118 <a href="#setFormElementProperties">setFormElementProperties</a>
4119 </li>
4120 <li><!--<code>String</code>-->
4121 <a href="#toString">toString</a>
4122 </li>
4123 </ul>
4124 </div>
4126 <div class="module">
4127 <h4>Events</h4>
4128 <ul class="content">
4129 <li>
4130 <a href="#blur">blur</a>
4131 </li>
4132 <li>
4133 <a href="#focus">focus</a>
4134 </li>
4135 <li>
4136 <a href="#init">init</a>
4137 </li>
4138 <li>
4139 <a href="#option">option</a>
4140 </li>
4141 </ul>
4142 </div>
4144 <div class="module">
4145 <h4>Configuration Attributes</h4>
4146 <ul class="content">
4147 <li>
4148 <a href="#checked">checked</a>
4149 </li>
4150 <li>
4151 <a href="#container">container</a>
4152 </li>
4153 <li>
4154 <a href="#disabled">disabled</a>
4155 </li>
4156 <li>
4157 <a href="#href">href</a>
4158 </li>
4159 <li>
4160 <a href="#label">label</a>
4161 </li>
4162 <li>
4163 <a href="#menu">menu</a>
4164 </li>
4165 <li>
4166 <a href="#name">name</a>
4167 </li>
4168 <li>
4169 <a href="#onclick">onclick</a>
4170 </li>
4171 <li>
4172 <a href="#oninit">oninit</a>
4173 </li>
4174 <li>
4175 <a href="#selectedMenuItem">selectedMenuItem</a>
4176 </li>
4177 <li>
4178 <a href="#srcelement">srcelement</a>
4179 </li>
4180 <li>
4181 <a href="#tabindex">tabindex</a>
4182 </li>
4183 <li>
4184 <a href="#target">target</a>
4185 </li>
4186 <li>
4187 <a href="#title">title</a>
4188 </li>
4189 <li>
4190 <a href="#type">type</a>
4191 </li>
4192 <li>
4193 <a href="#value">value</a>
4194 </li>
4195 </ul>
4196 </div>
4198 </div>
4199 </div>
4200 </div>
4201 <div id="ft">
4202 <hr />
4203 Copyright &copy; 2007 Yahoo! Inc. All rights reserved.
4204 </div>
4205 </div>
4206 </body>
4207 </html>