net.sf.jasperreports.engine
Class JRAbstractExporter

java.lang.Object
  extended bynet.sf.jasperreports.engine.JRAbstractExporter
All Implemented Interfaces:
JRExporter
Direct Known Subclasses:
JRCsvExporter, JRGraphics2DExporter, JRHtmlExporter, JRPdfExporter, JRPrintServiceExporter, JRRtfExporter, JRTextExporter, JRXlsAbstractExporter, JRXmlExporter

public abstract class JRAbstractExporter
extends java.lang.Object
implements JRExporter

Version:
$Id: JRAbstractExporter.java,v 1.23 2005/11/28 09:20:44 teodord Exp $
Author:
Teodor Danciu (teodord@users.sourceforge.net)

Field Summary
protected  java.lang.ClassLoader classLoader
           
protected  JRFont defaultFont
           
protected  int endPageIndex
           
protected  int globalOffsetX
           
protected  int globalOffsetY
           
protected  boolean isModeBatch
           
protected  JasperPrint jasperPrint
           
protected  java.util.List jasperPrintList
           
protected  java.util.Map parameters
           
protected  int startPageIndex
           
protected  JRStyledTextParser styledTextParser
           
 
Constructor Summary
protected JRAbstractExporter()
           
 
Method Summary
abstract  void exportReport()
          Actually starts the export process.
protected  JRBox getBox(JRPrintGraphicElement element)
           
protected  JRFont getDefaultFont()
           
protected  int getOffsetX()
          Returns the X axis offset used for element export.
protected  int getOffsetY()
          Returns the Y axis offset used for element export.
 java.lang.Object getParameter(JRExporterParameter parameter)
          Gets an export parameter.
 java.util.Map getParameters()
          Gets a map containing all export parameters.
protected  JRStyledText getStyledText(JRPrintText textElement)
           
protected  JRStyledText getStyledText(JRPrintText textElement, boolean setBackcolor)
           
protected  void resetClassLoader()
           
protected  void restoreElementOffsets()
          Restores offsets after a call to setFrameElementsOffset.
protected  void setClassLoader()
           
protected  void setFrameElementsOffset(JRPrintFrame frame, boolean relative)
          Sets the offsets for exporting elements from a frame.
protected  void setInput()
           
protected  void setOffset()
           
protected  void setOutput()
           
protected  void setPageRange()
           
 void setParameter(JRExporterParameter parameter, java.lang.Object value)
          Sets an export parameter for advanced customization of the export process.
 void setParameters(java.util.Map parameters)
          Sets export parameters from a specified map.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

parameters

protected java.util.Map parameters

jasperPrintList

protected java.util.List jasperPrintList

jasperPrint

protected JasperPrint jasperPrint

isModeBatch

protected boolean isModeBatch

startPageIndex

protected int startPageIndex

endPageIndex

protected int endPageIndex

globalOffsetX

protected int globalOffsetX

globalOffsetY

protected int globalOffsetY

classLoader

protected java.lang.ClassLoader classLoader

defaultFont

protected JRFont defaultFont

styledTextParser

protected JRStyledTextParser styledTextParser
Constructor Detail

JRAbstractExporter

protected JRAbstractExporter()
Method Detail

setParameter

public void setParameter(JRExporterParameter parameter,
                         java.lang.Object value)
Description copied from interface: JRExporter
Sets an export parameter for advanced customization of the export process. Parameters can be either common parameters or specialized ones, depending on the exporter type.

Specified by:
setParameter in interface JRExporter
Parameters:
parameter - the parameter, selected from the static parameters defined by JasperReports
value - the parameter value
See Also:
JRExporterParameter

getParameter

public java.lang.Object getParameter(JRExporterParameter parameter)
Description copied from interface: JRExporter
Gets an export parameter.

Specified by:
getParameter in interface JRExporter

setParameters

public void setParameters(java.util.Map parameters)
Description copied from interface: JRExporter
Sets export parameters from a specified map.

Specified by:
setParameters in interface JRExporter
See Also:
JRExporter.setParameter(JRExporterParameter, Object)

getParameters

public java.util.Map getParameters()
Description copied from interface: JRExporter
Gets a map containing all export parameters.

Specified by:
getParameters in interface JRExporter

exportReport

public abstract void exportReport()
                           throws JRException
Description copied from interface: JRExporter
Actually starts the export process.

Specified by:
exportReport in interface JRExporter
Throws:
JRException

setOffset

protected void setOffset()

setClassLoader

protected void setClassLoader()

resetClassLoader

protected void resetClassLoader()

setInput

protected void setInput()
                 throws JRException
Throws:
JRException

setPageRange

protected void setPageRange()
                     throws JRException
Throws:
JRException

getDefaultFont

protected JRFont getDefaultFont()

getStyledText

protected JRStyledText getStyledText(JRPrintText textElement,
                                     boolean setBackcolor)

getStyledText

protected JRStyledText getStyledText(JRPrintText textElement)

setOutput

protected void setOutput()

getOffsetX

protected int getOffsetX()
Returns the X axis offset used for element export.

This method should be used istead of globalOffsetX when exporting elements.

Returns:
the X axis offset

getOffsetY

protected int getOffsetY()
Returns the Y axis offset used for element export.

This method should be used istead of globalOffsetY when exporting elements.

Returns:
the Y axis offset

setFrameElementsOffset

protected void setFrameElementsOffset(JRPrintFrame frame,
                                      boolean relative)
Sets the offsets for exporting elements from a frame.

After the frame elements are exported, a call to popElementOffsets is required so that the previous offsets are resored.

Parameters:
frame -
relative -
See Also:
getOffsetX(), getOffsetY(), restoreElementOffsets()

restoreElementOffsets

protected void restoreElementOffsets()
Restores offsets after a call to setFrameElementsOffset.


getBox

protected JRBox getBox(JRPrintGraphicElement element)


© 2001-2005 JasperSoft Corporation www.jaspersoft.com