Class Ext.form.Radio

Package:	Ext.form
Class:	Radio
Extends:	Checkbox
Defined In:	Radio.js

Single radio field. Same as Checkbox, but provided as a convenience for automatically setting the input type. Radio grouping is handled automatically by the browser if you give each radio in a group the same name.

Properties - Methods - Events - Config Options

Public Properties

Property		Defined By
	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

Public Methods

Method		Defined By
	Radio(`Object config`)	Radio
	Creates a new Radio	Radio
	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
	addListener(`String eventName`, `Function handler`, [`Object options`]) : void	Observable
	Appends an event handler to this component	Observable
	applyTo(`String/HTMLElement/Element el`) : Ext.form.Field	Field
	Apply the behaviors of this component to an existing element. This is used instead of render().	Field
	clearInvalid() : void	Field
	Clear any invalid styles/messages for this field	Field
	disable() : void	Component
	Disable this component	Component
	enable() : void	Component
	Enable this component	Component
	fireEvent(`String eventName`, `Object... args`) : Boolean	Observable
	Fires the specified event with the passed parameters (minus the event name).	Observable
	focus(`Boolean selectText`) : void	Component
	Try to focus this component	Component
	getEl() : Ext.Element	Component
	Returns the underlying Ext.Element	Component
	getName() : String	Field
	Returns the name attribute of the field if available	Field
	getRawValue() : Mixed	Field
	Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see getValue.	Field
	getValue() : Mixed	Field
	Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see getVa...	Field
	hasListener(`String eventName`) : Boolean	Observable
	Checks to see if this object is currently listening for a specified event	Observable
	hide() : void	Component
	Hide this component	Component
	isValid() : Boolean	Field
	Returns whether or not the field value is currently valid	Field
	markInvalid(`String msg`) : void	Field
	Mark this field as invalid	Field
	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
	removeListener(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	Removes a listener	Observable
	render(`String/HTMLElement/Element container`) : void	Component
	If this is a lazy rendering component, render it to it's container element	Component
	reset() : void	Field
	Resets the current field value to the originally-loaded value and clears any validation messages	Field
	setDisabled(`Boolean disabled`) : void	Component
	Convenience function for setting disabled/enabled by boolean	Component
	setRawValue(`Mixed value`) : void	Field
	Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see setValue.	Field
	setSize(`Number width`, `Number height`) : void	Field
	Sets the height and width of the field	Field
	setValue(`Mixed value`) : void	Field
	Sets a data value into the field and validates it. To set the value directly without validation see setRawValue.	Field
	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
	Removes a listener (shorthand for removeListener)	Observable
	validate() : Boolean	Field
	Validates the field value	Field

Public Events

Event		Defined By
	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
	blur : (`Ext.form.Field this`)	Field
	Fires when	Field
	change : (`Ext.form.Field this`, `Mixed value`, `Mixed value`)	Field
	Fires just before the field blurs if the field value has changed	Field
	check : (`Ext.form.Checkbox this`, `Boolean checked`)	Checkbox
	Fires when the checkbox is checked or unchecked	Checkbox
	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
	focus : (`Ext.form.Field this`)	Field
	Fires when this field receives input focus	Field
	hide : (`Ext.Component this`)	Component
	Fires after the component is hidden	Component
	invalid : (`Ext.form.Field this`, `String msg`)	Field
	Fires after the field has been marked as invalid	Field
	render : (`Ext.Component this`)	Component
	Fires after the component is rendered	Component
	show : (`Ext.Component this`)	Component
	Fires after the component is shown	Component
	specialkey : (`Ext.form.Field this`, `Ext.EventObject e`)	Field
	Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check Ext.EventObject.g...	Field
	valid : (`Ext.form.Field this`)	Field
	Fires after the field has been validated with no errors	Field

Config Options

Config Options		Defined By
	autoCreate : String/Object	Field
	A DomHelper element spec, or true for a default element spec (defaults to {tag: "input", type: "text", size: "20", au...	Field
	boxLabel : String	Checkbox
	The text that appears beside the checkbox	Checkbox
	checked : Boolean	Checkbox
	True if the the checkbox should render already checked (defaults to false)	Checkbox
	fieldClass : String	Field
	The default CSS class for the field (defaults to "x-form-field")	Field
	focusClass : String	Field
	The CSS class to use when the field receives focus (defaults to "x-form-focus")	Field
	inputType : String	Field
	The type attribute for input fields - e.g. radio, text, password. (defaults to "text")	Field
	inputValue : String	Checkbox
	The value that should go into the generated input element's value attribute	Checkbox
	invalidClass : String	Field
	The CSS class to use when marking a field invalid (defaults to "x-form-invalid")	Field
	invalidText : String	Field
	The error text to use when marking a field invalid and no message is provided (defaults to "The value in this field i...	Field
	msgFx : String	Field
	Experimental The effect used when displaying a validation message under the field (defaults to 'normal').	Field
	msgTarget : String	Field
	The location where error text should display. Should be one of the following values (defaults to 'qtip'): Value Desc...	Field
	validationDelay : Number	Field
	The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)	Field
	validationEvent : String/Boolean	Field
	The event that should initiate field validation. Set to false to disable automatic validation. (defaults to "keyup")	Field

Property Details

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.

Constructor Details

Radio

public function Radio(Object config)

Creates a new Radio

Parameters:

config : Object
Configuration options

Method Details

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.

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.

applyTo

public function applyTo(String/HTMLElement/Element el)

Apply the behaviors of this component to an existing element. This is used instead of render().

Parameters:

el : String/HTMLElement/Element
The id of the node, a DOM Node or an existing Element

Returns:

Ext.form.Field
this

This method is defined by Field.

clearInvalid

public function clearInvalid()

Clear any invalid styles/messages for this field

Parameters:

None.

Returns:

void

This method is defined by Field.

disable

public function disable()

Disable this component

Parameters:

None.

Returns:

void

This method is defined by Component.

enable

public function enable()

Enable this component

Parameters:

None.

Returns:

void

This method is defined by Component.

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.

focus

public function focus(Boolean selectText)

Try to focus this component

Parameters:

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

Returns:

void

This method is defined by Component.

getEl

public function getEl()

Returns the underlying Ext.Element

Parameters:

None.

Returns:

Ext.Element
The element

This method is defined by Component.

getName

public function getName()

Returns the name attribute of the field if available

Parameters:

None.

Returns:

String
name The field name

This method is defined by Field.

getRawValue

public function getRawValue()

Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see getValue.

Parameters:

None.

Returns:

Mixed
value The field value

This method is defined by Field.

getValue

public function getValue()

Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see getValue.

Parameters:

None.

Returns:

Mixed
value The field value

This method is defined by Field.

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

Hide this component

Parameters:

None.

Returns:

void

This method is defined by Component.

isValid

public function isValid()

Returns whether or not the field value is currently valid

Parameters:

None.

Returns:

Boolean
True if the value is valid, else false

This method is defined by Field.

markInvalid

public function markInvalid(String msg)

Mark this field as invalid

Parameters:

msg : String
The validation message

Returns:

void

This method is defined by Field.

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.

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.

render

public function render(String/HTMLElement/Element container)

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

Parameters:

container : String/HTMLElement/Element
The element this component should be rendered into

Returns:

void

This method is defined by Component.

reset

public function reset()

Resets the current field value to the originally-loaded value and clears any validation messages

Parameters:

None.

Returns:

void

This method is defined by Field.

setDisabled

public function setDisabled(Boolean disabled)

Convenience function for setting disabled/enabled by boolean

Parameters:

disabled : Boolean

Returns:

void

This method is defined by Component.

setRawValue

public function setRawValue(Mixed value)

Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see setValue.

Parameters:

value : Mixed
The value to set

Returns:

void

This method is defined by Field.

setSize

public function setSize(Number width, Number height)

Sets the height and width of the field

Parameters:

width : Number
The new field width in pixels
height : Number
The new field height in pixels

Returns:

void

This method is defined by Field.

setValue

public function setValue(Mixed value)

Sets a data value into the field and validates it. To set the value directly without validation see setRawValue.

Parameters:

value : Mixed
The value to set

Returns:

void

This method is defined by Field.

setVisible

public function setVisible(Boolean visible)

Convenience function to hide or show this component by boolean

Parameters:

visible : Boolean
True to show, false to hide

Returns:

void

This method is defined by Component.

show

public function show()

Show this component

Parameters:

None.

Returns:

void

This method is defined by Component.

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.

validate

public function validate()

Validates the field value

Parameters:

None.

Returns:

Boolean
True if the value is valid, else false

This method is defined by Field.