configuration.apt

分页标签

* Exporting

   Displaytag supports exporting to excel, csv, pdf, rtf, and xml formats. Some
   configurable properties are specific for one of these format.

   Replace <export name> in the property name with "excel", "csv", "pdf", "rtf",
   or "xml". Some of the properties won't work in any export format.


*------------------------------------+--------------------------------+-----------------------------+---------------------------------------------------+------------+-------------+
|| Property                          || Default                       || Valid Values               || Description                                    || allowed in || allowed in ||
||                                   ||                               ||                            ||                                                || properties || setProperty||
*------------------------------------+-----------------------------+-----------------------------+---------------------------------------------------+------------+-------------+
| export.types                       | csv excel xml               | any string                  | Whitespace separated list of configured export types           | yes  | no   |
|                                    | pdf                         |                             |                                                                |      |      |
*------------------------------------+-----------------------------+-----------------------------+----------------------------------------------------------------+------+------+
| export.<export name>               | true                        | true, false                 | Should the tag present the option to export data in this       | yes  | yes  |
|                                    |                             |                             | specific format                                                |      |      |
*------------------------------------+-----------------------------+-----------------------------+----------------------------------------------------------------+------+------+
| export.<export name>.class         |                             | Any valid class             | Fully qualified class name for the class which will be used    | yes  | no   |
|                                    |                             | that implements the         | for exporting                                                  |      |      |
|                                    |                             | <<<org.displaytag.export.ExportView interface>>> |                                           |      |      |
*------------------------------------+-----------------------------+-----------------------------+----------------------------------------------------------------+------+------+
| export.<export name>.label         | \<span class="export        | Any string                  | The label on the link that the user clicks on to export the    | yes  | yes  |
|                                    | <export name>"\>            |                             | data in a specific format                                      |      |      |
|                                    | <export name> \</span\>     |                             |                                                                |      |      |
*------------------------------------+-----------------------------+-----------------------------+----------------------------------------------------------------+------+------+
| export.<export name>.include_header | false                      | true, false                 | If set to true, the first line of the export will contain      | yes  | yes  |
|                                    |                             |                             | column titles as displayed on the HTML page.                   |      |      |
*------------------------------------+-----------------------------+-----------------------------+----------------------------------------------------------------+------+------+
| export.<export name>.filename      | none                        | any valid file name         | When saving exported files the user will be prompted to use    | yes  | yes  |
|                                    |                             |                             | this file name                                                 |      |      |
*------------------------------------+-----------------------------+-----------------------------+----------------------------------------------------------------+------+------+
| export.amount                      | list                        | page, list                  | Indicates how much data should be sent down to the user when   | yes  | yes  |
|                                    |                             |                             | they ask for a data export. By default, it sends the entire    |      |      |
|                                    |                             |                             | list. You can instruct the table tag to only send down the     |      |      |
|                                    |                             |                             | data that is currently being shown on the page                 |      |      |
*------------------------------------+-----------------------------+-----------------------------+----------------------------------------------------------------+------+------+
| export.decorated                   | true                        | true, false                 | Should the data be "decorated" as it is exported.  Note that   | yes  | yes  |
|                                    |                             |                             | <<<org.displaytag.export.excel.DefaultHssfExportView>>>,       |      |      |
|                                    |                             |                             | <<<org.displaytag.export.DefaultPdfExportView>>>, and          |      |      |
|                                    |                             |                             | <<<org.displaytag.export.DefaultRtfExportView>>>               |      |      |
|                                    |                             |                             | do not observe this value.                                     |      |      |
*------------------------------------+-----------------------------+-----------------------------+----------------------------------------------------------------+------+------+
| decorator.media.<export name>      |                             | Class name of               | Decorator used to render table in given media.                 | yes  | yes  |
|                                    |                             | <<<TableDecorator>>>        | Refer to the {{{tut_decorators.html#Table decorators and exports}exports and          |      |      |
|                                    |                             | subclass                    | decorators tutorial}} for detailed explanation.  Ignored if a  |      |      |
|                                    |                             |                             | decorator is configured in table tag's decorator attribute.    |      |      |
*------------------------------------+-----------------------------+-----------------------------+----------------------------------------------------------------+------+------+






* CSS

*--------------------------+------------------+--------------------+----------------------------------------------------------------+------------+-------------+
|| Property                || Default         || Valid Values      || Description                                                 || allowed in || allowed in ||
||                         ||                 ||                   ||                                                             || properties || setProperty||
*--------------------------+------------------+--------------------+----------------------------------------------------------------+------------+-------------+
| css.tr.even              | even             | any valid css      | css class automatically added to even rows                     | yes        | yes         |
|                          |                  | class name         |                                                                |            |             |
*--------------------------+------------------+--------------------+----------------------------------------------------------------+------------+-------------+
| css.tr.odd               | odd              | any valid css      | css class automatically added to odd rows                      | yes        | yes         |
|                          |                  | class name         |                                                                |            |             |
*--------------------------+------------------+--------------------+----------------------------------------------------------------+------------+-------------+
| css.th.sorted            | sorted           | any valid css      | css class automatically added to the header of sorted columns  | yes        | yes         |
|                          |                  | class name         |                                                                |            |             |
*--------------------------+------------------+--------------------+----------------------------------------------------------------+------------+-------------+
| css.th.ascending         | order1           | any valid css      | css class automatically added to the header of a column sorted | yes        | yes         |
|                          |                  | class name         | in ascending order                                             |            |             |
*--------------------------+------------------+--------------------+----------------------------------------------------------------+------------+-------------+
| css.th.descending        | order2           | any valid css      | css class automatically added to the header of a column sorted | yes        | yes         |
|                          |                  | class name         | in descending order                                            |            |             |
*--------------------------+------------------+--------------------+----------------------------------------------------------------+------------+-------------+
| css.table                | none             | any valid css      | css class automatically added to the main table tag            | yes        | yes         |
|                          |                  | class name         |                                                                |            |             |
*--------------------------+------------------+--------------------+----------------------------------------------------------------+------------+-------------+
| css.th.sortable          | none             | any valid css      | css class automatically added to any sortable column           | yes        | yes         |
|                          |                  | class name         |                                                                |            |             |
*--------------------------+------------------+--------------------+----------------------------------------------------------------+------------+-------------+