Upgrade to ExtJS 4.0.7 - Released 10/19/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="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
7   <script type="text/javascript" src="../resources/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'>/**
19 </span> * A split button that provides a built-in dropdown arrow that can fire an event separately from the default click event
20  * of the button. Typically this would be used to display a dropdown menu that provides additional options to the
21  * primary button action, but any custom handler can provide the arrowclick implementation.  Example usage:
22  *
23  *     @example
24  *     // display a dropdown menu:
25  *     Ext.create('Ext.button.Split', {
26  *         renderTo: Ext.getBody(),
27  *         text: 'Options',
28  *         // handle a click on the button itself
29  *         handler: function() {
30  *             alert(&quot;The button was clicked&quot;);
31  *         },
32  *         menu: new Ext.menu.Menu({
33  *             items: [
34  *                 // these will render as dropdown menu items when the arrow is clicked:
35  *                 {text: 'Item 1', handler: function(){ alert(&quot;Item 1 clicked&quot;); }},
36  *                 {text: 'Item 2', handler: function(){ alert(&quot;Item 2 clicked&quot;); }}
37  *             ]
38  *         })
39  *     });
40  *
41  * Instead of showing a menu, you can provide any type of custom functionality you want when the dropdown
42  * arrow is clicked:
43  *
44  *     Ext.create('Ext.button.Split', {
45  *         renderTo: 'button-ct',
46  *         text: 'Options',
47  *         handler: optionsHandler,
48  *         arrowHandler: myCustomHandler
49  *     });
50  *
51  */
52 Ext.define('Ext.button.Split', {
53
54     /* Begin Definitions */
55     alias: 'widget.splitbutton',
56
57     extend: 'Ext.button.Button',
58     alternateClassName: 'Ext.SplitButton',
59     /* End Definitions */
60     
61 <span id='Ext-button-Split-cfg-arrowHandler'>    /**
62 </span>     * @cfg {Function} arrowHandler
63      * A function called when the arrow button is clicked (can be used instead of click event)
64      */
65 <span id='Ext-button-Split-cfg-arrowTooltip'>    /**
66 </span>     * @cfg {String} arrowTooltip
67      * The title attribute of the arrow
68      */
69
70     // private
71     arrowCls      : 'split',
72     split         : true,
73
74     // private
75     initComponent : function(){
76         this.callParent();
77 <span id='Ext-button-Split-event-arrowclick'>        /**
78 </span>         * @event arrowclick
79          * Fires when this button's arrow is clicked.
80          * @param {Ext.button.Split} this
81          * @param {Event} e The click event
82          */
83         this.addEvents(&quot;arrowclick&quot;);
84     },
85
86 <span id='Ext-button-Split-method-setArrowHandler'>    /**
87 </span>     * Sets this button's arrow click handler.
88      * @param {Function} handler The function to call when the arrow is clicked
89      * @param {Object} scope (optional) Scope for the function passed above
90      */
91     setArrowHandler : function(handler, scope){
92         this.arrowHandler = handler;
93         this.scope = scope;
94     },
95
96     // private
97     onClick : function(e, t) {
98         var me = this;
99         
100         e.preventDefault();
101         if (!me.disabled) {
102             if (me.overMenuTrigger) {
103                 me.maybeShowMenu();
104                 me.fireEvent(&quot;arrowclick&quot;, me, e);
105                 if (me.arrowHandler) {
106                     me.arrowHandler.call(me.scope || me, me, e);
107                 }
108             } else {
109                 me.doToggle();
110                 me.fireHandler();
111             }
112         }
113     }
114 });</pre>
115 </body>
116 </html>