Overview | Library | Tag | Help
| FRAMES NO FRAMES

## ICEfaces-EE ACE Components
Tag listExporter

Utility to export data from an ace:list component as an Excel, PDF, XML or CSV document. This component renders an HTML button. More components and HTML elements can be nested inside this tag to give a different look to the button.

For more information, see the ListExporter Wiki Documentation.

Client Events
Name | Description | Supported classes for argument
action | Triggers when the button is clicked or pressed by any other means. By default, both this ace:listExporter component and the target ace:list component are executed in this ajax request. | javax.faces.event.AjaxBehaviorEvent

Client events can be used with Client Behaviors and the ace:ajax tag.

Tag Information
Tag Class | org.icefaces.ace.component.listexporter.ListExporterTag
TagExtraInfo Class | None
Body Content | JSP
Display Name | None

Attributes
Name | Required | Request-time | Type | Description
accesskey | no | true | `java.lang.String` | Access key that, when pressed, transfers focus to this component.
binding | no | true | `javax.el.ValueExpression` | Using an EL expression, bind the component reference to a bean property, so that the component may be accessed in the bean.
customExporter | no | true | `java.lang.Object` | Specifies an object that implements a custom format type to use instead of one of the built-in formats. When this attribute is specified, it will override the "type" attribute. The object must extend org.icefaces.ace.component.listexporter.Exporter.
encoding | no | true | `java.lang.String` | Define a character encoding to use. Valid values will depend on the host system and format in use. For plain text formats (CSV and XML), the encoding has to be supported by the JVM running the server. Typically, these values include UTF-8, UTF-16, US-ASCII, ISO-8859-1, Windows-1252, among others. For the PDF format, this attribute is only applicable if a custom font is also specified via the 'pdfFont' attribute, and the encoding has to be supported by such font. For the XLS format, this attributr is not applicable; Unicode is used by default. Default = 'UTF-8'.
fileName | yes | true | `java.lang.String` | Define the filename of the generated file, defaults to the target id.
id | no | true | `java.lang.String` | The component identifier for this component. This value must be unique within the closest parent component that is a naming container.
includeHeaders | no | true | `boolean` | When using ace:listValueExporter components, determine whether the names should be included at the top of the file. This is not applicable when the attribute 'type' is set to 'xml'. Default = 'true'.
label | no | true | `java.lang.String` | Define the text that will appear on the button to trigger the export. Default value is 'Export'. This attribute applies only if the component has no children.
pdfFont | no | true | `java.lang.String` | The absolute path in the host system (e.g. C:\Windows\Fonts\arial.ttf) to a font file to be used in the PDF exporting instead of the default font. If specifying a custom 'encoding' value, it has to be supported by this custom font. Note that the default font does not support unicode characters, so a custom font has to be set in order to support these characters.
postProcessor | no | true | `javax.el.MethodExpression` | Defines a public void method to invoke after the PDF or XLS document has been generated, allowing developers to manipulate the document. It must take a single argument of type Object. The object will be of type com.itextpdf.text.Document (iText library) for PDF documents and of type org.apache.poi.ss.usermodel.Workbook (Apache POI library) for XLS documents. (Note: if the old 2.1.7 iText library is being used, then the object has to be of type com.lowagie.text.Document for PDF documents)
preProcessor | no | true | `javax.el.MethodExpression` | Defines a public void method to invoke before the PDF or XLS document is generated, allowing developers to manipulate the document. It must take a single argument of type Object. The object will be of type com.itextpdf.text.Document (iText library) for PDF documents and of type org.apache.poi.ss.usermodel.Workbook (Apache POI library) for XLS documents. (Note: if the old 2.1.7 iText library is being used, then the object has to be of type com.lowagie.text.Document for PDF documents)
rendered | no | true | `boolean` | Return true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. Default = 'true'.
selectedItemsOnly | no | true | `boolean` | Enable to export only the currently selected list items instead of the whole data set. Default = 'false'.
style | no | true | `java.lang.String` | Custom inline CSS styles to use for this component. These styles are generally applied to the root DOM element of the component. This is intended for per-component basic style customizations. Note that due to browser CSS precedence rules, CSS rendered on a DOM element will take precedence over the external stylesheets used to provide the ThemeRoller theme on this component. If the CSS properties applied with this attribute do not affect the DOM element you want to style, you may need to create a custom theme styleClass for the theme CSS class that targets the particular DOM elements you wish to customize.
styleClass | no | true | `java.lang.String` | Custom CSS style class(es) to use for this component. These style classes can be defined in your page or in a theme CSS file.
target | yes | true | `java.lang.String` | Define the id of the ace:list component whose data will be exported.
textToExport | no | true | `java.lang.String` | When the model is based on SelectItem's, specify if the exported text should be the label, the actual value or both (the label with the actual value in parentheses). Default = 'label'.
type | no | true | `java.lang.String` | Define the format of file export. Available formats: "xls", "pdf", "csv", and "xml". Default = 'csv'.

Variables
| No Variables Defined.

Overview | Library | Tag | Help
| FRAMES NO FRAMES

Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.