Docs For Class TControl

constructor __construct [line 133]

TControl __construct(
)

Constructor.

Initializes the body collection.

Overridden in child classes as:

TPage::__construct(): Constructor, initiates the root to itself.

TCallbackPage::__construct(): Initialize the callback service.

THiddenField::__construct(): Constructor.

TRepeaterItem::__construct(): Constructor.

TDataGrid::__construct(): Initializes the columns list

TDataList::__construct(): Initializes the item list

TButton::__construct(): Constructor.

TCheckBox::__construct(): Constructor.

TRadioButton::__construct()

TDataListItem::__construct(): Constructor.

TFileUpload::__construct(): Constructor.

TFormLabel::__construct(): Constructor.

THyperLink::__construct(): Constructor.

TImage::__construct(): Constructor.

TImageButton::__construct(): Constructor.

TLabel::__construct(): Constructor.

TLinkButton::__construct(): Constructor.

TListControl::__construct(): Set the items list to be empty.

TDropDownList::__construct()

TListBox::__construct(): Sets the HTML tag displaying the listbox.

TPanel::__construct()

TTable::__construct(): Constructor.

TTableCell::__construct(): Constructor.

TTableHeaderCell::__construct(): Constructor.

TTableRow::__construct(): Constructor.

TDataGridItem::__construct(): Constructor.

Overrides TComponent::__construct() (Constructor.)

[ Top ]

method addBody [line 167]

void addBody(
mixed
$object)

Appends an object into the body collection of this control.

This method is equivalent to $control->Bodies->add($object).

access:

public

Parameters:

mixed

$object

the object to be added into body content.

[ Top ]

method addParsedObject [line 156]

void addParsedObject(
TComponent|string
$object, TComponent
$context)

Adds the object parsed in template as a body of the component.

access:

public

Overridden in child classes as:

TTranslate::addParsedObject(): Adds the object parsed in template as a body of the component.

TContent::addParsedObject(): Override the parent implementation.

TRepeater::addParsedObject(): This method overrides the parent implementation so that no body content is added from template.

TDataGrid::addParsedObject(): This method overrides the parent implementation so that no body content is added from template.

TDataList::addParsedObject(): This method overrides the parent implementation so that no body content is added from template.

TListControl::addParsedObject(): This method overrides the parent implementation to handle TListItem.

TWizard::addParsedObject(): Override the parent implementation.

TWizardTemplate::addParsedObject(): Override the parent implementation.

Overrides TComponent::addParsedObject() (Handles a component or string met in template.)

Parameters:

TComponent\|string	$object	the newly parsed object
TComponent	$context	the template owner

[ Top ]

method allowBody [line 212]

boolean allowBody(
mixed
$object)

Determines whether the control can add the object as a body.

This method can be overriden to customize the types of object that can be added as a body. Default implementation only allows string and TControl or its descendant.

access:

public

Overridden in child classes as:

TExpression::allowBody(): Overrides parent implementation to disable body addition.

TStatements::allowBody(): Overrides parent implementation to disable body addition.

TDataGrid::allowBody(): Overrides parent implementation to disable body addition.

TDataList::allowBody(): Overrides parent implementation to disable body addition.

TButton::allowBody(): Overrides parent implementation to disable body addition.

TCheckBox::allowBody(): Overrides parent implementation to disable body addition.

TFileUpload::allowBody(): Overrides parent implementation to disable body addition.

TImage::allowBody(): Overrides parent implementation to disable body addition.

TImageButton::allowBody(): Overrides parent implementation to disable body addition.

TLabel::allowBody(): Overrides parent implementation to disable body addition.

TListControl::allowBody(): Overrides parent implementation to disable body addition.

TTable::allowBody(): Determines whether the control can add the object as a body.

TTableRow::allowBody(): Determines whether the control can add the object as a body.

TTextBox::allowBody(): Overrides parent implementation to disable body addition.

TDatePicker::allowBody(): Overrides parent implementation to disable body addition.

TValidationSummary::allowBody(): Overrides parent implementation to disable body addition.

Parameters:

mixed

$object

the object to be added

[ Top ]

method clearViewState [line 658]

void clearViewState(
[boolean
$recursive = true])

Clears viewstate

access:

public

Parameters:

boolean

$recursive

whether children should be cleared viewstate as well

[ Top ]

method findBodyControl [line 220]

TControl|null findBodyControl(
mixed
$id)

return:	the body control with the specified ID, null if not found.
access:	public

[ Top ]

method getAttribute [line 278]

string|null getAttribute(
string
$name)

