BBJasperProgress

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

```
public class BBJasperProgress
```
Shows a cancelable progress window while a JasperReport is being filled with data

See Also:
[]
Since:
9.0

Field Summary

Fields
Modifier and Type	Field and Description
`static BBjNumber`	`CANCELED=2` Constant which represents the fill operation has been canceled
`static BBjNumber`	`FINISHED=3` Constant which represents the fill operation has finished
`static BBjNumber`	`RUNNING=1` Constant which represents the fill operation is running

Constructor Summary

Constructors
Constructor and Description
`BBJasperProgress(BBjString p_reportName$, BBjString p_bbJasperProgressKey$)` Constructor Constructs a BBJasperProgress object given a report name and a progress key

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`destroy()` destroy Destroys the progress window
`void`	`doModal()` doModal Shows the progress window and runs process events
`void`	`OnCancel(BBjButtonPushEvent p_event!)` OnCancel Callback called when the user selects the cancel button
`void`	`OnProgressChange(BBjNamespaceEvent p_event!)` OnProgressChange Called when the namespace progress key value is changed

Field Detail
- CANCELED=2
```
public static BBjNumber CANCELED=2
```
  Constant which represents the fill operation has been canceled
- FINISHED=3
```
public static BBjNumber FINISHED=3
```
  Constant which represents the fill operation has finished
- RUNNING=1
```
public static BBjNumber RUNNING=1
```
  Constant which represents the fill operation is running

Constructor Detail
- BBJasperProgress
```
public BBJasperProgress(BBjString p_reportName$, BBjString p_bbJasperProgressKey$)
```
  Constructor Constructs a BBJasperProgress object given a report name and a progress key
  
  Parameters:
  p_reportName$ Name of the report
  p_bbJasperProgressKey$ Key used to update the progress in the namespace

- Method Detail
  - destroy
```
public void destroy()
```
    destroy Destroys the progress window
  - doModal
```
public void doModal()
```
    doModal Shows the progress window and runs process events
  - OnCancel
```
public void OnCancel(BBjButtonPushEvent p_event!)
```
    OnCancel Callback called when the user selects the cancel button
    
    Parameters:
    p_event! BBjButtonPushEvent object
  - OnProgressChange
```
public void OnProgressChange(BBjNamespaceEvent p_event!)
```
    OnProgressChange Called when the namespace progress key value is changed
    
    Parameters:
    p_event! BBjNamespaceEvent object