Class TActiveLinkButton

Description

Implements interfaces:

TActiveLinkButton is the active control counter part to TLinkButton.

When a TActiveLinkButton is clicked, rather than a normal post back request a callback request is initiated.

The OnCallback event is raised during a callback request and it is raise after the OnClick event.

When the TBaseActiveCallbackControl::setEnableUpdate property is true, changing the Text property during callback request will update the link text upon callback response completion.

  • author: Wei Zhuo <weizhuo[at]gmail[dot]com>
  • version: $Id: TActiveLinkButton.php 2996 2011-06-20 15:24:57Z ctrlaltca@gmail.com $
  • since: 3.1

Located in /Web/UI/ActiveControls/TActiveLinkButton.php (line 36)

TComponent
   |
   --TApplicationComponent
      |
      --TControl
         |
         --TWebControl
            |
            --TLinkButton
               |
               --TActiveLinkButton
Method Summary
Variables

Inherited Variables

Inherited from TWebControl

TWebControl::$_decorator
Methods
Constructor __construct (line 43)

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.

  • access: public
TActiveLinkButton __construct ()

Redefinition of:
TControl::__construct()
Constructor.
addAttributesToRender (line 117)

Ensure that the ID attribute is rendered and registers the javascript code for initializing the active control.

  • access: protected
void addAttributesToRender ( $writer)
  • $writer

Redefinition of:
TLinkButton::addAttributesToRender()
Adds attribute name-value pairs to renderer.
getActiveControl (line 52)
  • return: standard callback control options.
  • access: public
TBaseActiveCallbackControl getActiveControl ()
getClientClassName (line 129)
  • return: corresponding javascript class name for this TActiveLinkButton.
  • access: protected
string getClientClassName ()

Redefinition of:
TLinkButton::getClientClassName()
Gets the name of the javascript class responsible for performing postback for this control.
getClientSide (line 60)
  • return: client side request options.
  • access: public
TCallbackClientSide getClientSide ()
onCallback (line 88)

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.

  • access: public
void onCallback (TCallbackEventParameter $param)
raiseCallbackEvent (line 75)

Raises the callback event. This method is required by

ICallbackEventHandlerICallbackEventHandler interface. If CausesValidation is true, it will invoke the page's TPage::validate method first. It will raise OnClick event first and then the OnCallback event. This method is mainly used by framework and control developers.

  • access: public
void raiseCallbackEvent (TCallbackEventParameter $param)
renderClientControlScript (line 109)

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

  • access: protected
void renderClientControlScript ( $writer)
  • $writer

Redefinition of:
TLinkButton::renderClientControlScript()
Renders the client-script code.
setText (line 98)

Updates the link text on the client-side if the setEnableUpdate property is set to true.

  • access: public
void setText (string $value)
  • string $value: caption of the button

Redefinition of:
TLinkButton::setText()

Inherited Methods

Inherited From TLinkButton

TLinkButton::addAttributesToRender()
TLinkButton::getCausesValidation()
TLinkButton::getClientClassName()
TLinkButton::getCommandName()
TLinkButton::getCommandParameter()
TLinkButton::getData()
TLinkButton::getEnableClientScript()
TLinkButton::getIsDefaultButton()
TLinkButton::getPostBackOptions()
TLinkButton::getTagName()
TLinkButton::getText()
TLinkButton::getValidationGroup()
TLinkButton::onClick()
TLinkButton::onCommand()
TLinkButton::raisePostBackEvent()
TLinkButton::renderClientControlScript()
TLinkButton::renderContents()
TLinkButton::renderLinkButtonHref()
TLinkButton::setCausesValidation()
TLinkButton::setCommandName()
TLinkButton::setCommandParameter()
TLinkButton::setData()
TLinkButton::setEnableClientScript()
TLinkButton::setIsDefaultButton()
TLinkButton::setText()
TLinkButton::setValidationGroup()

Inherited From TWebControl

TWebControl::addAttributesToRender()
TWebControl::clearStyle()
TWebControl::copyBaseAttributes()
TWebControl::createStyle()
TWebControl::getAccessKey()
TWebControl::getBackColor()
TWebControl::getBorderColor()
TWebControl::getBorderStyle()
TWebControl::getBorderWidth()
TWebControl::getCssClass()
TWebControl::getDecorator()
TWebControl::getDisplay()
TWebControl::getEnsureId()
TWebControl::getFont()
TWebControl::getForeColor()
TWebControl::getHasStyle()
TWebControl::getHeight()
TWebControl::getStyle()
TWebControl::getTabIndex()
TWebControl::getTagName()
TWebControl::getToolTip()
TWebControl::getWidth()
TWebControl::onPreRender()
TWebControl::render()
TWebControl::renderBeginTag()
TWebControl::renderContents()
TWebControl::renderEndTag()
TWebControl::setAccessKey()
TWebControl::setBackColor()
TWebControl::setBorderColor()
TWebControl::setBorderStyle()
TWebControl::setBorderWidth()
TWebControl::setCssClass()
TWebControl::setDisplay()
TWebControl::setEnsureId()
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::getIsSkinApplied()
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::__call()
TComponent::__get()
TComponent::__set()
TComponent::__sleep()
TComponent::__wakeup()
Class Constants

Documentation generated on Mon, 25 Jun 2012 14:37:04 +0200 by phpDocumentor 1.4.3