• Главная
• Prado
• Web
• UI
• WebControls
• TImageButton

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

TImageButton creates an image button on the page. It is used to submit data to a page. You can create either a submit button or a command button. A command button has a command name (specified by the {@link setCommandName CommandName} property) and and a command parameter (specified by {@link setCommandParameter CommandParameter} property) associated with the button. This allows you to create multiple TLinkButton components on a Web page and programmatically determine which one is clicked with what parameter. You can provide an event handler for {@link onCommand OnCommand} event to programmatically control the actions performed when the command button is clicked. In the event handler, you can determine the {@link setCommandName CommandName} property value and the {@link setCommandParameter CommandParameter} property value through the {@link TCommandParameter::getName Name} and {@link TCommandParameter::getParameter Parameter} properties of the event parameter which is of type {@link \Prado\Web\UI\TCommandEventParameter}. A submit button does not have a command name associated with the button and clicking on it simply posts the Web page back to the server. By default, a TImageButton control is a submit button. You can provide an event handler for the {@link onClick OnClick} event to programmatically control the actions performed when the submit button is clicked. The coordinates of the clicking point can be obtained from the {@link onClick OnClick} event parameter, which is of type {@link TImageClickEventParameter}. Clicking on button can trigger form validation, if {@link setCausesValidation CausesValidation} is true. And the validation may be restricted within a certain group of validator controls by setting {@link setValidationGroup ValidationGroup} property. If validation is successful, the data will be post back to the same page. TImageButton displays the {@link setText Text} property as the hint text to the displayed image. Показать файл Открыть проект Примеры использования класса

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

Метод	Описание
getCausesValidation ( ) : boolean
getCommandName ( ) : string
getCommandParameter ( ) : string
getDataChanged ( ) : boolean	Returns a value indicating whether postback has caused the control data change.
getEnableClientScript ( ) : boolean
getIsDefaultButton ( ) : boolean
getText ( ) : string
getValidationGroup ( ) : string
loadPostData ( $key, $values ) : boolean	This method checks if the TImageButton is clicked and loads the coordinates of the clicking position.
onClick ( $param )	This method is invoked when the button is clicked.
onCommand ( $param )	This method is invoked when the button is clicked.
onPreRender ( $param )	Registers the image button to receive postback data during postback.
raisePostBackEvent ( $param )	Raises the postback event.
raisePostDataChangedEvent ( )	A dummy implementation for the \Prado\Web\UI\IPostBackDataHandler interface.
renderContents ( $writer )	Renders the body content enclosed between the control tag.
setCausesValidation ( $value )
setCommandName ( $value )
setCommandParameter ( $value )
setEnableClientScript ( $value )
setIsDefaultButton ( $value )
setText ( $value )
setValidationGroup ( $value )

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

Метод	Описание
addAttributesToRender ( $writer )	Adds attribute name-value pairs to renderer.
canCauseValidation ( ) : boolean
getClientClassName ( ) : string	Gets the name of the javascript class responsible for performing postback for this control.
getPostBackOptions ( ) : array	Returns postback specifications for the button.
getTagName ( ) : string
needPostBackScript ( ) : boolean
renderClientControlScript ( $writer )	Renders the client-script code.

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