PHP Класс Prado\Web\UI\ActiveControls\TActiveCheckBox

The active control counter part to checkbox. The {@link setAutoPostBack AutoPostBack} property is set to true by default. Thus, when the checkbox is clicked a {@link onCallback OnCallback} event is raise after {@link OnCheckedChanged} event. The {@link setText Text} and {@link setChecked Checked} properties can be changed during a callback.

С версии: 3.1

Наследование: extends Prado\Web\UI\WebControls\TCheckBox, implements Prado\Web\UI\ActiveControls\ICallbackEventHandler, implements Prado\Web\UI\ActiveControls\IActiveControl

Показать файл Открыть проект Примеры использования класса

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

Метод	Описание
__construct ( )	Creates a new callback control, sets the adapter to TActiveControlAdapter. If you override this class, be sure to set the adapter appropriately by, for example, by calling this constructor.
getActiveControl ( ) : TBaseActiveCallbackControl
getClientSide ( ) : TCallbackClientSide
getLabelAttributes ( ) : TMap	Overrides parent implementation to ensure label has ID.
onCallback ( $param )	This method is invoked when a callback is requested. The method raises 'OnCallback' event to fire up the event handlers. If you override this method, be sure to call the parent implementation so that the event handler can be invoked.
raiseCallbackEvent ( $param )	Raises the callback event. This method is required by {@link ICallbackEventHandler} interface.
setChecked ( $value )	Sets a value indicating whether the checkbox is to be checked or not.
setText ( $value )	Updates the button text on the client-side if the {@link setEnableUpdate EnableUpdate} property is set to true.

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

Метод	Описание
getClientClassName ( ) : string
getDefaultLabelID ( ) : string
renderClientControlScript ( $writer )	Override parent implementation, no javascript is rendered here instead the javascript required for active control is registered in {@link addAttributesToRender}.
renderInputTag ( $writer, $clientID, $onclick )	Ensure that the ID attribute is rendered and registers the javascript code for initializing the active control.
renderLabel ( $writer, $clientID, $text )	Renders a label beside the checkbox.

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

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

Creates a new callback control, sets the adapter to TActiveControlAdapter. If you override this class, be sure to set the adapter appropriately by, for example, by calling this constructor.

public __construct ( )

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

public getActiveControl ( ) : TBaseActiveCallbackControl
Результат	TBaseActiveCallbackControl	standard callback control options.

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

protected getClientClassName ( ) : string
Результат	string	corresponding javascript class name for this TActiveCheckBox.

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

public getClientSide ( ) : TCallbackClientSide
Результат	TCallbackClientSide	client side request options.

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

protected getDefaultLabelID ( ) : string
Результат	string	checkbox label ID;

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

Overrides parent implementation to ensure label has ID.

public getLabelAttributes ( ) : TMap
Результат	TMap	list of attributes to be rendered for label beside the checkbox

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

This method is invoked when a callback is requested. The method raises 'OnCallback' event to fire up the event handlers. If you override this method, be sure to call the parent implementation so that the event handler can be invoked.

public onCallback ( $param )

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

This method is mainly used by framework and control developers.

public raiseCallbackEvent ( $param )

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

Override parent implementation, no javascript is rendered here instead the javascript required for active control is registered in {@link addAttributesToRender}.

protected renderClientControlScript ( $writer )

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

Since 3.1.4, the javascript code is not rendered if {@link setAutoPostBack AutoPostBack} is false

protected renderInputTag ( $writer, $clientID, $onclick )

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

Renders a label beside the checkbox.

protected renderLabel ( $writer, $clientID, $text )

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

Updates checkbox checked state on the client-side if the {@link setEnableUpdate EnableUpdate} property is set to true.

public setChecked ( $value )

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

Updates the button text on the client-side if the {@link setEnableUpdate EnableUpdate} property is set to true.

public setText ( $value )