Package org.compiere.print

Class ReportCtl

java.lang.Object

org.compiere.print.ReportCtl

public class ReportCtl
extends Object

Report Controller.

Version:

$Id: ReportCtl.java,v 1.3 2006/10/08 07:05:08 comdivision Exp $

Author:

Jorg Janke, Teo Sarca, SC ARHIPAC SERVICE SRL

FR [ 1866739 ] ReportCtl: use printformat from the transient/serializable

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARAM_PRINT_FORMAT	Deprecated. Please use ServerReportCtl.PARAM_PRINT_FORMAT
static final String	PARAM_PRINT_INFO	Deprecated. Please use ServerReportCtl.PARAM_PRINT_INFO
static final String	PARAM_PRINTER_NAME	Deprecated. Please use ServerReportCtl.PARAM_PRINTER_NAME

Method Summary

Modifier and Type	Method	Description
static ReportViewerProvider	getReportViewerProvider()	Get report viewer provider
static void	preview(ReportEngine re)	Launch viewer for report
static boolean	start(IProcessUI parent, int WindowNo, ProcessInfo pi)	Create Report. Called from ProcessCtl. - Check special reports first, if not, create standard Report
static boolean	start(IProcessUI parent, int WindowNo, ProcessInfo pi, boolean IsDirectPrint)	Create Report. Called from ProcessCtl. - Check special reports first, if not, create standard Report
static boolean	start(ProcessInfo pi, boolean IsDirectPrint)	Create Report. Called from ProcessCtl. - Check special reports first, if not, create standard Report
static boolean	startCheckPrint(int C_Payment_ID, boolean IsDirectPrint, MPInstance instance)	Start Check Print. Find/Create.
static boolean	startDocumentPrint(int type, int Record_ID, boolean IsDirectPrint)	Start Document Print for Type.
static boolean	startDocumentPrint(int type, int Record_ID, IProcessUI parent, int WindowNo, boolean IsDirectPrint)	Start Document Print for Type.
static boolean	startDocumentPrint(int type, int Record_ID, IProcessUI parent, int WindowNo, boolean IsDirectPrint, MPInstance instance)	Start Document Print for Type.
static boolean	startDocumentPrint(int type, MPrintFormat customPrintFormat, int Record_ID, IProcessUI parent, int WindowNo, boolean IsDirectPrint, String printerName, MPInstance instance)	Start Document Print for Type with specified printer.
static boolean	startDocumentPrint(int type, MPrintFormat customPrintFormat, int Record_ID, IProcessUI parent, int WindowNo, String printerName)	Start Document Print for Type with specified printer.
static boolean	startFinReport(ProcessInfo pi)	Start Financial Report.
static boolean	startFinReport(ProcessInfo pi, int WindowNo)	Start Financial Report.
static boolean	startFinReport(ProcessInfo pi, int WindowNo, MPInstance instance)	Start Financial Report.
static boolean	startStandardReport(ProcessInfo pi)	Start Standard Report. - Get Table Info and submit. A report can be created from: attached MPrintFormat, if any (see ProcessInfo.setTransientObject(Object), ProcessInfo.setSerializableObject(java.io.Serializable) process information (AD_Process.AD_PrintFormat_ID, AD_Process.AD_ReportView_ID)
static boolean	startStandardReport(ProcessInfo pi, boolean IsDirectPrint)	Start Standard Report. - Get Table Info and submit
static boolean	startStandardReport(ProcessInfo pi, int WindowNo)	Start Standard Report. - Get Table Info and submit. A report can be created from: attached MPrintFormat, if any (see ProcessInfo.setTransientObject(Object), ProcessInfo.setSerializableObject(java.io.Serializable) process information (AD_Process.AD_PrintFormat_ID, AD_Process.AD_ReportView_ID)
static boolean	startStandardReport(ProcessInfo pi, int WindowNo, boolean IsDirectPrint)	Start Standard Report. - Get Table Info and submit
static boolean	startStandardReport(ProcessInfo pi, int WindowNo, boolean IsDirectPrint, MPInstance instance)	Start Standard Report. - Get Table Info and submit
static boolean	startStandardReport(ProcessInfo pi, int WindowNo, MPInstance instance)	Start Standard Report. - Get Table Info and submit. A report can be created from: attached MPrintFormat, if any (see ProcessInfo.setTransientObject(Object), ProcessInfo.setSerializableObject(java.io.Serializable) process information (AD_Process.AD_PrintFormat_ID, AD_Process.AD_ReportView_ID)

Methods inherited from class java.lang.Object

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

Field Details

PARAM_PRINTER_NAME

public static final String PARAM_PRINTER_NAME

Deprecated.

Please use ServerReportCtl.PARAM_PRINTER_NAME

See Also:

• Constant Field Values

PARAM_PRINT_FORMAT

public static final String PARAM_PRINT_FORMAT

Deprecated.

Please use ServerReportCtl.PARAM_PRINT_FORMAT

See Also:

• Constant Field Values

PARAM_PRINT_INFO

public static final String PARAM_PRINT_INFO

Deprecated.

Please use ServerReportCtl.PARAM_PRINT_INFO

See Also:

• Constant Field Values

Method Details

start

public static boolean start(ProcessInfo pi,
 boolean IsDirectPrint)

Create Report.
Called from ProcessCtl.
- Check special reports first, if not, create standard Report

Parameters:

pi - process info

IsDirectPrint - if true, prints directly - otherwise View

Returns:

true if created

start

public static boolean start(IProcessUI parent,
 int WindowNo,
 ProcessInfo pi,
 boolean IsDirectPrint)

Create Report.
Called from ProcessCtl.
- Check special reports first, if not, create standard Report

Parameters:

parent - The window which invoked the printing

WindowNo - The windows number which invoked the printing

pi - process info

IsDirectPrint - if true, prints directly - otherwise View

Returns:

true if created

start

public static boolean start(IProcessUI parent,
 int WindowNo,
 ProcessInfo pi)

Create Report.
Called from ProcessCtl.
- Check special reports first, if not, create standard Report

Parameters:

parent - The window which invoked the printing

WindowNo - The windows number which invoked the printing

pi - process info

Returns:

true if created

startStandardReport

public static boolean startStandardReport(ProcessInfo pi,
 boolean IsDirectPrint)

Start Standard Report.
- Get Table Info and submit

Parameters:

pi - Process Info

IsDirectPrint - if true, prints directly - otherwise View

Returns:

true if OK

startStandardReport

public static boolean startStandardReport(ProcessInfo pi,
 int WindowNo,
 boolean IsDirectPrint)

Start Standard Report.
- Get Table Info and submit

Parameters:

pi - Process Info

WindowNo - The windows number which invoked the printing

IsDirectPrint - if true, prints directly - otherwise View

Returns:

true if OK

startStandardReport

public static boolean startStandardReport(ProcessInfo pi,
 int WindowNo,
 boolean IsDirectPrint,
 MPInstance instance)

Start Standard Report.
- Get Table Info and submit

Parameters:

pi - Process Info

WindowNo - The windows number which invoked the printing

IsDirectPrint - if true, prints directly - otherwise View

instance - - AD_PInstance

Returns:

true if OK

startStandardReport

public static boolean startStandardReport(ProcessInfo pi)

Start Standard Report.
- Get Table Info and submit.
A report can be created from:

1. attached MPrintFormat, if any (see ProcessInfo.setTransientObject(Object), ProcessInfo.setSerializableObject(java.io.Serializable)
2. process information (AD_Process.AD_PrintFormat_ID, AD_Process.AD_ReportView_ID)

Parameters:

pi - Process Info

Returns:

true if OK

startStandardReport

public static boolean startStandardReport(ProcessInfo pi,
 int WindowNo)

Start Standard Report.
- Get Table Info and submit.
A report can be created from:

1. attached MPrintFormat, if any (see ProcessInfo.setTransientObject(Object), ProcessInfo.setSerializableObject(java.io.Serializable)
2. process information (AD_Process.AD_PrintFormat_ID, AD_Process.AD_ReportView_ID)

Parameters:

pi - Process Info

WindowNo - The windows number which invoked the printing

Returns:

true if OK

startStandardReport

public static boolean startStandardReport(ProcessInfo pi,
 int WindowNo,
 MPInstance instance)

Start Standard Report.
- Get Table Info and submit.
A report can be created from:

1. attached MPrintFormat, if any (see ProcessInfo.setTransientObject(Object), ProcessInfo.setSerializableObject(java.io.Serializable)
2. process information (AD_Process.AD_PrintFormat_ID, AD_Process.AD_ReportView_ID)

Parameters:

pi - Process Info

WindowNo - The windows number which invoked the printing

instance - - AD_PInstance

Returns:

true if OK

startFinReport

public static boolean startFinReport(ProcessInfo pi)

Start Financial Report.

Parameters:

pi - Process Info

Returns:

true if OK

startFinReport

public static boolean startFinReport(ProcessInfo pi,
 int WindowNo)

Start Financial Report.

Parameters:

pi - Process Info

WindowNo - The windows number which invoked the printing

Returns:

true if OK

startFinReport

public static boolean startFinReport(ProcessInfo pi,
 int WindowNo,
 MPInstance instance)

Start Financial Report.

Parameters:

pi - Process Info

WindowNo - The windows number which invoked the printing

instance - - AD_PInstance

Returns:

true if OK

startDocumentPrint

public static boolean startDocumentPrint(int type,
 int Record_ID,
 boolean IsDirectPrint)

Start Document Print for Type.

Parameters:

type - document type in ReportEngine

Record_ID - id

IsDirectPrint - if true, prints directly - otherwise View

Returns:

true if success

startDocumentPrint

public static boolean startDocumentPrint(int type,
 MPrintFormat customPrintFormat,
 int Record_ID,
 IProcessUI parent,
 int WindowNo,
 String printerName)

Start Document Print for Type with specified printer. Always direct print.

Parameters:

type - document type in ReportEngine

customPrintFormat - Custom print format. Can be null.

Record_ID - id

parent - The window which invoked the printing

WindowNo - The windows number which invoked the printing

printerName - Specified printer name

Returns:

true if success

startDocumentPrint

public static boolean startDocumentPrint(int type,
 int Record_ID,
 IProcessUI parent,
 int WindowNo,
 boolean IsDirectPrint)

Start Document Print for Type.

Parameters:

type - document type in ReportEngine

Record_ID - id

parent - The window which invoked the printing

WindowNo - The windows number which invoked the printing

IsDirectPrint - if true, prints directly - otherwise View

Returns:

true if success

startDocumentPrint

public static boolean startDocumentPrint(int type,
 int Record_ID,
 IProcessUI parent,
 int WindowNo,
 boolean IsDirectPrint,
 MPInstance instance)

Start Document Print for Type.

Parameters:

type - document type in ReportEngine

Record_ID - id

parent - The window which invoked the printing

WindowNo - The windows number which invoked the printing

IsDirectPrint - if true, prints directly - otherwise View

instance - - AD_PInstance

Returns:

true if success

startDocumentPrint

public static boolean startDocumentPrint(int type,
 MPrintFormat customPrintFormat,
 int Record_ID,
 IProcessUI parent,
 int WindowNo,
 boolean IsDirectPrint,
 String printerName,
 MPInstance instance)

Start Document Print for Type with specified printer.

Parameters:

type - document type in ReportEngine

customPrintFormat -

Record_ID - id

parent - The window which invoked the printing

WindowNo - The windows number which invoked the printing

IsDirectPrint -

printerName - Specified printer name

instance - - AD_PInstance

Returns:

true if success

startCheckPrint

public static boolean startCheckPrint(int C_Payment_ID,
 boolean IsDirectPrint,
 MPInstance instance)

Start Check Print.
Find/Create.

Parameters:

C_Payment_ID - Payment

IsDirectPrint - if true, prints directly - otherwise View

instance - - AD_PInstance

Returns:

true if success

preview

public static void preview(ReportEngine re)

Launch viewer for report

Parameters:

re -

getReportViewerProvider

public static ReportViewerProvider getReportViewerProvider()

Get report viewer provider

Returns:

ReportViewerProvider