- - - -

- -

- - - - -

Roo.util.Observable
-Roo.Component
-Roo.menu.BaseItem
-Roo.menu.Item 
-
-

- - - - -

- - Class Roo.menu.Item -

- - - - - - - - - - - - - - - - -

Package:	Roo.menu
Defined In:	- - Roo/menu/Item.js. - -
Class:	Item
Subclasses:	- Roo.menu.CheckItem - - - -
Extends:	- Roo.menu.BaseItem - -

- - - -

- A base class for all menu items that require menu-related functionality (like sub-menus) and are not static
display items. Item extends the base functionality of {link Roo.menu.BaseItem} by adding menu-specific
activation and click handling. -

- - - - -

- Class Comments / Notes => - [Add Your comment/notes about this class] -
- -

- - - - - - - - -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Config Options (Usually are also Properties)
Options		Defined By
	- - - - HTML : String - - - - - - to render in menu The text to show on the menu item (HTML version). - - - - - to render in menu The text to show on the menu item (HTML version). - - - - - - -	- - Roo.menu.Item - -
	- - - - actionMode : String - - - - - - which property holds the element that used for hide() / show() / disable() / enable() default is 'el' - - - - - which property holds the element that used for hide() / show() / disable() / enable() default is 'el' - - - - - - -	- - Roo.Component - -
	- - - - activeClass : String - - - - - - The CSS class to use when the item becomes activated (defaults to "x-menu-item-active") - - - - - The CSS class to use when the item becomes activated (defaults to "x-menu-item-active") - - - - - - -	- - Roo.menu.BaseItem - -
	- - - - allowDomMove : Boolean - - - - - - Whether the component can move the Dom node when rendering (defaults to true). - - - - - Whether the component can move the Dom node when rendering (defaults to true). - - - - - - -	- - Roo.Component - -
	- - - - canActivate : Boolean - - - - - - True if this item can be visually activated (defaults to true) - - - - - True if this item can be visually activated (defaults to true) - - - - - - -	- - Roo.menu.Item - -
	- - - - disableClass : String - - - - - - CSS class added to the component when it is disabled (defaults to "x-item-disabled"). - - - - - CSS class added to the component when it is disabled (defaults to "x-item-disabled"). - - - - - - -	- - Roo.Component - -
	- - - - handler : Function - - - - - - A function that will handle the click event of this menu item (defaults to undefined) - - - - - A function that will handle the click event of this menu item (defaults to undefined) - - - - - - -	- - Roo.menu.BaseItem - -
	- - - - hidden : Boolean - - - - - - True to prevent creation of this menu item (defaults to false) - - - - - True to prevent creation of this menu item (defaults to false) - - - - - - -	- - Roo.menu.BaseItem - -
	- - - - hideDelay : Number - - - - - - Length of time in milliseconds to wait before hiding after a click (defaults to 100) - - - - - Length of time in milliseconds to wait before hiding after a click (defaults to 100) - - - - - - -	- - Roo.menu.BaseItem - -
	- - - - hideMode : String - - - - - - How this component should hidden. - - - - - How this component should hidden. Supported values are "visibility" (css visibility), "offsets" (negative offset position) and "display" (css display) - defaults to "display". - Possible Values: display, visibility - - - - - -	- - Roo.Component - -
	- - - - hideOnClick : Boolean - - - - - - True to hide the containing menu after this item is clicked (defaults to true) - - - - - True to hide the containing menu after this item is clicked (defaults to true) - - - - - - -	- - Roo.menu.BaseItem - -
	- - - - icon : String - - - - - - The path to an icon to display in this menu item (defaults to Roo.BLANK_IMAGE_URL) - - - - - The path to an icon to display in this menu item (defaults to Roo.BLANK_IMAGE_URL) - - - - - - -	- - Roo.menu.Item - -
	- - - - itemCls : String - - - - - - The default CSS class to use for menu items (defaults to "x-menu-item") - - - - - The default CSS class to use for menu items (defaults to "x-menu-item") - - - - - - -	- - Roo.menu.Item - -
	- - - - listeners : Object - - - - - - list of events and functions to call for this object, For example : `listeners : { 'click' : function(e) { .` `-` `- - - - list of events and functions to call for this object, For example : listeners : { 'click' : function(e) { ..... } , .... } - - - - - - -`	- - Roo.util.Observable - -
	- - - - showDelay : Number - - - - - - Length of time in milliseconds to wait before showing this item (defaults to 200) - - - - - Length of time in milliseconds to wait before showing this item (defaults to 200) - - - - - - -	- - Roo.menu.Item - -
	- - - - text : String - - - - - - The text to show on the menu item. - - - - - The text to show on the menu item. - - - - - - -	- - Roo.menu.Item - -

