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 TBulletedList

TBulletedList class

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

TBulletedList displays the item texts in three different modes, specified via setDisplayMode 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 setTarget 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 OnClick will be raised under such a circumstance.

TComponent
Extended by TApplicationComponent
Extended by TControl implements IRenderable, IBindable
Extended by TWebControl implements IStyleable
Extended by TDataBoundControl
Extended by TListControl implements IDataRenderer
Extended by TBulletedList implements IPostBackEventHandler
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.0
Located at Web/UI/WebControls/TBulletedList.php
Methods summary
public
# raisePostBackEvent( TEventParameter $param )

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

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

Parameters

$param
TEventParameter
the event parameter

Implementation of

IPostBackEventHandler::raisePostBackEvent()
protected string
# getTagName( )

Returns

string
tag name of the bulleted list

Overrides

TListControl::getTagName()
protected string
# getClientClassName( )

Gets the name of the javascript class responsible for performing postback for this control. This method overrides the parent implementation.

Gets the name of the javascript class responsible for performing postback for this control. This method overrides the parent implementation.

Returns

string
the javascript class name

Overrides

TListControl::getClientClassName()
protected
# addAttributesToRender( THtmlWriter $writer )

Adds attribute name-value pairs to renderer. This overrides the parent implementation with additional bulleted list specific attributes.

Adds attribute name-value pairs to renderer. This overrides the parent implementation with additional bulleted list specific attributes.

Parameters

$writer
THtmlWriter
the writer used for the rendering purpose

Overrides

TListControl::addAttributesToRender()
public string
# getBulletImageUrl( )

Returns

string
image URL used for bullets when getBulletStyle BulletStyle is 'CustomImage'.
public
# setBulletImageUrl( string $value )

Parameters

$value
string
image URL used for bullets when getBulletStyle BulletStyle is 'CustomImage'.
public TBulletStyle
# getBulletStyle( )

Returns

TBulletStyle
style of bullets. Defaults to TBulletStyle::NotSet.
public
# setBulletStyle( TBulletStyle $value )

Parameters

$value
TBulletStyle
style of bullets.
public TBulletedListDisplayMode
# getDisplayMode( )

Returns

TBulletedListDisplayMode
display mode of the list. Defaults to TBulletedListDisplayMode::Text.
public TBulletedListDisplayMode
# setDisplayMode( mixed $value )

Returns

TBulletedListDisplayMode
display mode of the list.
public integer
# getFirstBulletNumber( )

Returns

integer
starting index when getBulletStyle BulletStyle is one of the following: 'Numbered', 'LowerAlpha', 'UpperAlpha', 'LowerRoman', 'UpperRoman'. Defaults to 1.
public
# setFirstBulletNumber( integer $value )

Parameters

$value
integer
starting index when getBulletStyle BulletStyle is one of the following: 'Numbered', 'LowerAlpha', 'UpperAlpha', 'LowerRoman', 'UpperRoman'.
public
# onClick( TBulletedListEventParameter $param )

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

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

Parameters

$param
TBulletedListEventParameter
event parameter.
public string
# getTarget( )

Returns

string
the target window or frame to display the Web page content linked to when getDisplayMode DisplayMode is 'HyperLink' and one of the hyperlinks is clicked.
public
# setTarget( string $value )

Parameters

$value
string
the target window or frame to display the Web page content linked to when getDisplayMode DisplayMode is 'HyperLink' and one of the hyperlinks is clicked.
public
# render( THtmlWriter $writer )

Renders the control.

Renders the control.

Parameters

$writer
THtmlWriter
the writer for the rendering purpose.

Overrides

TWebControl::render()
public
# renderContents( THtmlWriter $writer )

Renders the body contents.

Renders the body contents.

Parameters

$writer
THtmlWriter
the writer for the rendering purpose.

Overrides

TListControl::renderContents()
protected
# renderBulletText( THtmlWriter $writer, TListItem $item, integer $index )

Renders each item

Renders each item

Parameters

$writer
THtmlWriter
writer for the rendering purpose
$item
TListItem
item to be rendered
$index
integer
index of the item being rendered
protected
# renderTextItem( mixed $writer, mixed $item, mixed $index )
protected
# renderHyperLinkItem( mixed $writer, mixed $item, mixed $index )
protected
# renderLinkButtonItem( mixed $writer, mixed $item, mixed $index )
protected array
# getPostBackOptions( )

Returns

array
postback options used for linkbuttons.

