Class TBulletedList

Description

Implements interfaces:

TBulletedList class

TBulletedList displays items in a bullet format. The bullet style is specified by BulletStyle. When the style is 'CustomImage', the setBackImageUrl specifies the image used as bullets.

TBulletedList displays the item texts in three different modes, specified via DisplayMode. When the mode is Text, the item texts are displayed as static texts; When the mode is 'HyperLink', each item is displayed as a hyperlink whose URL is given by the item value, and the Target property can be used to specify the target browser window; When the mode is 'LinkButton', each item is displayed as a link button which posts back to the page if a user clicks on that and the event OnClick will be raised under such a circumstance.

  • author: Qiang Xue <qiang.xue@gmail.com>
  • version: $Id: TBulletedList.php 2996 2011-06-20 15:24:57Z ctrlaltca@gmail.com $
  • since: 3.0

Located in /Web/UI/WebControls/TBulletedList.php (line 40)

TComponent
   |
   --TApplicationComponent
      |
      --TControl
         |
         --TWebControl
            |
            --TDataBoundControl
               |
               --TListControl
                  |
                  --TBulletedList
Method Summary
string getBulletImageUrl ()
string getClientClassName ()
string getTagName ()
string getTarget ()
void render (THtmlWriter $writer)
void renderBulletText (THtmlWriter $writer, TListItem $item, integer $index)
void renderContents (THtmlWriter $writer)
void renderHyperLinkItem ( $writer,  $item,  $index)
void renderLinkButtonItem ( $writer,  $item,  $index)
void renderTextItem ( $writer,  $item,  $index)
void setAutoPostBack ( $value)
void setBulletImageUrl (string $value)
void setBulletStyle (TBulletStyle $value)
void setFirstBulletNumber (integer $value)
void setSelectedIndex ( $index)
void setSelectedIndices ( $indices)
void setSelectedValue ( $value)
void setSelectedValues ( $values)
void setTarget (string $value)
Variables

Inherited Variables

Inherited from TWebControl

TWebControl::$_decorator
Methods
addAttributesToRender (line 101)

Adds attribute name-value pairs to renderer.

This overrides the parent implementation with additional bulleted list specific attributes.

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

Redefinition of:
TListControl::addAttributesToRender()
Adds attributes to renderer.
canCauseValidation (line 362)
  • access: protected
void canCauseValidation ()
getBulletImageUrl (line 152)
  • return: image URL used for bullets when BulletStyle is 'CustomImage'.
  • access: public
string getBulletImageUrl ()
getBulletStyle (line 168)
  • return: style of bullets. Defaults to TBulletStyle::NotSet.
  • access: public
TBulletStyle getBulletStyle ()
getClientClassName (line 91)

Gets the name of the javascript class responsible for performing postback for this control.

This method overrides the parent implementation.

  • return: the javascript class name
  • access: protected
string getClientClassName ()

Redefinition of:
TListControl::getClientClassName()
Gets the name of the javascript class responsible for performing postback for this control.
getDisplayMode (line 184)
  • return: display mode of the list. Defaults to TBulletedListDisplayMode::Text.
  • access: public
TBulletedListDisplayMode getDisplayMode ()
getFirstBulletNumber (line 202)
  • return: starting index when BulletStyle is one of the following: 'Numbered', 'LowerAlpha', 'UpperAlpha', 'LowerRoman', 'UpperRoman'. Defaults to 1.
  • access: public
integer getFirstBulletNumber ()
getPostBackOptions (line 351)
  • return: postback options used for linkbuttons.
  • access: protected
array getPostBackOptions ()

Redefinition of:
TListControl::getPostBackOptions()
getTagName (line 72)
  • return: tag name of the bulleted list
  • access: protected
string getTagName ()

Redefinition of:
TListControl::getTagName()
getTarget (line 232)
  • return: the target window or frame to display the Web page content linked to when DisplayMode is 'HyperLink' and one of the hyperlinks is clicked.
  • access: public
string getTarget ()
onClick (line 222)

Raises 'OnClick' event.

This method is invoked when the DisplayMode is 'LinkButton' and end-users click on one of the buttons.

  • access: public
void onClick (TBulletedListEventParameter $param)
raisePostBackEvent (line 62)

Raises the postback event.

