This class has no public properties.
|
Menu( Object config ) |
Menu |
Creates a new Menu |
|
add( Mixed args ) : Ext.menu.Item |
Menu |
Addds one or more items of any type supported by the Menu class, or that can be converted into menu items.
Any of the... |
|
addElement( String/HTMLElement/Ext.Element el ) : Ext.menu.Item |
Menu |
Adds an Ext.Element object to the menu |
|
addEvents( Object object ) : void |
Observable |
Used to define events on this Observable |
|
addItem( Ext.menu.Item item ) : Ext.menu.Item |
Menu |
Adds an existing object based on Ext.menu.Item to the menu |
|
addListener( String eventName , Function handler , [Object scope ], [Object options ] ) : void |
Observable |
Appends an event handler to this component |
|
addMenuItem( Object config ) : Ext.menu.Item |
Menu |
Creates a new Ext.menu.Item based an the supplied config object and adds it to the menu |
|
addSeparator() : Ext.menu.Item |
Menu |
Adds a separator bar to the menu |
|
addText( String text ) : Ext.menu.Item |
Menu |
Creates a new Ext.menu.TextItem with the supplied text and adds it to the menu |
|
fireEvent( String eventName , Object... args ) : Boolean |
Observable |
Fires the specified event with the passed parameters (minus the event name). |
|
getEl() : Ext.Element |
Menu |
Returns this menu's underlying Ext.Element object |
|
hasListener( String eventName ) : Boolean |
Observable |
Checks to see if this object has any listeners for a specified event |
|
hide( [Boolean deep ] ) : void |
Menu |
Hides this menu and optionally all parent menus |
|
insert( Number index , Ext.menu.Item item ) : Ext.menu.Item |
Menu |
Inserts an existing object based on Ext.menu.Item to the menu at a specified index |
|
isVisible() : void |
Menu |
Read-only. Returns true if the menu is currently displayed, else false. |
|
on( String eventName , Function handler , [Object scope ], [Object options ] ) : void |
Observable |
Appends an event handler to this element (shorthand for addListener) |
|
purgeListeners() : void |
Observable |
Removes all listeners for this object |
|
remove( Ext.menu.Item item ) : void |
Menu |
Removes an Ext.menu.Item from the menu and destroys the object |
|
removeAll() : void |
Menu |
Removes and destroys all items in the menu |
|
removeListener( String eventName , Function handler , [Object scope ] ) : void |
Observable |
Removes a listener |
|
show( String/HTMLElement/Ext.Element element , [String position ], [Ext.menu.Menu parentMenu ] ) : void |
Menu |
Displays this menu relative to another element |
|
showAt( Array xyPosition , [Ext.menu.Menu parentMenu ] ) : void |
Menu |
Displays this menu at a specific xy position |
|
un( String eventName , Function handler , [Object scope ] ) : void |
Observable |
Removes a listener (shorthand for removeListener) |
|
beforehide : ( Ext.menu.Menu this ) |
Menu |
Fires before this menu is hidden |
|
beforeshow : ( Ext.menu.Menu this ) |
Menu |
Fires before this menu is displayed |
|
click : ( Ext.menu.Menu this , Ext.menu.Item menuItem , Ext.EventObject e ) |
Menu |
Fires when this menu is clicked (or when the enter key is pressed while it is active) |
|
hide : ( Ext.menu.Menu this ) |
Menu |
Fires after this menu is hidden |
|
itemclick : ( Ext.menu.BaseItem baseItem , Ext.EventObject e ) |
Menu |
Fires when a menu item contained in this menu is clicked |
|
mouseout : ( Ext.menu.Menu this , Ext.EventObject e , Ext.menu.Item menuItem ) |
Menu |
Fires when the mouse exits this menu |
|
mouseover : ( Ext.menu.Menu this , Ext.EventObject e , Ext.menu.Item menuItem ) |
Menu |
Fires when the mouse is hovering over this menu |
|
show : ( Ext.menu.Menu this ) |
Menu |
Fires after this menu is displayed |
add
public function add( Mixed args
)
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 Ext.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 Ext.menu.TextItem and added
Usage:
// Create the menu
var menu = new Ext.menu.Menu();
// Create a menu item to add by reference
var menuItem = new Ext.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
);
This method is defined by Menu.
addElement
public function addElement( String/HTMLElement/Ext.Element el
)
This method is defined by Menu.
addEvents
public function addEvents( Object object
)
Used to define events on this Observable
addItem
public function addItem( Ext.menu.Item item
)
Adds an existing object based on
Ext.menu.Item to the menu
Parameters:
item
: Ext.menu.ItemThe menu item to add
Returns:
This method is defined by Menu.
addListener
public function addListener( String eventName
, Function handler
, [Object scope
], [Object options
] )
Appends an event handler to this component
Parameters:
eventName
: StringThe type of event to listen for
handler
: FunctionThe method the event invokes
scope
: Object(optional) The scope in which to execute the handler
function. The handler function's "this" context.
options
: Object(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 Ext.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
});
Returns:
addMenuItem
public function addMenuItem( Object config
)
Creates a new
Ext.menu.Item based an the supplied config object and adds it to the menu
Parameters:
config
: ObjectA MenuItem config object
Returns:
This method is defined by Menu.
addSeparator
public function addSeparator()
Adds a separator bar to the menu
This method is defined by Menu.
addText
public function addText( String text
)
This method is defined by Menu.
fireEvent
public function fireEvent( String eventName
, Object... args
)
Fires the specified event with the passed parameters (minus the event name).
getEl
public function getEl()
This method is defined by Menu.
hasListener
public function hasListener( String eventName
)
Checks to see if this object has any listeners for a specified event
hide
public function hide( [Boolean deep
] )
Hides this menu and optionally all parent menus
This method is defined by Menu.
insert
public function insert( Number index
, Ext.menu.Item item
)
Inserts an existing object based on
Ext.menu.Item to the menu at a specified index
This method is defined by Menu.
isVisible
public function isVisible()
Read-only. Returns true if the menu is currently displayed, else false.
This method is defined by Menu.
on
public function on( String eventName
, Function handler
, [Object scope
], [Object options
] )
Appends an event handler to this element (shorthand for addListener)
Parameters:
eventName
: StringThe type of event to listen for
handler
: FunctionThe method the event invokes
scope
: Object(optional) The scope in which to execute the handler
function. The handler function's "this" context.
options
: Object(optional)
Returns:
purgeListeners
public function purgeListeners()
Removes all listeners for this object
remove
public function remove( Ext.menu.Item item
)
Removes an
Ext.menu.Item from the menu and destroys the object
Parameters:
item
: Ext.menu.ItemThe menu item to remove
Returns:
This method is defined by Menu.
removeAll
public function removeAll()
Removes and destroys all items in the menu
This method is defined by Menu.
removeListener
public function removeListener( String eventName
, Function handler
, [Object scope
] )
show
public function show( String/HTMLElement/Ext.Element element
, [String position
], [Ext.menu.Menu parentMenu
] )
Displays this menu relative to another element
This method is defined by Menu.
showAt
public function showAt( Array xyPosition
, [Ext.menu.Menu parentMenu
] )
Displays this menu at a specific xy position
Parameters:
xyPosition
: ArrayContains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)
parentMenu
: Ext.menu.Menu(optional) This menu's parent menu, if applicable (defaults to undefined)
Returns:
This method is defined by Menu.
un
public function un( String eventName
, Function handler
, [Object scope
] )
Removes a listener (shorthand for removeListener)
beforehide
public event beforehide
Fires before this menu is hidden
Subscribers will be called with the following parameters:
This event is defined by Menu.
beforeshow
public event beforeshow
Fires before this menu is displayed
Subscribers will be called with the following parameters:
This event is defined by Menu.
click
public event click
Fires when this menu is clicked (or when the enter key is pressed while it is active)
Subscribers will be called with the following parameters:
This event is defined by Menu.
hide
public event hide
Fires after this menu is hidden
Subscribers will be called with the following parameters:
This event is defined by Menu.
itemclick
public event itemclick
Fires when a menu item contained in this menu is clicked
Subscribers will be called with the following parameters:
This event is defined by Menu.
mouseout
public event mouseout
Fires when the mouse exits this menu
Subscribers will be called with the following parameters:
This event is defined by Menu.
mouseover
public event mouseover
Fires when the mouse is hovering over this menu
Subscribers will be called with the following parameters:
This event is defined by Menu.
show
public event show
Fires after this menu is displayed
Subscribers will be called with the following parameters:
This event is defined by Menu.
allowOtherMenus
allowOtherMenus : Boolean
True to allow multiple menus to be displayed at the same time (defaults to false)
This config option is defined by Menu.
defaultAlign
defaultAlign : String
The default {@link Ext.Element#alignTo) anchor position value for this menu relative to its element of origin (defaults to "tl-bl?")
This config option is defined by Menu.
minWidth
minWidth : Number
The minimum width of the menu in pixels (defaults to 120)
This config option is defined by Menu.
shadow
shadow : Boolean/String
True or "sides" for the default effect, "frame" for 4-way shadow, and "drop" for bottom-right shadow (defaults to "sides")
This config option is defined by Menu.
subMenuAlign
subMenuAlign : String
The
Ext.Element.alignTo anchor position value to use for submenus of this menu (defaults to "tl-tr?")
This config option is defined by Menu.