Class \Prado\Web\UI\WebControls\TBulletedList

TBulletedList class

TBulletedList displays items in a bullet format. The bullet style is specified by \Prado\Web\UI\WebControls\setBulletStyle. When the style is 'CustomImage', the \Prado\Web\UI\WebControls\setBackImageUrl specifies the image used as bullets.

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

Class hierarchy

\Prado\Web\UI\WebControls\TBulletedList implements IPostBackEventHandler

\Prado\Web\UI\WebControls\TListControl implements IDataRenderer

\Prado\Web\UI\WebControls\TDataBoundControl

\Prado\Web\UI\WebControls\TWebControl implements IStyleable

\Prado\Web\UI\TControl implements IRenderable, IBindable

\Prado\TApplicationComponent

\Prado\TComponent

Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0

Methods summary
`public`	`getBulletImageUrl() : string`
`public`	`getBulletStyle() : TBulletStyle`
`public`	`getDisplayMode() : TBulletedListDisplayMode`
`public`	`getFirstBulletNumber() : int`
`public`	`getTarget() : string`
`public`	`onClick(TBulletedListEventParameter $param) : mixed` Raises 'OnClick' event. This method is invoked when the \Prado\Web\UI\WebControls\getDisplayMode is 'LinkButton' and end-users click on one of the buttons.
`public`	`raisePostBackEvent(mixed $param) : mixed` Raises the postback event. This method is required by IPostBackEventHandler interface. If \Prado\Web\UI\WebControls\getCausesValidation is true, it will invoke the page's \Prado\Web\UI\TPage::validate method first. It will raise \Prado\Web\UI\WebControls\onClick events. This method is mainly used by framework and control developers.
`public`	`render(THtmlWriter $writer) : mixed` Renders the control.
`public`	`renderContents(THtmlWriter $writer) : mixed` Renders the body contents.
`public`	`setAutoPostBack(mixed $value) : mixed` Sets the value indicating if postback automatically.
`public`	`setBulletImageUrl(string $value) : mixed`
`public`	`setBulletStyle(TBulletStyle $value) : mixed`
`public`	`setDisplayMode(TBulletedListDisplayMode $value) : mixed`
`public`	`setFirstBulletNumber(int $value) : mixed`
`public`	`setSelectedIndex(mixed $index) : mixed`
`public`	`setSelectedIndices(mixed $indices) : mixed`
`public`	`setSelectedValue(mixed $value) : mixed` Sets selection by item value.
`public`	`setSelectedValues(mixed $values) : mixed`
`public`	`setTarget(string $value) : mixed`
`protected`	`addAttributesToRender(THtmlWriter $writer) : mixed` Adds attribute name-value pairs to renderer. This overrides the parent implementation with additional bulleted list specific attributes.
`protected`	`canCauseValidation() : mixed`
`protected`	`getClientClassName() : string` Gets the name of the javascript class responsible for performing postback for this control. This method overrides the parent implementation.
`protected`	`getPostBackOptions() : array<string\|int, mixed>`
`protected`	`getTagName() : string`
`protected`	`renderBulletText(THtmlWriter $writer, TListItem $item, int $index) : mixed` Renders each item
`protected`	`renderHyperLinkItem(mixed $writer, mixed $item, mixed $index) : mixed`
`protected`	`renderLinkButtonItem(mixed $writer, mixed $item, mixed $index) : mixed`
`protected`	`renderTextItem(mixed $writer, mixed $item, mixed $index) : mixed`

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addedControl, addParsedObject, applyStyleSheetSkin, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, autoBindProperty, bindProperty, broadcastEvent, bubbleEvent, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, clearNamingContainer, clearSelection, clearStyle, clearViewState, convertUniqueIdToClientId, copyBaseAttributes, createChildControls, createdOnTemplate, dataBind, dataSourceViewChanged, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, ensureChildControls, evaluateExpression, evaluateStatements, findControl, findControlsByID, findControlsByType, focus, fxAttachClassBehavior, fxDetachClassBehavior, getAccessKey, getAdapter, getAllowChildControls, getAllowCustomPaging, getAllowPaging, getAppendDataBoundItems, getApplication, getAttribute, getAttributes, getAutoGlobalListen, getAutoPostBack, getBackColor, getBehaviors, getBehaviorsEnabled, getBorderColor, getBorderStyle, getBorderWidth, getCausesValidation, getClassHierarchy, getClientID, getControls, getCssClass, getCurrentPageIndex, getCustomData, getData, getDataGroupField, getDataMember, getDataSource, getDataSourceID, getDataTextField, getDataTextFormatString, getDataValueField, getDecorator, getDisplay, getEnableClientScript, getEnabled, getEnableTheming, getEnableViewState, getEnsureId, getEventHandlers, getFont, getForeColor, getHasAdapter, getHasAttributes, getHasChildInitialized, getHasControls, getHasInitialized, getHasItems, getHasLoaded, getHasLoadedPostData, getHasPreRendered, getHasStyle, getHeight, getID, getIsSkinApplied, getItemCount, getItems, getListeningToGlobalEvents, getNamingContainer, getPage, getPageCount, getPageSize, getParent, getPluginModule, getPromptText, getPromptValue, getRegisteredObject, getRequest, getResponse, getSelectedIndex, getSelectedIndices, getSelectedItem, getSelectedValue, getSelectedValues, getSelectParameters, getService, getSession, getSkinID, getSourceTemplateControl, getStyle, getSubProperty, getTabIndex, getTemplateControl, getText, getToolTip, getUniqueID, getUser, getValidationGroup, getViewState, getVirtualItemCount, getVisible, getWidth, hasAttribute, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, isObjectRegistered, listen, loadState, onDataBinding, onDataBound, onDataSourceChanged, onInit, onLoad, onPreRender, onSelectedIndexChanged, onTextChanged, onUnload, pagePreLoad, publishAsset, publishFilePath, raiseEvent, registerObject, removeAttribute, removedControl, render, renderBeginTag, renderChildren, renderContents, renderControl, renderEndTag, saveState, setAccessKey, setAdapter, setAllowCustomPaging, setAllowPaging, setAppendDataBoundItems, setAttribute, setAutoPostBack, setBackColor, setBorderColor, setBorderStyle, setBorderWidth, setCausesValidation, setCssClass, setCurrentPageIndex, setCustomData, setData, setDataGroupField, setDataMember, setDataSource, setDataSourceID, setDataTextField, setDataTextFormatString, setDataValueField, setDisplay, setEnableClientScript, setEnabled, setEnableTheming, setEnableViewState, setEnsureId, setForeColor, setHeight, setID, setPage, setPageSize, setPromptText, setPromptValue, setSelectedIndex, setSelectedIndices, setSelectedValue, setSelectedValues, setSkinID, setStyle, setSubProperty, setTabIndex, setTemplateControl, setText, setToolTip, setValidationGroup, setViewState, setVirtualItemCount, setVisible, setWidth, trackViewState, unbindProperty, unlisten, unregisterObject, _getZappableSleepProps, addAttributesToRender, autoDataBindProperties, clearChildState, clearControlState, createControlCollection, createListItemCollection, createPagedDataSource, createStyle, dataBindChildren, dataBindProperties, determineDataSource, ensureDataBound, formatDataValue, getCallChain, getChildControlsCreated, getClassFxEvents, getClientClassName, getControlStage, getControlState, getDataSourceView, getInitialized, getIsDataBound, getIsMultiSelect, getPostBackOptions, getRequiresDataBinding, getTagName, getUsingDataSourceID, initRecursive, instanceBehavior, isDescendentOf, loadRecursive, loadStateRecursive, performDataBinding, preRenderRecursive, raiseBubbleEvent, renderClientControlScript, renderPrompt, saveStateRecursive, setChildControlsCreated, setControlStage, setControlState, setInitialized, setIsDataBound, setRequiresDataBinding, traverseChildControls, unloadRecursive, validateDataSource, broadcastEventInternal, clearCachedUniqueID, clearNameTable, fillNameTable, filter_prado_fx, generateAutomaticID, resetCachedSelections

