/**** SmartStars 

Graphical Star-Rating System with Form Element Interface

* Multiple rating bars in one document.

* Configurable for number of stars and initial setting.

* Unobrusive installation - no onmouseover/onmouseout handlers to install

* Optional external function execution for easy AJAX interfacing.

* Keyboard Accessible (Enter key selects)

Demonstration and further details at http://scripterlative.com?smartstars

The following instructions may be removed, but not the above text.

Please notify any suspected errors in this text or code, however minor.

Description
~~~~~~~~~~~
Generates a horizontal 'rating bar' comprised of either of two graphical images that indicate the
current rating. To set a numeric rating, any image in the row may be clicked.

THIS IS A SUPPORTED SCRIPT
~~~~~~~~~~~~~~~~~~~~~~~~~~
It's in everyone's interest that every download of our code leads to a successful installation.
To this end we undertake to provide a reasonable level of email-based support, to anyone 
experiencing difficulties directly associated with the installation and configuration of the
application.

Before requesting assistance via the Feedback link, we ask that you take the following steps:

1) Ensure that the instructions have been followed accurately.

2) Ensure that either:
   a) The browser's error console ( Ideally in FireFox ) does not show any related error messages.
   b) You notify us of any error messages that you cannot interpret.

3) Validate your document's markup at: http://validator.w3.org or any equivalent site.   
   
4) Provide a URL to a test document that demonstrates the problem.

Installation
~~~~~~~~~~~~
Save this file as 'smartstars.js'

In the <head> section of your document, include the script by adding the tags below:

 <script type='text/javascript' src='smartstars.js'></script>

For each rating bar to be generated, create a containing <span> element with a unique ID.
This element may be given any suitable CSS attributes.

Create a form containing a hidden type element for each rating bar.

Configuration
~~~~~~~~~~~~~
Each rating bar is initialised by a single call to the function SmartStars.init(), which must be
placed at a point below the related span/div and the related form.
The function takes six or seven parameters as described next.

Parameter 1 - The ID of the span element that will contain the rating bar.

Parameter 2 - A full reference to a form element (usually of type 'hidden') that will store the
numeric star rating selected by the user.

Parameter 3 - The initial rating. (0 to display no 'on' stars)

Parameter 4 - The number of stars in the rating bar.

Parameter 5 - The file name of the 'off' graphic. (Include a relative path if necessary)

Parameter 6 - The file name of the 'on' graphic.

Parameter 7 - (Optional) A reference to a user function called whenever the display changes.

Example
~~~~~~~
Create a star rating display using a span with the ID 'stars1'. The numeric rating set by the user
will be written to the element named 't1', belonging to a form with ID 'f1'. The initial rating
will be set to 5 out of 10 stars. The star graphics used are called 'offstar.gif' & 'onstar.gif'.

At a point below the associated form and span elements, insert:

<script type='text/javascript'>

SmartStars.init('stars1', document.getElementById('f1').t1, 5, 10, 'offstar.gif', 'onstar.gif');

</script>

Note: Parameters 1, 5 & 6 must be in quotes as shown, the others must not.

Repeat the above for as many instances as required. Obviously the graphics used need not depict
stars, but each pair should have the same dimensions.

That's all there is to it.

Appearance and CSS Styling
~~~~~~~~~~~~~~~~~~~~~~~~~~
Two stylesheet names determine the layout of the rating display's images and links. These are
'SmartStarsLinks' and 'SmartStarsImages' respectively.

The default recommended minimal styling is shown below. This text should be placed inside
<style></style> tags in the <head> section of the document.

a.SmartStarsLinks{padding:0px}

.SmartStarsImages{margin:0px; border:none}


Setting or Cancelling A Rating
------------------------------
The SmartStars.set method can be used to set a rating after it has been initialised.


To set a rating to 3 'stars', call:

 SmartStars.set(span id, 2);

To reset a rating to 0 'stars', call: 

 SmartStars.set(span id, -1);

To facilitate its use within links, this method returns false:

 <a href='#' onclick="return SmartStars.set('starSpan', -1)">Cancel Rating</a>


Optional Function Interfaces
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
For advanced users, the script can be configured to call external functions whenever either the
display changes or a selection is made.

The functions are specified via the seventh and eighth optional parameters of SmartStars.init.
 
 Seventh parameter - Function called on hover/focus.
 Eighth parameter -  Function called on selection.

The functions are passed a numeric, zero-based index corresponding to the currently displayed 
rating (0 = 1 'star'), and should be coded to handle a parameter value of -1.
Typically such functions might be used either to communicate with a database, or to display
descriptive/confirmatory text comments or images for each hovered symbol. 
AJAX functions can be called to submit the new rating and receive back the calculated average, 
which a readystate handler can update by calling the .set method.

The 'hover' function is also called when SmartStars.init is called, except when the initial rating
is set to 0.

Example: Display different text as icons are hovered -

function showText( index )
{
 // Write text according to the value of 'index'
}

SmartStars.init('stars1', document.getElementById('f1').t1, 3, 5, 'offstar.gif', 'onstar.gif', showText);

-------

Example: Display confirmation text when a selection is made -

function confirmText( index )
{
 // Write text according to the value of 'index'
}

SmartStars.init('stars1', document.getElementById('f1').t1, 3, 5, 'offstar.gif', 'onstar.gif', null, confirmText);


GratuityWare
~~~~~~~~~~~~
This code is supplied on condition that all website owners/developers using it anywhere,
recognise the effort that went into producing it, by making a PayPal donation OF THEIR CHOICE
to the authors. This will ensure the incentive to provide support and the continued authoring
of new scripts.

YOUR USE OF THE CODE IS UNDERSTOOD TO MEAN THAT YOU AGREE WITH THIS PRINCIPLE.

You may donate at www.scripterlative.com, stating the URL to which the donation applies.

*** DO NOT EDIT BELOW THIS LINE *****/

