System.Web.UI.WebControls
[ class tree: System.Web.UI.WebControls ] [ index: System.Web.UI.WebControls ] [ all elements ]

Class: TDataListItem

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

Class Overview

TComponent
   |
   --TControl
      |
      --TWebControl
         |
         --TDataListItem

TDataListItem class

Class Details

[line 42]
TDataListItem class

A TDataListItem control represents an item in the TDataList control, such as heading section, footer section, or a data item. The data items are stored in the Items property of TDataList control. The index and data value of the item can be accessed via Index and Data properties, respectively.

Namespace: System.Web.UI.WebControls

Properties

  • ItemIndex, mixed
    Gets or sets the index of the data item in the Items collection of datalist.
  • Data, mixed
    Gets or sets the value of the data item.
  • Type, mixed
    Gets or sets the type of the item (Header, Footer, Item, AlternatingItem, EditItem, SelectedItem, Separator)




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


[ Top ]

Constants

Methods


Inherited Variables

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 92]

TDataListItem __construct( )

Constructor.

Initializes the type to 'Item'.




access:  public


Overrides TControl::__construct() (Constructor.)

[ Top ]

method getAttributesToRender [line 179]

ArrayObject getAttributesToRender( )

Returns the attributes to be rendered.



return:  attributes to be rendered
access:  protected


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

[ Top ]

method getData [line 118]

mixed getData( )



return:  the value of the data item
access:  public


[ Top ]

method getItemIndex [line 101]

mixed getItemIndex( )



return:  the index of the data item
access:  public


[ Top ]

method getType [line 135]

string getType( )



return:  the item type
access:  public


[ Top ]

method onBubbleEvent [line 159]

boolean onBubbleEvent( TControl $sender, TEventParameter $param)

Handles OnBubbleEvent.

This method overrides parent's implementation to bubble OnItemCommand event if an OnCommand event is bubbled from a child control. This method should only be used by control developers.




return:  whether the event bubbling should stop here.
access:  protected


Overrides TControl::onBubbleEvent() (This method responds to a bubbled event.)

Parameters:

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

[ Top ]

method renderAttributes [line 192]

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

Renders the attributes.



return:  the rendering result
access:  public
see:  TDataListItem::getAttributesToRender()


Overrides TControl::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 setData [line 127]

void setData( mixed $value)

Sets the value of the data item



access:  public


Parameters:

mixed   $value   the value of the data item

[ Top ]

method setItemIndex [line 110]

void setItemIndex( mixed $value)

Sets the index of the data item



access:  public


Parameters:

mixed   $value   the data item index

[ Top ]

method setType [line 144]

void setType( string $value)

Sets the item type



access:  public


Parameters:

string   $value   the item type

[ Top ]


Class Constants

TYPE_ALTERNATING_ITEM = 'AlternatingItem'

[line 59]

Alternating data item


[ Top ]

TYPE_EDIT_ITEM = 'EditItem'

[line 67]

Edit item


[ Top ]

TYPE_FOOTER = 'Footer'

[line 51]

Footer


[ Top ]

TYPE_HEADER = 'Header'

[line 47]

Header


[ Top ]

TYPE_ITEM = 'Item'

[line 55]

Data item


[ Top ]

TYPE_SELECTED_ITEM = 'SelectedItem'

[line 63]

Selected item


[ Top ]

TYPE_SEPARATOR = 'Separator'

[line 71]

Separator


[ Top ]



© 2004-2005 PRADO Software Group. All Rights Reserved.