Class: TCheckBox

Source Location: /Web/UI/WebControls/TCheckBox.php

Class Overview

TComponent
   |
   --TControl
      |
      --TWebControl
         |
         --TCheckBox

TCheckBox class

Class Details

[line 68]
TCheckBox class

TCheckBox creates a check box on the page. You can specify the caption to display beside the check box by setting the Text property. The caption can appear either on the right or left of the check box, which is determined by the TextAlign property.

To determine whether the TCheckBox component is checked, test the Checked property. The OnCheckedChanged event is raised when the Checked state of the TCheckBox component changes between posts to the server. You can provide an event handler for the OnCheckedChanged event to to programmatically control the actions performed when the state of the TCheckBox component changes between posts to the server.

Note, Text will be HTML encoded before it is displayed in the TCheckBox component. If you don't want it to be so, set EncodeText to false.

Namespace: System.Web.UI.WebControls

Properties

Text, string, kept in viewstate
Gets or sets the text caption displayed in the TCheckBox component.
EncodeText, boolean, default=true, kept in viewstate
Gets or sets the value indicating whether Text should be HTML-encoded when rendering.
TextAlign, Left|Right, default=Right, kept in viewstate
Gets or sets the alignment of the text label associated with the TCheckBox component.
Checked, boolean, default=false, kept in viewstate
Gets or sets a value indicating whether the TCheckBox component is checked.
AutoPostBack, boolean, default=false, kept in viewstate
Gets or sets a value indicating whether the TCheckBox automatically posts back to the server when clicked.

Events

OnCheckedChanged Occurs when the value of the Checked property changes between posts to the server.

Examples

On a page template file, insert the following line to create a TCheckBox component,
```
   <com:TCheckBox Text="Agree" OnCheckedChanged="checkAgree" />
```

The checkbox will show "Agree" text on its right side. If the user makes any change to the Checked state, the checkAgree() method of the page class will be invoked automatically.

version:	v1.0, last update on 2004/08/13 21:44:52
author:	Qiang Xue <qiang.xue@gmail.com>

[ Top ]

Methods

Child classes:

TRadioButton: TRadioButton class

Inherited Variables

Class: TComponent

TComponent::$children

Inherited Methods

Class: TWebControl

TWebControl::appendJavascriptEvent(): Append a javascript statement to a particular attribute, e.g. "onclick".
TWebControl::getAccessKey()
TWebControl::getAttributesToRender(): This overrides the parent implementation by rendering more TWebControl-specific attributes.
TWebControl::getBackColor()
TWebControl::getBorderColor()
TWebControl::getBorderStyle()
TWebControl::getBorderWidth()
TWebControl::getCssClass()
TWebControl::getForeColor()
TWebControl::getHeight()
TWebControl::getJavascriptEvents(): Get the list of all the javascript statements.
TWebControl::getStyle()
TWebControl::getTabIndex()
TWebControl::getToolTip()
TWebControl::getWidth()
TWebControl::isEnabled()
TWebControl::parseStyle(): Parses a CSS style string into an array representation.
TWebControl::removeJavascriptEvent(): Remove all or a particular javascript statements.
TWebControl::setAccessKey(): Sets the access key of the control.
TWebControl::setBackColor(): Sets the background color of the control
TWebControl::setBorderColor(): Sets the border color of the control
TWebControl::setBorderStyle(): Sets the border style of the control
TWebControl::setBorderWidth(): Sets the border width of the control
TWebControl::setCssClass(): Sets the CSS class name of the control
TWebControl::setEnabled(): Enables or disables a control.
TWebControl::setForeColor(): Sets the foreground color of the control
TWebControl::setHeight(): Sets the height of the control
TWebControl::setStyle(): Sets the CSS style of the control.
TWebControl::setTabIndex(): Sets the tab index of the control.
TWebControl::setToolTip(): Sets the tooltip of the control.
TWebControl::setWidth(): Sets the width of the control

Class: TControl

