Roo.util.Observable
Roo.menu.Menu

Class Roo.menu.Menu

Package:	Roo.menu
Defined In:	Roo/menu/Menu.js.
Class:	Menu
Subclasses:	Roo.menu.ColorMenu, Roo.menu.DateMenu
Extends:	Roo.util.Observable

A menu object. This is the container to which you add all other menu items. Menu can also serve a as a base class
when you want a specialzed menu based off of another component (like {link Roo.menu.DateMenu} for example).

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

Config Options (Usually are also Properties)
Options		Defined By
	allowOtherMenus : Boolean True to allow multiple menus to be displayed at the same time (defaults to false) True to allow multiple menus to be displayed at the same time (defaults to false)	Roo.menu.Menu
	defaultAlign : String The default {link Roo.ElementalignTo) anchor position value for this menu relative to its element of origin (defaults to "tl-bl?") The default {link Roo.ElementalignTo) anchor position value for this menu relative to its element of origin (defaults to "tl-bl?")	Roo.menu.Menu
	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
	minWidth : Number The minimum width of the menu in pixels (defaults to 120) The minimum width of the menu in pixels (defaults to 120)	Roo.menu.Menu
	registerMenu : Boolean True (default) - means that clicking on screen etc. True (default) - means that clicking on screen etc. hides it.	Roo.menu.Menu
	shadow : Boolean/String True or "sides" for the default effect, "frame" for 4-way shadow, and "drop" for bottom-right shadow (defaults to "sides") True or "sides" for the default effect, "frame" for 4-way shadow, and "drop" for bottom-right shadow (defaults to "sides")	Roo.menu.Menu
	subMenuAlign : String The {link Roo.ElementalignTo} anchor position value to use for submenus of this menu (defaults to "tl-tr?") The {link Roo.ElementalignTo} anchor position value to use for submenus of this menu (defaults to "tl-tr?")	Roo.menu.Menu

