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 TRatingList

TRatingList class.

This class is EXPERIMENTAL.

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 TCheckBoxList implements IRepeatInfoUser, INamingContainer, IPostBackDataHandler, IValidatable
Extended by TRadioButtonList
Extended by TRatingList

Direct known subclasses

TActiveRatingList
Package: System\Web\UI\WebControls
Copyright: Copyright © 2005-2014 PradoSoft
License: http://www.pradosoft.com/license/
Author: Wei Zhuo <weizhuo[at]gmail[dot]com>
Author: Bradley Booms <bradley[dot]booms[at]gmail[dot]com>
Since: 3.0
Located at Web/UI/WebControls/TRatingList.php
Methods summary
public
# __construct( )

Sets the default repeat direction to horizontal.

Sets the default repeat direction to horizontal.

Overrides

TCheckBoxList::__construct()
public boolean
# getReadOnly( )

Returns

boolean
whether the items in the column can be edited. Defaults to false.
public
# setReadOnly( boolean $value )

Parameters

$value
boolean
whether the items in the column can be edited
public boolean
# getAllowInput( )

Wrapper for setReadOnly ReadOnly property.

Wrapper for setReadOnly ReadOnly property.

Returns

boolean
whether the rating list can be edited. Defaults to true.
public
# setAllowInput( boolean $value )

Wrapper for setReadOnly ReadOnly property.

Wrapper for setReadOnly ReadOnly property.

Parameters

$value
boolean
whether the rating list can be edited
public
# setEnabled( boolean $value )

Wrapper for setReadOnly ReadOnly property.

Wrapper for setReadOnly ReadOnly property.

Parameters

$value
boolean
whether the rating list can be edited

Overrides

TCheckBoxList::setEnabled()
public
# setRepeatLayout( string $value )

The repeat layout must be Table.

The repeat layout must be Table.

Parameters

$value
string
repeat layout type

Throws

TInvaliddataValueException
when repeat layout is not Table.

Overrides

TCheckBoxList::setRepeatLayout()
public float
# getRating( )

Returns

float
rating value.
public
# setRating( float $value )

Parameters

$value
float
rating value, also sets the selected Index
public
# setSelectedIndex( integer $value )

Parameters

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

Overrides

TListControl::setSelectedIndex()
protected integer
# getRatingIndex( float $rating )

Parameters

$rating
float
rating value

Returns

integer
rating as integer
public
# onSelectedIndexChanged( integer $param )

Parameters

$param
integer
change the rating selection index

Overrides

TListControl::onSelectedIndexChanged()
public string
# getCaptionID( )

Returns

string
control or html element ID for displaying a caption.
public
# setCaptionID( string $value )

Parameters

$value
string
control or html element ID for displaying a caption.
protected
# getCaptionControl( )
public string
# getCaption( )

Returns

string
caption text. Default is "Rate It:".
public TRatingListStyle
# setCaption( mixed $value )

Returns

TRatingListStyle
current rating style
public
# setRatingStyle( string $value )

Parameters

$value
string
set the rating style, default is "default"
public TRatingListStyle
# getRatingStyle( )

Returns

TRatingListStyle
current rating style
protected string
# getRatingStyleCssClass( )

Returns

string
rating style css class name.
public
# setHalfRatingInterval( array $value )

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

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

Parameters

$value
array
rating display half value interval, default is array(0.3, 0.7);
public array
# getHalfRatingInterval( )

Returns

array
rating display half value interval, default is array(0.3, 0.7);
protected array
# getPostBackOptions( )

Returns

array
list of post back options.

Overrides

TCheckBoxList::getPostBackOptions()
protected string
# getCaptionControlID( )

Returns

string
find the client ID of the caption control.
public
# onPreRender( mixed $param )

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

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

Parameters

$param
mixed
event parameter

Overrides

TCheckBoxList::onPreRender()
protected string
# publishStyle( string $style )

Parameters

$style
string
rating style name

Returns

string
URL of the css style file
protected array
# publishImages( string $style, string $fileExt = '.gif' )

Parameters

$style
string
rating style name
$fileExt
string
rating image file extension, default is '.gif'

Returns

array
URL of publish the rating images
protected
# registerClientScript( )

Registers the relevant JavaScript.

Registers the relevant JavaScript.

protected string
# getAssetUrl( string $file = '' )

Parameters

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

Returns

string
asset file url.
public
# render( THtmlWriter $writer )

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

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

Parameters

$writer
THtmlWriter
renderer

Overrides

TCheckBoxList::render()
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

TRadioButtonList::getClientClassName()
Methods inherited from TRadioButtonList
createRepeatedControl(), getIsMultiSelect(), loadPostData(), setSelectedIndices()
Methods inherited from TCheckBoxList
createStyle(), findControl(), generateItemStyle(), getCellPadding(), getCellSpacing(), getDataChanged(), getHasFooter(), getHasHeader(), getHasSeparators(), getIsValid(), getRepeatColumns(), getRepeatDirection(), getRepeatInfo(), getRepeatLayout(), getSpanNeeded(), getTextAlign(), getValidationPropertyValue(), raisePostDataChangedEvent(), renderItem(), setCellPadding(), setCellSpacing(), setIsValid(), setRepeatColumns(), setRepeatDirection(), setTextAlign()
Methods inherited from TListControl
addAttributesToRender(), addParsedObject(), clearSelection(), createListItemCollection(), formatDataValue(), getAppendDataBoundItems(), getAutoPostBack(), getCausesValidation(), getData(), getDataGroupField(), getDataTextField(), getDataTextFormatString(), getDataValueField(), getEnableClientScript(), getHasItems(), getItemCount(), getItems(), getPromptText(), getPromptValue(), getSelectedIndex(), getSelectedIndices(), getSelectedItem(), getSelectedValue(), getSelectedValues(), getTagName(), getText(), getValidationGroup(), loadState(), onTextChanged(), performDataBinding(), renderClientControlScript(), renderContents(), renderPrompt(), saveState(), setAppendDataBoundItems(), setAutoPostBack(), setCausesValidation(), setData(), setDataGroupField(), setDataTextField(), setDataTextFormatString(), setDataValueField(), setEnableClientScript(), setPromptText(), setPromptValue(), setSelectedValue(), setSelectedValues(), 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(), pagePreLoad(), setAllowCustomPaging(), setAllowPaging(), setCurrentPageIndex(), setDataMember(), setDataSource(), setDataSourceID(), setInitialized(), setIsDataBound(), setPageSize(), setRequiresDataBinding(), setVirtualItemCount(), validateDataSource()
Methods inherited from TWebControl
clearStyle(), copyBaseAttributes(), 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
__get(), addToPostDataLoader(), addedControl(), applyStyleSheetSkin(), autoBindProperty(), autoDataBindProperties(), bindProperty(), broadcastEvent(), bubbleEvent(), clearChildState(), clearControlState(), clearNamingContainer(), clearViewState(), convertUniqueIdToClientId(), createChildControls(), createControlCollection(), dataBindChildren(), dataBindProperties(), ensureChildControls(), 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(), 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 summary
string SCRIPT_PATH 'prado/ratings'
#

Script path relative to the TClientScriptManager::SCRIPT_PATH

Script path relative to the TClientScriptManager::SCRIPT_PATH

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