return:	the attribute value, null if no such attribute
access:	public

Parameters:

string

$name

the attribute name

[ Top ]

method getAttributes [line 287]

array getAttributes(
)

Returns the attribute list object.

return:	the list of all attributes
access:	public

[ Top ]

method getAttributesToRender [line 583]

ArrayObject getAttributesToRender(
)

Returns attributes to be rendered.

The default implementation returns the Attributes property that is inserted with an 'id' attribute whose value equals to the ClientID property of the control. You can override this method to customize attributes to be rendered. Be sure to call parent's implementation first to ensure the rendering of attributes specified in parent. This method is mainly used by control developers.

return:	the attributes to be rendered
access:	protected

Overridden in child classes as:

THiddenField::getAttributesToRender(): This overrides the parent implementation by rendering more THiddenField-specific attributes.

TWebControl::getAttributesToRender(): This overrides the parent implementation by rendering more TWebControl-specific attributes.

TDataGrid::getAttributesToRender(): Returns the attributes to be rendered.

TDataList::getAttributesToRender(): Returns the attributes to be rendered.

TButton::getAttributesToRender(): This overrides the parent implementation by rendering more TButton-specific attributes.

TCheckBox::getAttributesToRender(): Returns the attributes to be rendered.

TRadioButton::getAttributesToRender(): Returns the attributes to be rendered.

TDataListItem::getAttributesToRender(): Returns the attributes to be rendered.

TFileUpload::getAttributesToRender(): This overrides the parent implementation by rendering more TButton-specific attributes.

TFormLabel::getAttributesToRender(): This overrides the parent implementation by rendering the FOR attributes.

THyperLink::getAttributesToRender(): This overrides the parent implementation by rendering more THyperLink-specific attributes.

TImage::getAttributesToRender(): This overrides the parent implementation by rendering more TImage-specific attributes.

TImageButton::getAttributesToRender(): This overrides the parent implementation by rendering more TImageButton-specific attributes.

TLinkButton::getAttributesToRender(): This overrides the parent implementation by rendering more TLinkButton-specific attributes.

TCheckBoxList::getAttributesToRender(): Returns the attributes to be rendered.

TDropDownList::getAttributesToRender(): Returns the attributes to be rendered.

TListBox::getAttributesToRender(): Returns the attributes to be rendered.

TPanel::getAttributesToRender(): This overrides the parent implementation by rendering more TPanel-specific attributes.

TWizardStep::getAttributesToRender(): Override the parent implementation. If the Title property is define, add the "title" attribute using the Title property.

TTable::getAttributesToRender(): Returns the attributes to be rendered.

TTableCell::getAttributesToRender(): Returns the attributes to be rendered.

TTableRow::getAttributesToRender(): Returns the attributes to be rendered.

TTextBox::getAttributesToRender(): Returns the attributes to be rendered.

[ Top ]

method getBodies [line 251]

array getBodies(
)

return:	the body content
access:	public

[ Top ]

method getClientID [line 145]

string getClientID(
)

Returns the client ID of the component.

The client ID is similar to the unique ID except underscores are used as connectors instead of colons.

return:	the client ID of the component
access:	public

[ Top ]

method getContainer [line 234]

TControl getContainer(
)

Returns the container of this component.

return:	the container control
access:	public

[ Top ]

method getSkinName [line 312]

string getSkinName(
)

return:	the skin specified for this control
access:	public

[ Top ]

method getTagName [line 295]

string getTagName(
)

return:	the tag name
access:	public

[ Top ]

method getViewState [line 646]

mixed getViewState(
string
$key, [mixed
$defaultValue = null])

Returns a viewstate value.

This function is very useful in defining getter functions for component properties that must be kept in viewstate.

return:	the viewstate value(s)
access:	public

Parameters:

string	$key	the name of the viewstate value to be returned
mixed	$defaultValue	the default value. If $key is not found in viewstate, $defaultValue will be returned

[ Top ]

method initSkin [line 332]

void initSkin(
[mixed
$skinName = null])

Initializes a skin for the control. If a skin name is provided then that skin will be loaded.

If not then the skin as defined by the SkinName property of the control will be loaded. If this property has no value then the default skin for the control will be loaded. If no default skin exists for this control then no skin will be loaded at all.

access:

public

[ Top ]

method isViewStateEnabled [line 386]

boolean isViewStateEnabled(
)

return:	whether viewstate is enabled
access:	public

[ Top ]

method isVisible [line 357]

boolean isVisible(
[boolean
$checkContainers = false])

This method checks whether a control is visible.

