configuration.apt

分页标签

                                    ------------------------------
                                           Configuration
                                    ------------------------------
                                          Fabrizio Giustina
                                    ------------------------------
                                              11-11-2005
                                    ------------------------------

Configuration

* Configuration properties

   This table lists all the configurable properties for the tag
   libraries. The default properties are defined in the
   <<<displaytag.properties>>> file included in the library jar.

   There are 2 ways to override default property settings:

     * For the whole web application, create a custom properties file
       named <<<displaytag.properties>>> and place it in the application
       classpath (tipically into <<<WEB-INF/classes>>>).
       Displaytag will use the locale of the request object
       to determine the locale of the property file to use; if the key
       required does not exist in the specified file, the key will be
       loaded from a more general property file.

     * For a single table instance, using the \<display:setProperty\> tag

     []

   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.


* I18n

   Some properties contain messages you may wish to display according
   to the user Locale. To do that first add a default
   displaytag.properties file where you set all the locale independent
   entries and default messages. Then you can add localized properties
   file (for example displaytag_IT.properties ).


* Generic

*------------------------------------+--------------------------------+-----------------------------+---------------------------------------------------+------------+-------------+
|| Property                          || Default                       || Valid Values               || Description                                    || allowed in || allowed in ||
||                                   ||                               ||                            ||                                                || properties || setProperty||
*------------------------------------+--------------------------------+-----------------------------+---------------------------------------------------+------------+-------------+
| basic.show.header                  | true                           | true, false                 | Indicates if you want the header to appear at the top of       | yes  | yes  |
|                                    |                                |                             | the table, the header contains the column names, and any       |      |      |
|                                    |                                |                             | additional action banners that might be required (like         |      |      |
|                                    |                                |                             | paging, export, etc...)                                        |      |      |
*------------------------------------+--------------------------------+-----------------------------+----------------------------------------------------------------+------+------+
| basic.empty.showtable              | false                          | true, false                 | Indicates if you want the table to show up also if the list is | yes  | yes  |
|                                    |                                |                             | empty                                                          |      |      |
*------------------------------------+--------------------------------+-----------------------------+----------------------------------------------------------------+------+------+
| basic.msg.empty_list               | Nothing found to display       | any string                  | The message that is displayed if the list that this table is   | yes  | yes  |
|                                    |                                |                             | associated with is either null, or empty. Used only if         |      |      |
|                                    |                                |                             | basic.empty.showtable is false                                 |      |      |
*------------------------------------+--------------------------------+-----------------------------+----------------------------------------------------------------+------+------+
| basic.msg.empty_list_row           | \<tr class="empty"\>           | Any string                  | The message that is displayed into the first table row if the  | yes  | yes  |
|                                    | \<td colspan="{0}"\>Nothing    |                             | list that this table is associated with is either null, or     |      |      |
|                                    | found to display.\</td\>       |                             | empty. \{0\} is replaced with the total number of columns to   |      |      |
|                                    | \</tr\>                        |                             | generate a correct colspan. Used only if                       |      |      |
|                                    | \</tr\>                        |                             | <<<basic.empty.showtable>>> is true                            |      |      |
*------------------------------------+--------------------------------+-----------------------------+----------------------------------------------------------------+------+------+
| sort.amount                        | page                           | page, list                  | Indicates if the full list should be sorted before paging or   | yes  | no   |
|                                    |                                |                             | if the sorting only affects items in the current page.         |      |      |
|                                    |                                |                             | Default behaviour is to sort only items in the current page    |      |      |
|                                    |                                |                             | (first paging, then sorting)                                   |      |      |
*------------------------------------+--------------------------------+-----------------------------+----------------------------------------------------------------+------+------+
| export.banner                      | \<div class="exportlinks"\>    | any string                  | Contains the string that is displayed in the table footer when | yes  | yes  |
|                                    |   Export options: \{0\}        |                             | the user indicates that they want to enable the export         |      |      |
|                                    | \</div\>                       |                             | function. The placeholder is replaced with links to the        |      |      |
|                                    |                                |                             | various supported export formats                               |      |      |
*------------------------------------+--------------------------------+-----------------------------+----------------------------------------------------------------+------+------+
| export.banner.sepchar              | \|                             | any string                  | Used to separate the valid export type (typically would be a   | yes  | yes  |
|                                    |                                |                             | bar, a comma, or a dash)                                       |      |      |
*------------------------------------+--------------------------------+-----------------------------+----------------------------------------------------------------+------+------+
| paging.banner.placement            | top                            | top, bottom, both           | When the table tag has to show the header for paging through   | yes  | yes  |
|                                    |                                |                             | a long list, this option indicates where that header should be |      |      |
|                                    |                                |                             | shown in relation to the table                                 |      |      |
*------------------------------------+--------------------------------+-----------------------------+----------------------------------------------------------------+------+------+
| paging.banner.item_name            | item                           | any string                  | What the various objects in the list being displayed should be | yes  | yes  |
|                                    |                                |                             | referred to as (singular)                                      |      |      |