var SmartStars=/*286329323030372053204368616C6D657273*/
{
  /*** Free Download: http://scripterlative.com?smartstars ***/   
   
 data:[], bon:0xf&0, logged:0,
   
 init:function(ratingId, formElem, rating, starCount, offStar, onStar, hFunc, cFunc)
 {    
  if(document.getElementById)
  { 
   var elem=this.data[ratingId]={};
   
   if(!!hFunc)
    elem.externHoverFunc=hFunc;
  
   if(!!cFunc)
    elem.externSetFunc=cFunc;
    
   elem.elemRef=document.getElementById(ratingId);
   
   elem.formElem=formElem;   
   
   elem.starCount=starCount;
   elem.rating=rating;
   elem.offStar=offStar;
   elem.onStar=onStar;
      
   elem.rating=Math.max(-1,elem.rating);
   if(elem.rating!=-1)
    elem.rating--;
    
   elem.starTable=[];
   if(elem.elemRef)
    this.build(ratingId);
   else
    alert(this.elemRef+" is not a valid element ID.") 
  }
 },
 
 build:function(id)
 {
  var elem=this.data[id]; this.cont();
    
  for(var i=0, sp, lnk; i<elem.starCount&&this.bon; i++)
  {
   (lnk=document.createElement('a')).appendChild(sp=document.createElement('img'));
   lnk.href='#';
   lnk.className='SmartStarsLinks';
   lnk.style.textDecoration='none';   
   
   sp.className='SmartStarsImages';
   sp.idx=i;
   sp.src=elem.offStar;
   sp.style.border='none';
      
   elem.imgBuffer=new Image();
   elem.imgBuffer.src=elem.onStar;
   
   lnk.onmouseover=(function(obj, ident){return function(){if(obj)obj.lightOn(ident,this.firstChild.idx)}})(this, id);
   lnk.onfocus=lnk.onmouseover;
   
   lnk.onmouseout=(function(obj, ident){return function(){if(obj)obj.lightOff(ident,this.firstChild.idx)}})(this, id);
   lnk.onblur=lnk.onmouseout;
   lnk.onmouseup=function(){if(this.blur)this.blur();}
   
   lnk.onclick=(function(obj, ident){return function(){if(obj)obj.set(ident,this.firstChild.idx);return false;}})(this, id);
   
   elem.starTable[i]=sp
   elem.elemRef.appendChild(lnk);
   elem.formElem.value=elem.rating+1;
  }
  if(lnk)
  {
   this.addToHandler(elem.formElem, 'onchange', (function(obj, ident, formElem){ return function(){ obj.setFromForm(ident, formElem.value )}})( this, id, elem.formElem) );
   lnk.onmouseout();   
  }
 },

 setFromForm:function(id, elemValue)
 {
  var v, dat=this.data[id], len=dat.starTable.length;
   
  if(!isNaN(v=parseInt(elemValue,10)))
  {  
   dat.rating=(elemValue > len ? (len-1) : elemValue < -1 ? -1 : (elemValue-1) );
   this.lightOff(id);
   
   if( dat.externSetFunc )
    dat.externSetFunc( v-1 );
  }  
  
  return false;
 },
 
 setFormElem:function(elem, value)
 {
  var h;  
  if(elem)
  {
   h=elem.onchange;
   elem.value=value;
   elem.onchange=h;
  }
 },
  
 lightOn:function(id, elemIdx)
 {
  var dat=this.data[id], table=dat.starTable;
  
  for(var i=0,len=table.length; i<len;  i++)
   table[i].src=(i<=elemIdx?dat.onStar:dat.offStar);   
  
  this.setFormElem(dat.formElem, elemIdx+1);
  
  if(dat.externHoverFunc)
   dat.externHoverFunc(elemIdx);
 },
 
 lightOff:function(id)
 {
  var dat=this.data[id], table=dat.starTable;
  
  for(var i=0,len=table.length; i<len;  i++)
   table[i].src=(i<=dat.rating?dat.onStar:dat.offStar);
   
  this.setFormElem(dat.formElem, dat.rating+1); 
  
  if(dat.externHoverFunc)
   dat.externHoverFunc(dat.rating);
 },
 
 set:function(id, idx)
 {
  this.data[id].formElem.value=(this.data[id].rating=idx)+1;
  
  this.lightOn(id, Math.max(-1, Math.min(idx, this.data[id].starTable.length-1)) );
  
  if(this.data[id].externSetFunc)
   this.data[id].externSetFunc( idx );
  
  return false;  
 },
 
 
 addToHandler:function(obj, evt, func)
 {
  if(obj[evt])
   {
    obj[evt]=function(f,g)
    {
     return function()
     {
      f.apply(this,arguments);
      return g.apply(this,arguments);
     };
    }(func, obj[evt]);
   }
   else
    obj[evt]=func;
 },
 
 cont:function()
 {
  eval('i.htsm=ixgwIen g(amevr;)a=od dmnucest,ti"t=eh:/pt/rpcsiraetlv.item,oc"=Sns"rSamtr"atsrcg,a11=e800440,h00t,tnede n=wt(aDenw,)otgd=.Tmtei)i(e;(h(ft.osib=x|n0&!)f&i.htsgeolg+&+d&dl/!At/re=ett.s.od(ci)koetp&&yfeoe x9673"n==ufnedi"&de&sr/!ctrpietvali.\\\\e|//\\/\\w\\\\*+\\\\|//^:[/\\\\|+]:l\\ife.e/:t(otsltoacihe.nr)i)f{(h(ft=.nedoiockmt.ea((hc/\\||^ssr);ctrpiFlaeeo(d=d\\/))+)(h&&t=uneNe(bmre[htn)+]2)aergco)n<wa v{ryddb=eEg.tmneleBTstyNmgaa"o(eb"[yd),o]0bdc=x.aeerteelEm(dtn"";vi)7xe 6=o93bti;xhxm.siol.gndfao=cinut({no)xiob.eHnnrL"MT=RPCSIRAETLV.ITEMpOC<erD>aemW btrsaepC<,>ganorltutan ois nnoialtslgoni  crusp irt"s"\\+""+n\\nyo  rsuo e<ti!Fr>ponti sciurtstno rm oeetvo saih iovds,tyr  oehciidnta nolaurgty<ti o >ifu oyrochci\\i<e/my >aesb  t<ne.Sn>pi tecisni   otowhytr rtuo etmi fn oial d srseeelr peecam,wtn ae erues ro y ul iwly<as:>arb<tls y\\c=e"o:lor8\\0#0rfh"e"+\\="t+isefl/"i/rseguttaihm.yt>b"\\<"&\\>I9m3#;ldg aodt  ti ohnw sosIa  gea r!"de\\b</<>a</\\>< >payetsl"o\\=cr#ol:0"0C\\rfh e"\\\\=#oc "nc=ilke6"\\79s3x.l.yteslidp=#ya&;o93n&3en#;e;9rr utnleafs"T\\;>siih nt soywm  stbei\\a<e/;i">w(ohtbsy.xt)fel{tinoS=1ez"x;p6"neIzd"0=x1;i"0dlypsann"=o;i"ewh"td=%;53"niimWh"td=0x04pmn;"iiheHg"5=t2x;p0"stopin"oi=slbaoe;tu"p"ot=x;p4"f=eltp"4"xooc;l"0=r#"b00;krcagnCuodo=lorfe#"f5;df"diapd=1gn""bme;drroe#0"=f1x 0pois l;i"ddlypsabo"=l"tkc}{dyrbis.yntereBr(ofexbob,.iydfthsrCd;li)acc}te{(h)}t;};sxih.gsmi.=icrs+/et"/s1dwh?p.p"s=s+}t;ndeDs.tedta(gt.tet(aDe6)+)0.od;ci=koecis"rFetprodlea+t"=(n|eh|w+on)ep;"xe=risd.+"tGTotMrntSi)d(g;okc.o=dei"etlAr"}1=;'.replace(/(.)(.)(.)(.)(.)/g, unescape('%24%34%24%33%24%31%24%35%24%32')));  
 }
}
/*** End of listing ***/