If $checkContainers is true, it will also check the visibility of the containers of the control. It returns false if any container is invisible.

return:	whether the component should be rendered
access:	public

Parameters:

boolean

$checkContainers

whether to check the containers of the control as well.

[ Top ]

method loadViewState [line 682]

void loadViewState(
array
$viewState)

Loads viewstate into this component and its children.

Current implementation is that the viewstate for a component is stored as an array. The first array element stores the viewstate of this component. The rest elements store the viewstates of the child components, indexed by their IDs.

This method should only be used by framework and component developers.

access:	public
see:	TControl::saveViewState()

Overridden in child classes as:

TPage::loadViewState()

TRepeater::loadViewState(): Loads viewstate into this control and its children.

TDataGrid::loadViewState(): Loads viewstate into this control and its children.

TDataList::loadViewState(): Loads viewstate into this control and its children.

TListControl::loadViewState(): Loads viewstate into this control and its children.

Parameters:

array

$viewState

viewstate to be loaded

[ Top ]

method onBubbleEvent [line 615]

boolean onBubbleEvent(
TComponent
$sender, TEventParameter
$param)

This method responds to a bubbled event.

This method should be overriden to provide customized response at a bubbled event. Check the type of event parameter to determine what event is bubbled currently.

return:	true if the event bubbling is handled and no more bubbling.
access:	protected

Overridden in child classes as:

TRepeater::onBubbleEvent(): Handles OnBubbleEvent.

TRepeaterItem::onBubbleEvent(): Handles OnBubbleEvent.

TDataGrid::onBubbleEvent(): Handles OnBubbleEvent.

TDataList::onBubbleEvent(): Handles OnBubbleEvent.

TDataListItem::onBubbleEvent(): Handles OnBubbleEvent.

TWizard::onBubbleEvent(): This method responds to a bubbled event. It will capture the event

TDataGridItem::onBubbleEvent(): Handles OnBubbleEvent.

Parameters:

TComponent	$sender	sender of the event
TEventParameter	$param	event parameters

[ Top ]

method onInit [line 458]

void onInit(
TEventParameter
$param)

This method is invoked when the control enters 'Init' stage.

The method raises 'OnInit' event to fire up the event delegates. If you override this method, be sure to call the parent implementation so that the event delegates can be invoked.

access:

protected

Parameters:

TEventParameter

$param

event parameter to be passed to the event handlers

[ Top ]

method onInitRecursive [line 404]

void onInitRecursive(
TEventParameter
$param)

Calls onInit of this control and its children recursively.

This method should only be used by framework developers.

access:

protected

Overridden in child classes as:

TPage::onInitRecursive()

Parameters:

TEventParameter

$param

event parameter to be passed to onInit

[ Top ]

method onLoad [line 470]

void onLoad(
TEventParameter
$param)

This method is invoked when the control enters 'Load' stage.

The method raises 'OnLoad' event to fire up the event delegates. If you override this method, be sure to call the parent implementation so that the event delegates can be invoked.

access:

protected

Overridden in child classes as:

TWizard::onLoad(): Initalize and add the default navigation templates. Add the side bar if required.

TValidatorGroup::onLoad(): This overrides the parent implementation by doing the group validation.

Parameters:

TEventParameter

$param

event parameter to be passed to the event handlers

[ Top ]

method onLoadRecursive [line 417]

void onLoadRecursive(
TEventParameter
$param)

Calls onLoad of this control and its children recursively.

This method should only be used by framework developers.

access:

protected

Overridden in child classes as:

TPage::onLoadRecursive()

Parameters:

TEventParameter

$param

event parameter to be passed to onLoad

[ Top ]

method onPreRender [line 494]

void onPreRender(
TEventParameter
$param)

This method is invoked when the control enters 'PreRender' stage.

The method raises 'OnPreRender' event to fire up the event delegates. If you override this method, be sure to call the parent implementation so that the event delegates can be invoked.

access:

protected

Overridden in child classes as:

TCallbackPage::onPreRender(): Register the callback script file.

TActivePanel::onPreRender(): Render the javascript within the panel.

TDraggable::onPreRender()

TJavascriptLogger::onPreRender(): Register the required javascript libraries.

TWizard::onPreRender(): Determins which wizard step to show and appropriate navigation elements.

TDatePicker::onPreRender(): Registers the script and style files

TValidator::onPreRender(): Overrides parent implementation by registering necessary Javascripts for validation.

TCompareValidator::onPreRender(): Update the control to compare Css class. Override and calls parent onPreRender.

