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; }
11 <script type="text/javascript">
12 function highlight() {
13 document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
17 <body onload="prettyPrint(); highlight();">
18 <pre class="prettyprint lang-js"><span id='Ext-menu-CheckItem'>/**
19 </span> * @class Ext.menu.CheckItem
20 * @extends Ext.menu.Item
22 * A menu item that contains a togglable checkbox by default, but that can also be a part of a radio group.
24 * {@img Ext.menu.CheckItem/Ext.menu.CheckItem.png Ext.menu.CheckItem component}
28 * Ext.create('Ext.menu.Menu', {
31 * floating: false, // usually you want this set to True (default)
32 * renderTo: Ext.getBody(), // usually rendered by it's containing component
34 * xtype: 'menucheckitem',
37 * xtype: 'menucheckitem',
38 * text: 'select specific',
43 * text: 'regular item'
48 Ext.define('Ext.menu.CheckItem', {
49 extend: 'Ext.menu.Item',
50 alias: 'widget.menucheckitem',
52 <span id='Ext-menu-CheckItem-cfg-checkedCls'> /**
53 </span> * @cfg {String} checkedCls
54 * The CSS class used by {@link #cls} to show the checked state.
55 * Defaults to `Ext.baseCSSPrefix + 'menu-item-checked'`.
58 checkedCls: Ext.baseCSSPrefix + 'menu-item-checked',
59 <span id='Ext-menu-CheckItem-cfg-uncheckedCls'> /**
60 </span> * @cfg {String} uncheckedCls
61 * The CSS class used by {@link #cls} to show the unchecked state.
62 * Defaults to `Ext.baseCSSPrefix + 'menu-item-unchecked'`.
65 uncheckedCls: Ext.baseCSSPrefix + 'menu-item-unchecked',
66 <span id='Ext-menu-CheckItem-cfg-groupCls'> /**
67 </span> * @cfg {String} groupCls
68 * The CSS class applied to this item's icon image to denote being a part of a radio group.
69 * Defaults to `Ext.baseCSSClass + 'menu-group-icon'`.
70 * Any specified {@link #iconCls} overrides this.
73 groupCls: Ext.baseCSSPrefix + 'menu-group-icon',
75 <span id='Ext-menu-CheckItem-cfg-hideOnClick'> /**
76 </span> * @cfg {Boolean} hideOnClick
77 * Whether to not to hide the owning menu when this item is clicked.
78 * Defaults to `false` for checkbox items, and to `true` for radio group items.
83 afterRender: function() {
86 me.checked = !me.checked;
87 me.setChecked(!me.checked, true);
90 initComponent: function() {
93 <span id='Ext-menu-CheckItem-event-beforecheckchange'> /**
94 </span> * @event beforecheckchange
95 * Fires before a change event. Return false to cancel.
96 * @param {Ext.menu.CheckItem} this
97 * @param {Boolean} checked
101 <span id='Ext-menu-CheckItem-event-checkchange'> /**
102 </span> * @event checkchange
103 * Fires after a change event.
104 * @param {Ext.menu.CheckItem} this
105 * @param {Boolean} checked
110 me.callParent(arguments);
112 Ext.menu.Manager.registerCheckable(me);
116 me.iconCls = me.groupCls;
118 if (me.initialConfig.hideOnClick !== false) {
119 me.hideOnClick = true;
124 <span id='Ext-menu-CheckItem-method-disableCheckChange'> /**
125 </span> * Disables just the checkbox functionality of this menu Item. If this menu item has a submenu, that submenu
126 * will still be accessible
128 disableCheckChange: function() {
132 me.iconEl.addCls(me.disabledCls);
134 me.checkChangeDisabled = true;
137 <span id='Ext-menu-CheckItem-method-enableCheckChange'> /**
138 </span> * Reenables the checkbox functionality of this menu item after having been disabled by {@link #disableCheckChange}
140 enableCheckChange: function() {
143 me.iconEl.removeCls(me.disabledCls);
144 me.checkChangeDisabled = false;
147 onClick: function(e) {
149 if(!me.disabled && !me.checkChangeDisabled && !(me.checked && me.group)) {
150 me.setChecked(!me.checked);
152 this.callParent([e]);
155 onDestroy: function() {
156 Ext.menu.Manager.unregisterCheckable(this);
157 this.callParent(arguments);
160 <span id='Ext-menu-CheckItem-method-setChecked'> /**
161 </span> * Sets the checked state of the item
162 * @param {Boolean} checked True to check, false to uncheck
163 * @param {Boolean} suppressEvents (optional) True to prevent firing the checkchange events. Defaults to `false`.
166 setChecked: function(checked, suppressEvents) {
168 if (me.checked !== checked && (suppressEvents || me.fireEvent('beforecheckchange', me, checked) !== false)) {
170 me.el[checked ? 'addCls' : 'removeCls'](me.checkedCls)[!checked ? 'addCls' : 'removeCls'](me.uncheckedCls);
172 me.checked = checked;
173 Ext.menu.Manager.onCheckChange(me, checked);
174 if (!suppressEvents) {
175 Ext.callback(me.checkHandler, me.scope, [me, checked]);
176 me.fireEvent('checkchange', me, checked);