Referencia de la Clase FLJasperEngine

#include <FLJasperEngine.h>

Diagrama de herencias de FLJasperEngine

Lista de todos los miembros.

Tipos públicos
enum	AQReportsMsgType { AQErrorMsg, AQLogMsg, AQSysMsg }
Slots públicos
bool	setReportData (QDomNode n)
bool	setReportData (FLDomNodeInterface *n)
bool	setReportTemplate (const QString &t)
QDomDocument	rptXmlData () const
FLDomNodeInterface *	reportData () const
QDomDocument	rptXmlTemplate () const
FLDomNodeInterface *	reportTemplate () const
void	setDataSourceParameters (const QString &selectExpression, const QString &datePattern, const QString &numberPattern)
QString	compileReport ()
QString	fillReport ()
FLReportPages *	printReportToPages ()
void	updateReportPages ()
bool	printReport (bool withPrintDialog=true)
bool	printReport (const QString &printServiceName, int copies=1)
QStringList	printServiceNames ()
bool	exportReportToFile (const QString &outFileName, const QString &format)
void	execExportFileDialog (const QString &defaultFileName=QString::null, const QString &defaultFormat=QString::null)
void	exportReportToPdf (const QString &outFileName=QString::null, bool withFileDialog=true)
void	exportReportToCsv (const QString &outFileName=QString::null, bool withFileDialog=true)
QString	lastJasperFile () const
QString	lastJRPrintFile () const
FLReportPages *	lastReportPages () const
void	setShowErrorDialog (bool b=true)
Señales
void	msgReceived (int, const QString &)
Métodos públicos
	FLJasperEngine (QObject *parent=0)
	~FLJasperEngine ()
Amigas
void	JasperEngineMsgHandler (AQReportsMsgType, const char *, void *)

---

Descripción detallada

Motor de generaci�n informes para JasperReports

Necesita el plugin AQReports para poder utilizar como backend el motor JasperReports

Autor:

InfoSiAL S.L.

---

Documentación de las enumeraciones miembro de la clase

enum FLJasperEngine::AQReportsMsgType

Valores de enumeraciones:

AQErrorMsg
AQLogMsg
AQSysMsg

---

Documentación del constructor y destructor

FLJasperEngine::FLJasperEngine

(

QObject *

parent = 0

)

FLJasperEngine::~FLJasperEngine

(

)

---

Documentación de las funciones miembro

QString FLJasperEngine::compileReport

(

)

[slot]

Compila el informe generando el fichero ".jasper" correspondiente

Importante: El fichero creado es autom�ticamente borrado cuando se destruye el objeto del tipo FLJasperEngine que lo creo y cada vez que se llama a compileReport() para crear uno nuevo.

Devuelve:

El nombre y ruta del fichero creado, o vacio si no se pudo crear

void FLJasperEngine::execExportFileDialog	(	const QString &	defaultFileName = QString::null,
		const QString &	defaultFormat = QString::null
	)		[slot]

Abre un dialogo del tipo "Guardar como" para exportar el informe indicando el nombre del fichero y el formato de exportacion

Parámetros:

defaultFileName	Nombre de fichero a utilizar por defecto
defaultFormat	Nombre del formato a utilizar por defecto. Los posibles valores son los utilizados por exportReportToFile.

void FLJasperEngine::exportReportToCsv	(	const QString &	outFileName = QString::null,
		bool	withFileDialog = true
	)		[slot]

Proporcionada por ergonomia.

Exporta el informe a CSV con la posibilidad de mostrar antes el dialogo llamando a execExportFileDialog.

bool FLJasperEngine::exportReportToFile	(	const QString &	outFileName,
		const QString &	format
	)		[slot]

M�todos para exportar a varios formatos

Si existe, se utiliza el ultimo fichero ".jrprint" creado con fillReport(), si no existe, intenta crear uno llamando a fillReport().

Parámetros:

