Class Ext.ColorPalette

Package:	Ext
Class:	ColorPalette
Extends:	Component
Defined In:	ColorPalette.js

Simple color palette class for choosing colors. The palette can be rendered to any container.
Here's an example of typical usage:

var cp = new Ext.ColorPalette({value:'993300'});  // initial selected color
cp.render('my-div');

cp.on('select', function(palette, selColor){
    // do something with selColor
});

属性 - 方法 - 事件 - 设置选项

公共属性

属性		定义对象
	colors : Array	ColorPalette
	An array of 6-digit color hex code strings (without the # symbol). This array can contain any number of colors, and ...	ColorPalette
	disabled : Object	Component
	true if this component is disabled. Read-only.	Component
	disabledClass : Object	Component
	CSS class added to the component when it is disabled.	Component
	hidden : Object	Component
	true if this component is hidden. Read-only.	Component
	rendered : Object	Component
	true if this component has been rendered. Read-only.	Component

公共方法

方法		定义对象
	ColorPalette(`Object config`)	ColorPalette
	Create a new ColorPalette	ColorPalette
	addEvents(`Object object`) : void	Observable
	将对象中没有的事件从给出的对象中复制过来。	Observable
	addListener(`String eventName`, `Function handler`, [`Object scope`], [`Object options`]) : void	Observable
	为该组件加入事件处理器函数	Observable
	disable() : void	Component
	Disable this component	Component
	enable() : void	Component
	Enable this component	Component
	fireEvent(`String eventName`, `Object... args`) : Boolean	Observable
	触发指定的事件, 并将参数传入（至少要有事件名称）。	Observable
	focus(`Boolean selectText`) : void	Component
	Try to focus this component	Component
	getEl() : Ext.Element	Component
	Returns the underlying Ext.Element	Component
	getId() : String	Component
	Returns the id of this component	Component
	hasListener(`String eventName`) : Boolean	Observable
	检查该对象是否拥有指定事件的侦听器	Observable
	hide() : void	Component
	Hide this component	Component
	isVisible() : void	Component
	Returns true if this component is visible	Component
	on(`String eventName`, `Function handler`, [`Object options`]) : void	Observable
	为该组件加入事件处理器函数, addListener 的简写方式	Observable
	purgeListeners() : void	Observable
	从对象身上移除所有的侦听器	Observable
	removeListener(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	移除侦听器	Observable
	render([`String/HTMLElement/Element container`]) : void	Component
	If this is a lazy rendering component, render it to its container element	Component
	select(`String color`) : void	ColorPalette
	Selects the specified color in the palette (fires the select event)	ColorPalette
	setDisabled(`Boolean disabled`) : void	Component
	Convenience function for setting disabled/enabled by boolean	Component
	setVisible(`Boolean visible`) : void	Component
	Convenience function to hide or show this component by boolean	Component
	show() : void	Component
	Show this component	Component
	un(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	移除侦听器, removeListener 的简写方式	Observable

公共事件

事件		定义对象
	beforedestroy : (`Ext.Component this`)	Component
	Fires before the component is destroyed	Component
	beforehide : (`Ext.Component this`)	Component
	Fires before the component is hidden	Component
	beforerender : (`Ext.Component this`)	Component
	Fires before the component is rendered	Component
	beforeshow : (`Ext.Component this`)	Component
	Fires before the component is shown	Component
	destroy : (`Ext.Component this`)	Component
	Fires after the component is destroyed	Component
	disable : (`Ext.Component this`)	Component
	Fires after the component is disabled	Component
	enable : (`Ext.Component this`)	Component
	Fires after the component is enabled	Component
	hide : (`Ext.Component this`)	Component
	Fires after the component is hidden	Component
	render : (`Ext.Component this`)	Component
	Fires after the component is rendered	Component
	select : (`ColorPalette this`, `String color`)	ColorPalette
	Fires when a color is selected	ColorPalette
	show : (`Ext.Component this`)	Component
	Fires after the component is shown	Component

设置选项

设置选项		定义对象
	itemCls : String	ColorPalette
	The CSS class to apply to the containing element (defaults to "x-color-palette")	ColorPalette
	value : String	ColorPalette
	The initial color to highlight (should be a valid 6-digit color hex code without the # symbol). Note that the hex cod...	ColorPalette

属性详情

colors

public Array colors

An array of 6-digit color hex code strings (without the # symbol). This array can contain any number of colors, and each hex code should be unique. The width of the palette is controlled via CSS by adjusting the width property of the 'x-color-palette' class (or assigning a custom class), so you can balance the number of colors with the width setting until the box is symmetrical.

You can override individual colors if needed:


var cp = new Ext.ColorPalette();
cp.colors[0] = "FF0000";  // change the first box to red

Or you can provide a custom array of your own for complete control:


var cp = new Ext.ColorPalette();
cp.colors = ["000000", "993300", "333300"];

This property is defined by ColorPalette.

disabled

public Object disabled

true if this component is disabled. Read-only.

This property is defined by Component.

disabledClass

public Object disabledClass

CSS class added to the component when it is disabled.

This property is defined by Component.

hidden

public Object hidden

true if this component is hidden. Read-only.

This property is defined by Component.

rendered

public Object rendered

true if this component has been rendered. Read-only.

This property is defined by Component.

构造函数

ColorPalette

public function ColorPalette(Object config)

Create a new ColorPalette

参数：

config : Object
The config object

方法详情

addEvents

public function addEvents(Object object)

将对象中没有的事件从给出的对象中复制过来。给出的对象必须也继承于 Observable 对象此方法才会有效果。

参数：

object : Object
要复制事件的源对象

返回：

void

This method is defined by Observable.

addListener

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

为组件添加一个事件监听器

参数：

eventName : String
侦听事件的类型
handler : Function
事件调用的方法
scope : Object
（可选）处理函数执行的作用域。处理函数 "this" 的内容。
options : Object
（可选）一个包含处理设置属性的对象。可以包含下列的属性：
- scope {Object} 处理函数执行的作用域。处理函数 "this" 的内容。
- delegate {String} 一个简单的选择器用来过滤目标或查找目标的子节点。
- stopEvent {Boolean} 值为 True 时用来中止事件。那样将中止传播，并防止缺省动作。
- preventDefault {Boolean} 值为 True 时用来防止缺省动作。
- stopPropagation {Boolean} 值为 True 时用来中止事件传播。
- normalized {Boolean} 值为 False 时向处理函数传递浏览器事件用以代替 Ext.EventObject 对象。
- delay {Number} 当事件触发后启用处理函数的延迟微秒数。
- single {Boolean} 值为 True 时将添加一个处理函数用来处理下个触发的事件，并在处理完后移除。
- buffer {Number} 使处理函数计划在由 Ext.util.DelayedTask 指定的微秒数后执行。如果事件在延迟期间再次触发，原来的处理函数将不再启动，而是由新的计划代替。
组合选项
使用选项参数可以组合不同类型的监听器：

下面是一个标准的、延迟执行的、一次性的监听器，将会自动停止事件并传递一个自定义的参数(forumId)
代码：
```
el.on('click', this.onClick, this, { single: true, delay: 100, stopEvent : true, forumId: 4 });
```
这个方法也允许传递的单个参数是一个包含多个指定处理函数的设置对象。

一次调用多个处理函数
代码：
```
el.on({ 'click' : { fn: this.onClick scope: this, delay: 100 }, 'mouseover' : { fn: this.onMouseOver scope: this }, 'mouseout' : { fn: this.onMouseOut scope: this } });
```
或者简写为：
代码：
```
el.on({ 'click' : this.onClick, 'mouseover' : this.onMouseOver, 'mouseout' : this.onMouseOut scope: this });
```

返回：

void

This method is defined by Observable.

disable

public function disable()

Disable this component

参数：

无。

返回：

void

This method is defined by Component.

enable

public function enable()

Enable this component

参数：

无。

返回：

void

This method is defined by Component.

fireEvent

public function fireEvent(String eventName, Object... args)

触发指定的事件并给出参数（至少要有事件名称）。

参数：

eventName : String
args : Object...
传入处理函数的参数

返回：

Boolean
如果任何处理函数返回 false 则返回值为 false, 否则返回 true。

This method is defined by Observable.

focus

public function focus(Boolean selectText)

Try to focus this component

参数：

selectText : Boolean
True to also select the text in this component (if applicable)

返回：

void

This method is defined by Component.

getEl

public function getEl()

Returns the underlying Ext.Element

参数：

无。

返回：

Ext.Element
The element

This method is defined by Component.

getId

public function getId()

Returns the id of this component

参数：

无。

返回：

String

This method is defined by Component.

hasListener

public function hasListener(String eventName)

检查该对象是否拥有指定事件的侦听器

参数：

eventName : String
查询事件之名称

返回：

Boolean
值为 True 值表示事件监听器存在, 否则值为 false。

This method is defined by Observable.

hide

public function hide()

Hide this component

参数：

无。

返回：

void

This method is defined by Component.

isVisible

public function isVisible()

Returns true if this component is visible

参数：

无。

返回：

void

This method is defined by Component.

on

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

为该组件加入事件处理器函数, addListener 的简写方式

参数：

eventName : String
侦听事件的类型
handler : Function
事件调用的方法
options : Object
（可选）

返回：

void

This method is defined by Observable.

purgeListeners

public function purgeListeners()

从对象身上移除所有的侦听器

参数：

无。

返回：

void

This method is defined by Observable.

removeListener

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

移除侦听器

参数：

eventName : String
侦听事件的类型
handler : Function
删除的处理函数
scope : Object
（可选） The scope (this object) for the handler

返回：

void

This method is defined by Observable.

render

public function render([String/HTMLElement/Element container])

If this is a lazy rendering component, render it to its container element

参数：

container : String/HTMLElement/Element
（可选） The element this component should be rendered into. If it is being applied to existing markup, this should be left off.

返回：

void

This method is defined by Component.

select

public function select(String color)

Selects the specified color in the palette (fires the select event)

参数：

color : String
A valid 6-digit color hex code (# will be stripped if included)

返回：

void

This method is defined by ColorPalette.

setDisabled

public function setDisabled(Boolean disabled)

Convenience function for setting disabled/enabled by boolean

参数：

disabled : Boolean

返回：

void

This method is defined by Component.

setVisible

public function setVisible(Boolean visible)

Convenience function to hide or show this component by boolean

参数：

visible : Boolean
True to show, false to hide

返回：

void

This method is defined by Component.

show

public function show()

Show this component

参数：

无。

返回：

void

This method is defined by Component.

un

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

移除侦听器, removeListener 的简写方式

参数：

eventName : String
侦听事件的类型
handler : Function
删除的处理函数
scope : Object
（可选） The scope (this object) for the handler

返回：

void

This method is defined by Observable.