## Class TRatingList

Description

TRatingList class.

This class is EXPERIMENTAL.

- since: 3.0
- version: $Id: TRatingList.php 1844 2007-04-06 04:28:46Z wei $
- author: Wei Zhuo <weizhuo[at]gmail[dot]com>

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

    TComponent
       |
       --TApplicationComponent
          |
          --TControl
             |
             --TWebControl
                |
                --TDataBoundControl
                   |
                   --TListControl
                      |
                      --TCheckBoxList
                         |
                         --TRadioButtonList
                            |
                            --TRatingList

Class Constant Summary
SCRIPT_PATH = 'prado/ratings'
Method Summary
TRatingList __construct ()
void generateItemStyle (mixed $itemType, mixed $index)
void getAllowInput ()
string getAssetUrl ([string $file = ''])
string getCaption ()
string getClientClassName ()
void getHalfRatingLimit ()
void getRating ()
void getRatingClientOptions ()
void getRatingImageType (mixed $index)
TRatingListStyle getRatingStyle ()
void onPreRender (THtmlWriter $param)
void publishRatingListImages (mixed $style, [mixed $fileExt = '.gif'])
void publishRatingListStyle (mixed $style)
void registerRatingListClientScript ()
void renderItem (mixed $writer, mixed $repeatInfo, mixed $itemType, mixed $index)
void renderRatingListItem (mixed $writer, mixed $repeatInfo, mixed $itemType, mixed $index)
void setAllowInput (mixed $value)
void setCaption (string $value)
void setHalfRatingLimit (mixed $value)
void setRating (mixed $value)
void setRatingStyle (string $value)
Methods
Constructor __construct (line 34)

- access: public

TRatingList __construct ()

Redefinition of:

TCheckBoxList::__construct()
  Constructor.

generateItemStyle (line 205)

- access: public

void generateItemStyle (mixed $itemType, mixed $index)

Redefinition of:

TCheckBoxList::generateItemStyle()
  Returns a style used for rendering items.

getAllowInput (line 40)

- access: public

void getAllowInput ()
getAssetUrl (line 114)

- return: asset file url.
- access: protected

string getAssetUrl ([string $file = ''])

- string $file: asset file in the self::SCRIPT_PATH directory.

getCaption (line 85)

- return: caption text. Default is "Rate It:".
- access: public

string getCaption ()
getClientClassName (line 215)

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.

getHalfRatingLimit (line 105)

- access: public

void getHalfRatingLimit ()
getRating (line 50)

- access: public

void getRating ()
getRatingClientOptions (line 120)

- access: public

void getRatingClientOptions ()
getRatingImageType (line 193)

- access: protected

void getRatingImageType (mixed $index)
getRatingStyle (line 77)

- return: current rating style
- access: public

TRatingListStyle getRatingStyle ()
onPreRender (line 151)

- access: public

void onPreRender (THtmlWriter $param)

- THtmlWriter $param: writer

Redefinition of:

TCheckBoxList::onPreRender()
  Registers for post data on postback.

publishRatingListImages (line 139)

- access: protected

void publishRatingListImages (mixed $style, [mixed $fileExt = '.gif'])
publishRatingListStyle (line 130)

- access: protected

void publishRatingListStyle (mixed $style)
registerRatingListClientScript (line 167)

- access: protected

void registerRatingListClientScript ()
renderItem (line 177)

- access: public

void renderItem (mixed $writer, mixed $repeatInfo, mixed $itemType, mixed $index)

Redefinition of:

TCheckBoxList::renderItem()
  Renders an item in the list.

renderRatingListItem (line 185)

- access: protected

void renderRatingListItem (mixed $writer, mixed $repeatInfo, mixed $itemType, mixed $index)
setAllowInput (line 45)

- access: public

void setAllowInput (mixed $value)
setCaption (line 93)

- access: public

void setCaption (string $value)

- string $value: caption text

setHalfRatingLimit (line 99)

- access: public

void setHalfRatingLimit (mixed $value)
setRating (line 58)

- access: public

void setRating (mixed $value)
setRatingStyle (line 69)

- access: public

void setRatingStyle (string $value)

- string $value: set the rating style

#### 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::getPostBackOptions()
> TCheckBoxList::getRepeatColumns()
> TCheckBoxList::getRepeatDirection()
> TCheckBoxList::getRepeatInfo()
> TCheckBoxList::getRepeatLayout()
> TCheckBoxList::getTextAlign()
> TCheckBoxList::getValidationPropertyValue()
> TCheckBoxList::loadPostData()
> TCheckBoxList::onPreRender()
> TCheckBoxList::raisePostDataChangedEvent()
> TCheckBoxList::render()
> TCheckBoxList::renderItem()
> TCheckBoxList::setCellPadding()
> TCheckBoxList::setCellSpacing()
> 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
SCRIPT_PATH = 'prado/ratings' (line 30)

#### Inherited Constants

Inherited from TControl

> TControl::AUTOMATIC_ID_PREFIX
> TControl::CLIENT_ID_SEPARATOR
> TControl::CS_CHILD_INITIALIZED
> TControl::CS_CONSTRUCTED
> TControl::CS_INITIALIZED
> TControl::CS_LOADED
> TControl::CS_PRERENDERED
> TControl::CS_STATE_LOADED
> TControl::ID_FORMAT
> TControl::ID_SEPARATOR
> TControl::IS_CHILD_CREATED
> TControl::IS_CREATING_CHILD
> TControl::IS_DISABLE_THEMING
> TControl::IS_DISABLE_VIEWSTATE
> TControl::IS_ID_SET
> TControl::IS_SKIN_APPLIED
> TControl::IS_STYLESHEET_APPLIED
> TControl::RF_ADAPTER
> TControl::RF_AUTO_BINDINGS
> TControl::RF_CHILD_STATE
> TControl::RF_CONTROLS
> TControl::RF_CONTROLSTATE
> TControl::RF_DATA_BINDINGS
> TControl::RF_EVENTS
> TControl::RF_NAMED_CONTROLS
> TControl::RF_NAMED_CONTROLS_ID
> TControl::RF_NAMED_OBJECTS
> TControl::RF_SKIN_ID

Documentation generated on Sun, 30 Sep 2007 19:17:05 -0400 by phpDocumentor 1.3.0RC4