TControl::__construct(): Constructor.
TControl::addBody(): Appends an object into the body collection of this control.
TControl::addParsedObject(): Adds the object parsed in template as a body of the component.
TControl::allowBody(): Determines whether the control can add the object as a body.
TControl::clearViewState(): Clears viewstate
TControl::findBodyControl()
TControl::getAttribute()
TControl::getAttributes(): Returns the attribute list object.
TControl::getAttributesToRender(): Returns attributes to be rendered.
TControl::getBodies()
TControl::getClientID(): Returns the client ID of the component.
TControl::getContainer(): Returns the container of this component.
TControl::getSkinName()
TControl::getTagName()
TControl::getViewState(): Returns a viewstate value.
TControl::initSkin(): Initializes a skin for the control. If a skin name is provided then that skin will be loaded.
TControl::isViewStateEnabled()
TControl::isVisible(): This method checks whether a control is visible.
TControl::loadViewState(): Loads viewstate into this component and its children.
TControl::onBubbleEvent(): This method responds to a bubbled event.
TControl::onInit(): This method is invoked when the control enters 'Init' stage.
TControl::onInitRecursive(): Calls onInit of this control and its children recursively.
TControl::onLoad(): This method is invoked when the control enters 'Load' stage.
TControl::onLoadRecursive(): Calls onLoad of this control and its children recursively.
TControl::onPreRender(): This method is invoked when the control enters 'PreRender' stage.
TControl::onPreRenderRecursive(): Calls onPreRender of this control and its children recursively.
TControl::onUnload(): This method is invoked when the control enters 'Unload' stage.
TControl::onUnloadRecursive(): Calls onUnload of this control and its children recursively.
TControl::raiseBubbleEvent(): Invokes the parent's onBubbleEvent method.
TControl::removeBodies(): Removes all body content.
TControl::render(): Renders this control.
TControl::renderAttributes(): Renders the attributes.
TControl::renderBody(): Renders the body content.
TControl::saveViewState(): Returns the viewstate of this component and its children.
TControl::setAttribute(): Sets an attribute.
TControl::setContainer(): Sets the container of this component
TControl::setEnableViewState()
TControl::setSkinName(): Sets the skin to use for this control
TControl::setTagName(): Sets the tag name.
TControl::setViewState(): Sets a viewstate value.
TControl::setVisible()
TControl::synchronizeControl(): This method should only be used by framework developer.

Class: TComponent

TComponent::__construct(): Constructor.
TComponent::addChild(): Adds a child component.
TComponent::addParsedObject(): Handles a component or string met in template.
TComponent::attachEventHandler(): Attaches a handler function to an event.
TComponent::bindProperty(): Sets up the binding between a property and an expression.
TComponent::canGetProperty(): Determines whether a property can be read.
TComponent::canSetProperty(): Determines whether a property can be written.
TComponent::createComponent(): Creates a child component.
TComponent::dataBind(): Performs the databinding for this component.
TComponent::evaluateExpression(): Evaluates a PHP expression.
TComponent::evaluateStatements(): Evaluates a list of PHP statements.
TComponent::findObject(): Finds an object by its ID path.
TComponent::getApplication()
TComponent::getChild()
TComponent::getChildren()
TComponent::getDefinition(): Returns or builds a component definition.
TComponent::getGlobalization(): Returns the Globalization instance for the application.
TComponent::getID()
TComponent::getModule(): Returns the module object that contains the component or the page containing the component.
TComponent::getPage()
TComponent::getParent()
TComponent::getPropertyInitValue(): Gets the initial value of a property.
TComponent::getPropertyType(): Returns the type of a property
TComponent::getRequest(): Returns the request object associated with application.
TComponent::getServiceManager(): Returns the service manager for this application.
TComponent::getSession(): Returns the session object associated with the application.
TComponent::getSessionState(): Returns a session variable.
TComponent::getUniqueID(): Returns the unique ID of the component.
TComponent::getUser(): Returns the user object associated with the application.
TComponent::hasChildren()
TComponent::hasEvent(): Determines whether an event is defined.
TComponent::hasProperty(): Determines whether a property is defined.
TComponent::initProperties(): Initializes the property values.
TComponent::instantiateTemplate(): Parses a template string and instantiates the content.
TComponent::onDataBinding(): This method is invoked when dataBind is invoked for the component.
TComponent::raiseEvent(): Invokes all attached event handler functions for a particular event.
TComponent::removeChild(): Removes a child component.
TComponent::removeChildren(): Removes all child components.
TComponent::setAttribute(): Sets an attribute.
TComponent::setDefinition(): Sets a component definition.
TComponent::setID(): Sets a component ID.
TComponent::setParent(): Sets the parent of this component.
TComponent::setPropertyInitValue(): Sets the initial value of a property.
TComponent::setRoot(): Sets the root component in the component hierarchy.
TComponent::setSessionState(): Sets a session variable.
TComponent::unbindProperty(): Breaks the binding between a property and an expression.
TComponent::__get(): Returns a property value by name or a child component by ID.
TComponent::__set(): Sets value of a component property.

