X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/2e847cf21b8ab9d15fa167b315ca5b2fa92638fc..b37ceabb82336ee82757cd32efe353cfab8ec267:/docs/output/Ext.form.CheckboxGroup.html diff --git a/docs/output/Ext.form.CheckboxGroup.html b/docs/output/Ext.form.CheckboxGroup.html index 25bcbd22..eb2dc712 100644 --- a/docs/output/Ext.form.CheckboxGroup.html +++ b/docs/output/Ext.form.CheckboxGroup.html @@ -1,4 +1,4 @@ -
Observable Component BoxComponent Field CheckboxGroup
Package: | Ext.form |
Defined In: | CheckboxGroup.js |
Class: | CheckboxGroup |
Subclasses: | RadioGroup |
Extends: | Field |
A grouping container for Ext.form.Checkbox controls.
+Observable Component BoxComponent Field CheckboxGroup
Package: | Ext.form |
Defined In: | CheckboxGroup.js |
Class: | CheckboxGroup |
Subclasses: | RadioGroup |
Extends: | Field |
A grouping container for Ext.form.Checkbox controls.
Sample usage:
var myCheckboxGroup = new Ext.form.CheckboxGroup({
id:'myGroup',
@@ -39,102 +39,11 @@ element's parent node will automatically be used as the component's container.
element spec. Used to create the Element which will encapsulate this ...
A tag name or DomHelper spec used to create the Element which will -encapsulate this Component.
-You do not normally need to specify this. For the base classes Ext.Component, Ext.BoxComponent, -and Ext.Container, this defaults to 'div'. The more complex Ext classes use a more complex -DOM structure created by their own onRender methods.
-This is intended to allow the developer to create application-specific utility Components encapsulated by -different DOM elements. Example usage:
{
- xtype: 'box',
- autoEl: {
- tag: 'img',
- src: 'http://www.example.com/example.jpg'
- }
-}, {
- xtype: 'box',
- autoEl: {
- tag: 'blockquote',
- html: 'autoEl is cool!'
- }
-}, {
- xtype: 'container',
- autoEl: 'ul',
- cls: 'ux-unordered-list',
- items: {
- xtype: 'box',
- autoEl: 'li',
- html: 'First list item'
- }
-}
True to use height:'auto', false to use fixed height (or allow it to be managed by its parent -Container's layout manager. Defaults to false.
-Note: Although many components inherit this config option, not all will -function as expected with a height of 'auto'. Setting autoHeight:true means that the -browser will manage height based on the element's contents, and that Ext will not manage it at all.
-If the browser is managing the height, be aware that resizes performed by the browser in response -to changes within the structure of the Component cannot be detected. Therefore changes to the height might -result in elements needing to be synchronized with the new height. Example:
var w = new Ext.Window({
- title: 'Window',
- width: 600,
- autoHeight: true,
- items: {
- title: 'Collapse Me',
- height: 400,
- collapsible: true,
- border: false,
- listeners: {
- beforecollapse: function() {
- w.el.shadow.hide();
- },
- beforeexpand: function() {
- w.el.shadow.hide();
- },
- collapse: function() {
- w.syncShadow();
- },
- expand: function() {
- w.syncShadow();
- }
- }
- }
-}).show();
{tag: 'input', type: 'text', size: '20', autocomplete: 'off'}
true
to use overflow:'auto' on the components layout element and show scroll bars automatically when
necessary, false
to clip any overflowing content (defaults to false
).True to use width:'auto', false to use fixed width (or allow it to be managed by its parent -Container's layout manager. Defaults to false.
-Note: Although many components inherit this config option, not all will -function as expected with a width of 'auto'. Setting autoWidth:true means that the -browser will manage width based on the element's contents, and that Ext will not manage it at all.
-If the browser is managing the width, be aware that resizes performed by the browser in response -to changes within the structure of the Component cannot be detected. Therefore changes to the width might -result in elements needing to be synchronized with the new width. For example, where the target element is:
<div id='grid-container' style='margin-left:25%;width:50%'></div>
-A Panel rendered into that target element must listen for browser window resize in order to relay its
-child items when the browser changes its width:var myPanel = new Ext.Panel({
- renderTo: 'grid-container',
- monitorResize: true, // relay on browser resize
- title: 'Panel',
- height: 400,
- autoWidth: true,
- layout: 'hbox',
- layoutConfig: {
- align: 'stretch'
- },
- defaults: {
- flex: 1
- },
- items: [{
- title: 'Box 1',
- }, {
- title: 'Box 2'
- }, {
- title: 'Box 3'
- }],
-});
The maximum value in pixels which this BoxComponent will set its height to.
@@ -144,7 +53,10 @@ Warning: This will override any size manag...The maxi Warning: This will override any size mana...
The minimum value in pixels which this BoxComponent will set its height to.
Warning: This will override any size management applied by layout managers.
The minimum value in pixels which this BoxComponent will set its width to.
-Warning: This will override any size management applied by layout managers.
Warning: This will override any size management applied by layout managers.
An array of events that, when fired, should be bubbled to any parent container. +See Ext.util.Observable.enableBubble. +Defaults to [].
The CSS class used to to apply to the special clearing div rendered directly after each form field wrapper to provide field clearing (defaults to 'x-form-clear-left').
@@ -439,9 +351,9 @@ to the second, and the bottom is set to the third.Defaults to:
{top:0, right:0, bottom:0, left:0}
The location where the message text set through markInvalid should display. Must be one of the following values:
qtip
Display a quick tip containing the message when the user hovers over the field. This is the default.
@@ -450,7 +362,7 @@ Must be one of the following values:
under
Add a block div beneath the field containing the error message.side
Add an error icon to the right of the field, displaying the message in a popup on hover.[element id]
Add the error message directly to the innerHTML of the specified element.Ext.Component
String/Array events
)
:
- voidEnables events fired by this Observable to bubble up an owner hierarchy by calling
-this.getBubbleTarget()
if present. There is no implementation in the Observable base class.
This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default -implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to -access the required target more quickly.
-Example:
Ext.override(Ext.form.Field, {
- // Add functionality to Field's initComponent to enable the change event to bubble
- initComponent : Ext.form.Field.prototype.initComponent.createSequence(function() {
- this.enableBubble('change');
- }),
-
- // We know that we want Field's events to bubble directly to the FormPanel.
- getBubbleTarget : function() {
- if (!this.formPanel) {
- this.formPanel = this.findParentByType('form');
- }
- return this.formPanel;
- }
-});
-
-var myForm = new Ext.formPanel({
- title: 'User Details',
- items: [{
- ...
- }],
- listeners: {
- change: function() {
- // Title goes red if form has been modified.
- myForm.header.setStyle('color', 'red');
- }
- }
+ voidEnables events fired by this Observable to bubble up an owner hierarchy by calling
+this.getBubbleTarget() if present....Enables events fired by this Observable to bubble up an owner hierarchy by calling
+this.getBubbleTarget()
if present. There is no implementation in the Observable base class.
+This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default
+implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to
+access the required target more quickly.
+Example:
Ext.override(Ext.form.Field, {
+ // Add functionality to Field's initComponent to enable the change event to bubble
+ initComponent : Ext.form.Field.prototype.initComponent.createSequence(function() {
+ this.enableBubble('change');
+ }),
+
+ // We know that we want Field's events to bubble directly to the FormPanel.
+ getBubbleTarget : function() {
+ if (!this.formPanel) {
+ this.formPanel = this.findParentByType('form');
+ }
+ return this.formPanel;
+ }
+});
+
+var myForm = new Ext.formPanel({
+ title: 'User Details',
+ items: [{
+ ...
+ }],
+ listeners: {
+ change: function() {
+ // Title goes red if form has been modified.
+ myForm.header.setStyle('color', 'red');
+ }
+ }
});
Parameters:events
: String/ArrayThe event name to bubble, or an Array of event names.
Returns:- void
Function fn
)
:
Ext.Containernew Ext.Panel({
},
single: true // Remove the listener after first invocation
}
-});
Ext.Element
Ext.Element
Array
Number
Boolean scroll
)
+events fired during event suspension will be sent to any listeners now.String msg
, Boolean suppressEvent
)
+ :
+ voidmsg
: StringsuppressEvent
: BooleanBoolean scroll
)
:
Ext.BoxComponentscroll
: BooleanExt.BoxComponent
Boolean disabled
)
:
- Ext.Componentdisabled
: BooleanExt.Component
Number height
)
+ Ext.Componentdisabled
: BooleanExt.Component
Mixed height
)
:
- Ext.BoxComponentheight
: Numberheight
: MixedExt.BoxComponent
Number x
, Number y
)
@@ -1022,10 +943,10 @@ myCheckboxGroup.setValue({
myCheckboxGroup.setValue('cb-col-1,cb-col-3');
See Ext.form.Checkbox.setValue for additional information.id
: Mixedvalue
: BooleanExt.form.CheckboxGroup
Boolean visible
)
:
- Ext.Componentvisible
: BooleanExt.Component
Number width
)
+ Ext.Componentvisible
: BooleanExt.Component
Mixed width
)
:
- Ext.BoxComponentwidth
: Numberwidth
: MixedExt.BoxComponent
Ext.BoxComponent
String eventName
, Function handler
, [Object scope
] )
:
- voideventName
: Stringhandler
: Functionscope
: ObjectMixed htmlOrData
, [Boolean loadScripts
], [Function callback
] )
+ voideventName
: Stringhandler
: Functionscope
: ObjectBoolean suppressEvent
)
+ :
+ voidsuppressEvent
: BooleanMixed htmlOrData
, [Boolean loadScripts
], [Function callback
] )
:
voidhtmlOrData
: MixedloadScri
:
Ext.BoxComponentSets the current box measurements of the component's underlying element.Sets the current box measurements of the component's underlying element.Parameters:box
: ObjectAn object in the format {x, y, width, height}
Returns:Ext.BoxComponent
this
Boolean
Event | Defined By | |
---|---|---|
added :
+ Boolean Validates the field value Validates the field value Parameters:
| Field | |
validateValue( Mixed The )
+ :
+ BooleanUses getErrors to build an array of validation errors. If any errors are found, markInvalid is called
+with the first ... Uses getErrors to build an array of validation errors. If any errors are found, markInvalid is called
+with the first and false is returned, otherwise true is returned. Previously, subclasses were invited
+to provide an implementation of this to process validations - from 3.2 onwards getErrors should be
+overridden instead. Parameters:
| Field |
Event | Defined By | |
---|---|---|
added :
( Ext.Component this , Ext.Container ownerCt , number index )
Fires when a component is added to an Ext.Container Fires when a component is added to an Ext.Container Listeners will be called with the following arguments:
| Component | |
afterrender :
( Ext.Component this )
|