Class TDataListItemRenderer

Description

Implements interfaces:

TDataListItemRenderer class

TDataListItemRenderer can be used as a convenient base class to define an item renderer class specific for TDataList.

TDataListItemRenderer extends TItemDataRenderer and implements the bubbling scheme for the OnCommand event of data list items.

TDataListItemRenderer also implements the IStyleable interface, which allows TDataList to apply CSS styles to the renders.

  • since: 3.1.0
  • version: $Id: TDataListItemRenderer.php 2359 2008-01-09 20:03:41Z xue $
  • author: Qiang Xue <qiang.xue@gmail.com>

Located in /Web/UI/WebControls/TDataListItemRenderer.php (line 33)

TComponent
   |
   --TApplicationComponent
      |
      --TControl
         |
         --TCompositeControl
            |
            --TTemplateControl
               |
               --TDataRenderer
                  |
                  --TItemDataRenderer
                     |
                     --TDataListItemRenderer
Method Summary
boolean bubbleEvent (TControl $sender, TEventParameter $param)
void clearStyle ()
boolean getHasStyle ()
string getTagName ()
void render (THtmlWriter $writer)
void renderBeginTag (THtmlWriter $writer)
void renderContents (THtmlWriter $writer)
void renderEndTag (THtmlWriter $writer)
Methods
addAttributesToRender (line 112)

Adds attribute name-value pairs to renderer.

By default, this method renders the style string. The method can be overriden to provide customized attribute rendering.

  • access: protected
void addAttributesToRender (THtmlWriter $writer)
  • THtmlWriter $writer: the writer used for the rendering purpose
bubbleEvent (line 83)

This method overrides parent's implementation by wrapping event parameter for OnCommand event with item information.

  • return: whether the event bubbling should stop here.
  • access: public
boolean bubbleEvent (TControl $sender, TEventParameter $param)

Redefinition of:
TControl::bubbleEvent()
This method responds to a bubbled event.
clearStyle (line 71)

Removes all style data.

  • access: public
void clearStyle ()
createStyle (line 40)

Creates a style object to be used by the control.

This method may be overriden by controls to provide customized style.

  • access: protected
TStyle createStyle ()
getHasStyle (line 48)
  • return: whether the control has defined any style information
  • access: public
boolean getHasStyle ()
getStyle (line 56)
  • return: the object representing the css style of the control
  • access: public
TStyle getStyle ()
getTagName (line 101)

Returns the tag name used for this control.

By default, the tag name is 'span'. You can override this method to provide customized tag names. If the tag name is empty, the opening and closing tag will NOT be rendered.

  • return: tag name of the control to be rendered
  • access: protected
string getTagName ()
render (line 128)

Renders the control.

This method overrides the parent implementation by replacing it with the following sequence:

If the TagName is empty, only renderContents is invoked.

  • access: public
void render (THtmlWriter $writer)
  • THtmlWriter $writer: the writer used for the rendering purpose

Redefinition of:
TControl::render()
Renders the control.
renderBeginTag (line 145)

Renders the openning tag for the control (including attributes) This method is invoked when getTagName is not empty.

  • access: public
void renderBeginTag (THtmlWriter $writer)
  • THtmlWriter $writer: the writer used for the rendering purpose
renderContents (line 157)

Renders the body content enclosed between the control tag.

By default, child controls and text strings will be rendered. You can override this method to provide customized content rendering.

  • access: public
void renderContents (THtmlWriter $writer)
  • THtmlWriter $writer: the writer used for the rendering purpose
renderEndTag (line 167)

Renders the closing tag for the control This method is invoked when getTagName is not empty.

  • access: public
void renderEndTag (THtmlWriter $writer)
  • THtmlWriter $writer: the writer used for the rendering purpose

Inherited Methods

Inherited From TItemDataRenderer

TItemDataRenderer::getItemIndex()
TItemDataRenderer::getItemType()
TItemDataRenderer::setItemIndex()
TItemDataRenderer::setItemType()

Inherited From TDataRenderer

TDataRenderer::getData()
TDataRenderer::setData()

Inherited From TTemplateControl

TTemplateControl::createChildControls()
TTemplateControl::getIsSourceTemplateControl()
TTemplateControl::getMaster()
TTemplateControl::getMasterClass()
TTemplateControl::getTemplate()
TTemplateControl::getTemplateDirectory()
TTemplateControl::initRecursive()
TTemplateControl::injectContent()
TTemplateControl::loadTemplate()
TTemplateControl::registerContent()
TTemplateControl::registerContentPlaceHolder()
TTemplateControl::setMasterClass()
TTemplateControl::setTemplate()

