PRADO Component Framework for PHP 5
  • Home
  • About
  • Testimonials
  • Demos
  • Download
  • Documentation
  • Forum
  • Development
  • Tutorials
  • Class Docs
  • API Manual
  • Wiki

Packages

  • None
  • System
    • Caching
    • Collections
    • Data
      • ActiveRecord
        • Relations
        • Scaffold
          • InputBuilder
      • Commom
        • Sqlite
      • Common
        • Mssql
        • Mysql
        • Oracle
        • Pgsql
        • Sqlite
      • DataGateway
      • SqlMap
        • Configuration
        • Statements
    • Exceptions
    • I18N
    • IO
    • Security
    • Util
    • Web
      • Javascripts
      • Services
      • UI
        • ActiveControls
        • WebControls
    • Xml
  • Wsat
    • pages
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class TDataListItemRenderer

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.

TComponent
Extended by TApplicationComponent
Extended by TControl implements IRenderable, IBindable
Extended by TCompositeControl implements INamingContainer
Extended by TTemplateControl
Extended by TDataRenderer implements IDataRenderer
Extended by TItemDataRenderer implements IItemDataRenderer
Extended by TDataListItemRenderer implements IStyleable
Package: System\Web\UI\WebControls
Copyright: Copyright © 2005-2014 PradoSoft
License: http://www.pradosoft.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.1.0
Located at Web/UI/WebControls/TDataListItemRenderer.php
Methods summary
protected TStyle
# createStyle( )

Creates a style object to be used by the control. This method may be overriden by controls to provide customized style.

Creates a style object to be used by the control. This method may be overriden by controls to provide customized style.

Returns

TStyle
public boolean
# getHasStyle( )

Returns

boolean
whether the control has defined any style information

Implementation of

IStyleable::getHasStyle()
public TStyle
# getStyle( )

Returns

TStyle
the object representing the css style of the control

Implementation of

IStyleable::getStyle()
public
# clearStyle( )

Removes all style data.

Removes all style data.

Implementation of

IStyleable::clearStyle()
public boolean
# bubbleEvent( TControl $sender, TEventParameter $param )

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

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

Parameters

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

Returns

boolean
whether the event bubbling should stop here.

Overrides

TControl::bubbleEvent()
protected string
# getTagName( )

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.

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.

Returns

string
tag name of the control to be rendered
protected
# addAttributesToRender( THtmlWriter $writer )

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.

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.

Parameters

$writer
THtmlWriter
the writer used for the rendering purpose
public
# render( THtmlWriter $writer )

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

  • TDataListItemRenderer::renderBeginTag()
  • TDataListItemRenderer::renderContents()
  • TDataListItemRenderer::renderEndTag()

If the getTagName TagName is empty, only TDataListItemRenderer::renderContents() is invoked.

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

  • TDataListItemRenderer::renderBeginTag()
  • TDataListItemRenderer::renderContents()
  • TDataListItemRenderer::renderEndTag()

If the getTagName TagName is empty, only TDataListItemRenderer::renderContents() is invoked.

Parameters

$writer
THtmlWriter
the writer used for the rendering purpose

Overrides

TControl::render()
public
# renderBeginTag( THtmlWriter $writer )

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

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

Parameters

$writer
THtmlWriter
the writer used for the rendering purpose
public
# renderContents( THtmlWriter $writer )

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.

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.

Parameters

$writer
THtmlWriter
the writer used for the rendering purpose
public
# renderEndTag( THtmlWriter $writer )

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

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

Parameters

