Docs For Class TLabel

Description

TLabel class

TLabel displays a piece of text on a Web page. Use Text property to set the text to be displayed. TLabel will render the contents enclosed within its component tag if Text is empty. To use TLabel as a form label, associate it with a control by setting the ForControl property. The associated control must be locatable within the label's naming container. If the associated control is not visible, the label will not be rendered, either.

Note, Text will NOT be encoded for rendering. Make sure it does not contain dangerous characters that you want to avoid.

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

Located in /Web/UI/WebControls/TLabel.php (line 33)

TComponent
   |
   --TApplicationComponent
      |
      --TControl
         |
         --TWebControl
            |
            --TLabel

Direct descendents

Class	Description
TActiveLabel	TActiveLabel class
TBaseValidator	TBaseValidator class

Method Summary

void addAttributesToRender (THtmlWriter $writer)

string getForControl ()

string getTagName ()

string getText ()

void render (THtmlWriter $writer)

void renderContents (THtmlWriter $writer)

void setForControl (string $value)

void setText (string $value)

Methods

addAttributesToRender (line 50)

Adds attributes to renderer.

access: protected
throws: TInvalidDataValueException if associated control cannot be found using the ID

void addAttributesToRender (THtmlWriter $writer)

THtmlWriter $writer: the renderer

Redefinition of:

TWebControl::addAttributesToRender(): Adds attribute name-value pairs to renderer.

Redefined in descendants as:

TBaseValidator::addAttributesToRender() : Adds attributes to renderer. Calls parent implementation and renders the client control scripts.

getForControl (line 113)

return: the associated control ID
access: public

string getForControl ()

getTagName (line 40)

return: tag name of the label, returns 'label' if there is an associated control, 'span' otherwise.
access: protected

string getTagName ()

Redefinition of:

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

getText (line 97)

return: the text value of the label
access: public

string getText ()

render (line 63)

Renders the label.

It overrides the parent implementation by checking if an associated control is visible or not. If not, the label will not be rendered.

access: public

void render (THtmlWriter $writer)

THtmlWriter $writer: writer

Redefinition of:

TWebControl::render(): Renders the control.

renderContents (line 86)

Renders the body content of the label.

access: public

void renderContents (THtmlWriter $writer)

THtmlWriter $writer: the renderer

Redefinition of:

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

Redefined in descendants as:

TBaseValidator::renderContents() : Renders the validator control.

setForControl (line 123)

Sets the ID of the control that the label is associated with.

The control must be locatable via TControl::findControl using the ID.

access: public

void setForControl (string $value)

string $value: the associated control ID

Redefined in descendants as:

TActiveLabel::setForControl() : Sets the ID of the control that the label is associated with.
TBaseValidator::setForControl() : This method overrides the parent implementation to forbid setting ForControl.

setText (line 105)

access: public

void setText (string $value)

string $value: the text value of the label

Redefined in descendants as:

TActiveLabel::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