PRADO 3.0.6 : Vue détaillée de TLinkButton.php

Classe: TLinkButton - X-Ref

TLinkButton class

TLinkButton creates a hyperlink style button on the page.
TLinkButton has the same appearance as a hyperlink. However, it is mainly
used to submit data to a page. Like {@link TButton}, 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 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 TLinkButton component 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.

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.

TLinkButton will display the {@link setText Text} property value
as the hyperlink text. If {@link setText Text} is empty, the body content
of TLinkButton will be displayed. Therefore, you can use TLinkButton
as an image button by enclosing an <img> tag as the body of TLinkButton.

getTagName() X-Ref

return: string tag name of the button

addAttributesToRender($writer) X-Ref

Adds attribute name-value pairs to renderer.
This overrides the parent implementation with additional button specific attributes.

param: THtmlWriter the writer used for the rendering purpose

getPostBackOptions() X-Ref

Returns postback specifications for the button.
This method is used by framework and control developers.

return: array parameters about how the button defines its postback behavior.

renderContents($writer) X-Ref

Renders the body content enclosed between the control tag.
If {@link getText Text} is not empty, it will be rendered. Otherwise,
the body content enclosed in the control tag will be rendered.

param: THtmlWriter the writer used for the rendering purpose

getText() X-Ref

return: string the text caption of the button

setText($value) X-Ref

param: string the text caption to be set

getCommandName() X-Ref

return: string the command name associated with the {@link onCommand OnCommand} event.

setCommandName($value) X-Ref

param: string the command name associated with the {@link onCommand OnCommand} event.

getCommandParameter() X-Ref

return: string the parameter associated with the {@link onCommand OnCommand} event

setCommandParameter($value) X-Ref

param: string the parameter associated with the {@link onCommand OnCommand} event.

getCausesValidation() X-Ref

return: boolean whether postback event trigger by this button will cause input validation

setCausesValidation($value) X-Ref

Sets the value indicating whether postback event trigger by this button will cause input validation.

param: string the text caption to be set

getValidationGroup() X-Ref

return: string the group of validators which the button causes validation upon postback

setValidationGroup($value) X-Ref

param: string the group of validators which the button causes validation upon postback

raisePostBackEvent($param) X-Ref

Raises the postback event.
This method is required by {@link IPostBackEventHandler} interface.
If {@link getCausesValidation CausesValidation} is true, it will
invoke the page's {@link TPage::validate validate} method first.
It will raise {@link onClick OnClick} and {@link onCommand OnCommand} events.
This method is mainly used by framework and control developers.

param: TEventParameter the event parameter

onClick($param) X-Ref

This method is invoked when the button is clicked.
The method raises 'OnClick' 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.

param: TEventParameter event parameter to be passed to the event handlers

onCommand($param) X-Ref

This method is invoked when the button is clicked.
The method raises 'OnCommand' event to fire up the event handlers.
If you override this method, be sure to call the parent implementation
so that the event handlers can be invoked.

param: TCommandEventParameter event parameter to be passed to the event handlers

Author:	Qiang Xue <qiang.xue@gmail.com>
Copyright:	Copyright © 2005 PradoSoft
License:	http://www.pradosoft.com/license/
Version:	$Id: TLinkButton.php 1397 2006-09-07 07:55:53Z wei $
Poids:	249 lignes (9 kb)
Inclus ou requis:	0 fois
Référencé:	0 fois
Nécessite:	0 fichiers

Code source de PRADO 3.0.6

/framework/Web/UI/WebControls/ -> TLinkButton.php (sommaire)

Définit 1 class