|
ICEfaces ACE Components 3.3.0 Java API Documentation |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
org.icefaces.ace.component.dataexporter.DataExporterBase
public class DataExporterBase
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.
Nested Class Summary | |
---|---|
protected static class |
DataExporterBase.PropertyKeys
|
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_TYPE
|
static java.lang.String |
RENDERER_TYPE
|
Fields inherited from class javax.faces.component.UIComponent |
---|
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY |
Constructor Summary | |
---|---|
DataExporterBase()
|
Method Summary | |
---|---|
void |
addClientBehavior(java.lang.String eventName,
javax.faces.component.behavior.ClientBehavior behavior)
|
java.lang.Object |
getCustomExporter()
Return the value of the customExporter property. |
java.lang.String |
getDefaultEventName()
|
java.lang.String |
getDefaultExecute(java.lang.String event)
|
java.lang.String |
getDefaultRender(java.lang.String event)
|
java.lang.String |
getEncoding()
Return the value of the encoding property. |
java.util.Collection<java.lang.String> |
getEventNames()
|
java.lang.String |
getExcludeColumns()
Return the value of the excludeColumns property. |
java.lang.String |
getFamily()
|
java.lang.String |
getFileName()
Return the value of the fileName property. |
java.lang.String |
getLabel()
Return the value of the label property. |
javax.el.MethodExpression |
getPostProcessor()
Return the value of the postProcessor property. |
javax.el.MethodExpression |
getPreProcessor()
Return the value of the preProcessor property. |
java.lang.String |
getStyle()
Return the value of the style property. |
java.lang.String |
getStyleClass()
Return the value of the styleClass property. |
java.lang.String |
getTarget()
Return the value of the target property. |
java.lang.String |
getType()
Return the value of the type property. |
boolean |
isExpandedOnly()
Return the value of the expandedOnly property. |
boolean |
isIncludeFooters()
Return the value of the includeFooters property. |
boolean |
isIncludeHeaders()
Return the value of the includeHeaders property. |
boolean |
isPageOnly()
Return the value of the pageOnly property. |
boolean |
isSelectedRowsOnly()
Return the value of the selectedRowsOnly property. |
boolean |
isUserColumnOrder()
Return the value of the userColumnOrder property. |
void |
setCustomExporter(java.lang.Object customExporter)
Set the value of the customExporter property. |
void |
setEncoding(java.lang.String encoding)
Set the value of the encoding property. |
void |
setExcludeColumns(java.lang.String excludeColumns)
Set the value of the excludeColumns property. |
void |
setExpandedOnly(boolean expandedOnly)
Set the value of the expandedOnly property. |
void |
setFileName(java.lang.String fileName)
Set the value of the fileName property. |
void |
setIncludeFooters(boolean includeFooters)
Set the value of the includeFooters property. |
void |
setIncludeHeaders(boolean includeHeaders)
Set the value of the includeHeaders property. |
void |
setLabel(java.lang.String label)
Set the value of the label property. |
void |
setPageOnly(boolean pageOnly)
Set the value of the pageOnly property. |
void |
setPostProcessor(javax.el.MethodExpression postProcessor)
Set the value of the postProcessor property. |
void |
setPreProcessor(javax.el.MethodExpression preProcessor)
Set the value of the preProcessor property. |
void |
setSelectedRowsOnly(boolean selectedRowsOnly)
Set the value of the selectedRowsOnly property. |
void |
setStyle(java.lang.String style)
Set the value of the style property. |
void |
setStyleClass(java.lang.String styleClass)
Set the value of the styleClass property. |
void |
setTarget(java.lang.String target)
Set the value of the target property. |
void |
setType(java.lang.String type)
Set the value of the type property. |
void |
setUserColumnOrder(boolean userColumnOrder)
Set the value of the userColumnOrder property. |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder |
---|
getClientBehaviors |
Field Detail |
---|
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String RENDERER_TYPE
Constructor Detail |
---|
public DataExporterBase()
Method Detail |
---|
public java.lang.String getFamily()
getFamily
in class javax.faces.component.UIComponent
public void setCustomExporter(java.lang.Object customExporter)
Set the value of the customExporter
property.
Contents: 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.dataexporter.Exporter.
setCustomExporter
in interface IDataExporter
public java.lang.Object getCustomExporter()
Return the value of the customExporter
property.
Contents: 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.dataexporter.Exporter.
getCustomExporter
in interface IDataExporter
public void setEncoding(java.lang.String encoding)
Set the value of the encoding
property.
Contents: Define a character encoding to use.
setEncoding
in interface IDataExporter
public java.lang.String getEncoding()
Return the value of the encoding
property.
Contents: Define a character encoding to use. Default = 'UTF-8'.
getEncoding
in interface IDataExporter
public void setExcludeColumns(java.lang.String excludeColumns)
Set the value of the excludeColumns
property.
Contents: Define a comma separated list of column indexes (zero-relative) to be excluded from export.
setExcludeColumns
in interface IDataExporter
public java.lang.String getExcludeColumns()
Return the value of the excludeColumns
property.
Contents: Define a comma separated list of column indexes (zero-relative) to be excluded from export.
getExcludeColumns
in interface IDataExporter
public void setExpandedOnly(boolean expandedOnly)
Set the value of the expandedOnly
property.
Contents: When 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.
setExpandedOnly
in interface IDataExporter
public boolean isExpandedOnly()
Return the value of the expandedOnly
property.
Contents: When 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'.
isExpandedOnly
in interface IDataExporter
public void setFileName(java.lang.String fileName)
Set the value of the fileName
property.
Contents: Define the filename of the generated file, defaults to dataTable id.
setFileName
in interface IDataExporter
public java.lang.String getFileName()
Return the value of the fileName
property.
Contents: Define the filename of the generated file, defaults to dataTable id.
getFileName
in interface IDataExporter
public void setIncludeFooters(boolean includeFooters)
Set the value of the includeFooters
property.
Contents: Disable whether column footers should be included at the bottom of the file. This is not applicable when attribute 'type' is set to 'xml'.
setIncludeFooters
in interface IDataExporter
public boolean isIncludeFooters()
Return the value of the includeFooters
property.
Contents: Disable 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'.
isIncludeFooters
in interface IDataExporter
public void setIncludeHeaders(boolean includeHeaders)
Set the value of the includeHeaders
property.
Contents: Disable whether column headers should be included at the top of the file. This is not applicable when attribute 'type' is set to 'xml'.
setIncludeHeaders
in interface IDataExporter
public boolean isIncludeHeaders()
Return the value of the includeHeaders
property.
Contents: Disable 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'.
isIncludeHeaders
in interface IDataExporter
public void setLabel(java.lang.String label)
Set the value of the label
property.
Contents: Define 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.
setLabel
in interface IDataExporter
public java.lang.String getLabel()
Return the value of the label
property.
Contents: Define 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.
getLabel
in interface IDataExporter
public void setPageOnly(boolean pageOnly)
Set the value of the pageOnly
property.
Contents: Enable to export only the current page instead of the whole data set.
setPageOnly
in interface IDataExporter
public boolean isPageOnly()
Return the value of the pageOnly
property.
Contents: Enable to export only the current page instead of the whole data set. Default = 'false'.
isPageOnly
in interface IDataExporter
public void setPostProcessor(javax.el.MethodExpression postProcessor)
Set the value of the postProcessor
property.
Contents: 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.lowagie.text.Document (iText library) for PDF documents and of type org.apache.poi.ss.usermodel.Workbook (Apache POI library) for XLS documents.
setPostProcessor
in interface IDataExporter
public javax.el.MethodExpression getPostProcessor()
Return the value of the postProcessor
property.
Contents: 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.lowagie.text.Document (iText library) for PDF documents and of type org.apache.poi.ss.usermodel.Workbook (Apache POI library) for XLS documents.
getPostProcessor
in interface IDataExporter
public void setPreProcessor(javax.el.MethodExpression preProcessor)
Set the value of the preProcessor
property.
Contents: 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.lowagie.text.Document (iText library) for PDF documents and of type org.apache.poi.ss.usermodel.Workbook (Apache POI library) for XLS documents.
setPreProcessor
in interface IDataExporter
public javax.el.MethodExpression getPreProcessor()
Return the value of the preProcessor
property.
Contents: 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.lowagie.text.Document (iText library) for PDF documents and of type org.apache.poi.ss.usermodel.Workbook (Apache POI library) for XLS documents.
getPreProcessor
in interface IDataExporter
public void setSelectedRowsOnly(boolean selectedRowsOnly)
Set the value of the selectedRowsOnly
property.
Contents: Enable to export only the currently selected rows instead of the whole dataset.
setSelectedRowsOnly
in interface IDataExporter
public boolean isSelectedRowsOnly()
Return the value of the selectedRowsOnly
property.
Contents: Enable to export only the currently selected rows instead of the whole dataset. Default = 'false'.
isSelectedRowsOnly
in interface IDataExporter
public void setStyle(java.lang.String style)
Set the value of the style
property.
Contents: 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.
setStyle
in interface IDataExporter
public java.lang.String getStyle()
Return the value of the style
property.
Contents: 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.
getStyle
in interface IDataExporter
public void setStyleClass(java.lang.String styleClass)
Set the value of the styleClass
property.
Contents: 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.
setStyleClass
in interface IDataExporter
public java.lang.String getStyleClass()
Return the value of the styleClass
property.
Contents: 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.
getStyleClass
in interface IDataExporter
public void setTarget(java.lang.String target)
Set the value of the target
property.
Contents: Define the id of the ace:dataTable whose data will be exported.
setTarget
in interface IDataExporter
public java.lang.String getTarget()
Return the value of the target
property.
Contents: Define the id of the ace:dataTable whose data will be exported.
getTarget
in interface IDataExporter
public void setType(java.lang.String type)
Set the value of the type
property.
Contents: Define the format of file export. Available formats: "xls","pdf","csv", "xml".
setType
in interface IDataExporter
public java.lang.String getType()
Return the value of the type
property.
Contents: Define the format of file export. Available formats: "xls","pdf","csv", "xml".
getType
in interface IDataExporter
public void setUserColumnOrder(boolean userColumnOrder)
Set the value of the userColumnOrder
property.
Contents: Specify 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.
setUserColumnOrder
in interface IDataExporter
public boolean isUserColumnOrder()
Return the value of the userColumnOrder
property.
Contents: Specify 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'.
isUserColumnOrder
in interface IDataExporter
public java.util.Collection<java.lang.String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
getEventNames
in class javax.faces.component.UIComponentBase
public java.lang.String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class javax.faces.component.UIComponentBase
public java.lang.String getDefaultRender(java.lang.String event)
getDefaultRender
in interface IceClientBehaviorHolder
public java.lang.String getDefaultExecute(java.lang.String event)
getDefaultExecute
in interface IceClientBehaviorHolder
public void addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior)
addClientBehavior
in interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior
in class javax.faces.component.UIComponentBase
|
ICEfaces ACE Components 3.3.0 Java API Documentation |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |