PHP Класс Prado\Web\UI\WebControls\TRadioButton

TRadioButton displays a radio button on the page. You can specify the caption to display beside the radio buttonby setting the {@link setText Text} property. The caption can appear either on the right or left of the radio button, which is determined by the {@link setTextAlign TextAlign} property. To determine whether the TRadioButton component is checked, test the {@link getChecked Checked} property. The {@link onCheckedChanged OnCheckedChanged} event is raised when the {@link getChecked Checked} state of the TRadioButton component changes between posts to the server. You can provide an event handler for the {@link onCheckedChanged OnCheckedChanged} event to to programmatically control the actions performed when the state of the TRadioButton component changes between posts to the server. TRadioButton uses {@link setGroupName GroupName} to group together a set of radio buttons. Once the {@link setGroupName GroupName} is set, you can use the {@link getRadioButtonsInGroup} method to get an array of TRadioButtons having the same group name. If {@link setAutoPostBack AutoPostBack} is set true, changing the radio button state will cause postback action. And if {@link setCausesValidation CausesValidation} is true, validation will also be processed, which can be further restricted within a {@link setValidationGroup ValidationGroup}. Note, {@link setText Text} is rendered as is. Make sure it does not contain unwanted characters that may bring security vulnerabilities.
С версии: 3.0
Автор: Qiang Xue ([email protected])
Наследование: extends TCheckBox
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
__construct ( ) Constructor.
getEnableClientScript ( ) : boolean
getGroupName ( ) : string
getRadioButtonsInGroup ( ) : array Gets an array of radiobuttons whose group name is the same as this radiobutton's.
getUniqueGroupName ( ) : string
loadPostData ( $key, $values ) : boolean Loads user input data.
onInit ( $param ) Registers the radio button groupings. If overriding onInit method, ensure to call parent implemenation.
onUnLoad ( $param ) Unregisters the radio button groupings. If overriding onInit method, ensure to call parent implemenation.
setEnableClientScript ( $value )
setGroupName ( $value ) Sets the name of the group that the radio button belongs to.
setUniqueGroupName ( $value ) Sets the unique group name that the radio button belongs to.

Защищенные методы

Метод Описание
getClientClassName ( ) : string Gets the name of the javascript class responsible for performing postback for this control.
getValueAttribute ( ) : string
renderClientControlScript ( $writer ) Renders the client-script code.
renderInputTag ( $writer, $clientID, $onclick ) Renders a radiobutton input element.

Описание методов

__construct() публичный Метод

Registers the radiobutton in a global radiobutton collection. If overridden, the parent implementation must be invoked first.
public __construct ( )

getClientClassName() защищенный Метод

This method overrides the parent implementation.
protected getClientClassName ( ) : string
Результат string the javascript class name

getEnableClientScript() публичный Метод

public getEnableClientScript ( ) : boolean
Результат boolean whether to render javascript.

getGroupName() публичный Метод

public getGroupName ( ) : string
Результат string the name of the group that the radio button belongs to. Defaults to empty.

getRadioButtonsInGroup() публичный Метод

Note, only those radiobuttons that are on the current page hierarchy may be returned in the result.
public getRadioButtonsInGroup ( ) : array
Результат array list of TRadioButton with the same group

getUniqueGroupName() публичный Метод

public getUniqueGroupName ( ) : string
Результат string the name used to fetch radiobutton post data

getValueAttribute() защищенный Метод

protected getValueAttribute ( ) : string
Результат string the value attribute to be rendered

loadPostData() публичный Метод

This method is primarly used by framework developers.
public loadPostData ( $key, $values ) : boolean
Результат boolean whether the data of the control has been changed

onInit() публичный Метод

Registers the radio button groupings. If overriding onInit method, ensure to call parent implemenation.
public onInit ( $param )

onUnLoad() публичный Метод

Unregisters the radio button groupings. If overriding onInit method, ensure to call parent implemenation.
public onUnLoad ( $param )

renderClientControlScript() защищенный Метод

Renders the client-script code.
protected renderClientControlScript ( $writer )

renderInputTag() защищенный Метод

Renders a radiobutton input element.
protected renderInputTag ( $writer, $clientID, $onclick )

setEnableClientScript() публичный Метод

public setEnableClientScript ( $value )

setGroupName() публичный Метод

The group is unique among the control's naming container.
См. также: setUniqueGroupName
public setGroupName ( $value )

setUniqueGroupName() публичный Метод

A unique group is a radiobutton group unique among the whole page hierarchy, while the {@link setGroupName GroupName} specifies a group that is unique among the control's naming container only. For example, each cell of a {@link TDataGrid} is a naming container. If you specify {@link setGroupName GroupName} for a radiobutton in a cell, it groups together radiobutton within a cell, but not the other, even though they have the same {@link setGroupName GroupName}. On the contratry, if {@link setUniqueGroupName UniqueGroupName} is used instead, it will group all appropriate radio buttons on the whole page hierarchy. Note, when both {@link setUniqueGroupName UniqueGroupName} and {@link setGroupName GroupName}, the former takes precedence.
См. также: setGroupName
public setUniqueGroupName ( $value )