This method is required by IPostBackEventHandler interface. If CausesValidation is true, it will invoke the page's TPage::validate method first. It will raise OnClick events. This method is mainly used by framework and control developers.

  • access: public
void raisePostBackEvent (TEventParameter $param)
render (line 251)

Renders the control.

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

Redefinition of:
TWebControl::render()
Renders the control.
renderBulletText (line 283)

Renders each item

  • access: protected
void renderBulletText (THtmlWriter $writer, TListItem $item, integer $index)
  • THtmlWriter $writer: writer for the rendering purpose
  • TListItem $item: item to be rendered
  • integer $index: index of the item being rendered
renderContents (line 261)

Renders the body contents.

  • access: public
void renderContents (THtmlWriter $writer)
  • THtmlWriter $writer: the writer for the rendering purpose.

Redefinition of:
TListControl::renderContents()
Renders body content of the list control.
renderHyperLinkItem (line 312)
  • access: protected
void renderHyperLinkItem ( $writer,  $item,  $index)
  • $writer
  • $item
  • $index
renderLinkButtonItem (line 329)
  • access: protected
void renderLinkButtonItem ( $writer,  $item,  $index)
  • $writer
  • $item
  • $index
renderTextItem (line 299)
  • access: protected
void renderTextItem ( $writer,  $item,  $index)
  • $writer
  • $item
  • $index
setAutoPostBack (line 372)
  • throws: TNotSupportedException if this method is invoked
  • access: public
void setAutoPostBack ( $value)
  • $value

Redefinition of:
TListControl::setAutoPostBack()
Sets the value indicating if postback automatically.
setBulletImageUrl (line 160)
  • access: public
void setBulletImageUrl (string $value)
  • string $value: image URL used for bullets when BulletStyle is 'CustomImage'.
setBulletStyle (line 176)
  • access: public
void setBulletStyle (TBulletStyle $value)
setDisplayMode (line 192)
  • return: display mode of the list.
  • access: public
TBulletedListDisplayMode setDisplayMode ( $value)
  • $value
setFirstBulletNumber (line 211)
  • access: public
void setFirstBulletNumber (integer $value)
  • integer $value: starting index when BulletStyle is one of the following: 'Numbered', 'LowerAlpha', 'UpperAlpha', 'LowerRoman', 'UpperRoman'.
setSelectedIndex (line 380)
  • throws: TNotSupportedException if this method is invoked
  • access: public
void setSelectedIndex ( $index)
  • $index

Redefinition of:
TListControl::setSelectedIndex()
setSelectedIndices (line 388)
  • throws: TNotSupportedException if this method is invoked
  • access: public
void setSelectedIndices ( $indices)
  • $indices

Redefinition of:
TListControl::setSelectedIndices()
setSelectedValue (line 396)
  • throws: TNotSupportedException if this method is invoked
  • access: public
void setSelectedValue ( $value)
  • $value

Redefinition of:
TListControl::setSelectedValue()
Sets selection by item value.
setSelectedValues (line 404)
  • throws: TNotSupportedException if this method is invoked
  • access: public
void setSelectedValues ( $values)
  • $values

Redefinition of:
TListControl::setSelectedValues()
setTarget (line 242)
  • access: public
void setTarget (string $value)
  • string $value: the target window or frame to display the Web page content linked to when DisplayMode is 'HyperLink' and one of the hyperlinks is clicked.

Inherited Methods

Inherited From TListControl

TListControl::addAttributesToRender()
TListControl::addParsedObject()
TListControl::clearSelection()
TListControl::createListItemCollection()
TListControl::formatDataValue()
TListControl::getAppendDataBoundItems()
TListControl::getAutoPostBack()
TListControl::getCausesValidation()
TListControl::getClientClassName()
TListControl::getData()
TListControl::getDataGroupField()
TListControl::getDataTextField()
TListControl::getDataTextFormatString()
TListControl::getDataValueField()
TListControl::getEnableClientScript()
TListControl::getHasItems()
TListControl::getIsMultiSelect()
TListControl::getItemCount()
TListControl::getItems()
TListControl::getPostBackOptions()
TListControl::getPromptText()
TListControl::getPromptValue()
TListControl::getSelectedIndex()
TListControl::getSelectedIndices()
TListControl::getSelectedItem()
TListControl::getSelectedValue()
TListControl::getSelectedValues()
TListControl::getTagName()
TListControl::getText()
TListControl::getValidationGroup()
TListControl::loadState()
TListControl::onSelectedIndexChanged()
TListControl::onTextChanged()
TListControl::performDataBinding()
TListControl::renderClientControlScript()
TListControl::renderContents()
TListControl::renderPrompt()
TListControl::saveState()
TListControl::setAppendDataBoundItems()
TListControl::setAutoPostBack()
TListControl::setCausesValidation()
TListControl::setData()
TListControl::setDataGroupField()
TListControl::setDataTextField()
TListControl::setDataTextFormatString()
TListControl::setDataValueField()
TListControl::setEnableClientScript()
TListControl::setPromptText()
TListControl::setPromptValue()
TListControl::setSelectedIndex()
TListControl::setSelectedIndices()
TListControl::setSelectedValue()
TListControl::setSelectedValues()
TListControl::setText()
TListControl::setValidationGroup()

