|
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
-
TApplicationComponent
-
TControl
implements
IRenderable,
IBindable
-
TWebControl
implements
IStyleable
-
TLabel
implements
IDataRenderer
Indirect known subclasses
TActiveCustomValidator,
TCaptchaValidator,
TRequiredFieldValidator,
TCompareValidator,
TCustomValidator,
TDataTypeValidator,
TEmailAddressValidator,
TListControlValidator,
TRangeValidator,
TReCaptchaValidator,
TRegularExpressionValidator
Methods summary
protected
string
|
#
getTagName( )
Returns
string tag name of the label, returns 'label' if there is an associated control, 'span'
otherwise.
Overrides
|
protected
|
#
addAttributesToRender( THtmlWriter $writer )
Adds attributes to renderer.
Adds attributes to renderer.
Parameters
Throws
Overrides
|
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
Overrides
|
public
|
#
renderContents( THtmlWriter $writer )
Renders the body content of the label.
Renders the body content of the label.
Parameters
Overrides
|
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
string the text value of the label
Since
3.1.0
See
Implementation of
|
public
|
#
setData( string $value )
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
Implementation of
|
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 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
|
|