ICEfaces ACE Components
Tag dataExporter


Utility to export data from a datatable 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 DataExporter Wiki Documentation.


Client Events
NameDescriptionSupported Classes for ArgumentDefault Event Scopes
actionTriggers when the button is clicked or pressed by any other means. By default, both this data exporter component and the target table are executed in this ajax request.javax.faces.event.AjaxBehaviorEventexecute=@this render=@all
Client events can be used with Client Behaviors and the ace:ajax tag.


Tag Information
Tag Classorg.icefaces.ace.component.dataexporter.DataExporterTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
accesskeynotruejava.lang.StringAccess key that, when pressed, transfers focus to this component.
bindingnotruejavax.el.ValueExpressionUsing an EL expression, bind the component reference to a bean property, so that the component may be accessed in the bean.
customExporternotruejava.lang.ObjectSpecifies 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.dataexporter.Exporter.
encodingnotruejava.lang.StringDefine 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'.
excludeColumnsnotruejava.lang.StringDefine a comma separated list of column indexes (zero-relative) to be excluded from export. Only Column components, without a rendered ExcludeFromExport child, count towards this indexing scheme.
expandedOnlynotruebooleanWhen using row expansion in the table, specify whether the child rows should be exported only if the parent row has been expanded by the user. Default = 'false'.
fileNameyestruejava.lang.StringDefine the filename of the generated file, defaults to dataTable id.
idnotruejava.lang.StringThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.
includeFootersnotruebooleanDisable whether column footers should be included at the bottom of the file. This is not applicable when attribute 'type' is set to 'xml'. Default = 'true'.
includeHeadersnotruebooleanDisable whether column headers should be included at the top of the file. This is not applicable when attribute 'type' is set to 'xml'. Default = 'true'.
labelnotruejava.lang.StringDefine the text that will appear on the button to trigger the export. Default value is 'Export'. Attribute applies only if the component has no children.
pageOnlynotruebooleanEnable to export only the current page instead of the whole data set. Default = 'false'.
pdfFontnotruejava.lang.StringThe 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.
postProcessornotruejavax.el.MethodExpressionDefines 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.lowagie.text.Document (iText library) for PDF documents and of type org.apache.poi.ss.usermodel.Workbook (Apache POI library) for XLS documents.
preProcessornotruejavax.el.MethodExpressionDefines 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.lowagie.text.Document (iText library) for PDF documents and of type org.apache.poi.ss.usermodel.Workbook (Apache POI library) for XLS documents.
renderednotruebooleanReturn true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. Default = 'true'.
selectedRowsOnlynotruebooleanEnable to export only the currently selected rows instead of the whole dataset. Default = 'false'.
stylenotruejava.lang.StringCustom 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.
styleClassnotruejava.lang.StringCustom CSS style class(es) to use for this component. These style classes can be defined in your page or in a theme CSS file.
targetyestruejava.lang.StringDefine the id of the ace:dataTable whose data will be exported.
typenotruejava.lang.StringDefine the format of file export. Available formats: "xls", "xlsx", "pdf", "csv", and "xml". Default = 'csv'.
userColumnOrdernotruebooleanSpecify whether the columns should be exported according to the order established by the user in the client. When false, the column order defined in the markup will be used. Default = 'true'.

Variables
No Variables Defined.


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.