Overrides

TListControl::getPostBackOptions()
protected
# canCauseValidation( )
public
# setAutoPostBack( boolean $value )

Parameters

$value
boolean
the value indicating if postback automatically

Throws

TNotSupportedException
if this method is invoked

Overrides

TListControl::setAutoPostBack()
public
# setSelectedIndex( integer $index )

Parameters

$index
integer
the index (zero-based) of the item to be selected

Throws

TNotSupportedException
if this method is invoked

Overrides

TListControl::setSelectedIndex()
public
# setSelectedIndices( array $indices )

Parameters

$indices
array
list of index of items to be selected

Throws

TNotSupportedException
if this method is invoked

Overrides

TListControl::setSelectedIndices()
public
# setSelectedValue( string $value )

Parameters

$value
string
the value of the item to be selected.

Throws

TNotSupportedException
if this method is invoked

Overrides

TListControl::setSelectedValue()
public
# setSelectedValues( array $values )

Parameters

$values
array
list of the selected item values

Throws

TNotSupportedException
if this method is invoked

Overrides

TListControl::setSelectedValues()
Methods inherited from TListControl
addParsedObject(), clearSelection(), createListItemCollection(), formatDataValue(), getAppendDataBoundItems(), getAutoPostBack(), getCausesValidation(), getData(), getDataGroupField(), getDataTextField(), getDataTextFormatString(), getDataValueField(), getEnableClientScript(), getHasItems(), getIsMultiSelect(), getItemCount(), getItems(), getPromptText(), getPromptValue(), getSelectedIndex(), getSelectedIndices(), getSelectedItem(), getSelectedValue(), getSelectedValues(), getText(), getValidationGroup(), loadState(), onSelectedIndexChanged(), onTextChanged(), performDataBinding(), renderClientControlScript(), renderPrompt(), saveState(), setAppendDataBoundItems(), setCausesValidation(), setData(), setDataGroupField(), setDataTextField(), setDataTextFormatString(), setDataValueField(), setEnableClientScript(), setPromptText(), setPromptValue(), setText(), setValidationGroup()
Methods inherited from TDataBoundControl
createPagedDataSource(), dataBind(), dataSourceViewChanged(), determineDataSource(), ensureDataBound(), getAllowCustomPaging(), getAllowPaging(), getCurrentPageIndex(), getDataMember(), getDataSource(), getDataSourceID(), getDataSourceView(), getInitialized(), getIsDataBound(), getPageCount(), getPageSize(), getRequiresDataBinding(), getSelectParameters(), getUsingDataSourceID(), getVirtualItemCount(), onDataBound(), onDataSourceChanged(), onInit(), onPreRender(), pagePreLoad(), setAllowCustomPaging(), setAllowPaging(), setCurrentPageIndex(), setDataMember(), setDataSource(), setDataSourceID(), setInitialized(), setIsDataBound(), setPageSize(), setRequiresDataBinding(), setVirtualItemCount(), validateDataSource()
Methods inherited from TWebControl
clearStyle(), copyBaseAttributes(), createStyle(), getAccessKey(), getBackColor(), getBorderColor(), getBorderStyle(), getBorderWidth(), getCssClass(), getDecorator(), getDisplay(), getEnsureId(), getFont(), getForeColor(), getHasStyle(), getHeight(), getStyle(), getTabIndex(), getToolTip(), getWidth(), renderBeginTag(), renderEndTag(), setAccessKey(), setBackColor(), setBorderColor(), setBorderStyle(), setBorderWidth(), setCssClass(), setDisplay(), setEnsureId(), setForeColor(), setHeight(), setStyle(), setTabIndex(), setToolTip(), setWidth()
Methods inherited from TControl
__construct(), __get(), addToPostDataLoader(), addedControl(), applyStyleSheetSkin(), autoBindProperty(), autoDataBindProperties(), bindProperty(), broadcastEvent(), bubbleEvent(), clearChildState(), clearControlState(), clearNamingContainer(), clearViewState(), convertUniqueIdToClientId(), createChildControls(), createControlCollection(), 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(), initRecursive(), isDescendentOf(), isObjectRegistered(), loadRecursive(), loadStateRecursive(), onDataBinding(), onLoad(), onUnload(), preRenderRecursive(), raiseBubbleEvent(), registerObject(), removeAttribute(), removedControl(), renderChildren(), renderControl(), 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 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
Properties inherited from TWebControl
$_decorator
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