/*
star_rating.js - a program to display a SVG based star rating widget
Copyright (C) 2011 Siddharth Jain <siddjain@live.com>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version provided this notice is copied
verbatim in your redistribution and/or modification.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* A class to parse color values
* @author Stoyan Stefanov <sstoo@gmail.com>
* @link http://www.phpied.com/rgb-color-parser-in-javascript/
* @license Use it if you like it
*/
function RGBColor(color_string)
{
this.ok = false;
// strip any leading #
if (color_string.charAt(0) == '#') { // remove # if any
color_string = color_string.substr(1,6);
}
color_string = color_string.replace(/ /g,'');
color_string = color_string.toLowerCase();
// before getting into regexps, try simple matches
// and overwrite the input
var simple_colors = {
aliceblue: 'f0f8ff',
antiquewhite: 'faebd7',
aqua: '00ffff',
aquamarine: '7fffd4',
azure: 'f0ffff',
beige: 'f5f5dc',
bisque: 'ffe4c4',
black: '000000',
blanchedalmond: 'ffebcd',
blue: '0000ff',
blueviolet: '8a2be2',
brown: 'a52a2a',
burlywood: 'deb887',
cadetblue: '5f9ea0',
chartreuse: '7fff00',
chocolate: 'd2691e',
coral: 'ff7f50',
cornflowerblue: '6495ed',
cornsilk: 'fff8dc',
crimson: 'dc143c',
cyan: '00ffff',
darkblue: '00008b',
darkcyan: '008b8b',
darkgoldenrod: 'b8860b',
darkgray: 'a9a9a9',
darkgreen: '006400',
darkkhaki: 'bdb76b',
darkmagenta: '8b008b',
darkolivegreen: '556b2f',
darkorange: 'ff8c00',
darkorchid: '9932cc',
darkred: '8b0000',
darksalmon: 'e9967a',
darkseagreen: '8fbc8f',
darkslateblue: '483d8b',
darkslategray: '2f4f4f',
darkturquoise: '00ced1',
darkviolet: '9400d3',
deeppink: 'ff1493',
deepskyblue: '00bfff',
dimgray: '696969',
dodgerblue: '1e90ff',
feldspar: 'd19275',
firebrick: 'b22222',
floralwhite: 'fffaf0',
forestgreen: '228b22',
fuchsia: 'ff00ff',
gainsboro: 'dcdcdc',
ghostwhite: 'f8f8ff',
gold: 'ffd700',
goldenrod: 'daa520',
gray: '808080',
green: '008000',
greenyellow: 'adff2f',
honeydew: 'f0fff0',
hotpink: 'ff69b4',
indianred : 'cd5c5c',
indigo : '4b0082',
ivory: 'fffff0',
khaki: 'f0e68c',
lavender: 'e6e6fa',
lavenderblush: 'fff0f5',
lawngreen: '7cfc00',
lemonchiffon: 'fffacd',
lightblue: 'add8e6',
lightcoral: 'f08080',
lightcyan: 'e0ffff',
lightgoldenrodyellow: 'fafad2',
lightgrey: 'd3d3d3',
lightgreen: '90ee90',
lightpink: 'ffb6c1',
lightsalmon: 'ffa07a',
lightseagreen: '20b2aa',
lightskyblue: '87cefa',
lightslateblue: '8470ff',
lightslategray: '778899',
lightsteelblue: 'b0c4de',
lightyellow: 'ffffe0',
lime: '00ff00',
limegreen: '32cd32',
linen: 'faf0e6',
magenta: 'ff00ff',
maroon: '800000',
mediumaquamarine: '66cdaa',
mediumblue: '0000cd',
mediumorchid: 'ba55d3',
mediumpurple: '9370d8',
mediumseagreen: '3cb371',
mediumslateblue: '7b68ee',
mediumspringgreen: '00fa9a',
mediumturquoise: '48d1cc',
mediumvioletred: 'c71585',
midnightblue: '191970',
mintcream: 'f5fffa',
mistyrose: 'ffe4e1',
moccasin: 'ffe4b5',
navajowhite: 'ffdead',
navy: '000080',
oldlace: 'fdf5e6',
olive: '808000',
olivedrab: '6b8e23',
orange: 'ffa500',
orangered: 'ff4500',
orchid: 'da70d6',
palegoldenrod: 'eee8aa',
palegreen: '98fb98',
paleturquoise: 'afeeee',
palevioletred: 'd87093',
papayawhip: 'ffefd5',
peachpuff: 'ffdab9',
peru: 'cd853f',
pink: 'ffc0cb',
plum: 'dda0dd',
powderblue: 'b0e0e6',
purple: '800080',
red: 'ff0000',
rosybrown: 'bc8f8f',
royalblue: '4169e1',
saddlebrown: '8b4513',
salmon: 'fa8072',
sandybrown: 'f4a460',
seagreen: '2e8b57',
seashell: 'fff5ee',
sienna: 'a0522d',
silver: 'c0c0c0',
skyblue: '87ceeb',
slateblue: '6a5acd',
slategray: '708090',
snow: 'fffafa',
springgreen: '00ff7f',
steelblue: '4682b4',
tan: 'd2b48c',
teal: '008080',
thistle: 'd8bfd8',
tomato: 'ff6347',
turquoise: '40e0d0',
violet: 'ee82ee',
violetred: 'd02090',
wheat: 'f5deb3',
white: 'ffffff',
whitesmoke: 'f5f5f5',
yellow: 'ffff00',
yellowgreen: '9acd32'
};
for (var key in simple_colors) {
if (color_string == key) {
color_string = simple_colors[key];
}
}
// emd of simple type-in colors
// array of color definition objects
var color_defs = [
{
re: /^rgb\((\d{1,3}),\s*(\d{1,3}),\s*(\d{1,3})\)$/,
example: ['rgb(123, 234, 45)', 'rgb(255,234,245)'],
process: function (bits){
return [
parseInt(bits[1]),
parseInt(bits[2]),
parseInt(bits[3])
];
}
},
{
re: /^(\w{2})(\w{2})(\w{2})$/,
example: ['#00ff00', '336699'],
process: function (bits){
return [
parseInt(bits[1], 16),
parseInt(bits[2], 16),
parseInt(bits[3], 16)
];
}
},
{
re: /^(\w{1})(\w{1})(\w{1})$/,
example: ['#fb0', 'f0f'],
process: function (bits){
return [
parseInt(bits[1] + bits[1], 16),
parseInt(bits[2] + bits[2], 16),
parseInt(bits[3] + bits[3], 16)
];
}
}
];
// search through the definitions to find a match
for (var i = 0; i < color_defs.length; i++) {
var re = color_defs[i].re;
var processor = color_defs[i].process;
var bits = re.exec(color_string);
if (bits) {
channels = processor(bits);
this.r = channels[0];
this.g = channels[1];
this.b = channels[2];
this.ok = true;
}
}
// validate/cleanup values
this.r = (this.r < 0 || isNaN(this.r)) ? 0 : ((this.r > 255) ? 255 : this.r);
this.g = (this.g < 0 || isNaN(this.g)) ? 0 : ((this.g > 255) ? 255 : this.g);
this.b = (this.b < 0 || isNaN(this.b)) ? 0 : ((this.b > 255) ? 255 : this.b);
// some getters
this.toRGB = function () {
return 'rgb(' + this.r + ', ' + this.g + ', ' + this.b + ')';
}
this.toHex = function () {
var r = this.r.toString(16);
var g = this.g.toString(16);
var b = this.b.toString(16);
if (r.length == 1) r = '0' + r;
if (g.length == 1) g = '0' + g;
if (b.length == 1) b = '0' + b;
return '#' + r + g + b;
}
// help
this.getHelpXML = function () {
var examples = new Array();
// add regexps
for (var i = 0; i < color_defs.length; i++) {
var example = color_defs[i].example;
for (var j = 0; j < example.length; j++) {
examples[examples.length] = example[j];
}
}
// add type-in colors
for (var sc in simple_colors) {
examples[examples.length] = sc;
}
var xml = document.createElement('ul');
xml.setAttribute('id', 'rgbcolor-examples');
for (var i = 0; i < examples.length; i++) {
try {
var list_item = document.createElement('li');
var list_color = new RGBColor(examples[i]);
var example_div = document.createElement('div');
example_div.style.cssText =
'margin: 3px; '
+ 'border: 1px solid black; '
+ 'background:' + list_color.toHex() + '; '
+ 'color:' + list_color.toHex()
;
example_div.appendChild(document.createTextNode('test'));
var list_item_value = document.createTextNode(
' ' + examples[i] + ' -> ' + list_color.toRGB() + ' -> ' + list_color.toHex()
);
list_item.appendChild(example_div);
list_item.appendChild(list_item_value);
xml.appendChild(list_item);
} catch(e){}
}
return xml;
}
}
function parseColor(color_string, fallback_value)
{
var ans = fallback_value;
if (color_string)
{
var color = new RGBColor(color_string);
if (color.ok)
{
ans = color.toRGB();
}
}
return ans;
};
var rating_widget = function(options)
{
var self = this;
var n = 5;
var initial_value = 0;
var iv_color = color(255, 255, 0);
var fv_color = color(255, 0, 0);
var default_color = color(200, 200, 200);
var captions = null;
var captions_default_style = 'font-family:sans-serif';
var captions_class_name = '';
var on_click = null;
var disabled = null;
if (options)
{
captions = options.captions;
if (typeof captions === 'string')
{
captions = captions.split(',');
}
if (options.number_of_stars)
{
var i = parseInt(options.number_of_stars);
if (i <= 0 || i > 10)
{
throw new Error('number_of_stars should be between 1 and 10');
}
n = i;
}
if (options.initial_value)
{
var f = Math.round(parseFloat(options.initial_value));
if (f < 0 || f > n)
{
throw new Error('initial_value should be between 0 and number_of_stars');
}
initial_value = f;
}
if (options.default_color)
{
default_color = options.default_color;
}
if (options.initial_value_color)
{
iv_color = options.initial_value_color;
}
if (options.final_value_color)
{
fv_color = options.final_value_color;
}
if (options.captions_class_name)
{
captions_class_name = options.captions_class_name;
}
on_click = options.onclick;
disabled = options.disabled;
if (typeof disabled === 'string')
{
disabled = disabled.toLowerCase() === 'true'
}
}
var coordinates= "M 46.296296,51.906272 L 31.916351,42.474649 L 17.502712,51.8547 L 22.029072,35.264028 L 8.654054,24.454438 L 25.831443,23.632463 L 31.978866,7.5717174 L 38.068716,23.65438 L 55.243051,24.537884 L 41.829396,35.299492 L 46.296296,51.906272 z ";
var style = "fill-opacity:1;stroke:black;stroke-width:2;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1";
var svgns = "http://www.w3.org/2000/svg";
var root = document.createElement('span');
var svg_root = document.createElementNS(svgns, "svg");
var caption_node = document.createElement('span');
if (captions_class_name) { caption_node.className = captions_class_name; }
else { caption_node.style.cssText = captions_default_style; }
var text_node = document.createTextNode('');
caption_node.appendChild(text_node);
svg_root.setAttributeNS(null, 'width', 21*n);
svg_root.setAttributeNS(null, 'height', 25);
root.appendChild(svg_root);
root.appendChild(caption_node);
if (options && options.parentNode && options.parentNode.appendChild)
{
options.parentNode.appendChild(root);
}
var stars = [];
var boxes = [];
var selectedValue = null;
for(var i = 0; i < n; i++)
{
var star = document.createElementNS(svgns, "path");
star.setAttributeNS(null, "d", coordinates);
star.setAttributeNS(null, "transform", transform(0.3947432, 0, 0, 0.414816, 20*i, 1.159472));
star.setAttributeNS(null, "style", style);
svg_root.appendChild(star);
var box = bbox(star);
if (!disabled)
{
if (box) { attachEventHandlers(box, boxes); }
else { attachEventHandlers(star, stars); }
}
stars.push(star);
boxes.push(box);
}
initial_state();
this.root = root;
function attachEventHandlers(e, array)
{
e.onmouseover = function (evt)
{
var flag = true;
for(var j = 0; j < stars.length; j++)
{
if (flag) { stars[j].setAttributeNS(null, "fill", fv_color); }
else { stars[j].setAttributeNS(null, "fill", default_color); }
if (flag && array[j] === evt.target)
{
if (captions && captions[j]) { text_node.textContent = captions[j]; }
selectedValue = j + 1;
flag = false;
}
}
};
e.onmouseout = function (evt)
{
text_node.textContent = '';
initial_state();
};
e.onclick = function (evt)
{
for(var j = 0; j < array.length; j++)
{
array[j].onmouseover = null;
array[j].onmouseout = null;
array[j].onclick = null;
}
if (typeof on_click === 'string')
{
eval(on_click+'(self , selectedValue)');
}
else if (typeof on_click === 'function')
{
on_click(self, selectedValue);
}
};
};
function initial_state()
{
for(var i = 0; i < stars.length; i++)
{
var star = stars[i];
if (i < initial_value)
{
star.setAttributeNS(null, "fill", iv_color);
}
else
{
star.setAttributeNS(null, "fill", default_color);
}
}
};
function bbox(e)
{
if (e && e.getBBox && e.getAttributeNS)
{
var box = e.getBBox();
var transform = e.getAttributeNS(null, 'transform');
if (box.x && box.y && box.width && box.height && transform)
{
var rect = document.createElementNS(svgns, 'rect');
rect.setAttributeNS(null, 'x', box.x);
rect.setAttributeNS(null, 'y', box.y);
rect.setAttributeNS(null, 'width', box.width);
rect.setAttributeNS(null, 'height', box.height);
rect.setAttributeNS(null, 'fill', 'rgba(0,0,0,0)');
rect.setAttributeNS(null, 'stroke', 'rgba(0,0,0,0)');
rect.setAttributeNS(null, 'transform', transform);
e.parentNode.appendChild(rect);
return rect;
}
}
return null;
};
function color(r, g, b)
{
return "rgb(" + r + ", " + g + ", " + b + ")"
};
function transform(a, b, c, d, e, f)
{
return "matrix(" + a + "," + b + "," + c + "," + d + "," + e + "," + f + ")";
};
};
document.body.onload = function()
{
var array = document.getElementsByClassName('rating_widget');
for(var i = 0; i < array.length; i++)
{
var e = array[i];
var widget = new rating_widget(
{
number_of_stars: e.getAttribute('number_of_stars') ? e.getAttribute('number_of_stars') : 5,
initial_value: e.getAttribute('initial_value') ? e.getAttribute('initial_value') : 0,
default_color: parseColor(e.getAttribute('default_color'), 'rgb(200,200,200)'),
initial_value_color: parseColor(e.getAttribute('initial_value_color'), 'rgb(255,255,0)'),
final_value_color: parseColor(e.getAttribute('final_value_color'), 'rgb(255,0,0)'),
captions: e.getAttribute('captions'),
captions_class_name: e.getAttribute('captions_class_name'),
onclick: e.getAttribute('onclick'),
disabled: e.getAttribute('disabled'),
parentNode: e
});
}
};
Submit an article or tip