Class: TBaseDataList

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

Class Overview

TComponent
   |
   --TControl
      |
      --TWebControl
         |
         --TBaseDataList

TBaseDataList class

Class Details

[line 49]
TBaseDataList class

TBaseDataList is the base class for data listing controls including TDataList and TDataGrid.

Namespace: System.Web.UI.WebControls

Properties

HorizontalAlign, string (Right, Center, Left, Justify, NotSet), default=NotSet, kept in viewstate
Gets or sets the horizontal alignment of a data listing control within its container.
CellPadding, integer, default=-1, kept in viewstate
Gets or sets the cellpadding for the table keeping the checkbox list.
CellSpacing, integer, default=-1, kept in viewstate
Gets or sets the amount of space between cells.
GridLines, string (Both, Vertical, Horizontal, None), default=Both, kept in viewstate
Gets or sets a value specifying whether the border between the cells is displayed.
DataSource, Traversable|array
Gets or sets the list of values to be populated the items within the control
DataKeyField, string, kept in viewstate
Gets or sets the key field in the data source specified by the DataSource property.
DataKeys, array, read-only
Gets a list of key values in a data listing control.

Events

OnSelectionChanged, Occurs when a different item is selected in a data listing control between postbacks.

abstract:
version:	$Revision: 1.6 $ $Date: 2005/04/01 02:23:43 $
author:	Qiang Xue <qiang.xue@gmail.com>

[ Top ]

Variables

$datasource

Methods

Child classes:

TDataGrid: TDataGrid class

TDataList: TDataList 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 Variables

$datasource = null

[line 51]

access:

protected

Type:

mixed

[ Top ]

Class Methods

method getCellPadding [line 156]

integer getCellPadding(
)

return:	the cellpadding for the table keeping the data listing items.
access:	public

[ Top ]

method getCellSpacing [line 139]

integer getCellSpacing(
)

return:	the cellspacing for the table keeping the data listing items.
access:	public

[ Top ]

method getDataKeyField [line 77]

string getDataKeyField(
)

return:	the field of the data source that provides the keys of the list items.
access:	public

[ Top ]

method getDataKeys [line 93]

array getDataKeys(
)

return:	the keys used in the data listing control.
access:	public

Overridden in child classes as:

TDataGrid::getDataKeys()

TDataList::getDataKeys()

[ Top ]

method getDataSource [line 55]

mixed getDataSource(
)

return:	the data source that populates the items of the data listing control.
access:	public

Overridden in child classes as:

TDataGrid::getDataSource()

TDataList::getDataSource()

[ Top ]

method getGridLines [line 120]

string getGridLines(
)

return:	the value specifying whether the border between the cells is displayed.
access:	public

[ Top ]

method getHorizontalAlign [line 101]

string getHorizontalAlign(
)

return:	the horizontal alignment of a data listing control within its container.
access:	public

[ Top ]

method setCellPadding [line 165]

void setCellPadding(
integer
$value)

Sets the cellpadding for the table keeping the data listing items.

access:

public

Parameters:

integer

$value

the cellpadding for the table keeping the data listing items.

[ Top ]

method setCellSpacing [line 148]

void setCellSpacing(
integer
$value)

Sets the cellspacing for the table keeping the data listing items.

access:

public

Parameters:

integer

$value

the cellspacing for the table keeping the data listing items.

[ Top ]

method setDataKeyField [line 85]

void setDataKeyField(
string
$value)

access:

public

Parameters:

string

$value

the field of the data source that provides the keys of the list items.

[ Top ]

method setDataSource [line 64]

void setDataSource(
mixed
$value)

Sets the data source that populates the items of the data listing control.

access:

public

Overridden in child classes as:

TDataGrid::setDataSource(): Sets the data source.

TDataList::setDataSource(): Sets the data source.

Parameters:

mixed

$value

the data source.

[ Top ]

method setGridLines [line 129]

void setGridLines(
string
$value)

Sets the value specifying whether the border between the cells is displayed.

access:

public

Parameters:

string

$value

Acceptable values include None, Horizontal, Vertical, Both

[ Top ]

method setHorizontalAlign [line 110]

void setHorizontalAlign(
string
$value)

Sets the horizontal alignment of a data listing control within its container.

access:

public

Parameters:

string

$value

Acceptable values include Left, Justify, Center, Right, NotSet

[ Top ]