Public Methods
Method		Defined By
	new Roo.menu.Menu (Object *config) Create a new Roo.menu.Menu Create a new Roo.menu.Menu Parameters: Object config* Configuration options
	add (Mixed *args) : Roo.menu.Item Addds one or more items of any type supported by the Menu class, or that can be converted into menu items. Addds one or more items of any type supported by the Menu class, or that can be converted into menu items. Any of the following are valid: Any menu item object based on {link* Roo.menu.Item} An HTMLElement object which will be converted to a menu item A menu item config object that will be created as a new menu item A string, which can either be '-' or 'separator' to add a menu separator, otherwise it will be converted into a {link Roo.menu.TextItem} and added Usage: `// Create the menu var menu = new Roo.menu.Menu(); // Create a menu item to add by reference var menuItem = new Roo.menu.Item({ text: 'New Item!' }); // Add a bunch of items at once using different methods. // Only the last item added will be returned. var item = menu.add( menuItem, // add existing item by ref 'Dynamic Item', // new TextItem '-', // new separator { text: 'Config Item' } // new item by config );` Parameters: Mixed args One or more menu items, menu item configs or other objects that can be converted to menu items Returns: Roo.menu.Item The menu item that was added, or the last one if multiple items were added	Roo.menu.Menu
	addElement (String/HTMLElement/Roo.Element el) : Roo.menu.Item Adds an {link Roo.Element} object to the menu Adds an {link Roo.Element} object to the menu Parameters: String/HTMLElement/Roo.Element el The element or DOM node to add, or its id Returns: Roo.menu.Item The menu item that was added	Roo.menu.Menu
	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
	addItem (Roo.menu.Item *item) : Roo.menu.Item Adds an existing object based on {link* Roo.menu.Item} to the menu Adds an existing object based on {link Roo.menu.Item} to the menu Parameters: Roo.menu.Item item The menu item to add Returns: Roo.menu.Item The menu item that was added	Roo.menu.Menu
	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
	addMenuItem (Object *config) : Roo.menu.Item Creates a new {link* Roo.menu.Item} based an the supplied config object and adds it to the menu Creates a new {link Roo.menu.Item} based an the supplied config object and adds it to the menu Parameters: Object config A MenuItem config object Returns: Roo.menu.Item The menu item that was added	Roo.menu.Menu
	addSeparator () : Roo.menu.Item Adds a separator bar to the menu Adds a separator bar to the menu Returns: Roo.menu.Item The menu item that was added	Roo.menu.Menu
	addText (String *text) : Roo.menu.Item Creates a new {link* Roo.menu.TextItem} with the supplied text and adds it to the menu Creates a new {link Roo.menu.TextItem} with the supplied text and adds it to the menu Parameters: String text The text to display in the menu item Returns: Roo.menu.Item The menu item that was added	Roo.menu.Menu
	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
	getEl () : Roo.Element Returns this menu's underlying {link Roo.Element} object Returns this menu's underlying {link Roo.Element} object Returns: Roo.Element The element	Roo.menu.Menu
	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 (Boolean *deep) Hides this menu and optionally all parent menus Hides this menu and optionally all parent menus Parameters: Boolean deep* (optional) True to hide all parent menus recursively, if any (defaults to false)	Roo.menu.Menu
	insert (Number *index, Roo.menu.Item item) : Roo.menu.Item Inserts an existing object based on {link* Roo.menu.Item} to the menu at a specified index Inserts an existing object based on {link Roo.menu.Item} to the menu at a specified index Parameters: Number index The index in the menu's list of current items where the new item should be inserted Roo.menu.Item item The menu item to add Returns: Roo.menu.Item The menu item that was added	Roo.menu.Menu
	isVisible () Read-only. Read-only. Returns true if the menu is currently displayed, else false.	Roo.menu.Menu
	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
	remove (Roo.menu.Item *item) Removes an {link* Roo.menu.Item} from the menu and destroys the object Removes an {link Roo.menu.Item} from the menu and destroys the object Parameters: Roo.menu.Item item The menu item to remove	Roo.menu.Menu
	removeAll () Removes and destroys all items in the menu Removes and destroys all items in the menu	Roo.menu.Menu
	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
	show (String/HTMLElement/Roo.Element *element, String position, Roo.menu.Menu parentMenu) Displays this menu relative to another element Displays this menu relative to another element Parameters: String/HTMLElement/Roo.Element element* The element to align to String position (optional) The {link Roo.ElementalignTo} anchor position to use in aligning to the element (defaults to this.defaultAlign) Roo.menu.Menu parentMenu (optional) This menu's parent menu, if applicable (defaults to undefined)	Roo.menu.Menu
	showAt (Array *xyPosition, Roo.menu.Menu parentMenu) Displays this menu at a specific xy position Displays this menu at a specific xy position Parameters: Array xyPosition* Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based) Roo.menu.Menu parentMenu (optional) This menu's parent menu, if applicable (defaults to undefined)	Roo.menu.Menu
	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
	beforehide (Roo.menu.Menu *this) Fires before this menu is hidden Fires before this menu is hidden Parameters: Roo.menu.Menu this*	Roo.menu.Menu
	beforeshow (Roo.menu.Menu *this) Fires before this menu is displayed Fires before this menu is displayed Parameters: Roo.menu.Menu this*	Roo.menu.Menu
	click (Roo.menu.Menu *this, Roo.menu.Item menuItem, Roo.EventObject e) Fires when this menu is clicked (or when the enter key is pressed while it is active) Fires when this menu is clicked (or when the enter key is pressed while it is active) Parameters: Roo.menu.Menu this* Roo.menu.Item menuItem The menu item that was clicked Roo.EventObject e	Roo.menu.Menu
	hide (Roo.menu.Menu *this) Fires after this menu is hidden Fires after this menu is hidden Parameters: Roo.menu.Menu this*	Roo.menu.Menu
	itemclick (Roo.menu.BaseItem *baseItem, Roo.EventObject e) Fires when a menu item contained in this menu is clicked Fires when a menu item contained in this menu is clicked Parameters: Roo.menu.BaseItem baseItem* The BaseItem that was clicked Roo.EventObject e	Roo.menu.Menu
	mouseout (Roo.menu.Menu *this, Roo.EventObject e, Roo.menu.Item menuItem) Fires when the mouse exits this menu Fires when the mouse exits this menu Parameters: Roo.menu.Menu this* Roo.EventObject e Roo.menu.Item menuItem The menu item that was clicked	Roo.menu.Menu
	mouseover (Roo.menu.Menu *this, Roo.EventObject e, Roo.menu.Item menuItem) Fires when the mouse is hovering over this menu Fires when the mouse is hovering over this menu Parameters: Roo.menu.Menu this* Roo.EventObject e Roo.menu.Item menuItem The menu item that was clicked	Roo.menu.Menu
	show (Roo.menu.Menu *this) Fires after this menu is displayed Fires after this menu is displayed Parameters: Roo.menu.Menu this*	Roo.menu.Menu

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