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

THiddenField displays a hidden input field on a Web page. The value of the input field can be accessed via {@link getValue Value} property. If upon postback the value is changed, a {@link onValueChanged OnValueChanged} event will be raised.
С версии: 3.0
Автор: Qiang Xue ([email protected])
Наследование: extends Prado\Web\UI\TControl, implements Prado\Web\UI\IPostBackDataHandler, implements Prado\Web\UI\IValidatable, implements Prado\IDataRenderer
Показать файл Открыть проект Примеры использования класса

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

Метод Описание
focus ( ) Sets focus to this control.
getData ( ) : string Returns the value of the hidden field.
getDataChanged ( ) : boolean Returns a value indicating whether postback has caused the control data change.
getEnableTheming ( ) : boolean
getIsValid ( ) : boolean Returns true if this control validated successfully.
getValidationPropertyValue ( ) : mixed Returns the value to be validated.
getValue ( ) : string
loadPostData ( $key, $values ) : boolean Loads hidden field data.
onValueChanged ( $param ) This method is invoked when the value of the {@link getValue Value} property changes between posts to the server.
raisePostDataChangedEvent ( ) Raises postdata changed event.
render ( $writer ) Renders the control.
setData ( $value ) Sets the value of the hidden field.
setEnableTheming ( $value )
setIsValid ( $value )
setSkinID ( $value )
setValue ( $value ) Sets the value of the THiddenField

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

Метод Описание
getTagName ( ) : string

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

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

This method overrides the parent implementation by forbidding setting focus to this control.
public focus ( )

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

This method is required by {@link \Prado\IDataRenderer}. It is the same as {@link getValue()}.
См. также: getValue
С версии: 3.1.0
public getData ( ) : string
Результат string value of the hidden field

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

This method is required by the \Prado\Web\UI\IPostBackDataHandler interface.
public getDataChanged ( ) : boolean
Результат boolean whether postback has caused the control data change. False if the page is not in postback mode.

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

public getEnableTheming ( ) : boolean
Результат boolean whether theming is enabled for this control. Defaults to false.

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

Defaults to true.
public getIsValid ( ) : boolean
Результат boolean wether this control validated successfully.

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

protected getTagName ( ) : string
Результат string tag name of the hidden field.

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

This methid is required by \Prado\Web\UI\IValidatable interface.
public getValidationPropertyValue ( ) : mixed
Результат mixed the value of the property to be validated.

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

public getValue ( ) : string
Результат string the value of the THiddenField

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

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

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

The method raises 'OnValueChanged' event to fire up the event delegates. If you override this method, be sure to call the parent implementation so that the attached event handlers can be invoked.
public onValueChanged ( $param )

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

This method calls {@link onValueChanged} method. This method is primarly used by framework developers.
public raisePostDataChangedEvent ( )

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

This method overrides the parent implementation by rendering the hidden field input element.
public render ( $writer )

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

This method is required by {@link \Prado\IDataRenderer}. It is the same as {@link setValue()}.
См. также: setValue
С версии: 3.1.0
public setData ( $value )

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

public setEnableTheming ( $value )

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

public setIsValid ( $value )

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

public setSkinID ( $value )

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

Sets the value of the THiddenField
public setValue ( $value )