addObserver

Adds an observer to the region. As with other components within Spry, the observer can be either an object or a function callback.

Format

widgetName.addObserver(observer);

Example

<script language="JavaScript" type="text/javascript">
   // Create an rating widget and bind it to the element with
   // the id of "firstRating".

   var rating1 = new Spry.Widget.Rating("firstRating");

   // Add a function as an observer of the widget.

   function myObserverFunc(notificationType, notifier, data)
   {
      if (notificationType == "onServerUpdate")
         alert("onServertUpdate fired!");
   }

   rating1.addObserver(myObserverFunc);

   // Add an object as an observer of the widget.

   var obs = new Object;
   obs.onServerUpdate = function(notifier, data) { alert("onServerUpdate was fired!"); };
   rating1.addObserver(obs);
</script>

removeObserver

Removes the specified observer from the widget's list of observers. The same observer function or object that was used for the addObserver() call must be used in a call to removeObserver().

Format

widgetName.removeObserver(observer);

Example

<script language="JavaScript" type="text/javascript">
   // Create a Rating widget and bind it to the element with
   // the id of "firstRating".

   var rating1 = new Spry.Widget.Rating("firstRating");

   // Add a function as an observer of the widget.

   function myObserverFunc(notificationType, notifier, data)
   {
      if (notificationType == "onServerUpdate")
         alert("onServerUpdate fired!");
   }

   rating1.addObserver(myObserverFunc);

   // Add an object as an observer of the widget.

   var obs = new Object;
   obs.onServerUpdate = function(notifier, data) { alert("onServerUpdate was fired!"); };
   rating1.addObserver(obs);

   ...

   // Remove the observers that were added.

  rating1.removeObserver(myObserverFunc);
  rating1.removeObserver(obs);
  </script>

disableNotifications

Disables the notification of observers.

Format

widgetName.disableNotifications();

Example

<a href="#" onclick="rating1.disableNotifications(); return false;">Disable Notifications</a>

enableNotifications

Enables observer notifications.

Notifications are enabled by default within an HTML Panel.

Format

widgetName.enableNotifications();

Example

<a href="#" onclick="rating1.enableNotifications(); return false;">Enable Notifications</a>

getState

Get the widget current state; possible values:

• 'initial' - rating allowed, but the user did not do a rating
• 'readonly' - rating not allowed, either by default or after the user made a rating and the widget doesn't allow multiple rating
• 'rated' - (multiple) rating allowed, user did a rating

Format

widgetName.getState();

Example

 <a href="#" onclick="alert(spryrating1.getState()); return false;">Get current state</a> 

setState

Set the state of the widget. See getState() for possible options.

Format

widgetName.setState(newState);

Example

 <a href="#" onclick="rating1.setState('readonly'); return false;">Set state</a> 

getValue

Get the widget current value. This can be:

• the initial value, if the did not use the widget
• the rated value / server computed value, if the usew used the widget
  

Format

widgetName.getValue();

Example

 <a href="#" onclick="alert(rating1.getValue()); return false;">Get current value</a> 

setValue

Set the widget value. newValue must be a float number between 0 and the number of stars in the wigdet. This method is also used when the user actually makes a rating.

Format

widgetName.setValue(newValue);

Example

 <a href="#" onclick="rating1.setValue(2); return false;">Set a value of 2</a> 

removeMessage

Removes a message from the widget. By default, error messages such as when the widhet is read-only and user tries to rate, or the thank you message after rating, remain on screen, next to the widget. If you want to delete them you can use this method.

• className - a the CSS class name that controls the display of the message; currently supported are:
• 'ratingRatedState' for the 'thanks for rating' message
• 'ratingReadOnlyErrState' for the read only message
• when - an optional paramater that specifies a delay to perform the action, in milliseconds (1 sec = 1000 ms)

Format

widgetName.removeMessage(className, timeout);

Example

 <a href="#" onclick="rating1.removeMessage('ratingReadOnlyErrState',1000); return false;">Remove error message</a>