Inherited constants
\Prado\Web\UI\TControl::AUTOMATIC_ID_PREFIX, \Prado\Web\UI\TControl::CLIENT_ID_SEPARATOR, \Prado\Web\UI\TControl::CS_CHILD_INITIALIZED, \Prado\Web\UI\TControl::CS_CONSTRUCTED, \Prado\Web\UI\TControl::CS_INITIALIZED, \Prado\Web\UI\TControl::CS_LOADED, \Prado\Web\UI\TControl::CS_PRERENDERED, \Prado\Web\UI\TControl::CS_STATE_LOADED, \Prado\TApplicationComponent::FX_CACHE_FILE, \Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER, \Prado\Web\UI\TControl::ID_FORMAT, \Prado\Web\UI\TControl::ID_SEPARATOR, \Prado\Web\UI\TControl::IS_CHILD_CREATED, \Prado\Web\UI\TControl::IS_CREATING_CHILD, \Prado\Web\UI\TControl::IS_DISABLE_THEMING, \Prado\Web\UI\TControl::IS_DISABLE_VIEWSTATE, \Prado\Web\UI\TControl::IS_ID_SET, \Prado\Web\UI\TControl::IS_SKIN_APPLIED, \Prado\Web\UI\TControl::IS_STYLESHEET_APPLIED, \Prado\Web\UI\TControl::RF_ADAPTER, \Prado\Web\UI\TControl::RF_AUTO_BINDINGS, \Prado\Web\UI\TControl::RF_CHILD_STATE, \Prado\Web\UI\TControl::RF_CONTROLS, \Prado\Web\UI\TControl::RF_CONTROLSTATE, \Prado\Web\UI\TControl::RF_DATA_BINDINGS, \Prado\Web\UI\TControl::RF_EVENTS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS, \Prado\Web\UI\TControl::RF_NAMED_CONTROLS_ID, \Prado\Web\UI\TControl::RF_NAMED_OBJECTS, \Prado\Web\UI\TControl::RF_SKIN_ID

Classes

Interfaces

Traits

Search results

Class \Prado\Web\UI\WebControls\TBulletedList

Class hierarchy