Class TActiveImageButton

Description

Implements interfaces:

TActiveImageButton class.

TActiveImageButton is the active control counter part to TLinkButton. When a TActiveImageButton 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.

  • since: 3.1
  • version: $Id: TActiveImageButton.php 1458 2006-10-06 03:46:05Z wei $
  • author: Wei Zhuo <weizhuo[at]gmail[dot]com>

Located in /Web/UI/ActiveControls/TActiveImageButton.php (line 28)

TComponent
   |
   --TApplicationComponent
      |
      --TControl
         |
         --TWebControl
            |
            --TImage
               |
               --TImageButton
                  |
                  --TActiveImageButton
Method Summary
TActiveImageButton __construct ()
void addAttributesToRender (mixed $writer)
string getClientClassName ()
void onPreRender (THtmlWriter $writer)
void renderClientControlScript (mixed $writer)
void setAlternateText (string $value)
void setDescriptionUrl (string $value)
void setImageAlign (string $value)
void setImageUrl (string $value)
Methods
Constructor __construct (line 35)

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
TActiveImageButton __construct ()

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

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

  • access: protected
void addAttributesToRender (mixed $writer)

Redefinition of:
TImageButton::addAttributesToRender()
Adds attribute name-value pairs to renderer.
getActiveControl (line 44)
  • return: basic active control options.
  • access: public
TBaseActiveControl getActiveControl ()
getClientClassName (line 164)
  • return: corresponding javascript class name for this TActiveLinkButton.
  • access: protected
string getClientClassName ()

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

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)
onPreRender (line 141)

Register the x and y hidden input names of the position clicked.

  • access: public
void onPreRender (THtmlWriter $writer)

Redefinition of:
TImageButton::onPreRender()
Registers the image button to receive postback data during postback.
raiseCallbackEvent (line 111)

Raises the callback event. This method is required by

ICallbackEventHandler} interface. If CausesValidation is true, it will invoke the page's TPage:: 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 133)

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

  • access: protected
void renderClientControlScript (mixed $writer)

Redefinition of:
TImageButton::renderClientControlScript()
Renders the client-script code.
setAlternateText (line 61)

Sets the alternative text to be displayed in the TImage when the image is unavailable.

  • access: public
void setAlternateText (string $value)
  • string $value: the alternative text

Redefinition of:
TImage::setAlternateText()
Sets the alternative text to be displayed in the TImage when the image is unavailable.
setDescriptionUrl (line 95)
  • access: public
void setDescriptionUrl (string $value)
  • string $value: the URL to the long description of the image.

Redefinition of:
TImage::setDescriptionUrl()
setImageAlign (line 75)

Sets the alignment of the image with respective to other elements on the page.

Possible values include: absbottom, absmiddle, baseline, bottom, left, middle, right, texttop, and top. If an empty string is passed in, imagealign attribute will not be rendered.

  • access: public
void setImageAlign (string $value)
  • string $value: the alignment of the image

Redefinition of:
TImage::setImageAlign()
Sets the alignment of the image with respective to other elements on the page.
setImageUrl (line 85)
  • access: public
void setImageUrl (string $value)
  • string $value: the URL of the image file

Redefinition of:
TImage::setImageUrl()

Inherited Methods

Inherited From TImageButton

TImageButton::addAttributesToRender()
TImageButton::canCauseValidation()
TImageButton::getCausesValidation()
TImageButton::getClientClassName()
TImageButton::getCommandName()
TImageButton::getCommandParameter()
TImageButton::getDataChanged()
TImageButton::getEnableClientScript()
TImageButton::getIsDefaultButton()
TImageButton::getPostBackOptions()
TImageButton::getTagName()
TImageButton::getText()
TImageButton::getValidationGroup()
TImageButton::loadPostData()
TImageButton::needPostBackScript()
TImageButton::onClick()
TImageButton::onCommand()
TImageButton::onPreRender()
TImageButton::raisePostBackEvent()
TImageButton::raisePostDataChangedEvent()
TImageButton::renderClientControlScript()
TImageButton::renderContents()
TImageButton::setCausesValidation()
TImageButton::setCommandName()
TImageButton::setCommandParameter()
TImageButton::setEnableClientScript()
TImageButton::setIsDefaultButton()
TImageButton::setText()
TImageButton::setValidationGroup()

Inherited From TImage

TImage::addAttributesToRender()
TImage::getAlternateText()
TImage::getData()
TImage::getDescriptionUrl()
TImage::getImageAlign()
TImage::getImageUrl()
TImage::getTagName()
TImage::renderContents()
TImage::setAlternateText()
TImage::setData()
TImage::setDescriptionUrl()
TImage::setImageAlign()
TImage::setImageUrl()

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

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