com.businessobjects.crystalreports.designer.sdk.input
Interface IReportClientDocumentLoadingProgressMonitor


public interface IReportClientDocumentLoadingProgressMonitor

This interface defines a progress monitor that provides status updates specific to loading a report. By using this progress monitor, you delegate progress monitor updates to the report engine when a report is loaded.

See Also:
IProgressMonitor

Field Summary
static int DEFAULT_DOCUMENT_LOADING_WORK
          The default value for the amount of work it takes to load a report from the file system.
 
Method Summary
 void delegateLoadingWork(java.io.File reportFile, int amountToWork)
          Delegates the progress monitor updates to the report engine, thereby providing more accurate status updates.
 

Field Detail

DEFAULT_DOCUMENT_LOADING_WORK

static final int DEFAULT_DOCUMENT_LOADING_WORK
The default value for the amount of work it takes to load a report from the file system.

See Also:
Constant Field Values
Method Detail

delegateLoadingWork

void delegateLoadingWork(java.io.File reportFile,
                         int amountToWork)
Delegates the progress monitor updates to the report engine, thereby providing more accurate status updates. Call this method from the createDocument method immediately before calling open or openReport. Note that you must initialize the progress monitor using the IProgressMonitor.beginTask method before calling delegateLoadingWork.

Parameters:
reportFile - the report file being opened
amountToWork - the percentage of total work to allocate to opening the report
See Also:
IProgressMonitor