Package: | Ext.menu |
Class: | ColorMenu |
Extends: | Menu |
Defined In: | ColorMenu.js |
Property | Defined By | |
---|---|---|
palette : ColorPalette | ColorMenu | |
The Ext.ColorPalette instance for this ColorMenu |
Method | Defined By | |
---|---|---|
ColorMenu( Object config ) |
ColorMenu | |
Creates a new ColorMenu | ||
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) |
Event | Defined By | |
---|---|---|
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 | ||
select : ( ColorPalette palette , String color ) |
ColorMenu | |
show : ( Ext.menu.Menu this ) |
Menu | |
Fires after this menu is displayed |
Config Options | Defined By | |
---|---|---|
allowOtherMenus : Boolean | Menu | |
True to allow multiple menus to be displayed at the same time (defaults to false) | ||
defaultAlign : String | Menu | |
The default {@link Ext.Element#alignTo) anchor position value for this menu relative to its element of origin (defaul... | ||
minWidth : Number | Menu | |
The minimum width of the menu in pixels (defaults to 120) | ||
shadow : Boolean/String | Menu | |
True or "sides" for the default effect, "frame" for 4-way shadow, and "drop" for bottom-right shadow (defaults to "si... | ||
subMenuAlign : String | Menu | |
The Ext.Element.alignTo anchor position value to use for submenus of this menu (defaults to "tl-tr?") |
public ColorPalette palette
public function ColorMenu( Object config
)
config
: Objectpublic function add( Mixed args
)
// 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
);
args
: MixedExt.menu.Item
public function addElement( String/HTMLElement/Ext.Element el
)
el
: String/HTMLElement/Ext.ElementExt.menu.Item
public function addEvents( Object object
)
object
: Objectvoid
public function addItem( Ext.menu.Item item
)
item
: Ext.menu.ItemExt.menu.Item
public function addListener( String eventName
, Function handler
, [Object scope
], [Object options
] )
eventName
: Stringhandler
: Functionscope
: Objectoptions
: Object
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
});
void
public function addMenuItem( Object config
)
config
: ObjectExt.menu.Item
public function addSeparator()
Ext.menu.Item
public function addText( String text
)
text
: StringExt.menu.Item
public function fireEvent( String eventName
, Object... args
)
eventName
: Stringargs
: Object...Boolean
public function getEl()
Ext.Element
public function hasListener( String eventName
)
eventName
: StringBoolean
public function hide( [Boolean deep
] )
deep
: Booleanvoid
public function insert( Number index
, Ext.menu.Item item
)
index
: Numberitem
: Ext.menu.ItemExt.menu.Item
public function isVisible()
void
public function on( String eventName
, Function handler
, [Object scope
], [Object options
] )
eventName
: Stringhandler
: Functionscope
: Objectoptions
: Objectvoid
public function purgeListeners()
void
public function remove( Ext.menu.Item item
)
item
: Ext.menu.Itemvoid
public function removeAll()
void
public function removeListener( String eventName
, Function handler
, [Object scope
] )
eventName
: Stringhandler
: Functionscope
: Objectvoid
public function show( String/HTMLElement/Ext.Element element
, [String position
], [Ext.menu.Menu parentMenu
] )
element
: String/HTMLElement/Ext.Elementposition
: StringparentMenu
: Ext.menu.Menuvoid
public function showAt( Array xyPosition
, [Ext.menu.Menu parentMenu
] )
xyPosition
: ArrayparentMenu
: Ext.menu.Menuvoid
public function un( String eventName
, Function handler
, [Object scope
] )
eventName
: Stringhandler
: Functionscope
: Objectvoid
public event beforehide
this
: Ext.menu.Menupublic event beforeshow
this
: Ext.menu.Menupublic event click
this
: Ext.menu.MenumenuItem
: Ext.menu.Iteme
: Ext.EventObjectpublic event hide
this
: Ext.menu.Menupublic event itemclick
baseItem
: Ext.menu.BaseIteme
: Ext.EventObjectpublic event mouseout
this
: Ext.menu.Menue
: Ext.EventObjectmenuItem
: Ext.menu.Itempublic event mouseover
this
: Ext.menu.Menue
: Ext.EventObjectmenuItem
: Ext.menu.Itempublic event select
palette
: ColorPalettecolor
: Stringpublic event show
this
: Ext.menu.MenuallowOtherMenus : Boolean
defaultAlign : String
minWidth : Number
shadow : Boolean/String
subMenuAlign : String