- - - - - - - - - - - - - - - - - - - - - -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Public Methods
Method		Defined By
	- - - new Roo.menu.Item - - (Object *config) - - - - - - - - Create a new Roo.menu.Item - - - - - - - Create a new Roo.menu.Item - - - - Parameters: - - - Object config* - - - Configuration options - - - - - - - - - - - - - - - - -	- -
	- - - addEvents - - (Object *object) - - - - - - - Used to define events on this Observable - - - - - - Used to define events on this Observable - - - - - - - - Parameters: - - - Object object* - - - The object with the events defined - - - - - - - - - - - - - - - - -	- - Roo.util.Observable - -
	- - - addListener - - (String *eventName, Function handler, Object scope, Object options) - - - - - - - Appends an event handler to this component - - - - - - Appends an event handler to this component - - - - - - - - Parameters: - - - String eventName* - - - The type of event to listen for - - - Function handler - - - The method the event invokes - - - Object scope - - - (optional) The scope in which to execute the handler function. The handler function's "this" context. - - - Object options - - - (optional) An object containing handler configuration properties. This may contain any of the following properties: scope {Object} The scope in which to execute the handler function. The handler function's "this" context. delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires. single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself. buffer {Number} Causes the handler to be scheduled to run in an {link Roo.util.DelayedTask} delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place. Combining Options Using the options argument, it is possible to combine different types of listeners: A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId) `el.on('click', this.onClick, this, { single: true, delay: 100, forumId: 4 });` Attaching multiple handlers in 1 call The method also allows for a single argument to be passed which is a config object containing properties which specify multiple handlers. `el.on({ 'click': { fn: this.onClick, scope: this, delay: 100 }, 'mouseover': { fn: this.onMouseOver, scope: this }, 'mouseout': { fn: this.onMouseOut, scope: this } });` Or a shorthand syntax which passes the same scope object to all handlers: `el.on({ 'click': this.onClick, 'mouseover': this.onMouseOver, 'mouseout': this.onMouseOut, scope: this });` - - - - - - - - - - - - - - - - -	- - Roo.util.Observable - -
	- - - destroy - - () - - - - - - - Destroys this component by purging any event listeners, removing the component's element from the DOM, removing the component from its {link Roo.Container} (if applicable) and unregistering it from {link Roo.ComponentMgr}. - - - - - - Destroys this component by purging any event listeners, removing the component's element from the DOM, removing the component from its {link Roo.Container} (if applicable) and unregistering it from {link Roo.ComponentMgr}. - - - - - - - - - - - - - - - - - - - -	- - Roo.Component - -
	- - - disable - - () - - - : - - - Roo.Component - - - - - - - - - Disable this component. - - - - - - Disable this component. - - - - - - - - - - - - Returns: - - Roo.Component this - - - - - - - - - - - - -	- - Roo.Component - -
	- - - enable - - () - - - : - - - Roo.Component - - - - - - - - - Enable this component. - - - - - - Enable this component. - - - - - - - - - - - - Returns: - - Roo.Component this - - - - - - - - - - - - -	- - Roo.Component - -
	- - - fireEvent - - (String *eventName, Object... args) - - - : - - - Boolean - - - - - - - - - Fires the specified event with the passed parameters (minus the event name). - - - - - - Fires the specified event with the passed parameters (minus the event name). - - - - - - - - Parameters: - - - String eventName* - - - - - - Object... args - - - Variable number of parameters are passed to handlers - - - - - - - - - Returns: - - Boolean returns false if any of the handlers return false otherwise it returns true - - - - - - - - - - - - -	- - Roo.util.Observable - -
	- - - focus - - (Boolean *selectText) - - - : - - - Roo.Component - - - - - - - - - Try to focus this component. - - - - - - Try to focus this component. - - - - - - - - Parameters: - - - Boolean selectText* - - - True to also select the text in this component (if applicable) - - - - - - - - - Returns: - - Roo.Component this - - - - - - - - - - - - -	- - Roo.Component - -
	- - - getEl - - () - - - : - - - Roo.Element - - - - - - - - - Returns the underlying {link Roo.Element}. - - - - - - Returns the underlying {link Roo.Element}. - - - - - - - - - - - - Returns: - - Roo.Element The element - - - - - - - - - - - - -	- - Roo.Component - -
	- - - getId - - () - - - : - - - String - - - - - - - - - Returns the id of this component. - - - - - - Returns the id of this component. - - - - - - - - - - - - Returns: - - String - - - - - - - - - - - - -	- - Roo.Component - -
	- - - hasListener - - (String *eventName) - - - : - - - Boolean - - - - - - - - - Checks to see if this object has any listeners for a specified event - - - - - - Checks to see if this object has any listeners for a specified event - - - - - - - - Parameters: - - - String eventName* - - - The name of the event to check for - - - - - - - - - Returns: - - Boolean True if the event is being listened for, else false - - - - - - - - - - - - -	- - Roo.util.Observable - -
	- - - hide - - () - - - : - - - Roo.Component - - - - - - - - - Hide this component. - - - - - - Hide this component. - - - - - - - - - - - - Returns: - - Roo.Component this - - - - - - - - - - - - -	- - Roo.Component - -
	- - - isVisible - - () - - - - - - - Returns true if this component is visible. - - - - - - Returns true if this component is visible. - - - - - - - - - - - - - - - - - - - -	- - Roo.Component - -
	- - - on - - (String *eventName, Function handler, Object scope, Object options) - - - - - - - Appends an event handler to this element (shorthand for addListener) - - - - - - Appends an event handler to this element (shorthand for addListener) - - - - - - - - Parameters: - - - String eventName* - - - The type of event to listen for - - - Function handler - - - The method the event invokes - - - Object scope - - - (optional) The scope in which to execute the handler function. The handler function's "this" context. - - - Object options - - - (optional) - - - - - - - - - - - - - - - - -	- - Roo.util.Observable - -
	- - - purgeListeners - - () - - - - - - - Removes all listeners for this object - - - - - - Removes all listeners for this object - - - - - - - - - - - - - - - - - - - -	- - Roo.util.Observable - -
	- - - removeListener - - (String *eventName, Function handler, Object scope) - - - - - - - Removes a listener - - - - - - Removes a listener - - - - - - - - Parameters: - - - String eventName* - - - The type of event to listen for - - - Function handler - - - The handler to remove - - - Object scope - - - (optional) The scope (this object) for the handler - - - - - - - - - - - - - - - - -	- - Roo.util.Observable - -
	- - - render - - (String/HTMLElement/Element *container) - - - - - - - If this is a lazy rendering component, render it to its container element. - - - - - - If this is a lazy rendering component, render it to its container element. - - - - - - - - Parameters: - - - String/HTMLElement/Element container* - - - (optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off. - - - - - - - - - - - - - - - - -	- - Roo.Component - -
	- - - setDisabled - - (Boolean *disabled) - - - - - - - Convenience function for setting disabled/enabled by boolean. - - - - - - Convenience function for setting disabled/enabled by boolean. - - - - - - - - Parameters: - - - Boolean disabled* - - - - - - - - - - - - - - - - - - - -	- - Roo.Component - -
	- - - setText - - (String *text, Boolean isHTML) - - - - - - - Sets the text to display in this menu item - - - - - - Sets the text to display in this menu item - - - - - - - - Parameters: - - - String text* - - - The text to display - - - Boolean isHTML - - - true to indicate text is pure html. - - - - - - - - - - - - - - - - -	- - Roo.menu.Item - -
	- - - setVisible - - (Boolean *visible) - - - : - - - Roo.Component - - - - - - - - - Convenience function to hide or show this component by boolean. - - - - - - Convenience function to hide or show this component by boolean. - - - - - - - - Parameters: - - - Boolean visible* - - - True to show, false to hide - - - - - - - - - Returns: - - Roo.Component this - - - - - - - - - - - - -	- - Roo.Component - -
	- - - show - - () - - - : - - - Roo.Component - - - - - - - - - Show this component. - - - - - - Show this component. - - - - - - - - - - - - Returns: - - Roo.Component this - - - - - - - - - - - - -	- - Roo.Component - -
	- - - un - - (String *eventName, Function handler, Object scope) - - - - - - - Removes a listener (shorthand for removeListener) - - - - - - Removes a listener (shorthand for removeListener) - - - - - - - - Parameters: - - - String eventName* - - - The type of event to listen for - - - Function handler - - - The handler to remove - - - Object scope - - - (optional) The scope (this object) for the handler - - - - - - - - - - - - - - - - -	- - Roo.util.Observable - -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Events
Event		Defined By
	- - - - activate (Roo.menu.BaseItem *this) - - - - - - Fires when this item is activated - - - - - - Fires when this item is activated - - - - - - - Parameters: - - - Roo.menu.BaseItem this* - - - - - - - - - - - - - - - - - - - -	- Roo.menu.BaseItem -
	- - - - beforedestroy (Roo.Component *this) - - - - - - Fires before the component is destroyed. - - - - - - Fires before the component is destroyed. Return false to stop the destroy. - - - - - - - Parameters: - - - Roo.Component this* - - - - - - - - - - - - - - - - - - - -	- Roo.Component -
	- - - - beforehide (Roo.Component *this) - - - - - - Fires before the component is hidden. - - - - - - Fires before the component is hidden. Return false to stop the hide. - - - - - - - Parameters: - - - Roo.Component this* - - - - - - - - - - - - - - - - - - - -	- Roo.Component -
	- - - - beforerender (Roo.Component *this) - - - - - - Fires before the component is rendered. - - - - - - Fires before the component is rendered. Return false to stop the render. - - - - - - - Parameters: - - - Roo.Component this* - - - - - - - - - - - - - - - - - - - -	- Roo.Component -
	- - - - beforeshow (Roo.Component *this) - - - - - - Fires before the component is shown. - - - - - - Fires before the component is shown. Return false to stop the show. - - - - - - - Parameters: - - - Roo.Component this* - - - - - - - - - - - - - - - - - - - -	- Roo.Component -
	- - - - click (Roo.menu.BaseItem *this, Roo.EventObject e) - - - - - - Fires when this item is clicked - - - - - - Fires when this item is clicked - - - - - - - Parameters: - - - Roo.menu.BaseItem this* - - - - - - Roo.EventObject e - - - - - - - - - - - - - - - - - - - -	- Roo.menu.BaseItem -
	- - - - deactivate (Roo.menu.BaseItem *this) - - - - - - Fires when this item is deactivated - - - - - - Fires when this item is deactivated - - - - - - - Parameters: - - - Roo.menu.BaseItem this* - - - - - - - - - - - - - - - - - - - -	- Roo.menu.BaseItem -
	- - - - destroy (Roo.Component *this) - - - - - - Fires after the component is destroyed. - - - - - - Fires after the component is destroyed. - - - - - - - Parameters: - - - Roo.Component this* - - - - - - - - - - - - - - - - - - - -	- Roo.Component -
	- - - - disable (Roo.Component *this) - - - - - - Fires after the component is disabled. - - - - - - Fires after the component is disabled. - - - - - - - Parameters: - - - Roo.Component this* - - - - - - - - - - - - - - - - - - - -	- Roo.Component -
	- - - - enable (Roo.Component *this) - - - - - - Fires after the component is enabled. - - - - - - Fires after the component is enabled. - - - - - - - Parameters: - - - Roo.Component this* - - - - - - - - - - - - - - - - - - - -	- Roo.Component -
	- - - - hide (Roo.Component *this) - - - - - - Fires after the component is hidden. - - - - - - Fires after the component is hidden. - - - - - - - Parameters: - - - Roo.Component this* - - - - - - - - - - - - - - - - - - - -	- Roo.Component -
	- - - - render (Roo.Component *this) - - - - - - Fires after the component is rendered. - - - - - - Fires after the component is rendered. - - - - - - - Parameters: - - - Roo.Component this* - - - - - - - - - - - - - - - - - - - -	- Roo.Component -
	- - - - show (Roo.Component *this) - - - - - - Fires after the component is shown. - - - - - - Fires after the component is shown. - - - - - - - Parameters: - - - Roo.Component this* - - - - - - - - - - - - - - - - - - - -	- Roo.Component -

- - - - - - -

- - Documentation generated by Introspection Doc Generator on Fri Jul 13 2018 14:10:55 GMT+0800 (HKT) - Based on - JsDoc Toolkit -

- -