Inherited From TCompositeControl

TCompositeControl::initRecursive()

Inherited From TControl

TControl::__construct()
TControl::addedControl()
TControl::addParsedObject()
TControl::addToPostDataLoader()
TControl::applyStyleSheetSkin()
TControl::autoBindProperty()
TControl::autoDataBindProperties()
TControl::bindProperty()
TControl::broadcastEvent()
TControl::bubbleEvent()
TControl::clearChildState()
TControl::clearControlState()
TControl::clearNamingContainer()
TControl::clearViewState()
TControl::convertUniqueIdToClientId()
TControl::createChildControls()
TControl::createControlCollection()
TControl::dataBind()
TControl::dataBindChildren()
TControl::dataBindProperties()
TControl::ensureChildControls()
TControl::findControl()
TControl::findControlsByID()
TControl::findControlsByType()
TControl::focus()
TControl::getAdapter()
TControl::getAllowChildControls()
TControl::getAttribute()
TControl::getAttributes()
TControl::getChildControlsCreated()
TControl::getClientID()
TControl::getControls()
TControl::getControlStage()
TControl::getControlState()
TControl::getCustomData()
TControl::getEnabled()
TControl::getEnableTheming()
TControl::getEnableViewState()
TControl::getHasAdapter()
TControl::getHasAttributes()
TControl::getHasChildInitialized()
TControl::getHasControls()
TControl::getHasInitialized()
TControl::getHasLoaded()
TControl::getHasLoadedPostData()
TControl::getHasPreRendered()
TControl::getID()
TControl::getNamingContainer()
TControl::getPage()
TControl::getParent()
TControl::getRegisteredObject()
TControl::getSkinID()
TControl::getSourceTemplateControl()
TControl::getTemplateControl()
TControl::getUniqueID()
TControl::getViewState()
TControl::getVisible()
TControl::hasAttribute()
TControl::initRecursive()
TControl::isDescendentOf()
TControl::isObjectRegistered()
TControl::loadRecursive()
TControl::loadState()
TControl::loadStateRecursive()
TControl::onDataBinding()
TControl::onInit()
TControl::onLoad()
TControl::onPreRender()
TControl::onUnload()
TControl::preRenderRecursive()
TControl::raiseBubbleEvent()
TControl::registerObject()
TControl::removeAttribute()
TControl::removedControl()
TControl::render()
TControl::renderChildren()
TControl::renderControl()
TControl::saveState()
TControl::saveStateRecursive()
TControl::setAdapter()
TControl::setAttribute()
TControl::setChildControlsCreated()
TControl::setControlStage()
TControl::setControlState()
TControl::setCustomData()
TControl::setEnabled()
TControl::setEnableTheming()
TControl::setEnableViewState()
TControl::setID()
TControl::setPage()
TControl::setSkinID()
TControl::setTemplateControl()
TControl::setViewState()
TControl::setVisible()
TControl::trackViewState()
TControl::traverseChildControls()
TControl::unbindProperty()
TControl::unloadRecursive()
TControl::unregisterObject()
TControl::__get()

Inherited From TApplicationComponent

TApplicationComponent::getApplication()
TApplicationComponent::getRequest()
TApplicationComponent::getResponse()
TApplicationComponent::getService()
TApplicationComponent::getSession()
TApplicationComponent::getUser()
TApplicationComponent::publishAsset()
TApplicationComponent::publishFilePath()

Inherited From TComponent

TComponent::addParsedObject()
TComponent::attachEventHandler()
TComponent::canGetProperty()
TComponent::canSetProperty()
TComponent::createdOnTemplate()
TComponent::detachEventHandler()
TComponent::evaluateExpression()
TComponent::evaluateStatements()
TComponent::getEventHandlers()
TComponent::getSubProperty()
TComponent::hasEvent()
TComponent::hasEventHandler()
TComponent::hasProperty()
TComponent::raiseEvent()
TComponent::setSubProperty()
TComponent::__get()
TComponent::__set()
Class Constants

Documentation generated on Mon, 21 Apr 2008 11:34:38 -0400 by phpDocumentor 1.3.0RC4