ExtJS笔记--Ext.form.Checkbox

Ext.form.Checkbox

类全称： Ext.form.Checkbox

继承自于： Ext.form.Field

单独的checkbox域，可以直接代替传统checkbox域。 

配置项

1、focusClass : String 

当表单元素获取焦点时的CSS样式（默认为"x-form-focus"）

2、fieldClass : String 

表单元素一般状态CSS样式（默认为"x-form-field"）。

3、checked : Boolean 

如果checkbox需要呈现选中状态，设置checked为True（默认为false）。

4、autoCreate : String/Object 

一个指定的DomHelper配置对象，如果为真则为一个默认对象（{tag: "input", type: "text", size: "20", autocomplete: "off"}）。

5、boxLabel : String 

checkbox旁边显示的文字。

6、inputValue : String 

应该显示在元素value处的值。 

7、fieldLabel : String 

在组件旁边那里显示的label文本（默认为''）。

此组件只有在Ext.form.FormLayout FormLayout布局管理器控制的容器下渲染才有用。 

8、inputType : String 

input字段的type属性，诸如 radio、text、password、file等的元素都有type属性。属性是“file”与“pssword”就要在这里设置了，因为当前Ext并没有这些单独的组件。 注意当你使用inputType:'file'时，#emptyText就避免使用。

9、tabIndex : Number 

字段的tabIndex。注意这只对已渲染的元素有效，applyTo的那些无效（默认为undfined）。

10、value : Mixed 

字段初始化的值（默认为undefined）。

11、name : String 

字段的name属性，HTML的name属性（默认为''）。 

12、cls : String 

一个可选添加的CSS样式类，加入到组件的元素上（默认为''）。这为组件或组件的子节点加入标准CSS规则提供了方便。

13、invalidClass : String 

当出现无效字段所使用上的CSS样式（默认为"x-form-invalid）。 

14、invalidText : String 

表单元素无效时标在上面的文本信息（默认为"The value in this field is invalid"）。

15、validationEvent : String/Boolean 

初始化元素验证的事件名，如果设假，则不进行验证（默认"keyup"）。

16、validateOnBlur : Boolean 

是否当失去焦点时验证此表单元素（默认真）。 

17、validationDelay : Number 

用户输入开始到验证开始的间隔毫秒数（默认250毫秒）。

18、msgTarget : String 

错误提示的显示位置。 可以是以下列表中的任意一项（默认为"qtip"）

19、msgFx : String 

Experimental 表单元素无效提示显示的动画效果（默认为"normal"）

20、readOnly : Boolean 

如果为真，则在HTML时标明此表单元素为只读 -- 注意：只是设置表单对象的只读属性。 

21、disabled : Boolean 

渲染该组件为禁用状态的（默认为false）。

22、x : Number 

如果该组件是在一个定位的组件之中，可通过该属性返回组件的x本地（左边）坐标。

23、y : Number 

如果该组件是在一个定位的组件之中，可通过该属性返回组件的y本地（顶部）坐标。

24、pageX : Number 

如果该组件是在一个定位的组件之中，可通过该属性返回组件的x页面坐标。 

25、pageY : Number 

如果该组件是在一个定位的组件之中，可通过该属性返回组件的y页面坐标。

26、height : Number 

此组件的高度（单位象素）（缺省为auto）。 

27、width : Number 

此组件的宽度（单位象素）（缺省为auto）。 

28、autoHeight : Boolean 

True表示为使用height:'auto'，false表示为使用固定高度（缺省为false）。 注意：尽管许多组件都会继承该配置选项，但是不是全部的'auto' height都有效。 autoHeight:true的设定表示会依照元素内容自适应大小，Ext就不会过问高度的问题。

29、autoWidth : Boolean 

True表示为使用width:'auto'，false表示为使用固定宽度（缺省为false）。 注意：尽管许多组件都会继承该配置选项，但是不是全部的'auto' width都有效。 autoWidth:true的设定表示会依照元素内容自适应大小，Ext就不会过问宽度的问题。

30、labelStyle : String 

关于表单字段的label提示文本的CSS样式的“完全表达式（CSS style specification）”。默认为""，若容器的lableStyle有设置这样设置值。 此组件只有在Ext.form.FormLayout FormLayout布局管理器控制的容器下渲染才有用。

31、labelSeparator : String 

分隔符，就是每行表单中的label文本显示后面紧接着的那个分隔符（默认值是Ext.layout.FormLayout#labelSeparator，即缺省是分号“:”）。 如果指定空白字符串""就表示不显示所谓的“分隔符”。此组件只有在Ext.form.FormLayout FormLayout布局管理器控制的容器下渲染才有用。 

32、hideLabel : Boolean 

True表示为完全隐藏label元素。默认下，即使你不指定fieldLabel都会有一个空白符插入，好让支撑field为一行。 设该值为true就不会有这个空白符了。 此组件只有在Ext.form.FormLayout FormLayout布局管理器控制的容器下渲染才有用。 

33、clearCls : String 