Class Methods

constructor __construct [line 74]

TCheckBox __construct(
)

Constructor.

Sets the tagname to 'span'.

access:

public

Overridden in child classes as:

TRadioButton::__construct()

Overrides TControl::__construct() (Constructor.)

[ Top ]

method allowBody [line 85]

boolean allowBody(
mixed
$object)

Overrides parent implementation to disable body addition.

access:

public

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

Parameters:

mixed

$object

the object to be added

[ Top ]

method getAttributesToRender [line 236]

ArrayObject getAttributesToRender(
)

Returns the attributes to be rendered.

This method overrides the parent's implementation.

return:	attributes to be rendered
access:	protected

Overridden in child classes as:

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

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

[ Top ]

method getText [line 147]

string getText(
)

return:	the text caption of the checkbox
access:	public

[ Top ]

method getTextAlign [line 181]

string getTextAlign(
)

return:	the alignment of the text caption
access:	public

[ Top ]

method getValidationPropertyValue [line 139]

mixed getValidationPropertyValue(
)

Returns the value of the property that needs validation.

return:	the property value to be validated
access:	public

[ Top ]

method isAutoPostBack [line 217]

boolean isAutoPostBack(
)

return:	whether clicking on the checkbox will post the page.
access:	public

[ Top ]

method isChecked [line 200]

boolean isChecked(
)

return:	whether the checkbox is checked
access:	public

[ Top ]

method isEncodeText [line 164]

boolean isEncodeText(
)

return:	whether the text should be HTML encoded before rendering
access:	public

[ Top ]

method loadPostData [line 97]

boolean loadPostData(
string
$key, array
&$values)

Loads user input data.

This method is primarly used by framework developers.

return:	whether the data of the component has been changed
access:	public

Overridden in child classes as:

TRadioButton::loadPostData(): Loads user input data.

Parameters:

string	$key	the key that can be used to retrieve data from the input data collection
array	&$values	the input data collection

[ Top ]

method onCheckedChanged [line 130]

void onCheckedChanged(
TEventParameter
$param)

This method is invoked when the value of the Checked property changes between posts to the server.

The method raises 'OnCheckedChanged' 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:

public

Parameters:

TEventParameter

$param

event parameter to be passed to the event handlers

[ Top ]

method raisePostDataChangedEvent [line 118]

void raisePostDataChangedEvent(
)

Raises postdata changed event.

This method calls onCheckedChanged method. This method is primarly used by framework developers.

access:

public

[ Top ]

method render [line 269]

string render(
)

Renders the body content of the control.

This method overrides the parent's implementation.

return:	the rendering result.
access:	public

Overrides TControl::render() (Renders this control.)

[ Top ]

method setAutoPostBack [line 226]

void setAutoPostBack(
boolean
$value)

Sets a value indicating whether clicking on the checkbox will post the page.

access:

public

Parameters:

boolean

$value

whether clicking on the checkbox will post the page.

[ Top ]

method setChecked [line 209]

void setChecked(
boolean
$value)

Sets a value indicating whether the checkbox is to be checked or not.

access:

public

Parameters:

boolean

$value

whether the checkbox is to be checked or not.

[ Top ]

method setEncodeText [line 173]

void setEncodeText(
boolean
$value)

Sets the value indicating whether the text should be HTML encoded before rendering

access:

public

Parameters:

boolean

$value

whether the text should be HTML encoded before rendering

[ Top ]

method setText [line 156]

void setText(
string
$value)

Sets the text caption of the checkbox.

access:

public

Parameters:

string

$value

the text caption to be set

[ Top ]

method setTextAlign [line 190]

void setTextAlign(
string
$value)

Sets the text alignment of the checkbox

access:

public

Parameters:

string

$value

either 'Left' or 'Right'

[ Top ]