PRADO Component Framework for PHP 5
  • Home
  • About
  • Testimonials
  • Demos
  • Download
  • Documentation
  • Forum
  • Development
  • Tutorials
  • Class Docs
  • API Manual
  • Wiki

Packages

  • None
  • System
    • Caching
    • Collections
    • Data
      • ActiveRecord
        • Relations
        • Scaffold
          • InputBuilder
      • Commom
        • Sqlite
      • Common
        • Mssql
        • Mysql
        • Oracle
        • Pgsql
        • Sqlite
      • DataGateway
      • SqlMap
        • Configuration
        • Statements
    • Exceptions
    • I18N
    • IO
    • Security
    • Util
    • Web
      • Javascripts
      • Services
      • UI
        • ActiveControls
        • WebControls
    • Xml
  • Wsat
    • pages
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class TActiveImageButton

TActiveImageButton class.

TActiveImageButton is the active control counter part to TImageButton. When a TActiveImageButton is clicked, rather than a normal post back request a callback request is initiated.

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

TComponent
Extended by TApplicationComponent
Extended by TControl implements IRenderable, IBindable
Extended by TWebControl implements IStyleable
Extended by TImage implements IDataRenderer
Extended by TImageButton implements IPostBackDataHandler, IPostBackEventHandler, IButtonControl
Extended by TActiveImageButton implements IActiveControl, ICallbackEventHandler
Package: System\Web\UI\ActiveControls
Copyright: Copyright © 2005-2014 PradoSoft
License: http://www.pradosoft.com/license/
Author: Wei Zhuo <weizhuo[at]gmail[dot]com>
Since: 3.1
Located at Web/UI/ActiveControls/TActiveImageButton.php
Methods summary
public
# __construct( )

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.

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.

Overrides

TControl::__construct()
public TBaseActiveControl
# getActiveControl( )

Returns

TBaseActiveControl
basic active control options.

Implementation of

IActiveControl::getActiveControl()
public TCallbackClientSide
# getClientSide( )

Returns

TCallbackClientSide
client side request options.
public
# setAlternateText( string $value )

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

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

Parameters

$value
string
the alternative text

Overrides

TImage::setAlternateText()
public
# setImageAlign( string $value )

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.

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.

Parameters

$value
string
the alignment of the image

Overrides

TImage::setImageAlign()
public
# setImageUrl( string $value )

Parameters

$value
string
the URL of the image file

Overrides

TImage::setImageUrl()
public
# setDescriptionUrl( string $value )

Parameters

$value
string
the URL to the long description of the image.

Overrides

TImage::setDescriptionUrl()
public
# raiseCallbackEvent( TCallbackEventParameter $param )

Raises the callback event. This method is required by ICallbackEventHandler ICallbackEventHandler interface. If getCausesValidation CausesValidation is true, it will invoke the page's TPage::validate() method first. It will raise onClick OnClick event first and then the onCallback OnCallback event. This method is mainly used by framework and control developers.

Raises the callback event. This method is required by ICallbackEventHandler ICallbackEventHandler interface. If getCausesValidation CausesValidation is true, it will invoke the page's TPage::validate() method first. It will raise onClick OnClick event first and then the onCallback OnCallback event. This method is mainly used by framework and control developers.

Parameters

$param
TCallbackEventParameter
the event parameter

Implementation of

ICallbackEventHandler::raiseCallbackEvent()
public
# onCallback( TCallbackEventParameter $param )

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.

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.

Parameters

$param
TCallbackEventParameter
event parameter to be passed to the event handlers
protected
# renderClientControlScript( mixed $writer )

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

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

Overrides

TImageButton::renderClientControlScript()
public
# onPreRender( THtmlWriter $writer )

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

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

Parameters

$writer
THtmlWriter
the renderer.

Overrides

TImageButton::onPreRender()
protected
# addAttributesToRender( THtmlWriter $writer )

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

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

Parameters

$writer
THtmlWriter
the writer used for the rendering purpose

Overrides

TImageButton::addAttributesToRender()
protected string
# getClientClassName( )

Returns

string
corresponding javascript class name for this TActiveLinkButton.

Overrides

