API Preview tool | The Dojo Toolkit

Warning: Use of undefined constant Symbol - assumed 'Symbol' (this will throw an Error in a future version of PHP) in /mnt/new-ebs/workbench-106550/lib/dojo/util/docscripts/lib/parser2/dojo2.inc on line 215 Warning: Use of undefined constant JavaScriptSymbol - assumed 'JavaScriptSymbol' (this will throw an Error in a future version of PHP) in /mnt/new-ebs/workbench-106550/lib/dojo/util/docscripts/lib/parser2/dojo2.inc on line 215

dojox/form/Rating.js

Provides:
- dojox.form.Rating
Requires:
- dijit.form._FormWidget in common
dojox.form.Rating
- type
```
Function
```
- chains:
  - dijit.form._FormWidget: (prototype)
  - dijit.form._FormWidget: (call)
- parameters:
  - params: (typeof Object)
- summary
```
A widget for rating using stars.

required: Boolean
TODO: Can be true or false, default is false.
required: false,
```
dojox.form.Rating.templateString
- type
```
Object
```

dojox.form.Rating.numStars

type
```
Integer/Float
```

summary

The number of stars to show, default is 3.

dojox.form.Rating.value

type
```
Integer/Float
```
summary
```
The current value of the Rating
```

dojox.form.Rating.constructor
- constructor - constructor
- type
```
Function
```
- parameters:
  - params: (typeof Object)
dojox.form.Rating.postCreate
- type
```
Function
```
dojox.form.Rating._onMouse
- parameters:
  - evt
- type
```
Function
```
dojox.form.Rating._renderStars
- parameters:
  - value
  - hover
- summary
```
Render the stars depending on the value.
```
- type
```
Function
```

dojox.form.Rating.onStarClick

parameters:
- evt: (typeof Event)

summary

Connect on this method to get noticed when a star was clicked.

example

dojo.connect(widget, "onStarClick", function(event){ ... })

type
```
Function
```

dojox.form.Rating.onMouseOver

summary

Connect here, the value is passed to this function as the second parameter!

type
```
Function
```

dojox.form.Rating.setAttribute

parameters:
- key: (typeof String)
- value

summary

When calling setAttribute(&quot;value&quot;, 4), set the value and render the stars accordingly.

type
```
Function
```

dojox.form
- type
```
Object
```
dojox
- type
```
Object
```