[displaytag-cvs] displaytag2/xdocs changes.xml,1.23,1.24 configuration.xml,1.5,1.6
Brought to you by:
fgiust
Menu
▾
▴
[displaytag-cvs] displaytag2/xdocs changes.xml,1.23,1.24 configuration.xml,1.5,1.6
|
From: <fg...@us...> - 2003-12-28 23:42:57
|
Update of /cvsroot/displaytag/displaytag2/xdocs
In directory sc8-pr-cvs1:/tmp/cvs-serv32555/xdocs
Modified Files:
changes.xml configuration.xml
Log Message:
documenting the new configuration properties
Index: changes.xml
===================================================================
RCS file: /cvsroot/displaytag/displaytag2/xdocs/changes.xml,v
retrieving revision 1.23
retrieving revision 1.24
diff -C2 -d -r1.23 -r1.24
*** changes.xml 27 Dec 2003 15:19:03 -0000 1.23
--- changes.xml 28 Dec 2003 23:42:54 -0000 1.24
***************
*** 16,19 ****
--- 16,24 ----
where the filter can't be used).
</action>
+ <action type="add" dev="fgiust" due-to="Fabrizio Giustina">
+ All the css classes in the table tag are now customizable. You can change the original <code>even, odd, sorted, order1, order2</code> classes
+ and also configure a css class to be added to any table or to any sortable column.
+ See <a href="configuration.html#Exporting">Reference>Configuration</a> for the full list of configurable properties.
+ </action>
</release>
Index: configuration.xml
===================================================================
RCS file: /cvsroot/displaytag/displaytag2/xdocs/configuration.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** configuration.xml 1 Dec 2003 05:12:00 -0000 1.5
--- configuration.xml 28 Dec 2003 23:42:54 -0000 1.6
***************
*** 1,309 ****
! <?xml version="1.0"?>
<document>
-
<properties>
<title>Configuration</title>
<author email="fgiust AT users.sourceforge.net">Fabrizio Giustina</author>
</properties>
-
<body>
-
<section name="Configuration properties">
-
<p>
! This table lists all the configurable properties for the tag libraries. The default properties are defined in
! the <code>TableTag.properties</code> file included in the library jar.
</p>
<p>There are 3 ways to override default property settings:</p>
<ul>
<li>
! For the whole web application, create a custom properties file named "displaytag.properties"
! and place it in the application classpath.
! </li>
! <li>To override a property at runtime for the whole web application, such as to include the context name in a
! fully qualified link to a
! resource, use <a href="./apidocs/org/displaytag/properties/TableProperties.html#setUserProperties">
! TableProperties#setUserProperties(Properties properties)</a>. #setProperties will copy all properties;
! future changes to your Properties parameter will not be reflected in the tag.
! <a href="./apidocs/org/displaytag/properties/DisplayPropertiesLoaderServlet.html"><code>DisplayPropertiesLoaderServlet</code></a>
! is included in the library jar as a convenience.)
</li>
<li>For a single table instance, using the <display:setProperty> tag</li>
</ul>
! <table>
! <thead>
! <tr>
! <th>Property</th>
! <th>Default</th>
! <th>Valid Values</th>
! <th>Description</th>
! </tr>
! </thead>
! <tbody>
!
! <tr>
! <td>basic.show.header</td>
! <td class="source">true</td>
! <td>true, false</td>
! <td>
! Indicates if you want the header to appear at the top of the table, the header contains the column names,
! and any additional action banners that might be required (like paging, export, etc...)
! </td>
! </tr>
!
! <tr>
! <td>basic.msg.empty_list</td>
! <td class="source">Nothing found to display</td>
! <td>Any string</td>
! <td>
! The message that is displayed with the list that this table is associated with is either null, or empty
! </td>
! </tr>
!
! <tr>
! <td>export.banner</td>
! <td class="source"><div class="exportlinks">Export options: {0}</div></td>
! <td>Any string in a message format with 1 placeholder</td>
! <td>
! Contains the string that is displayed in the table footer when the user indicates that they want to
! enabled the export function. The placeholder is replaced with links to the various export formats that
! are support.
! </td>
! </tr>
!
! <tr>
! <td>export.banner.sepchar</td>
! <td class="source">|</td>
! <td>Any string</td>
! <td>Used to separate the valid export type (typically would be a bar a comma, or a dash).</td>
! </tr>
!
! <tr>
! <td>export.csv</td>
! <td class="source">true</td>
! <td>true, false</td>
! <td>Should the tag present the option to export data in comma separated format (csv).</td>
! </tr>
!
! <tr>
! <td>export.csv.label</td>
! <td class="source"><span class="export csv">CSV </span></td>
! <td>Any string</td>
! <td>The label on the link that the user clicks on to export the data in CSV format.</td>
! </tr>
!
! <tr>
! <td>export.csv.include_header</td>
! <td class="source">false</td>
! <td>true, false</td>
! <td>
! If set to true, then the first line of the export will contain the column titles as displayed on the HTML
! page. By default this is set to false, so the header is not included in the export.
! </td>
! </tr>
!
! <tr>
! <td>export.excel</td>
! <td class="source">true</td>
! <td>true, false</td>
! <td>Should the tag present the option to export data in Excel format (tab separated values)</td>
! </tr>
!
! <tr>
! <td>export.excel.label</td>
! <td class="source"><span class="export excel">Excel </span></td>
! <td>Any string</td>
! <td>The label on the link that the user clicks on to export the data in Excel format</td>
! </tr>
!
! <tr>
! <td>export.excel.include_header</td>
! <td class="source">false</td>
! <td>true, false</td>
! <td>
! If set to true, then the first line of the export will contain the column titles as displayed on the HTML
! page. By default this is set to false, so the header is not included in the export.
! </td>
! </tr>
!
! <tr>
! <td>export.xml</td>
! <td class="source">true</td>
! <td>true, false</td>
! <td>Should the tag present the option to export data in XML format</td>
! </tr>
!
! <tr>
! <td>export.xml.label</td>
! <td class="source"><span class="export xml">XML </span></td>
! <td>Any string</td>
! <td>The label on the link that the user clicks on to export the data in XML format</td>
! </tr>
!
! <tr>
! <td>export.amount</td>
! <td class="source">list</td>
! <td>page, list</td>
! <td>
! Indicates how much data should be sent down to the user when they ask for a data export. By default, it
! sends the entire list, but you can instruct the table tag to only send down the data that is currently
! being shown on the page
! </td>
! </tr>
!
! <tr>
! <td>export.decorated</td>
! <td class="source">true</td>
! <td>true, false</td>
! <td>
! Should the data be "decorated" as it is exported. The default value is true, but you might want to turn
! off any decoration that is HTML specific for example when exporting the data.
! </td>
! </tr>
!
! <tr>
! <td>paging.banner.placement</td>
! <td class="source">top</td>
! <td>top, bottom, both</td>
! <td>
! When the table tag has to show the header for paging through a long list, this option indicates where
! that header should be shown in relation to the table
! </td>
! </tr>
!
! <tr>
! <td>paging.banner.item_name</td>
! <td class="source">item</td>
! <td>Any string</td>
! <td>What the various objects in the list being displayed should be referred to as (singular)</td>
! </tr>
!
! <tr>
! <td>paging.banner.items_name</td>
! <td class="source">items</td>
! <td>Any string</td>
! <td>What the various objects in the list being displayed should be referred to as (plural)</td>
! </tr>
!
! <tr>
! <td>paging.banner.no_items_found</td>
! <td class="source"><span class="pagebanner">No {0} found.</span></td>
! <td>Any string in a message format with 1 placeholder</td>
! <td>
! What is shown in the pagination header when no objects are available in the list to be displayed. The
! single placeholder is replaced with the name of the items in the list (plural)
! </td>
! </tr>
!
! <tr>
! <td>paging.banner.one_item_found</td>
! <td class="source"><span class="pagebanner">One {0} found.</span></td>
! <td>Any string in a message format with 1 placeholder</td>
! <td>
! What is shown in the pagination header when one object is available in the list to be displayed. The
! single placeholder is replaced with the name of the items in the list (singular)
! </td>
! </tr>
!
! <tr>
! <td>paging.banner.all_items_found</td>
! <td class="source"><span class="pagebanner">{0} {1} found, displaying all {2}.</span></td>
! <td>Any string in a message format with 3 placeholders</td>
! <td>
! What is shown in the pagination header when all the objects in the list are being shown. {0} and {2} are
! replaced with the number of objects in the list, {1} is replaced with the name of the items {plural}
! </td>
! </tr>
!
! <tr>
! <td>paging.banner.some_items_found</td>
! <td class="source"><span class="pagebanner">{0} {1} found, displaying {2} to {3}.</span></td>
! <td>Any string in a message format with 4 placeholders</td>
! <td>
! What is shown in the pagination header when a partial list of the the objects in the list are being
! shown. {0} indicates the total number of objects in the list, {1} is replaced with the name of the items
! (plural}, {2} and {3} are replaced with the start and end index of the objects being shown respectively
! </td>
! </tr>
!
! <tr>
! <td>paging.banner.group_size</td>
! <td class="source">8</td>
! <td>Any reasonable number</td>
! <td>The number of pages to show in the header that this person can instantly jump to</td>
! </tr>
!
! <tr>
! <td>paging.banner.full</td>
! <td class="source">
! <span class="pagelinks">[<a href="{1}">First</a>/<a href="{2}">Prev</a>] {0} [<a href="{3}">Next</a>/<a
! href="{4}">Last</a>]</span>
! </td>
! <td />
! <td>
! What is shown in the pagination bar when there are more pages and the selected page is not the first or
! the last one. {0} will be replaced with the numbered pages list. {1} indicates the link to the first
! page, {2} the link to the previous page, {3} to the next page and {4} to the last page.
! </td>
! </tr>
!
! <tr>
! <td>paging.banner.first</td>
! <td class="source"><span class="pagelinks">[First/Prev] {0} [<a href="{3}">Next</a>/<a href="{4}">Last</a>]</span></td>
! <td />
! <td>
! What is shown in the pagination bar when the first page is being shown. {0} will be replaced with the
! numbered pages list. {1} indicates the link to the first page, {2} the link to the previous page, {3} to
! the next page and {4} to the last page.
! </td>
! </tr>
!
! <tr>
! <td>paging.banner.last</td>
! <td class="source"><span class="pagelinks">[<a href="{1}">First</a>/<a href="{2}">Prev</a>] {0} [Next/Last]</span></td>
! <td />
! <td>
! What is shown in the pagination bar when the last page is being shown. {0} will be replaced with the
! numbered pages list. {1} indicates the link to the first page, {2} the link to the previous page, {3} to
! the next page and {4} to the last page.
! </td>
! </tr>
!
! <tr>
! <td>paging.banner.onepage</td>
! <td class="source"><span class="pagelinks">{0}</span></td>
! <td />
! <td>
! What is shown in the pagination bar when only one page is returned. {0} will be replaced with the
! numbered pages list. {1} indicates the link to the first page, {2} the link to the previous page, {3} to
! the next page and {4} to the last page.
! </td>
! </tr>
!
! <tr>
! <td>paging.banner.page.selected</td>
! <td class="source"><strong>{0}</strong></td>
! <td />
! <td>selected page. {0} is replaced with the page number, {1} with the page url.</td>
! </tr>
!
! <tr>
! <td>paging.banner.page.link</td>
! <td class="source"><a href="{1}" title="Go to page {0}">{0}</a></td>
! <td />
! <td>link to a page. {0} is replaced with the page number, {1} with the page url.</td>
! </tr>
!
! <tr>
! <td>paging.banner.page.separator</td>
! <td class="source">,</td>
! <td />
! <td>separator between pages</td>
! </tr>
! </tbody>
! </table>
!
</section>
-
</body>
</document>
--- 1,280 ----
! <?xml version="1.0" encoding="UTF-8"?>
<document>
<properties>
<title>Configuration</title>
<author email="fgiust AT users.sourceforge.net">Fabrizio Giustina</author>
</properties>
<body>
<section name="Configuration properties">
<p>
! This table lists all the configurable properties for the tag libraries. The default properties are defined in the
! <code>TableTag.properties</code>
! file included in the library jar.
</p>
<p>There are 3 ways to override default property settings:</p>
<ul>
+ <li>For the whole web application, create a custom properties file named "displaytag.properties" and place it in the application classpath.</li>
<li>
! To override a property at runtime for the whole web application, such as to include the context name in a fully qualified link to a resource, use
! <a href="./apidocs/org/displaytag/properties/TableProperties.html#setUserProperties">TableProperties#setUserProperties(Properties properties)</a>
! . #setProperties will copy all properties; future changes to your Properties parameter will not be reflected in the tag.
! <a href="./apidocs/org/displaytag/properties/DisplayPropertiesLoaderServlet.html">
! <code>DisplayPropertiesLoaderServlet</code>
! </a>
! is included in the library jar as a convenience.)
</li>
<li>For a single table instance, using the <display:setProperty> tag</li>
</ul>
! <p>
! Include in your custom properties file only the properties you need to change. If a property is not defined
! in the user file, the default from the TableTag.properties included in the jar is used.
! </p>
! <subsection name="Generic">
! <table>
! <thead>
! <tr>
! <th>Property</th>
! <th>Default</th>
! <th>Valid Values</th>
! <th>Description</th>
! </tr>
! </thead>
! <tbody>
! <tr>
! <td>basic.show.header</td>
! <td class="source">true</td>
! <td>true, false</td>
! <td>Indicates if you want the header to appear at the top of the table, the header contains the column names, and any additional action banners that might be required (like paging, export, etc...)</td>
! </tr>
! <tr>
! <td>basic.msg.empty_list</td>
! <td class="source">Nothing found to display</td>
! <td>Any string</td>
! <td>The message that is displayed with the list that this table is associated with is either null, or empty</td>
! </tr>
! <tr>
! <td>export.banner</td>
! <td class="source"><div class="exportlinks">Export options: {0}</div></td>
! <td>Any string in a message format with 1 placeholder</td>
! <td>Contains the string that is displayed in the table footer when the user indicates that they want to enabled the export function. The placeholder is replaced with links to the various export formats that are support.</td>
! </tr>
! <tr>
! <td>export.banner.sepchar</td>
! <td class="source">|</td>
! <td>Any string</td>
! <td>Used to separate the valid export type (typically would be a bar a comma, or a dash).</td>
! </tr>
! <tr>
! <td>paging.banner.placement</td>
! <td class="source">top</td>
! <td>top, bottom, both</td>
! <td>When the table tag has to show the header for paging through a long list, this option indicates where that header should be shown in relation to the table</td>
! </tr>
! <tr>
! <td>paging.banner.item_name</td>
! <td class="source">item</td>
! <td>Any string</td>
! <td>What the various objects in the list being displayed should be referred to as (singular)</td>
! </tr>
! <tr>
! <td>paging.banner.items_name</td>
! <td class="source">items</td>
! <td>Any string</td>
! <td>What the various objects in the list being displayed should be referred to as (plural)</td>
! </tr>
! <tr>
! <td>paging.banner.no_items_found</td>
! <td class="source"><span class="pagebanner">No {0} found.</span></td>
! <td>Any string in a message format with 1 placeholder</td>
! <td>What is shown in the pagination header when no objects are available in the list to be displayed. The single placeholder is replaced with the name of the items in the list (plural)</td>
! </tr>
! <tr>
! <td>paging.banner.one_item_found</td>
! <td class="source"><span class="pagebanner">One {0} found.</span></td>
! <td>Any string in a message format with 1 placeholder</td>
! <td>What is shown in the pagination header when one object is available in the list to be displayed. The single placeholder is replaced with the name of the items in the list (singular)</td>
! </tr>
! <tr>
! <td>paging.banner.all_items_found</td>
! <td class="source"><span class="pagebanner">{0} {1} found, displaying all {2}.</span></td>
! <td>Any string in a message format with 3 placeholders</td>
! <td>What is shown in the pagination header when all the objects in the list are being shown. {0} and {2} are replaced with the number of objects in the list, {1} is replaced with the name of the items {plural}</td>
! </tr>
! <tr>
! <td>paging.banner.some_items_found</td>
! <td class="source"><span class="pagebanner">{0} {1} found, displaying {2} to {3}.</span></td>
! <td>Any string in a message format with 4 placeholders</td>
! <td>What is shown in the pagination header when a partial list of the the objects in the list are being shown. {0} indicates the total number of objects in the list, {1} is replaced with the name of the items (plural}, {2} and {3} are replaced with the start and end index of the objects being shown respectively</td>
! </tr>
! <tr>
! <td>paging.banner.group_size</td>
! <td class="source">8</td>
! <td>Any reasonable number</td>
! <td>The number of pages to show in the header that this person can instantly jump to</td>
! </tr>
! <tr>
! <td>paging.banner.full</td>
! <td class="source"><span class="pagelinks">[<a href="{1}">First</a>/<a href="{2}">Prev</a>] {0} [<a href="{3}">Next</a>/<a href="{4}">Last</a>]</span></td>
! <td />
! <td>What is shown in the pagination bar when there are more pages and the selected page is not the first or the last one. {0} will be replaced with the numbered pages list. {1} indicates the link to the first page, {2} the link to the previous page, {3} to the next page and {4} to the last page.</td>
! </tr>
! <tr>
! <td>paging.banner.first</td>
! <td class="source"><span class="pagelinks">[First/Prev] {0} [<a href="{3}">Next</a>/<a href="{4}">Last</a>]</span></td>
! <td />
! <td>What is shown in the pagination bar when the first page is being shown. {0} will be replaced with the numbered pages list. {1} indicates the link to the first page, {2} the link to the previous page, {3} to the next page and {4} to the last page.</td>
! </tr>
! <tr>
! <td>paging.banner.last</td>
! <td class="source"><span class="pagelinks">[<a href="{1}">First</a>/<a href="{2}">Prev</a>] {0} [Next/Last]</span></td>
! <td />
! <td>What is shown in the pagination bar when the last page is being shown. {0} will be replaced with the numbered pages list. {1} indicates the link to the first page, {2} the link to the previous page, {3} to the next page and {4} to the last page.</td>
! </tr>
! <tr>
! <td>paging.banner.onepage</td>
! <td class="source"><span class="pagelinks">{0}</span></td>
! <td />
! <td>What is shown in the pagination bar when only one page is returned. {0} will be replaced with the numbered pages list. {1} indicates the link to the first page, {2} the link to the previous page, {3} to the next page and {4} to the last page.</td>
! </tr>
! <tr>
! <td>paging.banner.page.selected</td>
! <td class="source"><strong>{0}</strong></td>
! <td />
! <td>selected page. {0} is replaced with the page number, {1} with the page url.</td>
! </tr>
! <tr>
! <td>paging.banner.page.link</td>
! <td class="source"><a href="{1}" title="Go to page {0}">{0}</a></td>
! <td />
! <td>link to a page. {0} is replaced with the page number, {1} with the page url.</td>
! </tr>
! <tr>
! <td>paging.banner.page.separator</td>
! <td class="source">,</td>
! <td />
! <td>separator between pages</td>
! </tr>
! </tbody>
! </table>
! </subsection>
! <subsection name="Exporting">
! <p>
! Actually displaytag supports exporting to excel, csv, and xml formats. Some configurable properties are specific for one of this format. Replace "
! <em>{export name}</em>
! " in the property name with "excel", "csv" or "xml". Some of the properties could not be working in any export format.
! </p>
! <table>
! <thead>
! <tr>
! <th>Property</th>
! <th>Default</th>
! <th>Valid Values</th>
! <th>Description</th>
! </tr>
! </thead>
! <tbody>
! <tr>
! <td>
! export.<em>{export name}</em>
! </td>
! <td class="source">true</td>
! <td>true, false</td>
! <td>Should the tag present the option to export data in this specific format.</td>
! </tr>
! <tr>
! <td>
! export.<em>{export name}</em>.label
! </td>
! <td class="source">
! <span class="export<em>{export name}</em>"><em>{export name}</em></span>
! </td>
! <td>Any string</td>
! <td>The label on the link that the user clicks on to export the data in this specific format format.</td>
! </tr>
! <tr>
! <td>
! export.<em>{export name}</em>.include_header
! </td>
! <td class="source">false</td>
! <td>true, false</td>
! <td>If set to true, then the first line of the export will contain the column titles as displayed on the HTML page. By default this is set to false, so the header is not included in the export.</td>
! </tr>
! <tr>
! <td>export.amount</td>
! <td class="source">list</td>
! <td>page, list</td>
! <td>Indicates how much data should be sent down to the user when they ask for a data export. By default, it sends the entire list, but you can instruct the table tag to only send down the data that is currently being shown on the page</td>
! </tr>
! <tr>
! <td>export.decorated</td>
! <td class="source">true</td>
! <td>true, false</td>
! <td>Should the data be "decorated" as it is exported. The default value is true, but you might want to turn off any decoration that is HTML specific for example when exporting the data.</td>
! </tr>
! </tbody>
! </table>
! </subsection>
! <subsection name="css">
! <table>
! <thead>
! <tr>
! <th>Property</th>
! <th>Default</th>
! <th>Valid Values</th>
! <th>Description</th>
! </tr>
! </thead>
! <tbody>
! <tr>
! <td>css.tr.even</td>
! <td class="source">even</td>
! <td>any valid css class name</td>
! <td>css class automatically added to even rows</td>
! </tr>
! <tr>
! <td>css.tr.odd</td>
! <td class="source">odd</td>
! <td>any valid css class name</td>
! <td>css class automatically added to odd rows</td>
! </tr>
! <tr>
! <td>css.th.sorted</td>
! <td class="source">sorted</td>
! <td>any valid css class name</td>
! <td>css class automatically added to the header of sorted columns</td>
! </tr>
! <tr>
! <td>css.th.ascending</td>
! <td class="source">order1</td>
! <td>any valid css class name</td>
! <td>css class automatically added to the header of a column sorted is ascending order</td>
! </tr>
! <tr>
! <td>css.th.descending</td>
! <td class="source">order2</td>
! <td>any valid css class name</td>
! <td>css class automatically added to the header of a column sorted is descending order</td>
! </tr>
! <tr>
! <td>css.table</td>
! <td class="source">
! <em>none</em>
! </td>
! <td>any valid css class name</td>
! <td>css class automatically added to the main table tag</td>
! </tr>
! <tr>
! <td>css.th.sortable</td>
! <td class="source">
! <em>none</em>
! </td>
! <td>any valid css class name</td>
! <td>css class automatically added to any sortable column</td>
! </tr>
! </tbody>
! </table>
! </subsection>
</section>
</body>
</document>
+
|