Upgrade to ExtJS 4.0.2 - Released 06/09/2011
[extjs.git] / docs / source / Split.html
1 <!DOCTYPE html>
2 <html>
3 <head>
4   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5   <title>The source code</title>
6   <link href="../prettify/prettify.css" type="text/css" rel="stylesheet" />
7   <script type="text/javascript" src="../prettify/prettify.js"></script>
8   <style type="text/css">
9     .highlight { display: block; background-color: #ddd; }
10   </style>
11   <script type="text/javascript">
12     function highlight() {
13       document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
14     }
15   </script>
16 </head>
17 <body onload="prettyPrint(); highlight();">
18   <pre class="prettyprint lang-js"><span id='Ext-button-Split-cfg-arrowTooltip'><span id='Ext-button-Split-cfg-arrowHandler'><span id='Ext-button-Split'>/**
19 </span></span></span> * @class Ext.button.Split
20  * @extends Ext.button.Button
21  * A split button that provides a built-in dropdown arrow that can fire an event separately from the default
22  * click event of the button.  Typically this would be used to display a dropdown menu that provides additional
23  * options to the primary button action, but any custom handler can provide the arrowclick implementation.  
24  * {@img Ext.button.Split/Ext.button.Split.png Ext.button.Split component}
25  * Example usage:
26  * &lt;pre&gt;&lt;code&gt;
27 // display a dropdown menu:
28     Ext.create('Ext.button.Split', {
29         renderTo: 'button-ct', // the container id
30         text: 'Options',
31         handler: optionsHandler, // handle a click on the button itself
32         menu: new Ext.menu.Menu({
33         items: [
34                 // these items will render as dropdown menu items when the arrow is clicked:
35                 {text: 'Item 1', handler: item1Handler},
36                 {text: 'Item 2', handler: item2Handler}
37         ]
38         })
39     });
40
41 // Instead of showing a menu, you provide any type of custom
42 // functionality you want when the dropdown arrow is clicked:
43     Ext.create('Ext.button.Split', {
44         renderTo: 'button-ct',
45         text: 'Options',
46         handler: optionsHandler,
47         arrowHandler: myCustomHandler
48     });
49 &lt;/code&gt;&lt;/pre&gt;
50  * @cfg {Function} arrowHandler A function called when the arrow button is clicked (can be used instead of click event)
51  * @cfg {String} arrowTooltip The title attribute of the arrow
52  */
53 Ext.define('Ext.button.Split', {
54
55     /* Begin Definitions */
56
57     alias: 'widget.splitbutton',
58
59     extend: 'Ext.button.Button',
60     alternateClassName: 'Ext.SplitButton',
61
62     // private
63     arrowCls      : 'split',
64     split         : true,
65
66     // private
67     initComponent : function(){
68         this.callParent();
69 <span id='Ext-button-Split-event-arrowclick'>        /**
70 </span>         * @event arrowclick
71          * Fires when this button's arrow is clicked
72          * @param {MenuButton} this
73          * @param {EventObject} e The click event
74          */
75         this.addEvents(&quot;arrowclick&quot;);
76     },
77
78 <span id='Ext-button-Split-method-setArrowHandler'>     /**
79 </span>     * Sets this button's arrow click handler.
80      * @param {Function} handler The function to call when the arrow is clicked
81      * @param {Object} scope (optional) Scope for the function passed above
82      */
83     setArrowHandler : function(handler, scope){
84         this.arrowHandler = handler;
85         this.scope = scope;
86     },
87
88     // private
89     onClick : function(e, t) {
90         var me = this;
91         
92         e.preventDefault();
93         if (!me.disabled) {
94             if (me.overMenuTrigger) {
95                 if (me.menu &amp;&amp; !me.menu.isVisible() &amp;&amp; !me.ignoreNextClick) {
96                     me.showMenu();
97                 }
98                 me.fireEvent(&quot;arrowclick&quot;, me, e);
99                 if (me.arrowHandler) {
100                     me.arrowHandler.call(me.scope || me, me, e);
101                 }
102             } else {
103                 if (me.enableToggle) {
104                     me.toggle();
105                 }
106                 me.fireEvent(&quot;click&quot;, me, e);
107                 if (me.handler) {
108                     me.handler.call(me.scope || me, me, e);
109                 }
110                 me.onBlur();
111             }
112         }
113     }
114 });</pre>
115 </body>
116 </html>