outFileName	Nombre del fichero destino donde exportar
format	Indica el formato de exportacion, los posibles valores son: Csv Docx EmbeddedImagesXml Html MultipleSheetsXls Odt Pdf Rtf SingleSheetXls Xml

void FLJasperEngine::exportReportToPdf	(	const QString &	outFileName = QString::null,
		bool	withFileDialog = true
	)		[slot]

Proporcionada por ergonomia.

Exporta el informe a PDF con la posibilidad de mostrar antes el dialogo llamando a execExportFileDialog.

QString FLJasperEngine::fillReport

(

)

[slot]

Rellena el informe con los datos, generando el fichero ".jrprint" correspondiente

Si existe, se utiliza el ultimo fichero ".jasper" creado con compileReport(), si no existe, intenta crear uno llamando a compileReport().

Utiliza los par�metros establecidos con setDataSourceParameters() para seleccionar y formatear los datos XML. Si no se han establecido par�metros utiliza por defecto los necesarios para trabajar con datos XML en el formato que procesa Kugar.

Importante: El fichero creado es autom�ticamente borrado cuando se destruye el objeto del tipo FLJasperEngine que lo creo y cada vez que se llama a fillReport() para crear uno nuevo.

Devuelve:

El nombre y ruta del fichero creado, o vacio si no se pudo crear

QString FLJasperEngine::lastJasperFile

(

)

const [slot]

Devuelve:

Nombre del �ltimo fichero ".jasper" creado en la ultima llamada a compileReport(). Vacio si todavia no se ha creado ninguno.

QString FLJasperEngine::lastJRPrintFile

(

)

const [slot]

Devuelve:

Nombre del �ltimo fichero ".jrprint" creado en la ultima llamada a fillReport(). Vacio si todavia no se ha creado ninguno.

FLReportPages * FLJasperEngine::lastReportPages

(

)

const [slot]

Devuelve:

La �ltima colecci�n de paginas generada con printReportToPages. Ser� cero si todavia no se ha creado ninguna.

void FLJasperEngine::msgReceived	(	int	,
		const QString &
	)		[signal]

Propaga los mensajes recibidos por el plugin de AQReports, indicando el tipo (AQReportsMsgType) y el texto del mensaje

bool FLJasperEngine::printReport

(

bool

withPrintDialog = true

)

[slot]

Imprime el informe a la impresora predeterminada o permitiendo elegir una mediante un cuadro de dialogo.

Si existe, se utiliza el ultimo fichero ".jrprint" creado con fillReport(), si no existe, intenta crear uno llamando a fillReport().

Parámetros:

withPrintDialog

Si TRUE (por defecto) se muestra el cuadro de dialogo de impresion nativo de Jasper

Devuelve:

TRUE si no hubo error, FALSE en caso contrario

bool FLJasperEngine::printReport	(	const QString &	printServiceName,
		int	copies = 1
	)		[slot]

Imprime el informe directamente al servicio de impresi�n especificado.

Si existe, se utiliza el ultimo fichero ".jrprint" creado con fillReport(), si no existe, intenta crear uno llamando a fillReport().

Parámetros:

printServiceName	El nombre de un servicio de impresi�n en el que se desea imprimir, generalmente una impresora. El nombre deber� ser reconocido por Jasper, es decir, debe ser alguno de los nombres que devuelve el m�todo printServiceNames()
copies	N�mero de copias a imprimir, por defecto 1

Devuelve:

TRUE si no hubo error, FALSE en caso contrario

FLReportPages * FLJasperEngine::printReportToPages

(

)

[slot]

Imprime el informe a imagenes que devuelve como una colecci�n de paginas

Si existe, se utiliza el ultimo fichero ".jrprint" creado con fillReport(), si no existe, intenta crear uno llamando a fillReport().

Nota: La coleccion de paginas se puede visualizarla en un FLReportViewer mediante FLReportViewer::setReportPages()

Devuelve:

La colecci�n de paginas generada. La coleccion ser� vacia (pageCount() == -1) si no se pudo crear. FLJasperEngine no toma propiedad de la coleccion devuelta, debe ser borrada explicitamente con deleteLater para eliminarla de memoria.

QStringList FLJasperEngine::printServiceNames

(

)

[slot]

Devuelve:

La lista de nombres de los servicios de impresion (impresoras) reconocidos y utilizables por Jasper

FLDomNodeInterface * FLJasperEngine::reportData

(

)

const [slot]

FLDomNodeInterface * FLJasperEngine::reportTemplate

(

)

const [slot]

QDomDocument FLJasperEngine::rptXmlData

(

)

const [slot]

Devuelve:

Los datos de origen del informe en un documento XML. Se debe llamar despues de establecer los datos para el informe con set*ReportData, de lo contrario el resultado ser� indefinido.

QDomDocument FLJasperEngine::rptXmlTemplate

(

)

const [slot]

Devuelve:

Plantilla del informe en un documento XML con el formato usado por Jasper. Se debe llamar despues de establecer los datos para el informe con set*ReportTemplate, de lo contrario el resultado ser� indefinido.

void FLJasperEngine::setDataSourceParameters	(	const QString &	selectExpression,
		const QString &	datePattern,
		const QString &	numberPattern
	)		[slot]

Establece los par�metros a utilizar para acceder a los datos XML

Los par�metros que acepta determinan como se seleccionan los registros desde el documento XML mediante una expresi�n XPath, y como se formatean los campos de fecha y num�ricos. Para una descripci�n mas detallada se puede consultar la documentaci�n del API de JasperReports, concretamente esto dos enlaces:

http://jasperreports.sourceforge.net/api/net/sf/jasperreports/engine/JasperFillManager.html

http://jasperreports.sourceforge.net/api/net/sf/jasperreports/engine/data/JRXmlDataSource.html

Parámetros:

selectExpression	Expresi�n XPath para seleccionar los registros de los datos XML
datePattern	Patr�n para formatear los campos tipo fecha
numberPattern	Patr�n para formatear los campos num�ricos

bool FLJasperEngine::setReportData

(

QDomNode

n

)

[slot]

Establece los datos del informe a partir de un documento XML

El documento contiene el conjunto de registros en formato XML que pueden ser seleccionados mediante una expresion XPath, para mas detalles ver setDataSourceParameters().

Nota: Se puede obtener un conjunto de registros en el formato que procesa Kugar mediante FLReportEngine, estableciendo una consulta y obteniendo el resultado, para mas detalles ver la documentacion de FLReportEngine.

Parámetros:

d	Objeto QDomNode con los datos

Devuelve:

TRUE si ha ido bien

bool FLJasperEngine::setReportData

(

FLDomNodeInterface *

n

)

[slot]

bool FLJasperEngine::setReportTemplate

(

const QString &

t

)

[slot]

Establece la plantilla para el informe.

El nombre de la plantilla corresponde con el nombre del fichero con extesi�n ".jrxml".

Parámetros:

t	Nombre dela plantilla

Devuelve:

TRUE si ha ido bien

void FLJasperEngine::setShowErrorDialog

(

bool

b = true

)

[slot]

Para establecer si se debe mostrar el dialogo con el mensaje de error cuando se produce uno

void FLJasperEngine::updateReportPages

(

)

[slot]

Actualizar el contenido de la ultima coleccion de paginas generada con printReportToPages.

Siempre compila y rellena el informe llamando a compileReport() y fillReport()

Si no se ha invocado aun a printReportToPages esta funcion no hace nada.

---

Documentación de las funciones relacionadas y clases amigas

void JasperEngineMsgHandler	(	FLJasperEngine::AQReportsMsgType	type,
		const char *	msg,
		void *	rcv
	)		[friend]

---

La documentación para esta clase fue generada a partir de los siguientes ficheros:

• src/flbase/FLJasperEngine.h
• src/flbase/FLJasperEngine.cpp