Wiki source code of Live Table component
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | #info("This document is a work in progress") | ||
| 2 | |||
| 3 | 1 Live Table component | ||
| 4 | |||
| 5 | #warning("This section documents a feature that is only available starting with XWiki Enterprise 1.9M2. This version is not released yet. You can [stay in touch with the Roadmap>http://enterprise.xwiki.org/xwiki/bin/view/Main/Roadmap#HXWikiEnterprise19] or [grab a snapshot>http://maven.xwiki.org/snapshots/com/xpn/xwiki/products/xwiki-enterprise-jetty-hsqldb/1.9-SNAPSHOT/].") | ||
| 6 | |||
| 7 | #toc("" "" "") | ||
| 8 | |||
| 9 | 1.1 Summary | ||
| 10 | |||
| 11 | The *"Live Table"* 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. Below | ||
| 12 | |||
| 13 | 1.1 How to use | ||
| 14 | |||
| 15 | The Live Table component is made available in several ways to [Applications>code:Applications.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 Live Table component is to use the <tt>#livetable</tt> velocity macro, available in all pages of your wiki. With only one call to this macro, you will be able to display a live table 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 live table, it is possible to instantiate the live table 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] | ||
| 16 | |||
| 17 | 1.1.1 Using the Velocity <tt>#livetable</tt> macro | ||
| 18 | |||
| 19 | One velocity macro call is enough to display a live table of wiki data. The most common use case is displaying a table of documents that contains an [XWiki Object of a certain class>platform:DevGuide.DataModel]. This is a powerful way for in-wiki applications developers to offer a mining interface on their application data (for example Contacts in a CRM/Contact manager, Bills in a Billing application, etc.). Since Users in XWiki are managed and stored using the Class and Object abstraction of [XWiki' Data Model>platform:DevGuide.DataModel], we will illustrate usages of the <tt>#livetable</tt> velocity macro to create a dynamic user directory. | ||
| 20 | |||
| 21 | The signature of the macro is the following : | ||
| 22 | |||
| 23 | {code} | ||
| 24 | #macro(livetable $id $columns $columnsProperties $options) | ||
| 25 | {code} | ||
| 26 | |||
| 27 | 1.1.1 HTML + JavaScript |
