| Method | Description | |
|---|---|---|
| __construct ( ) | Sets the default repeat direction to horizontal. | |
| getAllowInput ( ) : boolean | Wrapper for {@link setReadOnly ReadOnly} property. | |
| getCaption ( ) : string | ||
| getCaptionID ( ) : string | ||
| getHalfRatingInterval ( ) : array | ||
| getRating ( ) : float | ||
| getRatingStyle ( ) : TRatingListStyle | ||
| getReadOnly ( ) : boolean | ||
| onPreRender ( $param ) | Publish the the rating style css file and rating image files. | |
| onSelectedIndexChanged ( $param ) | ||
| render ( $writer ) | Add rating style class name to the class attribute when {@link setReadOnly ReadOnly} property is true and when the {@link setCssClass CssClass} property is empty. | |
| setAllowInput ( $value ) | Wrapper for {@link setReadOnly ReadOnly} property. | |
| setCaption ( $value ) : TRatingListStyle | ||
| setCaptionID ( $value ) | ||
| setEnabled ( $value ) | Wrapper for {@link setReadOnly ReadOnly} property. | |
| setHalfRatingInterval ( $value ) | Sets the interval such that those rating values within the interval will be considered as a half star rating. | |
| setRating ( $value ) | ||
| setRatingStyle ( $value ) | ||
| setReadOnly ( $value ) | ||
| setRepeatLayout ( $value ) | The repeat layout must be Table. | |
| setSelectedIndex ( $value ) |
| Method | Description | |
|---|---|---|
| getAssetUrl ( $file = '' ) : string | ||
| getCaptionControl ( ) | ||
| getCaptionControlID ( ) : string | ||
| getClientClassName ( ) : string | Gets the name of the javascript class responsible for performing postback for this control. | |
| getPostBackOptions ( ) : array | ||
| getRatingIndex ( $rating ) : integer | ||
| getRatingStyleCssClass ( ) : string | ||
| publishImages ( $style, $fileExt = '.gif' ) : array | ||
| publishStyle ( $style ) : string | ||
| registerClientScript ( ) | Registers the relevant JavaScript. |
| public getAllowInput ( ) : boolean | ||
| return | boolean | whether the rating list can be edited. Defaults to true. |
| protected getAssetUrl ( $file = '' ) : string | ||
| return | string | asset file url. |
| public getCaption ( ) : string | ||
| return | string | caption text. Default is "Rate It:". |
| protected getCaptionControlID ( ) : string | ||
| return | string | find the client ID of the caption control. |
| public getCaptionID ( ) : string | ||
| return | string | control or html element ID for displaying a caption. |
| protected getClientClassName ( ) : string | ||
| return | string | the javascript class name |
| public getHalfRatingInterval ( ) : array | ||
| return | array | rating display half value interval, default is array(0.3, 0.7); |
| protected getPostBackOptions ( ) : array | ||
| return | array | list of post back options. |
| protected getRatingIndex ( $rating ) : integer | ||
| return | integer | rating as integer |
| public getRatingStyle ( ) : TRatingListStyle | ||
| return | TRatingListStyle | current rating style |
| protected getRatingStyleCssClass ( ) : string | ||
| return | string | rating style css class name. |
| public getReadOnly ( ) : boolean | ||
| return | boolean | whether the items in the column can be edited. Defaults to false. |
| public onPreRender ( $param ) |
| protected publishImages ( $style, $fileExt = '.gif' ) : array | ||
| return | array | URL of publish the rating images |
| protected publishStyle ( $style ) : string | ||
| return | string | URL of the css style file |
| protected registerClientScript ( ) |
| public render ( $writer ) |
| public setAllowInput ( $value ) |
| public setCaption ( $value ) : TRatingListStyle | ||
| return | TRatingListStyle | current rating style |
| public setEnabled ( $value ) |
| public setHalfRatingInterval ( $value ) |