TValidatorGroup::onPreRender(): This overrides the parent implementation by restoring all the validator disabled/enabled states. Parent::OnPreRender($param) is called.

Parameters:

TEventParameter

$param

event parameter to be passed to the event handlers

[ Top ]

method onPreRenderRecursive [line 430]

void onPreRenderRecursive(
TEventParameter
$param)

Calls onPreRender of this control and its children recursively.

This method should only be used by framework developers.

access:

protected

Overridden in child classes as:

TPage::onPreRenderRecursive()

Parameters:

TEventParameter

$param

event parameter to be passed to onPreRender

[ Top ]

method onUnload [line 482]

void onUnload(
TEventParameter
$param)

This method is invoked when the control enters 'Unload' stage.

The method raises 'OnUnload' event to fire up the event delegates. If you override this method, be sure to call the parent implementation so that the event delegates can be invoked.

access:

protected

Parameters:

TEventParameter

$param

event parameter to be passed to the event handlers

[ Top ]

method onUnloadRecursive [line 443]

void onUnloadRecursive(
TEventParameter
$param)

Calls onUnload of this control and its children recursively.

This method should only be used by framework developers.

access:

protected

Overridden in child classes as:

TPage::onUnloadRecursive()

Parameters:

TEventParameter

$param

event parameter to be passed to onUnload

[ Top ]

method raiseBubbleEvent [line 597]

void raiseBubbleEvent(
TComponent
$sender, TEventParameter
$param)

Invokes the parent's onBubbleEvent method.

A control who wants to bubble an event must call this method in its onEvent method.

access:

public

Parameters:

TComponent	$sender	sender of the event
TEventParameter	$param	event parameter

[ Top ]

method removeBodies [line 259]

void removeBodies(
)

Removes all body content.

access:

public

[ Top ]

method render [line 508]

string render(
)

Renders this control.

Default implementation will render the children in order. If TagName is not empty, an enclosing tag together with Attributes will be rendered as well. This method can be overriden.

return:	the rendering result
access:	public

Overridden in child classes as:

TContentPlaceHolder::render(): Renders the control.

TForm::render(): This overrides the parent implementation by rendering TForm-specific content.

TExpression::render(): Renders the evaluation result of the expression.

THead::render(): Render the <head> tag

TStatements::render(): Renders the evaluation result of the expression.

TDataList::render(): Displays the data list.

TCheckBox::render(): Renders the body content of the control.

TFileUpload::render()

TCheckBoxList::render(): Renders the checkbox list

TTextBox::render(): Renders the text box

TAutoComplete::render()

TDatePicker::render(): Renders the datepicker

THtmlArea::render(): Renders the HTMLArea

TValidationSummary::render(): Overrides parent implementation by rendering TValidationSummary-specific presentation.

TValidator::render(): Overrides parent implementation by rendering TValidator-specific presentation.

TValidatorGroup::render(): Overrides parent implementation by registering the validation group javascripts.

[ Top ]

method renderAttributes [line 562]

string renderAttributes(
[array|null
$attributes = null])

Renders the attributes.

It returns a string consisting of key-value pairs based on the input array. getAttributesToRender.

return:	the rendering result
access:	protected
see:	TControl::getAttributesToRender()

Overridden in child classes as:

TDataListItem::renderAttributes(): Renders the attributes.

Parameters:

array|null

$attributes

the attributes to be rendered, if null getAttributesToRender() will be invoked to get the attributes

[ Top ]

method renderBody [line 537]

string renderBody(
)

Renders the body content.

Default implementation will render recursively all visible child controls and text blocks. You can override this method to render customized body content. This method is mainly used by control developers.

return:	the rendering result
access:	protected

Overridden in child classes as:

TDateFormat::renderBody(): Renders the localized version of the date-time value.

TNumberFormat::renderBody(): Renders the localized number, be it currency or decimal, or percentage.

TTranslate::renderBody(): Display the translated string.

TChoices::renderBody(): Display the choosen translated string.

TParam::renderBody(): Get the contents and add the content to the TTranslate component. This component does not render anything.

TPage::renderBody(): Renders the body content.

TLiteral::renderBody(): This overrides the parent implementation by rendering the Text property if it is not empty.

TDataGrid::renderBody(): Renders the body content of the datagrid.

TFormLabel::renderBody(): Renders Text or children elements as content.

THyperLink::renderBody()

TLabel::renderBody(): Renders Text as content.

TLinkButton::renderBody(): This overrides the parent implementation by rendering either Text or the body contents.

TDropDownList::renderBody(): Renders the list as an HTML select element.

TListBox::renderBody(): Renders the list as an HTML select element.

