|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.as400.util.reportwriter.processor.ReportProcessor
The ReportProcessor class is the superclass for all ReportProcessors. The methods of this class are used to set various attributes associated with a report processing job.
Field Summary | |
static int |
ALL
Constant for specifying all pages of the report should be processed. |
protected com.ibm.as400.util.reportwriter.processor.Context |
context_
|
static int |
RANGE
Constant for specifying page ranges of the report should be processed. |
Method Summary | |
void |
addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Adds a property change listener. |
void |
addVetoableChangeListener(java.beans.VetoableChangeListener listener)
Adds a vetoable change listener. |
void |
cancel()
Cancels a report processor job that is in progress. |
int |
getCopies()
Returns the number of copies the report processor should generate. |
java.awt.print.PageFormat |
getPageFormat()
Returns the size and orientation of each page of the report. |
int[][] |
getPageRanges()
Returns, for jobs using these attributes, the ranges of pages to be processed, if possible. |
int |
getPageSelection()
Returns whether the report processor should process all pages or the range of pages specified by the return value of getPageRanges(). |
java.lang.String |
getReportName()
Returns the name of the report to be processed. |
boolean |
isCancelled()
Returns true if a report processor job is in progress, but is going to be cancelled at the next opportunity; otherwise, returns false. |
abstract void |
processReport()
Starts a report processing job. |
void |
removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Removes a property change listener. |
void |
removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
Removes a vetoable change listener. |
void |
setContext(com.ibm.as400.util.reportwriter.processor.Context context)
Sets the OutputGenerator to be used to generate pages of the report. |
void |
setCopies(int copies)
Specifies the number of copies the report processor should generate. |
void |
setPageFormat(java.awt.print.PageFormat pageFormat)
Specifies the size and orientation of each page of the report. |
void |
setPageRanges(int[][] pageRanges)
Specifies, for jobs using these attributes, the ranges of pages to be processed, if possible. |
void |
setPageSelection(int selection)
Specifies whether the report processor should process all pages or the range of pages specified by the return value of getPageRanges(). |
void |
setReportName(java.lang.String reportName)
Sets the name of the report to be processed. |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Field Detail |
public static final int ALL
public static final int RANGE
protected com.ibm.as400.util.reportwriter.processor.Context context_
Method Detail |
public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
listener
- The property change listener to add.public void addVetoableChangeListener(java.beans.VetoableChangeListener listener)
listener
- The vetoable change listener to add.public void cancel()
public int getCopies()
public java.awt.print.PageFormat getPageFormat()
public int[][] getPageRanges()
public int getPageSelection()
public java.lang.String getReportName()
public boolean isCancelled()
public abstract void processReport() throws java.io.IOException, org.xml.sax.SAXException
public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
listener
- The property change listener to remove.public void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
listener
- The vetoable change listener to remove.public void setCopies(int copies)
copies
- an integer greater than 0 representing number of copies.public void setContext(com.ibm.as400.util.reportwriter.processor.Context context)
public void setPageFormat(java.awt.print.PageFormat pageFormat)
pageFormat
- the page format.public void setPageRanges(int[][] pageRanges)
pageRanges
- an array of integer arrays of 2 elements. An array is
interpreted as a range spanning all pages including
and between the specified pages. Ranges MUST be in
ascending order and MUST NOT overlap. Specified page
numbers cannot be less than 1. For example:
new int[][]{ new int[]{1,3}, new int[]{5,5}, new int[]{15,19}})
specifies pages 1, 2, 3, 5, 15, 16, 17, 18, and 19.public void setPageSelection(int selection)
ReportProcessorJobAttributes.ALL
selection
- the selection to process.
ReportProcessorJobAttributes.ALL
- process all pages
ReportProcessorJobAttributes.RANGE
- process ranges of pages
public void setReportName(java.lang.String reportName)
reportName
- the name of the report to be processed.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |