Docs For Class THyperLink

Description

THyperLink class

THyperLink displays a hyperlink on a page. The hyperlink URL is specified via the NavigateUrl property, and link text is via the Text property. It is also possible to display an image by setting the ImageUrl property. In this case, Text is displayed as the alternate text of the image. The link target is specified via the Target property. If both ImageUrl and Text are empty, the content enclosed within the control tag will be rendered.

since: 3.0
version: $Id: THyperLink.php 1398 2006-09-08 19:31:03Z xue $
author: Qiang Xue <qiang.xue@gmail.com>

Located in /Web/UI/WebControls/THyperLink.php (line 30)

TComponent
   |
   --TApplicationComponent
      |
      --TControl
         |
         --TWebControl
            |
            --THyperLink

Direct descendents

Class	Description
TActiveHyperLink	TActiveHyperLink class.

Method Summary

void addAttributesToRender (THtmlWriter $writer)

TImage createImage (string $imageUrl)

string getImageUrl ()

string getNavigateUrl ()

string getTagName ()

string getTarget ()

string getText ()

void renderContents (THtmlWriter $writer)

void setImageUrl (string $value)

void setNavigateUrl (string $value)

void setTarget (string $value)

void setText (string $value)

Methods

addAttributesToRender (line 44)

Adds attributes related to a hyperlink element to renderer.

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.

createImage (line 81)

Gets the TImage for rendering the ImageUrl property. This is not for creating dynamic images.

return: image control for rendering.
access: protected

TImage createImage (string $imageUrl)

string $imageUrl: image url.

getImageUrl (line 112)

return: the location of the image file for the THyperLink
access: public

string getImageUrl ()

getNavigateUrl (line 129)

return: the URL to link to when the THyperLink component is clicked.
access: public

string getNavigateUrl ()

getTagName (line 35)

return: tag name of the hyperlink
access: protected

string getTagName ()

Redefinition of:

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

getTarget (line 146)

return: the target window or frame to display the Web page content linked to when the THyperLink component is clicked.
access: public

string getTarget ()

getText (line 95)

return: the text caption of the THyperLink
access: public

string getText ()

renderContents (line 60)

Renders the body content of the hyperlink.

access: public

void renderContents (THtmlWriter $writer)

THtmlWriter $writer: the writer for rendering

Redefinition of:

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

setImageUrl (line 121)

Sets the location of image file of the THyperLink.

access: public

void setImageUrl (string $value)

string $value: the image file location

Redefined in descendants as:

TActiveHyperLink::setImageUrl() : Sets the location of image file of the THyperLink.

setNavigateUrl (line 138)

Sets the URL to link to when the THyperLink component is clicked.

access: public

void setNavigateUrl (string $value)

string $value: the URL

Redefined in descendants as:

TActiveHyperLink::setNavigateUrl() : Sets the URL to link to when the THyperLink component is clicked.

setTarget (line 155)

Sets the target window or frame to display the Web page content linked to when the THyperLink component is clicked.

access: public

void setTarget (string $value)

string $value: the target window, valid values include '_blank', '_parent', '_self', '_top' and empty string.

Redefined in descendants as:

TActiveHyperLink::setTarget() : Sets the target window or frame to display the Web page content linked to when the THyperLink component is clicked.

setText (line 104)

Sets the text caption of the THyperLink.

access: public

void setText (string $value)

string $value: the text caption to be set

Redefined in descendants as:

TActiveHyperLink::setText() : On callback response, the inner HTMl of the label is updated.

Inherited Methods

Inherited From TWebControl

TWebControl::addAttributesToRender()
TWebControl::copyBaseAttributes()
TWebControl::createStyle()
TWebControl::getAccessKey()
TWebControl::getBackColor()
TWebControl::getBorderColor()
TWebControl::getBorderStyle()
TWebControl::getBorderWidth()
TWebControl::getCssClass()
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::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::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::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