Class \Prado\Web\UI\WebControls\TRatingList

TRatingList class.

This class is EXPERIMENTAL.

Class hierarchy

\Prado\Web\UI\WebControls\TRadioButtonList

\Prado\Web\UI\WebControls\TCheckBoxList implements IRepeatInfoUser, INamingContainer, IPostBackDataHandler, IValidatable

\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: Wei Zhuo <weizhuo[at]gmail[dot]com>
Author: Bradley Booms <bradley[dot]booms[at]gmail[dot]com>
Since: 3.0

Methods summary
`public`	`__construct() : mixed` Sets the default repeat direction to horizontal.
`public`	`getAllowInput() : bool` Wrapper for {@see setReadOnly ReadOnly} property.
`public`	`getCaption() : string`
`public`	`getCaptionID() : string`
`public`	`getHalfRatingInterval() : array<string\|int, mixed>`
`public`	`getRating() : float`
`public`	`getRatingStyle() : string`
`public`	`getReadOnly() : bool`
`public`	`onPreRender(mixed $param) : mixed` Publish the the rating style css file and rating image files.
`public`	`onSelectedIndexChanged(mixed $param) : mixed` Raised then the rating selection index changed
`public`	`render(THtmlWriter $writer) : mixed` Add rating style class name to the class attribute when {@see setReadOnly ReadOnly} property is true and when the {@see setCssClass CssClass} property is empty.
`public`	`setAllowInput(bool $value) : mixed` Wrapper for {@see setReadOnly ReadOnly} property.
`public`	`setCaption(string $value) : mixed`
`public`	`setCaptionID(string $value) : mixed`
`public`	`setEnabled(bool $value) : mixed` Wrapper for {@see setReadOnly ReadOnly} property.
`public`	`setHalfRatingInterval(array<string\|int, mixed> $value) : mixed` Sets the interval such that those rating values within the interval will be considered as a half star rating.
`public`	`setRating(float $value) : mixed`
`public`	`setRatingStyle(string $value) : mixed`
`public`	`setReadOnly(bool $value) : mixed`
`public`	`setRepeatLayout(string $value) : mixed` The repeat layout must be Table.
`public`	`setSelectedIndex(mixed $value) : mixed`
`protected`	`getAssetUrl([string $file = '' ]) : string`
`protected`	`getCaptionControl() : mixed`
`protected`	`getCaptionControlID() : string`
`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`	`getRatingIndex(float $rating) : int`
`protected`	`getRatingStyleCssClass() : string`
`protected`	`publishImages(string $style[, string $fileExt = '.gif' ]) : array<string\|int, mixed>`
`protected`	`publishStyle(string $style) : string`
`protected`	`registerClientScript() : mixed` Registers the relevant JavaScript.

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, generateItemStyle, getAccessKey, getAdapter, getAllowChildControls, getAllowCustomPaging, getAllowPaging, getAppendDataBoundItems, getApplication, getAttribute, getAttributes, getAutoGlobalListen, getAutoPostBack, getBackColor, getBehaviors, getBehaviorsEnabled, getBorderColor, getBorderStyle, getBorderWidth, getCausesValidation, getCellPadding, getCellSpacing, getClassHierarchy, getClientID, getControls, getCssClass, getCurrentPageIndex, getCustomData, getData, getDataChanged, getDataGroupField, getDataMember, getDataSource, getDataSourceID, getDataTextField, getDataTextFormatString, getDataValueField, getDecorator, getDisplay, getEnableClientScript, getEnabled, getEnableTheming, getEnableViewState, getEnsureId, getEventHandlers, getFont, getForeColor, getHasAdapter, getHasAttributes, getHasChildInitialized, getHasControls, getHasFooter, getHasHeader, getHasInitialized, getHasItems, getHasLoaded, getHasLoadedPostData, getHasPreRendered, getHasSeparators, getHasStyle, getHeight, getID, getIsSkinApplied, getIsValid, getItemCount, getItems, getListeningToGlobalEvents, getNamingContainer, getPage, getPageCount, getPageSize, getParent, getPluginModule, getPromptText, getPromptValue, getRegisteredObject, getRepeatColumns, getRepeatDirection, getRepeatLayout, getRequest, getResponse, getSelectedIndex, getSelectedIndices, getSelectedItem, getSelectedValue, getSelectedValues, getSelectParameters, getService, getSession, getSkinID, getSourceTemplateControl, getStyle, getSubProperty, getTabIndex, getTemplateControl, getText, getTextAlign, getToolTip, getUniqueID, getUser, getValidationGroup, getValidationPropertyValue, getViewState, getVirtualItemCount, getVisible, getWidth, hasAttribute, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, isObjectRegistered, listen, loadPostData, loadState, onDataBinding, onDataBound, onDataSourceChanged, onInit, onLoad, onPreRender, onSelectedIndexChanged, onTextChanged, onUnload, pagePreLoad, publishAsset, publishFilePath, raiseEvent, raisePostDataChangedEvent, registerObject, removeAttribute, removedControl, render, renderBeginTag, renderChildren, renderContents, renderControl, renderEndTag, renderItem, saveState, setAccessKey, setAdapter, setAllowCustomPaging, setAllowPaging, setAppendDataBoundItems, setAttribute, setAutoPostBack, setBackColor, setBorderColor, setBorderStyle, setBorderWidth, setCausesValidation, setCellPadding, setCellSpacing, setCssClass, setCurrentPageIndex, setCustomData, setData, setDataGroupField, setDataMember, setDataSource, setDataSourceID, setDataTextField, setDataTextFormatString, setDataValueField, setDisplay, setEnableClientScript, setEnabled, setEnableTheming, setEnableViewState, setEnsureId, setForeColor, setHeight, setID, setIsValid, setPage, setPageSize, setPromptText, setPromptValue, setRepeatColumns, setRepeatDirection, setRepeatLayout, setSelectedIndex, setSelectedIndices, setSelectedValue, setSelectedValues, setSkinID, setStyle, setSubProperty, setTabIndex, setTemplateControl, setText, setTextAlign, setToolTip, setValidationGroup, setViewState, setVirtualItemCount, setVisible, setWidth, trackViewState, unbindProperty, unlisten, unregisterObject, _getZappableSleepProps, addAttributesToRender, autoDataBindProperties, clearChildState, clearControlState, createControlCollection, createListItemCollection, createPagedDataSource, createRepeatedControl, createStyle, dataBindChildren, dataBindProperties, determineDataSource, ensureDataBound, formatDataValue, getCallChain, getChildControlsCreated, getClassFxEvents, getClientClassName, getControlStage, getControlState, getDataSourceView, getInitialized, getIsDataBound, getIsMultiSelect, getPostBackOptions, getRepeatInfo, getRequiresDataBinding, getSpanNeeded, 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

Constants summary
`public mixed`	`SCRIPT_PATH` Script path relative to the TClientScriptManager::SCRIPT_PATH	`'ratings'`

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\TRatingList

Class hierarchy