|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.jasperassistant.designer.viewer.ReportViewer
SWT based report viewer implementation.
| Field Summary |
| Fields inherited from interface com.jasperassistant.designer.viewer.IReportViewer |
ZOOM_MODE_ACTUAL_SIZE, ZOOM_MODE_FIT_HEIGHT, ZOOM_MODE_FIT_PAGE, ZOOM_MODE_FIT_WIDTH, ZOOM_MODE_NONE |
| Constructor Summary | |
ReportViewer()
Default constructor. |
|
ReportViewer(int style)
Constructor that allows to specify a SWT control style. |
|
| Method Summary | |
void |
addHyperlinkListener(net.sf.jasperreports.view.JRHyperlinkListener listener)
Registers a hyperlink click listener that will be notified when user clicks a hyperlink. |
void |
addReportViewerListener(IReportViewerListener listener)
Register a report viewer listener that will observe the viewer state changes |
boolean |
canChangeZoom()
Checks the necessary preconditions for zoom changing |
boolean |
canGotoFirstPage()
Checks the preconditions for first page positioning |
boolean |
canGotoLastPage()
Checks the preconditions for last page positioning |
boolean |
canGotoNextPage()
Checks the preconditions for next page positioning |
boolean |
canGotoPreviousPage()
Checks the preconditions for previous page positioning |
boolean |
canReload()
Checks whether the document can be reloaded. |
boolean |
canZoomIn()
Checks the zoom-in operation preconditions |
boolean |
canZoomOut()
Checks the zoom in preconditions |
org.eclipse.swt.widgets.Control |
createControl(org.eclipse.swt.widgets.Composite parent)
Creates the SWT control for the report viewer. |
net.sf.jasperreports.engine.JasperPrint |
getDocument()
Returns the jasper print document |
net.sf.jasperreports.view.JRHyperlinkListener[] |
getHyperlinkListeners()
Returns registered hyperlink listeners |
int |
getPageIndex()
Returns the current page index. |
java.lang.String |
getReason()
Returns the message that explains the reason that the document is missing. |
double |
getZoom()
Returns the current zoom level |
double[] |
getZoomLevels()
Returns an array with available zoom levels |
int |
getZoomMode()
Returns the current zoom mode |
void |
gotoFirstPage()
Positions the viewer on the first page in the document |
void |
gotoLastPage()
Positions the viewer on the last page in the document |
void |
gotoNextPage()
Positions the viewer on the next page in the document |
void |
gotoPreviousPage()
Positions the viewer on the previous page in the document |
boolean |
hasDocument()
Returns true if there is a jasper print document set |
void |
loadDocument(java.lang.String fileName,
boolean xml)
Loads the document from the given file. |
void |
reload()
Reloads the report. |
void |
removeHyperlinkListener(net.sf.jasperreports.view.JRHyperlinkListener listener)
Removes a previously registered hyperlink click listener |
void |
removeReportViewerListener(IReportViewerListener listener)
Removes a previously registered report viewer listener |
void |
setDocument(net.sf.jasperreports.engine.JasperPrint document)
Sets the jasper print document |
void |
setPageIndex(int pageIndex)
Sets the current page index. |
void |
setZoom(double zoom)
Sets the zoom level |
void |
setZoomLevels(double[] levels)
Sets the available zoom levels |
void |
setZoomMode(int zoomMode)
Sets the zoom mode. |
void |
unsetDocument(java.lang.String reason)
Sets to null the currently set document. |
void |
zoomIn()
Zooms in the viewer |
void |
zoomOut()
Zooms out the viewer |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public ReportViewer()
public ReportViewer(int style)
Canvas class. Most frequently you
will wont to specify the SWT.NONE style.
- Parameters:
style - the style| Method Detail |
public void setDocument(net.sf.jasperreports.engine.JasperPrint document)
IReportViewer
setDocument in interface IReportViewerdocument - document to set. Must be not null.IReportViewer.setDocument(net.sf.jasperreports.engine.JasperPrint)public net.sf.jasperreports.engine.JasperPrint getDocument()
IReportViewer
getDocument in interface IReportViewerIReportViewer.getDocument()public boolean hasDocument()
IReportViewer
hasDocument in interface IReportViewerIReportViewer.hasDocument()public void unsetDocument(java.lang.String reason)
IReportViewer
unsetDocument in interface IReportViewerreason - the reason for the missing document. Can be null.IReportViewer.unsetDocument(java.lang.String)public java.lang.String getReason()
IReportViewer
getReason in interface IReportViewerIReportViewer.getReason()public void setZoom(double zoom)
IReportViewer
setZoom in interface IReportViewerzoom - zoom levelIReportViewer.setZoom(double)public boolean canChangeZoom()
IReportViewer
canChangeZoom in interface IReportViewerIReportViewer.canChangeZoom()public double getZoom()
IReportViewer
getZoom in interface IReportViewerIReportViewer.getZoom()public void setZoomMode(int zoomMode)
IReportViewerZOOM_MODE
constants must be used.
setZoomMode in interface IReportViewerzoomMode - the zoom modeIReportViewer.setZoomMode(int)public int getZoomMode()
IReportViewer
getZoomMode in interface IReportViewerIReportViewer.getZoomMode()public int getPageIndex()
IReportViewer
getPageIndex in interface IReportViewerIReportViewer.getPageIndex()public void setPageIndex(int pageIndex)
IReportViewer
setPageIndex in interface IReportViewerpageIndex - the page indexIReportViewer.setPageIndex(int)public boolean canGotoFirstPage()
IReportViewer
canGotoFirstPage in interface IReportViewerIReportViewer.canGotoFirstPage()public void gotoFirstPage()
IReportViewer
gotoFirstPage in interface IReportViewerIReportViewer.gotoFirstPage()public boolean canGotoLastPage()
IReportViewer
canGotoLastPage in interface IReportViewerIReportViewer.canGotoLastPage()public void gotoLastPage()
IReportViewer
gotoLastPage in interface IReportViewerIReportViewer.gotoLastPage()public boolean canGotoNextPage()
IReportViewer
canGotoNextPage in interface IReportViewerIReportViewer.canGotoNextPage()public void gotoNextPage()
IReportViewer
gotoNextPage in interface IReportViewerIReportViewer.gotoNextPage()public boolean canGotoPreviousPage()
IReportViewer
canGotoPreviousPage in interface IReportViewerIReportViewer.canGotoPreviousPage()public void gotoPreviousPage()
IReportViewer
gotoPreviousPage in interface IReportViewerIReportViewer.gotoPreviousPage()public void addReportViewerListener(IReportViewerListener listener)
IReportViewer
addReportViewerListener in interface IReportViewerlistener - the listenerIReportViewer.addReportViewerListener(com.jasperassistant.designer.viewer.IReportViewerListener)public void removeReportViewerListener(IReportViewerListener listener)
IReportViewer
removeReportViewerListener in interface IReportViewerlistener - the listenerIReportViewer.removeReportViewerListener(com.jasperassistant.designer.viewer.IReportViewerListener)public void reload()
IReportViewerloadDocument method.
reload in interface IReportViewerIReportViewer.reload()public boolean canReload()
IReportViewer
canReload in interface IReportViewerIReportViewer.canReload()
public void loadDocument(java.lang.String fileName,
boolean xml)
IReportViewerJasperPrint object or a jrprint
xml document. The format is controlled by the xml
boolean parameter.
loadDocument in interface IReportViewerfileName - the file namexml - flag that indicates the type of file type. If true, the file
contains an xml and a serialized object otherwise.IReportViewer.loadDocument(java.lang.String,
boolean)public org.eclipse.swt.widgets.Control createControl(org.eclipse.swt.widgets.Composite parent)
parent - the parent
public double[] getZoomLevels()
IReportViewer
getZoomLevels in interface IReportViewerIReportViewer.getZoomLevels()public void setZoomLevels(double[] levels)
IReportViewer
setZoomLevels in interface IReportViewerlevels - a non-null and non-empty array of zoom levelsIReportViewer.setZoomLevels(double[])public void zoomIn()
IReportViewer
zoomIn in interface IReportViewerIReportViewer.zoomIn()public boolean canZoomIn()
IReportViewer
canZoomIn in interface IReportViewerIReportViewer.canZoomIn()public void zoomOut()
IReportViewer
zoomOut in interface IReportViewerIReportViewer.zoomOut()public boolean canZoomOut()
IReportViewer
canZoomOut in interface IReportViewerIReportViewer.canZoomOut()public void addHyperlinkListener(net.sf.jasperreports.view.JRHyperlinkListener listener)
IReportViewer
addHyperlinkListener in interface IReportViewerlistener - the listener to addIReportViewer.addHyperlinkListener(net.sf.jasperreports.view.JRHyperlinkListener)public void removeHyperlinkListener(net.sf.jasperreports.view.JRHyperlinkListener listener)
IReportViewer
removeHyperlinkListener in interface IReportViewerlistener - the listener to removeIReportViewer.removeHyperlinkListener(net.sf.jasperreports.view.JRHyperlinkListener)public net.sf.jasperreports.view.JRHyperlinkListener[] getHyperlinkListeners()
IReportViewer
getHyperlinkListeners in interface IReportViewerIReportViewer.getHyperlinkListeners()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||