net.sf.jasperreports.jsf.component
Class UIOutputReport

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          net.sf.jasperreports.jsf.component.UIReport
              net.sf.jasperreports.jsf.component.UIOutputReport

All Implemented Interfaces:

javax.faces.component.StateHolder

Direct Known Subclasses:

HtmlReportFrame, HtmlReportLink

public class UIOutputReport
extends UIReport

Base report class for JSF components that output a report filled with data.

Author:

A. Alonso Dominguez

Field Summary

Fields inherited from class net.sf.jasperreports.jsf.component.UIReport

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIComponent

bindings

Constructor Summary

UIOutputReport()
Instantiates a new UIOutputReport.

Method Summary

void	encodeContent(javax.faces.context.FacesContext context) Encodes the report contents into the current response.
void	encodeHeaders(javax.faces.context.FacesContext context) Encodes the report header into the current response.
Exporter	getExporter() Obtains the established exporter.
String	getFormat() Obtains the specified format for the report output.
void	setExporter(Exporter exporter) Establishes a new exporter instance.
void	setFormat(String format) Establishes a new value for the report's output.
void	updateModel(javax.faces.context.FacesContext context) Updates the provided bean property with the interpretted report instance.

Methods inherited from class net.sf.jasperreports.jsf.component.UIReport

decodeReport, decodeSource, executeDecodes, executeValidate, getFamily, getJRFacesContext, getName, getReportConverter, getSource, getSourceConverter, getSubmittedPrint, getSubmittedReport, getSubmittedSource, getValidator, getValue, isLocalValueSet, isValid, processDecodes, processValidators, resetValue, restoreState, saveState, setName, setReportConverter, setSource, setSourceConverter, setSubmittedPrint, setSubmittedReport, setSubmittedSource, setValid, setValidator, setValue, validate

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, processUpdates, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getContainerClientId, getValueExpression, setValueExpression

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UIOutputReport

public UIOutputReport()

Instantiates a new UIOutputReport.

Method Detail

getFormat

public final String getFormat()

Obtains the specified format for the report output.

Returns:

format for the report output.

setFormat

public final void setFormat(String format)

Establishes a new value for the report's output.

Parameters:

format - the new value for the report's output

getExporter

public final Exporter getExporter()

Obtains the established exporter.

Returns:

the exporter.

setExporter

public final void setExporter(Exporter exporter)

Establishes a new exporter instance.

Parameters:

exporter - the new exporter instance.

encodeContent

public final void encodeContent(javax.faces.context.FacesContext context)
                         throws IOException

Encodes the report contents into the current response.

Parameters:

context - current faces' context.

Throws:

IOException - when an error happens encoding the results.

encodeHeaders

public final void encodeHeaders(javax.faces.context.FacesContext context)
                         throws IOException

Encodes the report header into the current response.

Parameters:

context - current faces' context.

Throws:

IOException - when an error happens encoding the results.

updateModel

public void updateModel(javax.faces.context.FacesContext context)

Updates the provided bean property with the interpretted report instance.

Parameters:

context - current faces' context.