2 "name" : "Roo.menu.Item",
15 "desc" : "A base class for all menu items that require menu-related functionality (like sub-menus) and are not static\ndisplay items. Item extends the base functionality of {@link Roo.menu.BaseItem} by adding menu-specific\nactivation and click handling.",
16 "isSingleton" : false,
20 "isBuilderTop" : false,
30 "desc" : "Configuration options",
41 "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>",
42 "memberOf" : "Roo.util.Observable"
47 "desc" : "Length of time in milliseconds to wait before showing this item (defaults to 200)",
48 "memberOf" : "Roo.menu.Item"
53 "desc" : "The text to show on the menu item.",
54 "memberOf" : "Roo.menu.Item"
58 "type" : "Roo.menu.Menu",
59 "desc" : "A Sub menu",
60 "memberOf" : "Roo.menu.Item"
63 "name" : "activeClass",
65 "desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")",
66 "memberOf" : "Roo.menu.BaseItem"
71 "desc" : "True to prevent creation of this menu item (defaults to false)",
72 "memberOf" : "Roo.menu.BaseItem"
77 "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\".",
78 "memberOf" : "Roo.Component"
83 "desc" : "A function that will handle the click event of this menu item (defaults to undefined)",
84 "memberOf" : "Roo.menu.BaseItem"
89 "desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
90 "memberOf" : "Roo.menu.BaseItem"
93 "name" : "hideOnClick",
95 "desc" : "True to hide the containing menu after this item is clicked (defaults to true)",
96 "memberOf" : "Roo.menu.BaseItem"
99 "name" : "allowDomMove",
101 "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
102 "memberOf" : "Roo.Component"
107 "desc" : "The default CSS class to use for menu items (defaults to \"x-menu-item\")",
108 "memberOf" : "Roo.menu.Item"
113 "desc" : "to render in menu\nThe text to show on the menu item (HTML version).",
114 "memberOf" : "Roo.menu.Item"
117 "name" : "actionMode",
119 "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",
120 "memberOf" : "Roo.Component"
123 "name" : "canActivate",
125 "desc" : "True if this item can be visually activated (defaults to true)",
126 "memberOf" : "Roo.menu.Item"
131 "desc" : "The path to an icon to display in this menu item (defaults to Roo.BLANK_IMAGE_URL)",
132 "memberOf" : "Roo.menu.Item"
135 "name" : "disableClass",
137 "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
138 "memberOf" : "Roo.Component"
145 "desc" : "Sets the text to display in this menu item",
146 "sig" : "(text, isHTML)",
150 "isConstructor" : false,
162 "desc" : "The text to display",
168 "desc" : "true to indicate text is pure html.",
177 "desc" : "Returns the id of this component.",
178 "sig" : "()\n{\n\n}",
180 "memberOf" : "Roo.Component",
182 "isConstructor" : false,
202 "desc" : "If this is a lazy rendering component, render it to its container element.",
203 "sig" : "(container)",
205 "memberOf" : "Roo.Component",
207 "isConstructor" : false,
217 "name" : "container",
218 "type" : "String/HTMLElement/Element",
219 "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
228 "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}.",
229 "sig" : "()\n{\n\n}",
231 "memberOf" : "Roo.Component",
233 "isConstructor" : false,
245 "name" : "isVisible",
247 "desc" : "Returns true if this component is visible.",
248 "sig" : "()\n{\n\n}",
250 "memberOf" : "Roo.Component",
252 "isConstructor" : false,
264 "name" : "setDisabled",
266 "desc" : "Convenience function for setting disabled/enabled by boolean.",
267 "sig" : "(disabled)",
269 "memberOf" : "Roo.Component",
271 "isConstructor" : false,
292 "desc" : "Hide this component.",
293 "sig" : "()\n{\n\n}",
295 "memberOf" : "Roo.Component",
297 "isConstructor" : false,
309 "type" : "Roo.Component",
317 "desc" : "Try to focus this component.",
318 "sig" : "(selectText)",
320 "memberOf" : "Roo.Component",
322 "isConstructor" : false,
332 "name" : "selectText",
334 "desc" : "True to also select the text in this component (if applicable)",
341 "type" : "Roo.Component",
349 "desc" : "Show this component.",
350 "sig" : "()\n{\n\n}",
352 "memberOf" : "Roo.Component",
354 "isConstructor" : false,
366 "type" : "Roo.Component",
374 "desc" : "Enable this component.",
375 "sig" : "()\n{\n\n}",
377 "memberOf" : "Roo.Component",
379 "isConstructor" : false,
391 "type" : "Roo.Component",
397 "name" : "setVisible",
399 "desc" : "Convenience function to hide or show this component by boolean.",
402 "memberOf" : "Roo.Component",
404 "isConstructor" : false,
416 "desc" : "True to show, false to hide",
423 "type" : "Roo.Component",
431 "desc" : "Disable this component.",
432 "sig" : "()\n{\n\n}",
434 "memberOf" : "Roo.Component",
436 "isConstructor" : false,
448 "type" : "Roo.Component",
456 "desc" : "Returns the underlying {@link Roo.Element}.",
457 "sig" : "()\n{\n\n}",
459 "memberOf" : "Roo.Component",
461 "isConstructor" : false,
473 "type" : "Roo.Element",
474 "desc" : "The element"
479 "name" : "purgeListeners",
481 "desc" : "Removes all listeners for this object",
482 "sig" : "()\n{\n\n}",
484 "memberOf" : "Roo.util.Observable",
486 "isConstructor" : false,
500 "desc" : "Appends an event handler to this element (shorthand for addListener)",
501 "sig" : "(eventName, handler, scope, options)",
503 "memberOf" : "Roo.util.Observable",
505 "isConstructor" : false,
515 "name" : "eventName",
517 "desc" : "The type of event to listen for",
523 "desc" : "The method the event invokes",
529 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
535 "desc" : "(optional)",
544 "desc" : "Removes a listener (shorthand for removeListener)",
545 "sig" : "(eventName, handler, scope)",
547 "memberOf" : "Roo.util.Observable",
549 "isConstructor" : false,
559 "name" : "eventName",
561 "desc" : "The type of event to listen for",
567 "desc" : "The handler to remove",
573 "desc" : "(optional) The scope (this object) for the handler",
580 "name" : "addEvents",
582 "desc" : "Used to define events on this Observable",
585 "memberOf" : "Roo.util.Observable",
587 "isConstructor" : false,
599 "desc" : "The object with the events defined",
606 "name" : "releaseCapture",
608 "desc" : "Removes <b>all</b> added captures from the Observable.",
611 "memberOf" : "Roo.util.Observable",
613 "isConstructor" : false,
624 "type" : "Observable",
625 "desc" : "The Observable to release",
632 "name" : "removeListener",
634 "desc" : "Removes a listener",
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" : "fireEvent",
672 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
673 "sig" : "(eventName, args)",
675 "memberOf" : "Roo.util.Observable",
677 "isConstructor" : false,
687 "name" : "eventName",
694 "type" : "Object...",
695 "desc" : "Variable number of parameters are passed to handlers",
703 "desc" : "returns false if any of the handlers return false otherwise it returns true"
708 "name" : "hasListener",
710 "desc" : "Checks to see if this object has any listeners for a specified event",
711 "sig" : "(eventName)",
713 "memberOf" : "Roo.util.Observable",
715 "isConstructor" : false,
725 "name" : "eventName",
727 "desc" : "The name of the event to check for",
735 "desc" : "True if the event is being listened for, else false"
742 "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.",
743 "sig" : "(o, fn, scope)",
745 "memberOf" : "Roo.util.Observable",
747 "isConstructor" : false,
758 "type" : "Observable",
759 "desc" : "The Observable to capture",
765 "desc" : "The function to call",
771 "desc" : "(optional) The scope (this object) for the fn",
778 "name" : "addListener",
780 "desc" : "Appends an event handler to this component",
781 "sig" : "(eventName, handler, scope, options)",
783 "memberOf" : "Roo.util.Observable",
785 "isConstructor" : false,
795 "name" : "eventName",
797 "desc" : "The type of event to listen for",
803 "desc" : "The method the event invokes",
809 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
815 "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>",
826 "desc" : "Fires when this item is clicked",
827 "sig" : "function (_self, e)\n{\n\n}",
828 "memberOf" : "Roo.menu.BaseItem",
836 "type" : "Roo.menu.BaseItem",
842 "type" : "Roo.EventObject",
852 "desc" : "Fires when this item is activated",
853 "sig" : "function (_self)\n{\n\n}",
854 "memberOf" : "Roo.menu.BaseItem",
862 "type" : "Roo.menu.BaseItem",
870 "name" : "deactivate",
872 "desc" : "Fires when this item is deactivated",
873 "sig" : "function (_self)\n{\n\n}",
874 "memberOf" : "Roo.menu.BaseItem",
882 "type" : "Roo.menu.BaseItem",
890 "name" : "beforerender",
892 "desc" : "Fires before the component is rendered. Return false to stop the render.",
893 "sig" : "function (_self)\n{\n\n}",
894 "memberOf" : "Roo.Component",
902 "type" : "Roo.Component",
912 "desc" : "Fires after the component is disabled.",
913 "sig" : "function (_self)\n{\n\n}",
914 "memberOf" : "Roo.Component",
922 "type" : "Roo.Component",
932 "desc" : "Fires after the component is rendered.",
933 "sig" : "function (_self)\n{\n\n}",
934 "memberOf" : "Roo.Component",
942 "type" : "Roo.Component",
952 "desc" : "Fires after the component is destroyed.",
953 "sig" : "function (_self)\n{\n\n}",
954 "memberOf" : "Roo.Component",
962 "type" : "Roo.Component",
972 "desc" : "Fires after the component is hidden.",
973 "sig" : "function (_self)\n{\n\n}",
974 "memberOf" : "Roo.Component",
982 "type" : "Roo.Component",
990 "name" : "beforehide",
992 "desc" : "Fires before the component is hidden. Return false to stop the hide.",
993 "sig" : "function (_self)\n{\n\n}",
994 "memberOf" : "Roo.Component",
1002 "type" : "Roo.Component",
1004 "isOptional" : false
1011 "type" : "function",
1012 "desc" : "Fires after the component is shown.",
1013 "sig" : "function (_self)\n{\n\n}",
1014 "memberOf" : "Roo.Component",
1022 "type" : "Roo.Component",
1024 "isOptional" : false
1030 "name" : "beforeshow",
1031 "type" : "function",
1032 "desc" : "Fires before the component is shown. Return false to stop the show.",
1033 "sig" : "function (_self)\n{\n\n}",
1034 "memberOf" : "Roo.Component",
1042 "type" : "Roo.Component",
1044 "isOptional" : false
1051 "type" : "function",
1052 "desc" : "Fires after the component is enabled.",
1053 "sig" : "function (_self)\n{\n\n}",
1054 "memberOf" : "Roo.Component",
1062 "type" : "Roo.Component",
1064 "isOptional" : false
1070 "name" : "beforedestroy",
1071 "type" : "function",
1072 "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
1073 "sig" : "function (_self)\n{\n\n}",
1074 "memberOf" : "Roo.Component",
1082 "type" : "Roo.Component",
1084 "isOptional" : false