Class Ext.menu.ColorMenu

Package:	Ext.menu
Class:	ColorMenu
Extends:	Menu
Defined In:	ColorMenu.js

A menu containing a Ext.menu.ColorItem component (which provides a basic color picker).

Properties - Methods - Events - Config Options

Public Properties

Property		Defined By
	palette : ColorPalette	ColorMenu
	The Ext.ColorPalette instance for this ColorMenu	ColorMenu

Public Methods

Method		Defined By
	ColorMenu(`Object config`)	ColorMenu
	Creates a new ColorMenu	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...	Menu
	addElement(`String/HTMLElement/Ext.Element el`) : Ext.menu.Item	Menu
	Adds an Ext.Element object to the menu	Menu
	addEvents(`Object object`) : void	Observable
	Copies any events from the passed object onto this object if they do not already exist. The passed object must also ...	Observable
	addItem(`Ext.menu.Item item`) : Ext.menu.Item	Menu
	Adds an existing object based on Ext.menu.Item to the menu	Menu
	addListener(`String eventName`, `Function handler`, [`Object options`]) : void	Observable
	Appends an event handler to this component	Observable
	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	Menu
	addSeparator() : Ext.menu.Item	Menu
	Adds a separator bar to the menu	Menu
	addText(`String text`) : Ext.menu.Item	Menu
	Creates a new Ext.menu.TextItem with the supplied text and adds it to the menu	Menu
	fireEvent(`String eventName`, `Object... args`) : Boolean	Observable
	Fires the specified event with the passed parameters (minus the event name).	Observable
	getEl() : Ext.Element	Menu
	Returns this menu's underlying Ext.Element object	Menu
	hasListener(`String eventName`) : Boolean	Observable
	Checks to see if this object is currently listening for a specified event	Observable
	hide([`Boolean deep`]) : void	Menu
	Hides this menu and optionally all parent menus	Menu
	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	Menu
	isVisible() : void	Menu
	Read-only. Returns true if the menu is currently displayed, else false.	Menu
	on(`String eventName`, `Function handler`, [`Object options`]) : void	Observable
	Appends an event handler to this element (shorthand for addListener)	Observable
	purgeListeners() : void	Observable
	Removes all listeners for this object	Observable
	remove(`Ext.menu.Item item`) : void	Menu
	Removes an Ext.menu.Item from the menu and destroys the object	Menu
	removeAll() : void	Menu
	Removes and destroys all items in the menu	Menu
	removeListener(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	Removes a listener	Observable
	show(`String/HTMLElement/Ext.Element element`, [`String position`], [`Ext.menu.Menu parentMenu`]) : void	Menu
	Displays this menu relative to another element	Menu
	showAt(`Array xyPosition`, [`Ext.menu.Menu parentMenu`]) : void	Menu
	Displays this menu at a specific xy position	Menu
	un(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	Removes a listener (shorthand for removeListener)	Observable

Public Events

Event		Defined By
	beforehide : (`Ext.menu.Menu this`)	Menu
	Fires before this menu is hidden	Menu
	beforeshow : (`Ext.menu.Menu this`)	Menu
	Fires before this menu is displayed	Menu
	click : (`Ext.menu.Menu this`, `String menuItemId`, `Ext.EventObject e`)	Menu
	Fires when this menu is clicked (or when the enter key is pressed while it is active)	Menu
	hide : (`Ext.menu.Menu this`)	Menu
	Fires after this menu is hidden	Menu
	itemclick : (`Ext.menu.BaseItem baseItem`, `Ext.EventObject e`)	Menu
	Fires when a menu item contained in this menu is clicked	Menu
	mouseout : (`Ext.menu.Menu this`, `Ext.EventObject e`, `String menuItemId`)	Menu
	Fires when the mouse exits this menu	Menu
	mouseover : (`Ext.menu.Menu this`, `Ext.EventObject e`, `String menuItemId`)	Menu
	Fires when the mouse is hovering over this menu	Menu
	select : (`ColorPalette palette`, `String color`)	ColorMenu
		ColorMenu
	show : (`Ext.menu.Menu this`)	Menu
	Fires after this menu is displayed	Menu

Config Options

Config Options		Defined By
	allowOtherMenus : Boolean	Menu
	True to allow multiple menus to be displayed at the same time (defaults to false)	Menu
	defaultAlign : String	Menu
	The default {@link Ext.Element#alignTo) anchor position value for this menu relative to it's element of origin (defau...	Menu
	minWidth : Number	Menu
	The minimum width of the menu in pixels (defaults to 120)	Menu
	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...	Menu
	subMenuAlign : String	Menu
	The {@link Ext.Element#alignTo) anchor position value to use for submenus of this menu (defaults to "tl-tr?")	Menu

Property Details

palette

public ColorPalette palette

The Ext.ColorPalette instance for this ColorMenu

This property is defined by ColorMenu.

Constructor Details

ColorMenu

public function ColorMenu(Object config)

Creates a new ColorMenu

Parameters:

config : Object
Configuration options

Method Details

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
);

Parameters:

args : Mixed
One or more menu items, menu item configs or other objects that can be converted to menu items

Returns:

Ext.menu.Item
The menu item that was added, or the last one if multiple items were added

This method is defined by Menu.

addElement

public function addElement(String/HTMLElement/Ext.Element el)

Adds an Ext.Element object to the menu

Parameters:

el : String/HTMLElement/Ext.Element
The element or DOM node to add, or its id

Returns:

Ext.menu.Item
The menu item that was added

This method is defined by Menu.

addEvents

public function addEvents(Object object)

Copies any events from the passed object onto this object if they do not already exist. The passed object must also inherit from Observable for this method to have any effect.

Parameters:

object : Object
The object from which to copy events

Returns:

void

This method is defined by 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.Item
The menu item to add

Returns:

Ext.menu.Item
The menu item that was added

This method is defined by Menu.

addListener

public function addListener(String eventName, Function handler, [Object options])

Appends an event handler to this component

Parameters:

eventName : String
The type of event to listen for
handler : Function
The method the event invokes
options : Object
(optional)

Returns:

void

This method is defined by Observable.

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 : Object
A MenuItem config object

Returns:

Ext.menu.Item
The menu item that was added

This method is defined by Menu.

addSeparator

public function addSeparator()

Adds a separator bar to the menu

Parameters:

None.

Returns:

Ext.menu.Item
The menu item that was added

This method is defined by Menu.

addText

public function addText(String text)

Creates a new Ext.menu.TextItem with the supplied text and adds it to the menu

Parameters:

text : String
The text to display in the menu item

Returns:

Ext.menu.Item
The menu item that was added

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).

Parameters:

eventName : String
args : Object...
Variable number of parameters are passed to handlers

Returns:

Boolean
returns false if any of the handlers return false otherwise it returns true

This method is defined by Observable.

getEl

public function getEl()

Returns this menu's underlying Ext.Element object

Parameters:

None.

Returns:

Ext.Element
The element

This method is defined by Menu.

hasListener

public function hasListener(String eventName)

Checks to see if this object is currently listening for a specified event

Parameters:

eventName : String
The name of the event to check for

Returns:

Boolean
True if the event is being listened for, else false

This method is defined by Observable.

hide

public function hide([Boolean deep])

Hides this menu and optionally all parent menus

Parameters:

deep : Boolean
(optional) True to hide all parent menus recursively, if any (defaults to false)

Returns:

void

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

Parameters:

index : Number
The index in the menu's list of current items where the new item should be inserted
item : Ext.menu.Item
The menu item to add

Returns:

Ext.menu.Item
The menu item that was added

This method is defined by Menu.

isVisible

public function isVisible()

Read-only. Returns true if the menu is currently displayed, else false.

Parameters:

None.

Returns:

void

This method is defined by Menu.

on

public function on(String eventName, Function handler, [Object options])

Appends an event handler to this element (shorthand for addListener)

Parameters:

eventName : String
The type of event to listen for
handler : Function
The method the event invokes
options : Object
(optional)

Returns:

void

This method is defined by Observable.

purgeListeners

public function purgeListeners()

Removes all listeners for this object

Parameters:

None.

Returns:

void

This method is defined by Observable.

remove

public function remove(Ext.menu.Item item)

Removes an Ext.menu.Item from the menu and destroys the object

Parameters:

item : Ext.menu.Item
The menu item to remove

Returns:

void

This method is defined by Menu.

removeAll

public function removeAll()

Removes and destroys all items in the menu

Parameters:

None.

Returns:

void

This method is defined by Menu.

removeListener

public function removeListener(String eventName, Function handler, [Object scope])

Removes a listener

Parameters:

eventName : String
The type of event to listen for
handler : Function
The handler to remove
scope : Object
(optional) The scope (this object) for the handler

Returns:

void

This method is defined by Observable.

show

public function show(String/HTMLElement/Ext.Element element, [String position], [Ext.menu.Menu parentMenu])

Displays this menu relative to another element

Parameters:

element : String/HTMLElement/Ext.Element
The element to align to
position : String
(optional) The Ext.Element.alignTo anchor position to use in aligning to the element (defaults to this.defaultAlign)
parentMenu : Ext.menu.Menu
(optional) This menu's parent menu, if applicable (defaults to undefined)

Returns:

void

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 : Array
Contains 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:

void

This method is defined by Menu.

un

public function un(String eventName, Function handler, [Object scope])

Removes a listener (shorthand for removeListener)

Parameters:

eventName : String
The type of event to listen for
handler : Function
The handler to remove
scope : Object
(optional) The scope (this object) for the handler

Returns:

void

This method is defined by Observable.

Event Details

beforehide

public event beforehide

Fires before this menu is hidden

Subscribers will be called with the following parameters:

this : Ext.menu.Menu

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 : Ext.menu.Menu

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 : Ext.menu.Menu
menuItemId : String
The id of the menu item that was clicked
e : Ext.EventObject

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 : Ext.menu.Menu

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:

baseItem : Ext.menu.BaseItem
The BaseItem that was clicked
e : Ext.EventObject

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 : Ext.menu.Menu
e : Ext.EventObject
menuItemId : String
The id of the menu item that the mouse has exited

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 : Ext.menu.Menu
e : Ext.EventObject
menuItemId : String
The id of the menu item that the mouse is over

This event is defined by Menu.

select

public event select

Subscribers will be called with the following parameters:

palette : ColorPalette
color : String

This event is defined by ColorMenu.

show

public event show

Fires after this menu is displayed

Subscribers will be called with the following parameters:

this : Ext.menu.Menu

This event is defined by Menu.

Config Details

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 it's 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 {@link Ext.Element#alignTo) anchor position value to use for submenus of this menu (defaults to "tl-tr?")

This config option is defined by Menu.