X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/2e847cf21b8ab9d15fa167b315ca5b2fa92638fc..e9397f91ede62d446aed37d23256e8938fc4c335:/docs/output/Ext.form.Radio.html?ds=sidebyside diff --git a/docs/output/Ext.form.Radio.html b/docs/output/Ext.form.Radio.html index a6197d2b..82f38e1a 100644 --- a/docs/output/Ext.form.Radio.html +++ b/docs/output/Ext.form.Radio.html @@ -1,4 +1,9 @@ -
Package: | Ext.form |
Defined In: | Radio.js |
Class: | Radio |
Extends: | Checkbox |
Observable + Component + BoxComponent + Field + Checkbox + Radio
Package: | Ext.form |
Defined In: | Radio.js |
Class: | Radio |
Extends: | Checkbox |
Config Options | Defined By | |
---|---|---|
allowDomMove : Boolean Whether the component can move the Dom node when rendering (defaults to true). | Component | |
anchor : String Note: this config is only used when this Component is rendered
by a Container which has been configured to use an Anc... Note: this config is only used when this Component is rendered by a Container which has been configured to use an AnchorLayout (or subclass thereof). @@ -125,7 +130,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. | BoxComponent | |
boxMinWidth : Number The minimum value in pixels which this BoxComponent will set its width to.
Warning: This will override any size manag... The minimum value in pixels which this BoxComponent will set its width to. -Warning: This will override any size management applied by layout managers. | BoxComponent | |
checked : Boolean true if the checkbox should render initially checked (defaults to false) | Checkbox | |
clearCls : String The CSS class used to to apply to the special clearing div rendered
+ Warning: This will override any size management applied by layout managers. | BoxComponent | |
bubbleEvents : Array An array of events that, when fired, should be bubbled to any parent container.
+See Ext.util.Observable.enableBubble.... An array of events that, when fired, should be bubbled to any parent container. +See Ext.util.Observable.enableBubble. +Defaults to []. | Component | |
checked : Boolean true if the checkbox should render initially checked (defaults to false) | Checkbox | |
clearCls : String The CSS class used to to apply to the special clearing div rendered
directly after each form field wrapper to provide... 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'). @@ -182,8 +190,8 @@ by a Container which has been configured to use a BoxComponent | ||
focusClass : String The CSS class to use when the checkbox receives focus (defaults to undefined) | Checkbox | |
handler : Function A function called when the checked value changes (can be used instead of
-handling the check event). The handler is p... A function called when the checked value changes (can be used instead of
+either a flex = 0 or flex = undefined will not be 'flexed' (the initial size will not be changed). | BoxComponent | |
focusClass : String The CSS class to use when the checkbox receives focus (defaults to undefined) | Checkbox | |
handler : Function A function called when the checked value changes (can be used instead of
+handling the check event). The handler is pa... A function called when the checked value changes (can be used instead of
handling the check event). The handler is passed the following parameters:
Defaults to:
| BoxComponent | |
msgFx : String Experimental The effect used when displaying a validation message under the field
-(defaults to 'normal'). | Field | |
msgTarget<p>The : String location where the message text set through markInvalid should display.
+(defaults to 'normal'). | Field | |
msgTarget : String The location where the message text set through markInvalid should display.
Must be one of the following values:
-<div cla... location where the message text set through markInvalid should display.
+<div... The location where the message text set through markInvalid should display. Must be one of the following values:
| Field | |
name : String The field's HTML name attribute (defaults to '').
+ | Field | |
name : String The field's HTML name attribute (defaults to '').
Note: this property must be set if this field is to be automaticall... The field's HTML name attribute (defaults to '').
Note: this property must be set if this field is to be automatically included with
form submit(). | Field | |
overCls : String An optional extra CSS class that will be added to this component's Element when the mouse moves
@@ -687,7 +695,12 @@ Or a shorthand syntax: Returns:scope: this });
| Observable | |
applyToMarkup( String/HTMLElement el )
:
- voidApply this component to existing markup that is valid. With this function, no call to render() is required. Apply this component to existing markup that is valid. With this function, no call to render() is required. Parameters:
| Component | |
cloneConfig( Object overrides )
+ voidApply this component to existing markup that is valid. With this function, no call to render() is required. Apply this component to existing markup that is valid. With this function, no call to render() is required. Parameters:
| Component | |
bubble( Function fn , [Object scope ], [Array args ] )
+ :
+ Ext.ComponentBubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of... Bubbles up the component/container heirarchy, calling the specified function with each component. The scope (this) of
+function call will be the scope provided or the current component. The arguments to the function
+will be the args provided or the current component. If the function returns false at any point,
+the bubble is stopped. Parameters:
| Component | |
cloneConfig( Object overrides )
:
Ext.ComponentClone the current component using the original config values passed into this instance by default. Clone the current component using the original config values passed into this instance by default. Parameters:
| Component | |
destroy()
@@ -702,45 +715,47 @@ should usually not need to be called directly. Enable this component and fire the 'enable' event. Enable this component and fire the 'enable' event. Parameters:
| Component | |
enableBubble( String/Array events )
:
- 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 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:
| Observable | |
findParentBy( Function fn )
:
Ext.ContainerFind a container above this component at any level by a custom function. If the passed function returns
true, the con... Find a container above this component at any level by a custom function. If the passed function returns
-true, the container will be returned. Parameters:
| Component | |
findParentByType( String/Class xtype )
+true, the container will be returned.Parameters:
| Component | |
findParentByType( String/Ext.Component/Class xtype , [Boolean shallow ] )
:
- Ext.ContainerFind a container above this component at any level by xtype or class Find a container above this component at any level by xtype or class Parameters:
| Component | |
fireEvent( String eventName , Object... args )
+ Ext.ContainerFind a container above this component at any level by xtype or class Find a container above this component at any level by xtype or class Parameters:
| Component | |
fireEvent( String eventName , Object... args )
:
BooleanFires the specified event with the passed parameters (minus the event name).
An event may be set to bubble up an Obse... Fires the specified event with the passed parameters (minus the event name). @@ -771,7 +786,12 @@ or use a render listener directly:
Parameters:
| Component | |
getGroupValue()
+}); Parameters:
| Component | |
getErrors()
+ :
+ Array Runs this field's validators and returns an array of error messages for any validation failures.
+This is called inter... Runs this field's validators and returns an array of error messages for any validation failures.
+This is called internally during validation and would not usually need to be used manually.
+Each subclass should override or augment the return value to provide their own errors Parameters:
| Field | |
getGroupValue()
:
String If this radio is part of a group, it will return the selected value If this radio is part of a group, it will return the selected value Parameters:
| Radio | |
getHeight()
:
@@ -851,7 +871,7 @@ of the field. Note: disab... Returns whether or not the f
validating the processed value
of the field. Note: disabled fields are ignored. Parameters:
| Field | |
isVisible()
:
- Boolean Returns true if this component is visible. Returns true if this component is visible. Parameters:
| Component | |
isXType( String xtype , [Boolean shallow ] )
+ BooleanReturns true if this component is visible. Returns true if this component is visible. Parameters:
| Component | |
isXType( String/Ext.Component/Class xtype , [Boolean shallow ] )
:
BooleanTests whether or not this Component is of a specific xtype. This can test whether this Component is descended
from th... Tests whether or not this Component is of a specific xtype. This can test whether this Component is descended @@ -863,7 +883,11 @@ to participate in determination of inherited xtypes.
Parameters:
| Component | |
mon( Observable|Element item , Object|String ename , Function fn , Object scope , Object opt )
:
voidAdds listeners to any Observable object (or Elements) which are automatically removed when this Component
@@ -938,14 +962,19 @@ See Ext.fo
If events were suspended using the queueSuspended parameter, then all
event... Resume firing events. (see suspendEvents)
If events were suspended using the queueSuspended parameter, then all
-events fired during event suspension will be sent to any listeners now. Parameters:
| Observable | |
setAutoScroll( Boolean scroll )
+events fired during event suspension will be sent to any listeners now.Parameters:
| Observable | |
setActiveError( String msg , Boolean suppressEvent )
+ :
+ voidSets the current activeError to the given string. Fires the 'invalid' event.
+This does not set up the error icon, onl... Sets the current activeError to the given string. Fires the 'invalid' event.
+This does not set up the error icon, only sets the message and fires the event. To show the error icon,
+use markInvalid instead, which calls this method internally Parameters:
| Field | |
setAutoScroll( Boolean scroll )
:
Ext.BoxComponentSets the overflow on the content element of the component. Sets the overflow on the content element of the component. Parameters:
| BoxComponent | |
setDisabled( Boolean disabled )
:
- Ext.ComponentConvenience function for setting disabled/enabled by boolean. Convenience function for setting disabled/enabled by boolean. Parameters:
| Component | |
setHeight( Number height )
+ Ext.ComponentConvenience function for setting disabled/enabled by boolean. Convenience function for setting disabled/enabled by boolean. Parameters:
| Component | |
setHeight( Mixed height )
:
- Ext.BoxComponentSets the height of the component. This method fires the resize event. Sets the height of the component. This method fires the resize event. Parameters:
| BoxComponent | |
setPagePosition( Number x , Number y )
@@ -980,10 +1009,10 @@ This may be one of:
Sets either the checked/unchecked status of this Radio, or, if a string value
is passed, checks a sibling Radio of the same name whose value is the value specified. Parameters:
| Radio | |
setVisible( Boolean visible )
:
- Ext.ComponentConvenience function to hide or show this component by boolean. Convenience function to hide or show this component by boolean. Parameters:
| Component | |
setWidth( Number width )
+ Ext.ComponentConvenience function to hide or show this component by boolean. Convenience function to hide or show this component by boolean. Parameters:
| Component | |
setWidth( Mixed width )
:
- Ext.BoxComponentSets the width of the component. This method fires the resize event. Sets the width of the component. This method fires the resize event. Parameters:
| BoxComponent | |
show()
:
@@ -997,7 +1026,11 @@ after the Force the component's size to recalculate based on the underlying element's current height and width. Force the component's size to recalculate based on the underlying element's current height and width. Parameters:
| BoxComponent | |
un( String eventName , Function handler , [Object scope ] )
:
- voidRemoves an event handler (shorthand for removeListener.) Removes an event handler (shorthand for removeListener.) Parameters:
| Observable | |
update( Mixed htmlOrData , [Boolean loadScripts ], [Function callback ] )
+ voidRemoves an event handler (shorthand for removeListener.) Removes an event handler (shorthand for removeListener.) Parameters:
| Observable | |
unsetActiveError( Boolean suppressEvent )
+ :
+ voidClears the activeError and fires the 'valid' event. This is called internally by clearInvalid and would not
+usually n... Clears the activeError and fires the 'valid' event. This is called internally by clearInvalid and would not
+usually need to be called manually Parameters:
| Field | |
update( Mixed htmlOrData , [Boolean loadScripts ], [Function callback ] )
:
voidUpdate the content area of a component. Update the content area of a component. Parameters:
| BoxComponent | |
validate()
:
- Boolean Validates the field value Validates the field value Parameters:
| Field |
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 )
|