Inherited From TDataBoundControl

TDataBoundControl::createPagedDataSource()
TDataBoundControl::dataBind()
TDataBoundControl::dataSourceViewChanged()
TDataBoundControl::determineDataSource()
TDataBoundControl::ensureDataBound()
TDataBoundControl::getAllowCustomPaging()
TDataBoundControl::getAllowPaging()
TDataBoundControl::getCurrentPageIndex()
TDataBoundControl::getDataMember()
TDataBoundControl::getDataSource()
TDataBoundControl::getDataSourceID()
TDataBoundControl::getDataSourceView()
TDataBoundControl::getInitialized()
TDataBoundControl::getIsDataBound()
TDataBoundControl::getPageCount()
TDataBoundControl::getPageSize()
TDataBoundControl::getRequiresDataBinding()
TDataBoundControl::getSelectParameters()
TDataBoundControl::getUsingDataSourceID()
TDataBoundControl::getVirtualItemCount()
TDataBoundControl::onDataBound()
TDataBoundControl::onDataSourceChanged()
TDataBoundControl::onInit()
TDataBoundControl::onPreRender()
TDataBoundControl::pagePreLoad()
TDataBoundControl::performDataBinding()
TDataBoundControl::setAllowCustomPaging()
TDataBoundControl::setAllowPaging()
TDataBoundControl::setCurrentPageIndex()
TDataBoundControl::setDataMember()
TDataBoundControl::setDataSource()
TDataBoundControl::setDataSourceID()
TDataBoundControl::setInitialized()
TDataBoundControl::setIsDataBound()
TDataBoundControl::setPageSize()
TDataBoundControl::setRequiresDataBinding()
TDataBoundControl::setVirtualItemCount()
TDataBoundControl::validateDataSource()

Inherited From TWebControl

TWebControl::addAttributesToRender()
TWebControl::clearStyle()
TWebControl::copyBaseAttributes()
TWebControl::createStyle()
TWebControl::getAccessKey()
TWebControl::getBackColor()
TWebControl::getBorderColor()
TWebControl::getBorderStyle()
TWebControl::getBorderWidth()
TWebControl::getCssClass()
TWebControl::getDecorator()
TWebControl::getDisplay()
TWebControl::getEnsureId()
TWebControl::getFont()
TWebControl::getForeColor()
TWebControl::getHasStyle()
TWebControl::getHeight()
TWebControl::getStyle()
TWebControl::getTabIndex()
TWebControl::getTagName()
TWebControl::getToolTip()
TWebControl::getWidth()
TWebControl::onPreRender()
TWebControl::render()
TWebControl::renderBeginTag()
TWebControl::renderContents()
TWebControl::renderEndTag()
TWebControl::setAccessKey()
TWebControl::setBackColor()
TWebControl::setBorderColor()
TWebControl::setBorderStyle()
TWebControl::setBorderWidth()
TWebControl::setCssClass()
TWebControl::setDisplay()
TWebControl::setEnsureId()
TWebControl::setForeColor()
TWebControl::setHeight()
TWebControl::setStyle()
TWebControl::setTabIndex()
TWebControl::setToolTip()
TWebControl::setWidth()

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::getIsSkinApplied()
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::__call()
TComponent::__get()
TComponent::__set()
TComponent::__sleep()
TComponent::__wakeup()
Class Constants

Documentation generated on Mon, 25 Jun 2012 14:37:23 +0200 by phpDocumentor 1.4.3