## Class TLinkButton

Description

Implements interfaces:

- IPostBackEventHandler
- IButtonControl
- IDataRenderer

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 TButton, you can create either a submit button or a command button.

A command button has a command name (specified by the CommandName property) and and a command parameter (specified by 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 OnCommand event to programmatically control the actions performed when the command button is clicked. In the event handler, you can determine the CommandName property value and the CommandParameter property value through the TCommandParameter::getName and TCommandParameter::getParameter properties of the event parameter which is of type 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 OnClick event to programmatically control the actions performed when the submit button is clicked.

Clicking on button can trigger form validation, if CausesValidation is true. And the validation may be restricted within a certain group of validator controls by setting ValidationGroup property. If validation is successful, the data will be post back to the same page.

TLinkButton will display the Text property value as the hyperlink text. If Text is empty, the body content of TLinkButton will be displayed. Therefore, you can use TLinkButton as an image button by enclosing an &lt;img&gt; tag as the body of TLinkButton.

- since: 3.0
- version: $Id: TLinkButton.php 1827 2007-04-02 06:19:55Z wei $
- author: Qiang Xue <qiang.xue@gmail.com>

Located in /Web/UI/WebControls/TLinkButton.php (line 57)

    TComponent
       |
       --TApplicationComponent
          |
          --TControl
             |
             --TWebControl
                |
                --TLinkButton

Direct descendents

Class | Description
--- | ---
TActiveLinkButton | TActiveLinkButton is the active control counter part to TLinkButton.

Method Summary
void addAttributesToRender (THtmlWriter $writer)
boolean getCausesValidation ()
string getClientClassName ()
string getCommandName ()
string getCommandParameter ()
string getData ()
boolean getEnableClientScript ()
boolean getIsDefaultButton ()
array getPostBackOptions ()
string getTagName ()
string getText ()
string getValidationGroup ()
void onClick (TEventParameter $param)
void onCommand (TCommandEventParameter $param)
void raisePostBackEvent (TEventParameter $param)
void renderClientControlScript (THtmlWriter $writer)
void renderContents (THtmlWriter $writer)
void renderLinkButtonHref (THtmlWriter $writer)
void setCausesValidation (string $value)
void setCommandName (string $value)
void setCommandParameter (string $value)
void setData (string $value)
void setEnableClientScript (boolean $value)
void setIsDefaultButton (boolean $value)
void setText (string $value)
void setValidationGroup (string $value)
Methods
addAttributesToRender (line 88)

Adds attribute name-value pairs to renderer.

This overrides the parent implementation with additional button specific attributes.

- access: protected

void addAttributesToRender (THtmlWriter $writer)

- THtmlWriter $writer: the writer used for the rendering purpose

Redefinition of:

TWebControl::addAttributesToRender()
  Adds attribute name-value pairs to renderer.

Redefined in descendants as:

- TActiveLinkButton::addAttributesToRender() : Ensure that the ID attribute is rendered and registers the javascript code for initializing the active control.

getCausesValidation (line 262)

- return: whether postback event trigger by this button will cause input validation
- access: public

boolean getCausesValidation ()
getClientClassName (line 150)

Gets the name of the javascript class responsible for performing postback for this control.

This method overrides the parent implementation.

- return: the javascript class name
- access: protected

string getClientClassName ()

Redefined in descendants as:

- TActiveLinkButton::getClientClassName()

getCommandName (line 230)

- return: the command name associated with the OnCommand event.
- access: public

string getCommandName ()
getCommandParameter (line 246)

- return: the parameter associated with the OnCommand event
- access: public

string getCommandParameter ()
getData (line 209)

Returns the caption of the button.

This method is required by IDataRenderer. It is the same as getText().

- return: caption of the button.
- access: public
- since: 3.1.0
- see: TLinkButton::getText()

string getData ()
getEnableClientScript (line 70)

- return: whether to render javascript.
- access: public

boolean getEnableClientScript ()
getIsDefaultButton (line 129)

- return: true if this button is registered as a default button for a panel.
- access: public

boolean getIsDefaultButton ()
getPostBackOptions (line 160)

Returns postback specifications for the button.

This method is used by framework and control developers.

- return: parameters about how the button defines its postback behavior.
- access: protected

array getPostBackOptions ()
getTagName (line 62)

- return: tag name of the button
- access: protected

string getTagName ()

Redefinition of:

TWebControl::getTagName()
  Returns the tag name used for this control.

getText (line 188)

- return: the text caption of the button
- access: public

string getText ()
getValidationGroup (line 279)

- return: the group of validators which the button causes validation upon postback
- access: public

string getValidationGroup ()
onClick (line 316)

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.

- access: public

void onClick (TEventParameter $param)

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

onCommand (line 328)

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.

- access: public

void onCommand (TCommandEventParameter $param)

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

raisePostBackEvent (line 301)

Raises the postback event.

This method is required by IPostBackEventHandler interface. If CausesValidation is true, it will invoke the page's TPage::validate method first. It will raise OnClick and OnCommand events. This method is mainly used by framework and control developers.

- access: public

void raisePostBackEvent (TEventParameter $param)

- TEventParameter $param: the event parameter

renderClientControlScript (line 112)

Renders the client-script code.

- access: protected

void renderClientControlScript (THtmlWriter $writer)

- THtmlWriter $writer: renderer

Redefined in descendants as:

- TActiveLinkButton::renderClientControlScript() : Override parent implementation, no javascript is rendered here instead the javascript required for active control is registered in addAttributesToRender.

renderContents (line 177)

Renders the body content enclosed between the control tag.

If Text is not empty, it will be rendered. Otherwise, the body content enclosed in the control tag will be rendered.

- access: public

void renderContents (THtmlWriter $writer)

- THtmlWriter $writer: the writer used for the rendering purpose

Redefinition of:

TWebControl::renderContents()
  Renders the body content enclosed between the control tag.

renderLinkButtonHref (line 138)

Renders the Href for link button.

- access: protected

void renderLinkButtonHref (THtmlWriter $writer)

- THtmlWriter $writer: renderer

setCausesValidation (line 271)

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

- access: public

void setCausesValidation (string $value)

- string $value: the text caption to be set

setCommandName (line 238)

- access: public

void setCommandName (string $value)

- string $value: the command name associated with the OnCommand event.

setCommandParameter (line 254)

- access: public

void setCommandParameter (string $value)

- string $value: the parameter associated with the OnCommand event.

setData (line 222)

Sets the caption of the button.

This method is required by IDataRenderer. It is the same as setText().

- access: public
- since: 3.1.0
- see: TLinkButton::setText()

void setData (string $value)

- string $value: caption of the button

setEnableClientScript (line 78)

- access: public

void setEnableClientScript (boolean $value)

- boolean $value: whether to render javascript.

setIsDefaultButton (line 121)

- access: public

void setIsDefaultButton (boolean $value)

- boolean $value: set by a panel to register this button as the default button for the panel.

setText (line 196)

- access: public

void setText (string $value)

- string $value: the text caption to be set

Redefined in descendants as:

- TActiveLinkButton::setText() : Updates the link text on the client-side if the setEnableUpdate property is set to true.

setValidationGroup (line 287)

- access: public

void setValidationGroup (string $value)

- string $value: the group of validators which the button causes validation upon postback

#### Inherited Methods

Inherited From TWebControl

> TWebControl::addAttributesToRender()
> TWebControl::clearStyle()
> TWebControl::copyBaseAttributes()
> TWebControl::createStyle()
> TWebControl::getAccessKey()
> TWebControl::getBackColor()
> TWebControl::getBorderColor()
> TWebControl::getBorderStyle()
> TWebControl::getBorderWidth()
> TWebControl::getCssClass()
> TWebControl::getDisplay()
> TWebControl::getFont()
> TWebControl::getForeColor()
> TWebControl::getHasStyle()
> TWebControl::getHeight()
> TWebControl::getStyle()
> TWebControl::getTabIndex()
> TWebControl::getTagName()
> TWebControl::getToolTip()
> TWebControl::getWidth()
> TWebControl::render()
> TWebControl::renderBeginTag()
> TWebControl::renderContents()
> TWebControl::renderEndTag()
> TWebControl::setAccessKey()
> TWebControl::setBackColor()
> TWebControl::setBorderColor()
> TWebControl::setBorderStyle()
> TWebControl::setBorderWidth()
> TWebControl::setCssClass()
> TWebControl::setDisplay()
> TWebControl::setForeColor()
> TWebControl::setHeight()
> TWebControl::setStyle()
> TWebControl::setTabIndex()
> TWebControl::setToolTip()
> TWebControl::setWidth()

Inherited From TControl

> TControl::__construct()
> TControl::addedControl()
> TControl::addParsedObject()
> TControl::addToPostDataLoader()
> TControl::applyStyleSheetSkin()
> TControl::autoBindProperty()
> TControl::autoDataBindProperties()
> TControl::bindProperty()
> TControl::broadcastEvent()
> TControl::bubbleEvent()
> TControl::clearChildState()
> TControl::clearControlState()
> TControl::clearNamingContainer()
> TControl::clearViewState()
> TControl::convertUniqueIdToClientId()
> TControl::createChildControls()
> TControl::createControlCollection()
> TControl::dataBind()
> TControl::dataBindChildren()
> TControl::dataBindProperties()
> TControl::ensureChildControls()
> TControl::findControl()
> TControl::findControlsByID()
> TControl::findControlsByType()
> TControl::focus()
> TControl::getAdapter()
> TControl::getAllowChildControls()
> TControl::getAttribute()
> TControl::getAttributes()
> TControl::getChildControlsCreated()
> TControl::getClientID()
> TControl::getControls()
> TControl::getControlStage()
> TControl::getControlState()
> TControl::getCustomData()
> TControl::getEnabled()
> TControl::getEnableTheming()
> TControl::getEnableViewState()
> TControl::getHasAdapter()
> TControl::getHasAttributes()
> TControl::getHasChildInitialized()
> TControl::getHasControls()
> TControl::getHasInitialized()
> TControl::getHasLoaded()
> TControl::getHasLoadedPostData()
> TControl::getHasPreRendered()
> TControl::getID()
> TControl::getNamingContainer()
> TControl::getPage()
> TControl::getParent()
> TControl::getRegisteredObject()
> TControl::getSkinID()
> TControl::getSourceTemplateControl()
> TControl::getTemplateControl()
> TControl::getUniqueID()
> TControl::getViewState()
> TControl::getVisible()
> TControl::hasAttribute()
> TControl::initRecursive()
> TControl::isDescendentOf()
> TControl::isObjectRegistered()
> TControl::loadRecursive()
> TControl::loadState()
> TControl::loadStateRecursive()
> TControl::onDataBinding()
> TControl::onInit()
> TControl::onLoad()
> TControl::onPreRender()
> TControl::onUnload()
> TControl::preRenderRecursive()
> TControl::raiseBubbleEvent()
> TControl::registerObject()
> TControl::removeAttribute()
> TControl::removedControl()
> TControl::render()
> TControl::renderChildren()
> TControl::renderControl()
> TControl::saveState()
> TControl::saveStateRecursive()
> TControl::setAdapter()
> TControl::setAttribute()
> TControl::setChildControlsCreated()
> TControl::setControlStage()
> TControl::setControlState()
> TControl::setCustomData()
> TControl::setEnabled()
> TControl::setEnableTheming()
> TControl::setEnableViewState()
> TControl::setID()
> TControl::setPage()
> TControl::setSkinID()
> TControl::setTemplateControl()
> TControl::setViewState()
> TControl::setVisible()
> TControl::trackViewState()
> TControl::traverseChildControls()
> TControl::unbindProperty()
> TControl::unloadRecursive()
> TControl::unregisterObject()
> TControl::__get()

Inherited From TApplicationComponent

> TApplicationComponent::getApplication()
> TApplicationComponent::getRequest()
> TApplicationComponent::getResponse()
> TApplicationComponent::getService()
> TApplicationComponent::getSession()
> TApplicationComponent::getUser()
> TApplicationComponent::publishAsset()
> TApplicationComponent::publishFilePath()

Inherited From TComponent

> TComponent::addParsedObject()
> TComponent::attachEventHandler()
> TComponent::canGetProperty()
> TComponent::canSetProperty()
> TComponent::createdOnTemplate()
> TComponent::detachEventHandler()
> TComponent::evaluateExpression()
> TComponent::evaluateStatements()
> TComponent::getEventHandlers()
> TComponent::getSubProperty()
> TComponent::hasEvent()
> TComponent::hasEventHandler()
> TComponent::hasProperty()
> TComponent::raiseEvent()
> TComponent::setSubProperty()
> TComponent::__get()
> TComponent::__set()

Class Constants

#### Inherited Constants

Inherited from TControl

> TControl::AUTOMATIC_ID_PREFIX
> TControl::CLIENT_ID_SEPARATOR
> TControl::CS_CHILD_INITIALIZED
> TControl::CS_CONSTRUCTED
> TControl::CS_INITIALIZED
> TControl::CS_LOADED
> TControl::CS_PRERENDERED
> TControl::CS_STATE_LOADED
> TControl::ID_FORMAT
> TControl::ID_SEPARATOR
> TControl::IS_CHILD_CREATED
> TControl::IS_CREATING_CHILD
> TControl::IS_DISABLE_THEMING
> TControl::IS_DISABLE_VIEWSTATE
> TControl::IS_ID_SET
> TControl::IS_SKIN_APPLIED
> TControl::IS_STYLESHEET_APPLIED
> TControl::RF_ADAPTER
> TControl::RF_AUTO_BINDINGS
> TControl::RF_CHILD_STATE
> TControl::RF_CONTROLS
> TControl::RF_CONTROLSTATE
> TControl::RF_DATA_BINDINGS
> TControl::RF_EVENTS
> TControl::RF_NAMED_CONTROLS
> TControl::RF_NAMED_CONTROLS_ID
> TControl::RF_NAMED_OBJECTS
> TControl::RF_SKIN_ID

Documentation generated on Mon, 21 Apr 2008 11:35:24 -0400 by phpDocumentor 1.3.0RC4