Class TActiveImageButton
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.
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,
|
Constructor Summary |
public |
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.
|
Method Summary |
protected
void
|
Ensure that the ID attribute is rendered and registers the javascript code for initializing the active control.
|
TBaseActiveControl
|
|
protected
string
|
|
TCallbackClientSide
|
|
void
|
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.
|
void
|
Register the x and y hidden input names of the position clicked.
|
void
|
Raises the callback event. This method is required by
|
protected
void
|
Override parent implementation, no javascript is rendered here instead the javascript required for active control is registered in addAttributesToRender.
|
void
|
Sets the alternative text to be displayed in the TImage when the image is unavailable.
|
void
|
|
void
|
Sets the alignment of the image with respective to other elements on the page.
|
void
|
|
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()
|
Methods 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()
|
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()
|
Methods Inherited From TControl |
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()
|
Methods 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()
|
Constructor Details |
__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.
|
Method Details |
addAttributesToRender
protected void addAttributesToRender |
(mixed $writer ) |
Ensure that the ID attribute is rendered and registers the javascript code for initializing the active control.
Input |
mixed | $writer | |
Output |
Exception |
|
getActiveControl
|
getClientClassName
protected string getClientClassName |
() |
Output |
string
| corresponding javascript class name for this TActiveLinkButton. |
Exception |
|
getClientSide
|
onCallback
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.
|
onPreRender
Register the x and y hidden input names of the position clicked.
|
raiseCallbackEvent
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.
|
renderClientControlScript
protected void renderClientControlScript |
(mixed $writer ) |
Override parent implementation, no javascript is rendered here instead the javascript required for active control is registered in addAttributesToRender.
Input |
mixed | $writer | |
Output |
Exception |
|
setAlternateText
public void setAlternateText |
(string $value ) |
Sets the alternative text to be displayed in the TImage when the image is unavailable.
Input |
string | $value | the alternative text |
Output |
Exception |
|
setDescriptionUrl
public void setDescriptionUrl |
(string $value ) |
Input |
string | $value | the URL to the long description of the image. |
Output |
Exception |
|
setImageAlign
public void 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.
Input |
string | $value | the alignment of the image |
Output |
Exception |
|
setImageUrl
public void setImageUrl |
(string $value ) |
Input |
string | $value | the URL of the image file |
Output |
Exception |
|
|