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 TLabel

TLabel class

TLabel displays a piece of text on a Web page. Use setText Text property to set the text to be displayed. TLabel will render the contents enclosed within its component tag if setText Text is empty. To use TLabel as a form label, associate it with a control by setting the setForControl 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, setText Text will NOT be encoded for rendering. Make sure it does not contain dangerous characters that you want to avoid.

TComponent
Extended by TApplicationComponent
Extended by TControl implements IRenderable, IBindable
Extended by TWebControl implements IStyleable
Extended by TLabel implements IDataRenderer

Direct known subclasses

TActiveLabel, TBaseValidator

Indirect known subclasses

TActiveCustomValidator, TCaptchaValidator, TRequiredFieldValidator, TCompareValidator, TCustomValidator, TDataTypeValidator, TEmailAddressValidator, TListControlValidator, TRangeValidator, TReCaptchaValidator, TRegularExpressionValidator
Package: System\Web\UI\WebControls
Copyright: Copyright © 2005-2014 PradoSoft
License: http://www.pradosoft.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0
Located at Web/UI/WebControls/TLabel.php
Methods summary
protected string
# getTagName( )

Returns

string
tag name of the label, returns 'label' if there is an associated control, 'span' otherwise.

Overrides

TWebControl::getTagName()
protected
# addAttributesToRender( THtmlWriter $writer )

Adds attributes to renderer.

Adds attributes to renderer.

Parameters

$writer
THtmlWriter
the renderer

Throws

TInvalidDataValueException
if associated control cannot be found using the ID

Overrides

TWebControl::addAttributesToRender()
public
# render( THtmlWriter $writer )

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.

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.

Parameters

$writer
THtmlWriter
writer

Overrides

TWebControl::render()
public
# renderContents( THtmlWriter $writer )

Renders the body content of the label.

Renders the body content of the label.

Parameters

$writer
THtmlWriter
the renderer

Overrides

TWebControl::renderContents()
public string
# getText( )

Returns

string
the text value of the label
public
# setText( string $value )

Parameters

$value
string
the text value of the label
public string
# getData( )

Returns the text value of the label. This method is required by IDataRenderer. It is the same as TLabel::getText().

Returns the text value of the label. This method is required by IDataRenderer. It is the same as TLabel::getText().

Returns

string
the text value of the label

Since

3.1.0

See

TLabel::getText()

Implementation of

IDataRenderer::getData()
public
# setData( string $value )

Sets the text value of the label. This method is required by IDataRenderer. It is the same as TLabel::setText().

Sets the text value of the label. This method is required by IDataRenderer. It is the same as TLabel::setText().

Parameters

$value
string
the text value of the label

Since

3.1.0

See

TLabel::setText()

Implementation of

IDataRenderer::setData()
public string
# getForControl( )

Returns

string
the associated control ID
public
# setForControl( string $value )

Sets the ID of the control that the label is associated with. The control must be locatable via TControl::findControl() using the ID.

Sets the ID of the control that the label is associated with. The control must be locatable via TControl::findControl() using the ID.

Parameters

$value
string
the associated control ID
Methods inherited from TWebControl
clearStyle(), copyBaseAttributes(), createStyle(), getAccessKey(), getBackColor(), getBorderColor(), getBorderStyle(), getBorderWidth(), getCssClass(), getDecorator(), getDisplay(), getEnsureId(), getFont(), getForeColor(), getHasStyle(), getHeight(), getStyle(), getTabIndex(), getToolTip(), getWidth(), onPreRender(), renderBeginTag(), renderEndTag(), setAccessKey(), setBackColor(), setBorderColor(), setBorderStyle(), setBorderWidth(), setCssClass(), setDisplay(), setEnsureId(), setForeColor(), setHeight(), setStyle(), setTabIndex(), setToolTip(), setWidth()
Methods inherited from TControl
__construct(), __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