$writer
THtmlWriter
the writer used for the rendering purpose
Methods inherited from TItemDataRenderer
getItemIndex(), getItemType(), setItemIndex(), setItemType()
Methods inherited from TDataRenderer
getData(), setData()
Methods inherited from TTemplateControl
createChildControls(), getIsSourceTemplateControl(), getMaster(), getMasterClass(), getTemplate(), getTemplateDirectory(), initRecursive(), injectContent(), loadTemplate(), registerContent(), registerContentPlaceHolder(), setMasterClass(), setTemplate()
Methods inherited from TControl
__construct(), __get(), addParsedObject(), addToPostDataLoader(), addedControl(), applyStyleSheetSkin(), autoBindProperty(), autoDataBindProperties(), bindProperty(), broadcastEvent(), clearChildState(), clearControlState(), clearNamingContainer(), clearViewState(), convertUniqueIdToClientId(), createControlCollection(), dataBind(), dataBindChildren(), dataBindProperties(), ensureChildControls(), findControl(), findControlsByID(), findControlsByType(), focus(), getAdapter(), getAllowChildControls(), getAttribute(), getAttributes(), getChildControlsCreated(), getClientID(), getControlStage(), getControlState(), getControls(), getCustomData(), getEnableTheming(), getEnableViewState(), getEnabled(), getHasAdapter(), getHasAttributes(), getHasChildInitialized(), getHasControls(), getHasInitialized(), getHasLoaded(), getHasLoadedPostData(), getHasPreRendered(), getID(), getIsSkinApplied(), getNamingContainer(), getPage(), getParent(), getRegisteredObject(), getSkinID(), getSourceTemplateControl(), getTemplateControl(), getUniqueID(), getViewState(), getVisible(), hasAttribute(), isDescendentOf(), isObjectRegistered(), loadRecursive(), loadState(), loadStateRecursive(), onDataBinding(), onInit(), onLoad(), onPreRender(), onUnload(), preRenderRecursive(), raiseBubbleEvent(), registerObject(), removeAttribute(), removedControl(), renderChildren(), renderControl(), saveState(), saveStateRecursive(), setAdapter(), setAttribute(), setChildControlsCreated(), setControlStage(), setControlState(), setCustomData(), setEnableTheming(), setEnableViewState(), setEnabled(), setID(), setPage(), setSkinID(), setTemplateControl(), setViewState(), setVisible(), trackViewState(), traverseChildControls(), unbindProperty(), unloadRecursive(), unregisterObject()
Methods inherited from TApplicationComponent
getApplication(), getRequest(), getResponse(), getService(), getSession(), getUser(), publishAsset(), publishFilePath()
Methods inherited from TComponent
__call(), __destruct(), __isset(), __set(), __sleep(), __unset(), __wakeup(), asa(), attachBehavior(), attachBehaviors(), attachClassBehavior(), attachEventHandler(), canGetProperty(), canSetProperty(), clearBehaviors(), createdOnTemplate(), detachBehavior(), detachBehaviors(), detachClassBehavior(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), evaluateStatements(), fxAttachClassBehavior(), fxDetachClassBehavior(), getAutoGlobalListen(), getBehaviorsEnabled(), getClassHierarchy(), getEventHandlers(), getListeningToGlobalEvents(), getSubProperty(), hasEvent(), hasEventHandler(), hasProperty(), isa(), listen(), raiseEvent(), setSubProperty(), unlisten()
Constants inherited from TTemplateControl
EXT_TEMPLATE
Constants inherited from TControl
AUTOMATIC_ID_PREFIX, CLIENT_ID_SEPARATOR, CS_CHILD_INITIALIZED, CS_CONSTRUCTED, CS_INITIALIZED, CS_LOADED, CS_PRERENDERED, CS_STATE_LOADED, ID_FORMAT, ID_SEPARATOR, IS_CHILD_CREATED, IS_CREATING_CHILD, IS_DISABLE_THEMING, IS_DISABLE_VIEWSTATE, IS_ID_SET, IS_SKIN_APPLIED, IS_STYLESHEET_APPLIED, RF_ADAPTER, RF_AUTO_BINDINGS, RF_CHILD_STATE, RF_CONTROLS, RF_CONTROLSTATE, RF_DATA_BINDINGS, RF_EVENTS, RF_NAMED_CONTROLS, RF_NAMED_CONTROLS_ID, RF_NAMED_OBJECTS, RF_SKIN_ID
Constants inherited from TComponent
GLOBAL_RAISE_EVENT_LISTENER
Terms of Service | Contact Us
PRADO v3.2.4 API Manual API documentation generated by ApiGen 2.8.0
Copyright © 2006-2014 by the PRADO Group.
Powered by PRADO