关于field的清除样式（默认为“x-form-clear-left”）。此组件只有在Ext.form.FormLayout FormLayout布局管理器控制的容器下渲染才有用。 

34、itemCls : String 

关于容器的表单项元素的额外的CSS样式（默认为""，如容器的itemCls有设置的话就用那个值）。由于该样式是作用于整个条目容器的，这就会对在内的表单字段、label元素（若有指定）或其他元素只要属于条目内的元素都有效。 此组件只有在Ext.form.FormLayout FormLayout布局管理器控制的容器下渲染才有用。

35、id : String 

唯一的组件id（默认为自动分配的id）。 出于你打算用id来获取组件引用这一目的（像使用Ext.ComponentMgr#getCmp的情形），你就会送入一个你写好的id到这个方法。 提示：容器的元素即HTML元素也会使用该id渲染在页面上。如此一来你就可以采用CSS id匹配的规则来定义该组件的样式。 换句话说，实例化该组件时，送入不同的Id，就有对应不同的样式效果。

36、xtype : String 

用于登记一个xtype。 

37、overCls : String 

关于鼠标上移至该组件元素的CSS样式类，移出时撤销该样式的效果（默认为''）。该配置项在处理元素"active"或"hover"的时候很有用。 

38、style : String 

作用在组件元素上特定的样式。该值的有效格式应如Ext.Element#applyStyles。 

39、ctCls : String 

一个可选添加的CSS样式类，加入到组件的容器上（默认为''）。这为容器或容器的子节点加入标准CSS规则提供了方便。 An optional extra CSS class that will be added to this component's container (defaults to ''). 

40、hidden : Boolean 

渲染该组件为隐藏状态的（默认为false）。 

41、plugins : Object/Array 

针对该组件自定义的功能，是对象或这些对象组成的数组。一个有效的插件须保证带有一个init的方法以便接收属于Ext.Component类型的引用。当一个组件被创建后，若发现由插件可用，组件会调用每个插件上的init方法，传入一个应用到插件本身。这样，插件便能按照组件所提供的功能，调用到组件的方法或响应事件。

42、applyTo : Mixed 

节点的id,或是DOM节点，又或者是与DIV相当的现有元素，这些都是文档中已经存在的元素当使用applyTo后，主元素所指定的id或CSS样式类将会作用于组件构成的部分，而被创建的组件将会尝试着根据这些markup构建它的子组件。使用了这项配置后，不需要执行render()的方法。 若指定了applyTo，那么任何由#renderTo传入的值将会被忽略并使用目标元素的父级元素作为组件的容器。

43、renderTo : Mixed 

容器渲染的那个节点的id，或是DOM节点，又或者是与DIV相当的现有元素。 使用了这项配置后，不需要执行render()的方法。

44、stateful : Boolean 

组件记忆了一个状态信息，启动时候就根据这个标记获取状态信息。 组件必须设置其#stateId或#id，较有保障性， 而自动生成的id在跨页面加载的时候则不能保证一定不出现相同的情形。为了能记忆状态，必须通过方法设置一个Ext.state.Provider的实例置于一个状态管理器之中， 然后才可以用Ext.state.Provider#set set与Ext.state.Provider#get get的方法，保存记忆和提取记忆。 可用内建的Ext.state.CookieProvider实现设置一个。 

45、stateId : String 

出于状态管理目的id，（默认是人为设置过的组件id，如果组件是自动生成的id那种那么该项是null。

46、autoEl : Mixed 

某种标签的字符串或者Ext.DomHelper DomHelper配置对象，用于创建承载此组件的元素。一般而言你无须对其设置。对于这些基础类而言，就会使用div作为其默认的元素。 Ext类写得越复杂，组件的onRender方法产生的DOM结构就随之更为复杂。 该项是为创建形形色色的DOM元素而准备的，开发者可根据程序的特定要求去制定，

47、disabledClass : String 

当组件被禁用时作用的CSS样式类（默认为"x-item-disabled"）。

48、allowDomMove : Boolean 

当渲染进行时能否移动Dom节点上的组件（默认为true）。

49、autoShow : Boolean 

True表示为在渲染的时候先检测一下有否关于隐藏的样式类（如：'x-hidden'或'x-hide-display'），有就移除隐藏的样式类（缺省为false）。

50、hideMode : String 

这个组件是怎么隐藏的。可支持的值有"visibility" （css中的visibility），"offsets"（负偏移位置）和"display"（css中的display）－默认为“display”。 容器可能是{@link Ext.layout.CardLayout card layout}或Ext.TabPanel TabPanel中的一员，会有隐藏/显未的情形，这种情形下最好将其hideMode模式设为"offsets"。这保证了计算布局时，组件仍有正确的高度和宽度，组件管理器才能顺利地测量。

51、hideParent : Boolean 

True表示为当隐藏/显示组件时对组件的容器亦一同隐藏/显示,false就只会隐藏/显示组件本身（默认为false）。例如，可设置一个hide:true的隐藏按钮在window，如果按下就通知其父容器一起隐藏，这样做起来比较快捷省事。

<!--EndFragment-->