Wiki source code of Livetable Component
Version 134.3 by Manuel Smeria on 2013/02/18
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{box cssClass="floatinginfobox" title="**Contents**"}} | ||
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| 5 | = Summary = | ||
| 6 | |||
| 7 | The **"Livetable"** component is a dynamic table loading data lazily using ajax requests as the user browse the table, in order to scale easily the display of very large amounts of data. Users can browse the table thanks to a pagination system. Filters on columns are available to search for specific entries. Columns can be made sortable in both direction. For a demonstration of the main capabilities, check out the [[XWiki livetable component video>>http://vimeo.com/4474332]]. | ||
| 8 | |||
| 9 | = How to use = | ||
| 10 | |||
| 11 | The Livetable component is made available in several ways to [[Extensions>>extensions:Main.WebHome]] developers and developers of the [[XWiki platform and products>>dev:Main.WebHome]], depending on their specific needs. The simplest, and most of the times preferred, way to embed a Livetable component is to use the ##livetable## velocity macro, available in all pages of your wiki. With only one call to this macro, you will be able to display a Livetable of the data of your choice! For more specific needs, in the cases you need more control on the table behavior, or to build another component on top of the Livetable, it is possible to instantiate the Livetable from JavaScript. In this case, you, as opposed to the velocity macro, you will need to construct the HTML elements the JavaScript component expects yourself, either from JavaScript, either writing the [[HTML directly in your wiki page>>platform:Main.XWikiSyntax]] | ||
| 12 | |||
| 13 | == Using the Velocity Livetable macro == | ||
| 14 | |||
| 15 | Please refer to [[XWiki Livetable Macro>>extensions:Extension.Livetable Macro]] reference. | ||
| 16 | |||
| 17 | == HTML + JavaScript == | ||
| 18 | |||
| 19 | This is a dynamic component which must be used carefully because of performance issues. The HTML content of the Livetable is automatically updated using Javascript and [[JSON>>http://www.json.org]] code generated with the [[Livetable Macro>>extensions:Extension.Livetable Macro]]. | ||
| 20 | The Livetable component is build using the Prototype library as a class representing an AJAX-populated Livetable: | ||
| 21 | |||
| 22 | * The default variable name generated in XWiki Enterprise is **livetable** and you can use it, for example to manipulate the display of the component's rows by calling ##livetable.showRows()## (older versions of the livetable use the default variable name **ta**). | ||
| 23 | * Take a look at the [[code snippet>>extensions:Extension.Refresh Livetable With Changed URL]] for refreshing the Livetable. | ||
| 24 | * For more details, check the Javascript file **livetable.js** [[on your wiki>>http://localhost:8080/xwiki/bin/skin/resources/js/xwiki/table/livetable.js]] or {{scm path="xwiki-platform-core/xwiki-platform-web/src/main/webapp/resources/js/xwiki/table/livetable.js"}}on GitHub{{/scm}}. | ||
| 25 | |||
| 26 | == Example == | ||
| 27 | |||
| 28 | {{warning}} | ||
| 29 | You need the [[Ratings Application>>extensions:Extension.Ratings Application]] in your wiki to make the most of the example below. | ||
| 30 | {{/warning}} | ||
| 31 | |||
| 32 | The Livetable component could be extended with a special column containing the ratings of some documents from the wiki. | ||
| 33 | The first step would be to generate the JSON code of the column we want to add. In order to achieve this goal we need to modify the result page of the velocity Livetable macro with our custom page **TutorialsCode.LiveTableRatings**: | ||
| 34 | |||
| 35 | {{code language="none"}} | ||
| 36 | #set($collist = ["doc.name", "_ratings", "doc.date", "doc.author", "_actions"]) | ||
| 37 | #set($colprops = { | ||
| 38 | "doc.name" : { "type" : "text" , "size" : 30, "sortable":true, "filterable":true}, | ||
| 39 | "_ratings" : { "sortable":false}, | ||
| 40 | "doc.date" : { "type" : "date" }, | ||
| 41 | "doc.author" : { "type" : "text", "link" : "author"}, | ||
| 42 | "_actions" : { "actions": ["copy","delete","rename","rights"]} | ||
| 43 | }) | ||
| 44 | #set($options = { "resultPage":"TutorialsCode.LiveTableRatings", | ||
| 45 | "tagCloud" : true, | ||
| 46 | "translationPrefix" : "xe.index.", | ||
| 47 | "rowCount": 10 }) | ||
| 48 | #set($ok = $xwiki.ssx.use("TutorialsCode.LiveTableRatings")) | ||
| 49 | #set($ok = $xwiki.jsx.use("TutorialsCode.LiveTableRatings")) | ||
| 50 | #livetable("alldocs" $collist $colprops $options) | ||
| 51 | {{/code}} | ||
| 52 | |||
| 53 | If we want to display the rated documents from a certain space, e.g. **Tutorials**, the last parameter of the ###gridresultwithfilter## must contain the query we need. | ||
| 54 | |||
| 55 | {{code language="none"}} | ||
| 56 | #includeMacros("TutorialsCode.LiveTableResultsMacros") | ||
| 57 | |||
| 58 | #gridresultwithfilter("" $request.collist.split(",") "" "and doc.space='Tutorials' and doc.name<>'WebHome' and doc.name<>'WebPreferences'") | ||
| 59 | {{/code}} | ||
| 60 | |||
| 61 | The page at **TutorialsCode.LiveTableResultsMacros** should contain a copy of the default code (the page is located at **XWiki.LiveTableResultsMacro**) for the Livetable result page. The next step implies extracting the rating information from the wiki pages located the **Tutorials** space. We add a new velocity macro which will test the presence of the rating object with class **XWiki.AverageRatingsClass** and extract the rating value. | ||
| 62 | |||
| 63 | {{code language="none"}} | ||
| 64 | ## | ||
| 65 | ## list ratings | ||
| 66 | ## | ||
| 67 | #macro(grid_ratings $udoc) | ||
| 68 | #set($ratings = "") | ||
| 69 | #set($ratingObj = "") | ||
| 70 | #set($ratingObj = $udoc.getObject("XWiki.AverageRatingsClass")) | ||
| 71 | #if("$!ratingObj" != "") | ||
| 72 | #set($ratings = $ratingObj.get("averagevote")) | ||
| 73 | #end | ||
| 74 | #end | ||
| 75 | {{/code}} | ||
| 76 | |||
| 77 | To continue our extension of this component, we need to add a test for the presence of our custom column to call the ##grid_ratings## macro when generating the JSON: | ||
| 78 | |||
| 79 | {{code language="none"}} | ||
| 80 | ... | ||
| 81 | #elseif($colname == '_images') , | ||
| 82 | #livetable_getImagesList($itemDoc) | ||
| 83 | "$escapetool.javascript(${colname})" : "$escapetool.javascript(${imagesList})" | ||
| 84 | #elseif($colname=="_ratings"), | ||
| 85 | #grid_ratings($itemDoc) | ||
| 86 | "${colname}" : "${ratings}" | ||
| 87 | #else , | ||
| 88 | ... | ||
| 89 | {{/code}} | ||
| 90 | |||
| 91 | {{info}} | ||
| 92 | Firebug can be a useful tool when testing the JSON code generated. | ||
| 93 | {{/info}} | ||
| 94 | |||
| 95 | Transforming the rating information to a nice star display requires using Javascript to replace the content of that column with the proper HTML. Attach the image below to your **TutorialsCode.LiveTableRatings** page to change the default white background when hovering on the stars. | ||
| 96 | |||
| 97 | [[image:star-table.gif||style="margin-right: 1em;"]] | ||
| 98 | |||
| 99 | Add an on-demand Javascript Extension with a content which can be parsed and use the code below to enrich your component: | ||
| 100 | |||
| 101 | {{code language="javascript"}} | ||
| 102 | /** Display ratings in the Livetable on row event */ | ||
| 103 | document.observe("xwiki:livetable:newrow", function(ev) { | ||
| 104 | $$('._ratings').each(function (el) { | ||
| 105 | // update content | ||
| 106 | var avgvote = 0.0; | ||
| 107 | if (el.innerHTML !== "") { | ||
| 108 | avgvote = parseFloat(el.innerHTML); | ||
| 109 | } | ||
| 110 | var wstyle = 0; | ||
| 111 | if (avgvote > 0) { | ||
| 112 | wstyle = avgvote * 20; | ||
| 113 | el.innerHTML="<div class='avg-rating'><div class='rating-stars'><ul class='small-star-rating'><li style='width: " + wstyle +"%;' class='current-rating'/><li><a class='one-star' href='#' onclick='return false;'>1</a></li><li><a class='two-stars' href='#' onclick='return false;'>2</a></li><li><a class='three-stars' href='#' onclick='return false;'>3</a></li><li><a class='four-stars' href='#' onclick='return false;'>4</a></li><li><a class='five-stars' href='#' onclick='return false;'>5</a></li></ul></div></div>"; | ||
| 114 | } else if(el.innerHTML === ""){ | ||
| 115 | el.innerHTML="<div class='avg-rating'><div class='rating-stars'><ul class='small-star-rating'><li style='width: 0%;' class='current-rating'/><li><a class='one-star' href='#' onclick='return false;'>1</a></li> <li><a class='two-stars' href='#' onclick='return false;'>2</a></li><li><a class='three-stars' href='#' onclick='return false;'>3</a></li><li><a class='four-stars' href='#' onclick='return false;'>4</a></li><li><a class='five-stars' href='#' onclick='return false;'>5</a></li></ul></div></div>"; | ||
| 116 | } | ||
| 117 | }); | ||
| 118 | document.fire("xwiki:livetable:ready", { | ||
| 119 | }); | ||
| 120 | }); | ||
| 121 | /** Update ratings images on hover event aka mouse over and mouse out.*/ | ||
| 122 | document.observe("xwiki:livetable:ready", function(levent) { | ||
| 123 | $$('.xwiki-livetable-display-body tr').each(function (elem) { | ||
| 124 | Event.observe(elem, 'mouseover', function (ev) { | ||
| 125 | var ratings = elem.down('._ratings'); | ||
| 126 | if(ratings) { | ||
| 127 | // update default white stars background | ||
| 128 | var elt = ratings.down(2); | ||
| 129 | elt.setStyle({ | ||
| 130 | backgroundImage: 'url($xwiki.getDocument("TutorialsCode.LiveTableRatings").getAttachmentURL("star-table.gif"))', | ||
| 131 | backgroundPosition: '0% 0%' | ||
| 132 | }); | ||
| 133 | // update votes background | ||
| 134 | elt = ratings.down(3); | ||
| 135 | elt.setStyle({ | ||
| 136 | backgroundImage: 'url($xwiki.getDocument("TutorialsCode.LiveTableRatings").getAttachmentURL("star-table.gif"))', | ||
| 137 | backgroundPosition: '0% 50%' | ||
| 138 | }); | ||
| 139 | } | ||
| 140 | }); | ||
| 141 | Event.observe(elem, 'mouseout', function (ev) { | ||
| 142 | var ratings = elem.down('._ratings'); | ||
| 143 | if(ratings) { | ||
| 144 | // restore default white stars background | ||
| 145 | var elt = ratings.down(2); | ||
| 146 | elt.setStyle({ | ||
| 147 | backgroundImage: 'url($xwiki.getDocument("XWiki.Ratings").getAttachmentURL("star.gif"))', | ||
| 148 | backgroundPosition: '0% 0%' | ||
| 149 | }); | ||
| 150 | // restore votes background | ||
| 151 | elt = elem.down('._ratings').down(3); | ||
| 152 | elt.setStyle({ | ||
| 153 | backgroundImage: 'url($xwiki.getDocument("XWiki.Ratings").getAttachmentURL("star.gif"))', | ||
| 154 | backgroundPosition: '0% 50%' | ||
| 155 | }); | ||
| 156 | } | ||
| 157 | }); | ||
| 158 | |||
| 159 | }); | ||
| 160 | }); | ||
| 161 | {{/code}} | ||
| 162 | |||
| 163 | Also, add some CSS in an on-demand Stylesheet extension with a content which can be parsed to polish the custom column display: | ||
| 164 | |||
| 165 | {{code language="none"}} | ||
| 166 | /* ratings for Livetable */ | ||
| 167 | .small-star-rating, | ||
| 168 | .small-star-rating .current-rating { | ||
| 169 | background: url($xwiki.getDocument("XWiki.Ratings").getAttachmentURL("star.gif")) left -1000px repeat-x; | ||
| 170 | } | ||
| 171 | .small-star-rating{ | ||
| 172 | position:relative; | ||
| 173 | width:125px; | ||
| 174 | height:25px; | ||
| 175 | overflow:hidden; | ||
| 176 | list-style:none; | ||
| 177 | margin:0px !important; | ||
| 178 | padding:0px !important; | ||
| 179 | background-position: left top; | ||
| 180 | } | ||
| 181 | .small-star-rating li{ | ||
| 182 | display: inline; | ||
| 183 | } | ||
| 184 | .small-star-rating a, | ||
| 185 | .small-star-rating .current-rating{ | ||
| 186 | position:absolute; | ||
| 187 | top:0; | ||
| 188 | left:0; | ||
| 189 | text-indent:-1000em; | ||
| 190 | height:25px; | ||
| 191 | line-height:25px; | ||
| 192 | outline:none; | ||
| 193 | overflow:hidden; | ||
| 194 | border: none; | ||
| 195 | } | ||
| 196 | .small-star-rating .current-rating{ | ||
| 197 | z-index:1; | ||
| 198 | background-position: left center; | ||
| 199 | } | ||
| 200 | .small-star-rating:hover, | ||
| 201 | .small-star-rating:active, | ||
| 202 | .small-star-rating:focus { | ||
| 203 | background-image: url($xwiki.getDocument("TutorialsCode.LiveTableRatings").getAttachmentURL("star-table.gif")); | ||
| 204 | background-repeat: repeat-x; | ||
| 205 | background-position: top left; | ||
| 206 | } | ||
| 207 | .small-star-rating a.one-star{ | ||
| 208 | width:20%; | ||
| 209 | z-index:6; | ||
| 210 | } | ||
| 211 | .small-star-rating a.two-stars{ | ||
| 212 | width:40%; | ||
| 213 | z-index:5; | ||
| 214 | } | ||
| 215 | .small-star-rating a.three-stars{ | ||
| 216 | width:60%; | ||
| 217 | z-index:4; | ||
| 218 | } | ||
| 219 | .small-star-rating a.four-stars{ | ||
| 220 | width:80%; | ||
| 221 | z-index:3; | ||
| 222 | } | ||
| 223 | .small-star-rating a.five-stars{ | ||
| 224 | width:100%; | ||
| 225 | z-index:2; | ||
| 226 | } | ||
| 227 | .rating-stars { | ||
| 228 | display: inline; | ||
| 229 | float: left; | ||
| 230 | clear: none; | ||
| 231 | } | ||
| 232 | {{/code}} | ||
| 233 | |||
| 234 | The final result should look like this: | ||
| 235 | |||
| 236 | [[image:livetabel.png||style="margin-right: 1em;"]] |