TImageButton::getClientClassName()
Methods inherited from TImageButton
canCauseValidation(), getCausesValidation(), getCommandName(), getCommandParameter(), getDataChanged(), getEnableClientScript(), getIsDefaultButton(), getPostBackOptions(), getTagName(), getText(), getValidationGroup(), loadPostData(), needPostBackScript(), onClick(), onCommand(), raisePostBackEvent(), raisePostDataChangedEvent(), renderContents(), setCausesValidation(), setCommandName(), setCommandParameter(), setEnableClientScript(), setIsDefaultButton(), setText(), setValidationGroup()
Methods inherited from TImage
getAlternateText(), getData(), getDescriptionUrl(), getImageAlign(), getImageUrl(), setData()
Methods inherited from TWebControl
clearStyle(), copyBaseAttributes(), createStyle(), getAccessKey(), getBackColor(), getBorderColor(), getBorderStyle(), getBorderWidth(), getCssClass(), getDecorator(), getDisplay(), getEnsureId(), getFont(), getForeColor(), getHasStyle(), getHeight(), getStyle(), getTabIndex(), getToolTip(), getWidth(), render(), renderBeginTag(), renderEndTag(), setAccessKey(), setBackColor(), setBorderColor(), setBorderStyle(), setBorderWidth(), setCssClass(), setDisplay(), setEnsureId(), setForeColor(), setHeight(), setStyle(), setTabIndex(), setToolTip(), setWidth()
Methods inherited from TControl
__get(), addParsedObject(), addToPostDataLoader(), addedControl(), applyStyleSheetSkin(), autoBindProperty(), autoDataBindProperties(), bindProperty(), broadcastEvent(), bubbleEvent(), clearChildState(), clearControlState(), clearNamingContainer(), clearViewState(), convertUniqueIdToClientId(), createChildControls(), createControlCollection(), dataBind(), dataBindChildren(), dataBindProperties(), ensureChildControls(), findControl(), findControlsByID(), findControlsByType(), focus(), getAdapter(), getAllowChildControls(), getAttribute(), getAttributes(), getChildControlsCreated(), getClientID(), getControlStage(), getControlState(), getControls(), getCustomData(), getEnableTheming(), getEnableViewState(), getEnabled(), getHasAdapter(), getHasAttributes(), getHasChildInitialized(), getHasControls(), getHasInitialized(), getHasLoaded(), getHasLoadedPostData(), getHasPreRendered(), getID(), getIsSkinApplied(), getNamingContainer(), getPage(), getParent(), getRegisteredObject(), getSkinID(), getSourceTemplateControl(), getTemplateControl(), getUniqueID(), getViewState(), getVisible(), hasAttribute(), initRecursive(), isDescendentOf(), isObjectRegistered(), loadRecursive(), loadState(), loadStateRecursive(), onDataBinding(), onInit(), onLoad(), onUnload(), preRenderRecursive(), raiseBubbleEvent(), registerObject(), removeAttribute(), removedControl(), renderChildren(), renderControl(), saveState(), saveStateRecursive(), setAdapter(), setAttribute(), setChildControlsCreated(), setControlStage(), setControlState(), setCustomData(), setEnableTheming(), setEnableViewState(), setEnabled(), setID(), setPage(), setSkinID(), setTemplateControl(), setViewState(), setVisible(), trackViewState(), traverseChildControls(), unbindProperty(), unloadRecursive(), unregisterObject()
Methods inherited from TApplicationComponent
getApplication(), getRequest(), getResponse(), getService(), getSession(), getUser(), publishAsset(), publishFilePath()
Methods inherited from TComponent
__call(), __destruct(), __isset(), __set(), __sleep(), __unset(), __wakeup(), asa(), attachBehavior(), attachBehaviors(), attachClassBehavior(), attachEventHandler(), canGetProperty(), canSetProperty(), clearBehaviors(), createdOnTemplate(), detachBehavior(), detachBehaviors(), detachClassBehavior(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), evaluateStatements(), fxAttachClassBehavior(), fxDetachClassBehavior(), getAutoGlobalListen(), getBehaviorsEnabled(), getClassHierarchy(), getEventHandlers(), getListeningToGlobalEvents(), getSubProperty(), hasEvent(), hasEventHandler(), hasProperty(), isa(), listen(), raiseEvent(), setSubProperty(), unlisten()
Constants inherited from TControl
AUTOMATIC_ID_PREFIX, CLIENT_ID_SEPARATOR, CS_CHILD_INITIALIZED, CS_CONSTRUCTED, CS_INITIALIZED, CS_LOADED, CS_PRERENDERED, CS_STATE_LOADED, ID_FORMAT, ID_SEPARATOR, IS_CHILD_CREATED, IS_CREATING_CHILD, IS_DISABLE_THEMING, IS_DISABLE_VIEWSTATE, IS_ID_SET, IS_SKIN_APPLIED, IS_STYLESHEET_APPLIED, RF_ADAPTER, RF_AUTO_BINDINGS, RF_CHILD_STATE, RF_CONTROLS, RF_CONTROLSTATE, RF_DATA_BINDINGS, RF_EVENTS, RF_NAMED_CONTROLS, RF_NAMED_CONTROLS_ID, RF_NAMED_OBJECTS, RF_SKIN_ID
Constants inherited from TComponent
GLOBAL_RAISE_EVENT_LISTENER
Properties inherited from TWebControl
$_decorator
Terms of Service | Contact Us
PRADO v3.2.4 API Manual API documentation generated by ApiGen 2.8.0
Copyright © 2006-2014 by the PRADO Group.
Powered by PRADO