Class TRatingList

Description

TRatingList class.

This class is EXPERIMENTAL.

Located in /Web/UI/WebControls/TRatingList.php (line 29)

TComponent
   |
   --TApplicationComponent
      |
      --TControl
         |
         --TWebControl
            |
            --TDataBoundControl
               |
               --TListControl
                  |
                  --TCheckBoxList
                     |
                     --TRadioButtonList
                        |
                        --TRatingList
Direct descendents
Class Description
TActiveRatingList TActiveRatingList Class
Class Constant Summary
 SCRIPT_PATH = 'prado/ratings'
Method Summary
TRatingList __construct ()
boolean getAllowInput ()
string getAssetUrl ([string $file = ''])
string getCaption ()
string getCaptionID ()
string getClientClassName ()
float getRating ()
int getRatingIndex (float $rating)
TRatingListStyle getRatingStyle ()
boolean getReadOnly ()
void onPreRender (mixed $param)
void onSelectedIndexChanged (int $param)
array publishImages (string $style, [string $fileExt = '.gif'])
string publishStyle (string $style)
void render (THtmlWriter $writer)
void setAllowInput (boolean $value)
TRatingListStyle setCaption (mixed $value)
void setCaptionID (string $value)
void setEnabled (boolean $value)
void setHalfRatingInterval (array $value)
void setRating (float $value)
void setRatingStyle (string $value)
void setReadOnly (boolean $value)
void setRepeatLayout (string $value)
void setSelectedIndex (mixed $value)
Methods
Constructor __construct (line 44)

Sets the default repeat direction to horizontal.

  • access: public
TRatingList __construct ()

Redefinition of:
TCheckBoxList::__construct()
Constructor.

Redefined in descendants as:
  • TActiveRatingList::__construct() : Creates a new callback control, sets the adapter to TActiveListControlAdapter. If you override this class, be sure to set the adapter appropriately by, for example, by calling this constructor.
getAllowInput (line 70)

Wrapper for setReadOnly property.

  • return: whether the rating list can be edited. Defaults to true.
  • access: public
boolean getAllowInput ()
getAssetUrl (line 319)
  • return: asset file url.
  • access: protected
string getAssetUrl ([string $file = ''])
  • string $file: asset file in the self::SCRIPT_PATH directory.
getCaption (line 188)
  • return: caption text. Default is "Rate It:".
  • access: public
string getCaption ()
getCaptionControl (line 174)
  • access: protected
void getCaptionControl ()
getCaptionControlID (line 263)
  • return: find the client ID of the caption control.
  • access: protected
string getCaptionControlID ()
getCaptionID (line 161)
  • return: control or html element ID for displaying a caption.
  • access: public
string getCaptionID ()
getClientClassName (line 344)

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:
TRadioButtonList::getClientClassName()
Gets the name of the javascript class responsible for performing postback for this control.

Redefined in descendants as:
getHalfRatingInterval (line 239)
  • return: rating display half value interval, default is array(0.3, 0.7);
  • access: public
array getHalfRatingInterval ()
getPostBackOptions (line 247)
  • return: list of post back options.
  • access: protected
array getPostBackOptions ()

Redefinition of:
TCheckBoxList::getPostBackOptions()
Gets the post back options for this checkbox.
getRating (line 109)
  • return: rating value.
  • access: public
float getRating ()
getRatingIndex (line 139)
  • return: rating as integer
  • access: protected
int getRatingIndex (float $rating)
  • float $rating: rating value
getRatingStyle (line 212)
  • return: current rating style
  • access: public
TRatingListStyle getRatingStyle ()
getRatingStyleCssClass (line 220)
  • return: rating style css class name.
  • access: protected
string getRatingStyleCssClass ()
getReadOnly (line 53)
  • return: whether the items in the column can be edited. Defaults to false.
  • access: public
boolean getReadOnly ()
onPreRender (line 281)

Publish the the rating style css file and rating image files.

  • access: public
void onPreRender (mixed $param)

Redefinition of:
TCheckBoxList::onPreRender()
Registers for post data on postback.
onSelectedIndexChanged (line 150)
  • access: public
void onSelectedIndexChanged (int $param)
  • int $param: change the rating selection index

Redefinition of:
TListControl::onSelectedIndexChanged()
Raises OnSelectedIndexChanged event when selection is changed.
publishImages (line 306)
  • return: URL of publish the rating images
  • access: protected
array publishImages (string $style, [string $fileExt = '.gif'])
  • string $style: rating style name
  • string $fileExt: rating image file extension, default is '.gif'
publishStyle (line 292)
  • return: URL of the css style file
  • access: protected
string publishStyle (string $style)
  • string $style: rating style name