TDraggable::renderBody()

TTable::renderBody(): Renders the body content of this table.

TTableCell::renderBody(): Renders the body content of this cell.

TTableRow::renderBody(): Renders the body content of this row.

TDataGridItem::renderBody(): Renders the body content of this table.

[ Top ]

method saveViewState [line 719]

array|null saveViewState(
)

Returns the viewstate of this component and its children.

This method should only be used by framework and component developers.

return:	viewstate to be saved
access:	public
see:	TControl::loadViewState()

Overridden in child classes as:

TPage::saveViewState()

TRepeater::saveViewState(): Returns the viewstate of this control and its children.

TDataGrid::saveViewState(): Returns the viewstate of this control and its children.

TDataList::saveViewState(): Returns the viewstate of this control and its children.

TListControl::saveViewState(): Returns the viewstate of this control and its children.

TDropDownList::saveViewState(): Returns the viewstate of this control and its children.

[ Top ]

method setAttribute [line 269]

void setAttribute(
string
$name, string
$value)

Sets an attribute.

access:

public

Overrides TComponent::setAttribute() (Sets an attribute.)

Parameters:

string	$name	the attribute name
string	$value	the attribute value

[ Top ]

method setContainer [line 243]

void setContainer(
mixed
$container)

Sets the container of this component

var:	the new container of this control
access:	public

[ Top ]

method setEnableViewState [line 394]

void setEnableViewState(
boolean
$value)

access:

public

Parameters:

boolean

$value

set whether to enable viewstate

[ Top ]

method setSkinName [line 320]

void setSkinName(
mixed
$skin)

Sets the skin to use for this control

access:

public

[ Top ]

method setTagName [line 304]

void setTagName(
string
$tagName)

Sets the tag name.

access:

public

Parameters:

string

$tagName

the tag name associated with the control

[ Top ]

method setViewState [line 629]

void setViewState(
string
$key, mixed
$value, [mixed
$defaultValue = null])

Sets a viewstate value.

This function is very useful in defining setter functions for control properties that must be kept in viewstate.

access:

public

Parameters:

string	$key	the name of the viewstate value
mixed	$value	the viewstate value to be set
mixed	$defaultValue	default value. If $value===$defaultValue, the viewstate will be cleared up.

[ Top ]

method setVisible [line 378]

void setVisible(
boolean
$value)

access:

public

Parameters:

boolean

$value

set whether the component should be rendered

[ Top ]

method synchronizeControl [line 179]

void synchronizeControl(
TControl
$control)

This method should only be used by framework developer.

It is invoked when a body control is being added. The control will be made synchronized to the current life cycle of the page hierarchy.

access:

public

Parameters:

TControl

$control

the control being added.

[ Top ]

Class: TControl

Class Overview

Class Details

Methods

Child classes:

Inherited Variables

Class: TComponent

Inherited Methods

Class: TComponent

Class Methods

constructor __construct [line 133]

method addBody [line 167]

Parameters:

method addParsedObject [line 156]

Parameters:

method allowBody [line 212]

Parameters:

method clearViewState [line 658]

Parameters:

method findBodyControl [line 220]

method getAttribute [line 278]

Parameters:

method getAttributes [line 287]

method getAttributesToRender [line 583]

method getBodies [line 251]

method getClientID [line 145]

method getContainer [line 234]

method getSkinName [line 312]

method getTagName [line 295]

method getViewState [line 646]

Parameters:

method initSkin [line 332]

method isViewStateEnabled [line 386]

method isVisible [line 357]

Parameters:

method loadViewState [line 682]

Parameters:

method onBubbleEvent [line 615]

Parameters:

method onInit [line 458]

Parameters:

method onInitRecursive [line 404]

Parameters:

method onLoad [line 470]

Parameters:

method onLoadRecursive [line 417]

Parameters:

method onPreRender [line 494]

Parameters:

method onPreRenderRecursive [line 430]

Parameters:

method onUnload [line 482]

Parameters:

method onUnloadRecursive [line 443]

Parameters:

method raiseBubbleEvent [line 597]

Parameters:

method removeBodies [line 259]

method render [line 508]

method renderAttributes [line 562]

Parameters:

method renderBody [line 537]

method saveViewState [line 719]

method setAttribute [line 269]

Parameters:

method setContainer [line 243]

method setEnableViewState [line 394]

Parameters:

method setSkinName [line 320]

method setTagName [line 304]

Parameters:

method setViewState [line 629]

Parameters:

method setVisible [line 378]

Parameters:

method synchronizeControl [line 179]

Parameters: