2 "name" : "Roo.menu.CheckItem",
12 "desc" : "Adds a menu item that contains a checkbox by default, but can also be part of a radio group.",
13 "isSingleton" : false,
17 "isBuilderTop" : false,
18 "memberOf" : "CheckItem",
27 "desc" : "Configuration options",
38 "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
39 "memberOf" : "Roo.util.Observable",
46 "desc" : "Length of time in milliseconds to wait before showing this item (defaults to 200)",
47 "memberOf" : "Roo.menu.Item",
54 "desc" : "The text to show on the menu item.",
55 "memberOf" : "Roo.menu.Item",
61 "type" : "Roo.menu.Menu",
62 "desc" : "A Sub menu",
63 "memberOf" : "Roo.menu.Item",
68 "name" : "activeClass",
70 "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")",
71 "memberOf" : "Roo.menu.BaseItem",
78 "desc" : "True to prevent creation of this menu item (defaults to false)",
79 "memberOf" : "Roo.menu.BaseItem",
86 "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
87 "memberOf" : "Roo.Component",
97 "desc" : "All check items with the same group name will automatically be grouped into a single-select\nradio button group (defaults to '')",
105 "desc" : "A function that will handle the click event of this menu item (defaults to undefined)",
106 "memberOf" : "Roo.menu.BaseItem",
107 "isOptional" : false,
111 "name" : "hideDelay",
113 "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
114 "memberOf" : "Roo.menu.BaseItem",
115 "isOptional" : false,
119 "name" : "hideOnClick",
121 "desc" : "True to hide the containing menu after this item is clicked (defaults to true)",
122 "memberOf" : "Roo.menu.BaseItem",
123 "isOptional" : false,
127 "name" : "allowDomMove",
129 "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
130 "memberOf" : "Roo.Component",
131 "isOptional" : false,
137 "desc" : "The default CSS class to use for check items (defaults to \"x-menu-item x-menu-check-item\")",
139 "isOptional" : false,
145 "desc" : "to render in menu\nThe text to show on the menu item (HTML version).",
146 "memberOf" : "Roo.menu.Item",
147 "isOptional" : false,
151 "name" : "actionMode",
153 "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
154 "memberOf" : "Roo.Component",
155 "isOptional" : false,
159 "name" : "groupClass",
161 "desc" : "The default CSS class to use for radio group check items (defaults to \"x-menu-group-item\")",
163 "isOptional" : false,
167 "name" : "canActivate",
169 "desc" : "True if this item can be visually activated (defaults to true)",
170 "memberOf" : "Roo.menu.Item",
171 "isOptional" : false,
177 "desc" : "The path to an icon to display in this menu item (defaults to Roo.BLANK_IMAGE_URL)",
178 "memberOf" : "Roo.menu.Item",
179 "isOptional" : false,
185 "desc" : "True to initialize this checkbox as checked (defaults to false). Note that\nif this checkbox is part of a radio group (group = true) only the last item in the group that is\ninitialized with checked = true will be rendered as checked.",
187 "isOptional" : false,
191 "name" : "disableClass",
193 "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
194 "memberOf" : "Roo.Component",
195 "isOptional" : false,
201 "name" : "setChecked",
203 "desc" : "Set the checked state of this item",
204 "sig" : "(checked, suppressEvent)",
208 "isConstructor" : false,
220 "desc" : "The new checked value",
224 "name" : "suppressEvent",
226 "desc" : "(optional) True to prevent the checkchange event from firing (defaults to false)",
235 "desc" : "Sets the text to display in this menu item",
236 "sig" : "(text, isHTML)",
238 "memberOf" : "Roo.menu.Item",
240 "isConstructor" : false,
252 "desc" : "The text to display",
258 "desc" : "true to indicate text is pure html.",
267 "desc" : "Returns the id of this component.",
268 "sig" : "()\n{\n\n}",
270 "memberOf" : "Roo.Component",
272 "isConstructor" : false,
292 "desc" : "If this is a lazy rendering component, render it to its container element.",
293 "sig" : "(container)",
295 "memberOf" : "Roo.Component",
297 "isConstructor" : false,
307 "name" : "container",
308 "type" : "String/HTMLElement/Element",
309 "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
318 "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
319 "sig" : "()\n{\n\n}",
321 "memberOf" : "Roo.Component",
323 "isConstructor" : false,
335 "name" : "isVisible",
337 "desc" : "Returns true if this component is visible.",
338 "sig" : "()\n{\n\n}",
340 "memberOf" : "Roo.Component",
342 "isConstructor" : false,
354 "name" : "setDisabled",
356 "desc" : "Convenience function for setting disabled/enabled by boolean.",
357 "sig" : "(disabled)",
359 "memberOf" : "Roo.Component",
361 "isConstructor" : false,
382 "desc" : "Hide this component.",
383 "sig" : "()\n{\n\n}",
385 "memberOf" : "Roo.Component",
387 "isConstructor" : false,
399 "type" : "Roo.Component",
407 "desc" : "Try to focus this component.",
408 "sig" : "(selectText)",
410 "memberOf" : "Roo.Component",
412 "isConstructor" : false,
422 "name" : "selectText",
424 "desc" : "True to also select the text in this component (if applicable)",
431 "type" : "Roo.Component",
439 "desc" : "Show this component.",
440 "sig" : "()\n{\n\n}",
442 "memberOf" : "Roo.Component",
444 "isConstructor" : false,
456 "type" : "Roo.Component",
464 "desc" : "Enable this component.",
465 "sig" : "()\n{\n\n}",
467 "memberOf" : "Roo.Component",
469 "isConstructor" : false,
481 "type" : "Roo.Component",
487 "name" : "setVisible",
489 "desc" : "Convenience function to hide or show this component by boolean.",
492 "memberOf" : "Roo.Component",
494 "isConstructor" : false,
506 "desc" : "True to show, false to hide",
513 "type" : "Roo.Component",
521 "desc" : "Disable this component.",
522 "sig" : "()\n{\n\n}",
524 "memberOf" : "Roo.Component",
526 "isConstructor" : false,
538 "type" : "Roo.Component",
546 "desc" : "Returns the underlying {@link Roo.Element}.",
547 "sig" : "()\n{\n\n}",
549 "memberOf" : "Roo.Component",
551 "isConstructor" : false,
563 "type" : "Roo.Element",
564 "desc" : "The element"
569 "name" : "purgeListeners",
571 "desc" : "Removes all listeners for this object",
572 "sig" : "()\n{\n\n}",
574 "memberOf" : "Roo.util.Observable",
576 "isConstructor" : false,
590 "desc" : "Appends an event handler to this element (shorthand for addListener)",
591 "sig" : "(eventName, handler, scope, options)",
593 "memberOf" : "Roo.util.Observable",
595 "isConstructor" : false,
605 "name" : "eventName",
607 "desc" : "The type of event to listen for",
613 "desc" : "The method the event invokes",
619 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
625 "desc" : "(optional)",
634 "desc" : "Removes a listener (shorthand for removeListener)",
635 "sig" : "(eventName, handler, scope)",
637 "memberOf" : "Roo.util.Observable",
639 "isConstructor" : false,
649 "name" : "eventName",
651 "desc" : "The type of event to listen for",
657 "desc" : "The handler to remove",
663 "desc" : "(optional) The scope (this object) for the handler",
670 "name" : "addEvents",
672 "desc" : "Used to define events on this Observable",
675 "memberOf" : "Roo.util.Observable",
677 "isConstructor" : false,
689 "desc" : "The object with the events defined",
696 "name" : "releaseCapture",
698 "desc" : "Removes <b>all</b> added captures from the Observable.",
701 "memberOf" : "Roo.util.Observable",
703 "isConstructor" : false,
714 "type" : "Observable",
715 "desc" : "The Observable to release",
722 "name" : "removeListener",
724 "desc" : "Removes a listener",
725 "sig" : "(eventName, handler, scope)",
727 "memberOf" : "Roo.util.Observable",
729 "isConstructor" : false,
739 "name" : "eventName",
741 "desc" : "The type of event to listen for",
747 "desc" : "The handler to remove",
753 "desc" : "(optional) The scope (this object) for the handler",
760 "name" : "fireEvent",
762 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
763 "sig" : "(eventName, args)",
765 "memberOf" : "Roo.util.Observable",
767 "isConstructor" : false,
777 "name" : "eventName",
784 "type" : "Object...",
785 "desc" : "Variable number of parameters are passed to handlers",
793 "desc" : "returns false if any of the handlers return false otherwise it returns true"
798 "name" : "hasListener",
800 "desc" : "Checks to see if this object has any listeners for a specified event",
801 "sig" : "(eventName)",
803 "memberOf" : "Roo.util.Observable",
805 "isConstructor" : false,
815 "name" : "eventName",
817 "desc" : "The name of the event to check for",
825 "desc" : "True if the event is being listened for, else false"
832 "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
833 "sig" : "(o, fn, scope)",
835 "memberOf" : "Roo.util.Observable",
837 "isConstructor" : false,
848 "type" : "Observable",
849 "desc" : "The Observable to capture",
855 "desc" : "The function to call",
861 "desc" : "(optional) The scope (this object) for the fn",
868 "name" : "addListener",
870 "desc" : "Appends an event handler to this component",
871 "sig" : "(eventName, handler, scope, options)",
873 "memberOf" : "Roo.util.Observable",
875 "isConstructor" : false,
885 "name" : "eventName",
887 "desc" : "The type of event to listen for",
893 "desc" : "The method the event invokes",
899 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
905 "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
914 "name" : "beforecheckchange",
916 "desc" : "Fires before the checked value is set, providing an opportunity to cancel if needed",
917 "sig" : "function (_self, checked)\n{\n\n}",
926 "type" : "Roo.menu.CheckItem",
933 "desc" : "The new checked value that will be set",
940 "name" : "checkchange",
942 "desc" : "Fires after the checked value has been set",
943 "sig" : "function (_self, checked)\n{\n\n}",
952 "type" : "Roo.menu.CheckItem",
959 "desc" : "The checked value that was set",
968 "desc" : "Fires when this item is clicked",
969 "sig" : "function (_self, e)\n{\n\n}",
970 "memberOf" : "Roo.menu.BaseItem",
978 "type" : "Roo.menu.BaseItem",
984 "type" : "Roo.EventObject",
994 "desc" : "Fires when this item is activated",
995 "sig" : "function (_self)\n{\n\n}",
996 "memberOf" : "Roo.menu.BaseItem",
1004 "type" : "Roo.menu.BaseItem",
1006 "isOptional" : false
1012 "name" : "deactivate",
1013 "type" : "function",
1014 "desc" : "Fires when this item is deactivated",
1015 "sig" : "function (_self)\n{\n\n}",
1016 "memberOf" : "Roo.menu.BaseItem",
1024 "type" : "Roo.menu.BaseItem",
1026 "isOptional" : false
1032 "name" : "beforerender",
1033 "type" : "function",
1034 "desc" : "Fires before the component is rendered. Return false to stop the render.",
1035 "sig" : "function (_self)\n{\n\n}",
1036 "memberOf" : "Roo.Component",
1044 "type" : "Roo.Component",
1046 "isOptional" : false
1053 "type" : "function",
1054 "desc" : "Fires after the component is disabled.",
1055 "sig" : "function (_self)\n{\n\n}",
1056 "memberOf" : "Roo.Component",
1064 "type" : "Roo.Component",
1066 "isOptional" : false
1073 "type" : "function",
1074 "desc" : "Fires after the component is rendered.",
1075 "sig" : "function (_self)\n{\n\n}",
1076 "memberOf" : "Roo.Component",
1084 "type" : "Roo.Component",
1086 "isOptional" : false
1093 "type" : "function",
1094 "desc" : "Fires after the component is destroyed.",
1095 "sig" : "function (_self)\n{\n\n}",
1096 "memberOf" : "Roo.Component",
1104 "type" : "Roo.Component",
1106 "isOptional" : false
1113 "type" : "function",
1114 "desc" : "Fires after the component is hidden.",
1115 "sig" : "function (_self)\n{\n\n}",
1116 "memberOf" : "Roo.Component",
1124 "type" : "Roo.Component",
1126 "isOptional" : false
1132 "name" : "beforehide",
1133 "type" : "function",
1134 "desc" : "Fires before the component is hidden. Return false to stop the hide.",
1135 "sig" : "function (_self)\n{\n\n}",
1136 "memberOf" : "Roo.Component",
1144 "type" : "Roo.Component",
1146 "isOptional" : false
1153 "type" : "function",
1154 "desc" : "Fires after the component is shown.",
1155 "sig" : "function (_self)\n{\n\n}",
1156 "memberOf" : "Roo.Component",
1164 "type" : "Roo.Component",
1166 "isOptional" : false
1172 "name" : "beforeshow",
1173 "type" : "function",
1174 "desc" : "Fires before the component is shown. Return false to stop the show.",
1175 "sig" : "function (_self)\n{\n\n}",
1176 "memberOf" : "Roo.Component",
1184 "type" : "Roo.Component",
1186 "isOptional" : false
1193 "type" : "function",
1194 "desc" : "Fires after the component is enabled.",
1195 "sig" : "function (_self)\n{\n\n}",
1196 "memberOf" : "Roo.Component",
1204 "type" : "Roo.Component",
1206 "isOptional" : false
1212 "name" : "beforedestroy",
1213 "type" : "function",
1214 "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1215 "sig" : "function (_self)\n{\n\n}",
1216 "memberOf" : "Roo.Component",
1224 "type" : "Roo.Component",
1226 "isOptional" : false