render (line 331)

Add rating style class name to the class attribute when setReadOnly property is true and when the setCssClass property is empty.

  • access: public
void render (THtmlWriter $writer)

Redefinition of:
TCheckBoxList::render()
Renders the checkbox list control.
setAllowInput (line 79)

Wrapper for setReadOnly property.

  • access: public
void setAllowInput (boolean $value)
  • boolean $value: whether the rating list can be edited
setCaption (line 196)
  • return: current rating style
  • access: public
TRatingListStyle setCaption (mixed $value)

Redefined in descendants as:
setCaptionID (line 169)
  • access: public
void setCaptionID (string $value)
  • string $value: control or html element ID for displaying a caption.
setEnabled (line 88)

Wrapper for setReadOnly property.

  • access: public
void setEnabled (boolean $value)
  • boolean $value: whether the rating list can be edited

Redefinition of:
TControl::setEnabled()
setHalfRatingInterval (line 230)

Sets the interval such that those rating values within the interval will be considered as a half star rating.

  • access: public
void setHalfRatingInterval (array $value)
  • array $value: rating display half value interval, default is array(0.3, 0.7);
setRating (line 121)
  • access: public
void setRating (float $value)
  • float $value: rating value, also sets the selected Index

Redefined in descendants as:
setRatingStyle (line 204)
  • access: public
void setRatingStyle (string $value)
  • string $value: set the rating style, default is "default"
setReadOnly (line 61)
  • access: public
void setReadOnly (boolean $value)
  • boolean $value: whether the items in the column can be edited

Redefined in descendants as:
setRepeatLayout (line 98)

The repeat layout must be Table.

  • access: public
  • throws: TInvaliddataValueException when repeat layout is not Table.
void setRepeatLayout (string $value)
  • string $value: repeat layout type

Redefinition of:
TCheckBoxList::setRepeatLayout()
setSelectedIndex (line 129)
  • access: public
void setSelectedIndex (mixed $value)

Redefinition of:
TListControl::setSelectedIndex()

Inherited Methods

Inherited From TRadioButtonList

TRadioButtonList::createRepeatedControl()
TRadioButtonList::getClientClassName()
TRadioButtonList::getIsMultiSelect()
TRadioButtonList::loadPostData()
TRadioButtonList::setSelectedIndices()

Inherited From TCheckBoxList

TCheckBoxList::__construct()
TCheckBoxList::createRepeatedControl()
TCheckBoxList::createStyle()
TCheckBoxList::findControl()
TCheckBoxList::generateItemStyle()
TCheckBoxList::getCellPadding()
TCheckBoxList::getCellSpacing()
TCheckBoxList::getClientClassName()
TCheckBoxList::getDataChanged()
TCheckBoxList::getHasFooter()
TCheckBoxList::getHasHeader()
TCheckBoxList::getHasSeparators()
TCheckBoxList::getIsMultiSelect()
TCheckBoxList::getIsValid()
TCheckBoxList::getPostBackOptions()
TCheckBoxList::getRepeatColumns()
TCheckBoxList::getRepeatDirection()
TCheckBoxList::getRepeatInfo()
TCheckBoxList::getRepeatLayout()
TCheckBoxList::getSpanNeeded()
TCheckBoxList::getTextAlign()
TCheckBoxList::getValidationPropertyValue()
TCheckBoxList::loadPostData()
TCheckBoxList::onPreRender()
TCheckBoxList::raisePostDataChangedEvent()
TCheckBoxList::render()
TCheckBoxList::renderItem()
TCheckBoxList::setCellPadding()
TCheckBoxList::setCellSpacing()
TCheckBoxList::setIsValid()
TCheckBoxList::setRepeatColumns()
TCheckBoxList::setRepeatDirection()
TCheckBoxList::setRepeatLayout()
TCheckBoxList::setTextAlign()

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::getDisplay()
TWebControl::getFont()
TWebControl::getForeColor()
TWebControl::getHasStyle()
TWebControl::getHeight()
TWebControl::getStyle()
TWebControl::getTabIndex()
TWebControl::getTagName()
TWebControl::getToolTip()
TWebControl::getWidth()
TWebControl::render()
TWebControl::renderBeginTag()
TWebControl::renderContents()
TWebControl::renderEndTag()
TWebControl::setAccessKey()
TWebControl::setBackColor()
TWebControl::setBorderColor()
TWebControl::setBorderStyle()
TWebControl::setBorderWidth()
TWebControl::setCssClass()
TWebControl::setDisplay()
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::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::__get()
TComponent::__set()
Class Constants

Documentation generated on Sun, 11 Jan 2009 20:23:32 -0500 by phpDocumentor 1.3.0RC4