|
||||||||||
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 IReportViewer
document
- 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 IReportViewer
IReportViewer.getDocument()
public boolean hasDocument()
IReportViewer
hasDocument
in interface IReportViewer
IReportViewer.hasDocument()
public void unsetDocument(java.lang.String reason)
IReportViewer
unsetDocument
in interface IReportViewer
reason
- the reason for the missing document. Can be null.IReportViewer.unsetDocument(java.lang.String)
public java.lang.String getReason()
IReportViewer
getReason
in interface IReportViewer
IReportViewer.getReason()
public void setZoom(double zoom)
IReportViewer
setZoom
in interface IReportViewer
zoom
- zoom levelIReportViewer.setZoom(double)
public boolean canChangeZoom()
IReportViewer
canChangeZoom
in interface IReportViewer
IReportViewer.canChangeZoom()
public double getZoom()
IReportViewer
getZoom
in interface IReportViewer
IReportViewer.getZoom()
public void setZoomMode(int zoomMode)
IReportViewer
ZOOM_MODE
constants must be used.
setZoomMode
in interface IReportViewer
zoomMode
- the zoom modeIReportViewer.setZoomMode(int)
public int getZoomMode()
IReportViewer
getZoomMode
in interface IReportViewer
IReportViewer.getZoomMode()
public int getPageIndex()
IReportViewer
getPageIndex
in interface IReportViewer
IReportViewer.getPageIndex()
public void setPageIndex(int pageIndex)
IReportViewer
setPageIndex
in interface IReportViewer
pageIndex
- the page indexIReportViewer.setPageIndex(int)
public boolean canGotoFirstPage()
IReportViewer
canGotoFirstPage
in interface IReportViewer
IReportViewer.canGotoFirstPage()
public void gotoFirstPage()
IReportViewer
gotoFirstPage
in interface IReportViewer
IReportViewer.gotoFirstPage()
public boolean canGotoLastPage()
IReportViewer
canGotoLastPage
in interface IReportViewer
IReportViewer.canGotoLastPage()
public void gotoLastPage()
IReportViewer
gotoLastPage
in interface IReportViewer
IReportViewer.gotoLastPage()
public boolean canGotoNextPage()
IReportViewer
canGotoNextPage
in interface IReportViewer
IReportViewer.canGotoNextPage()
public void gotoNextPage()
IReportViewer
gotoNextPage
in interface IReportViewer
IReportViewer.gotoNextPage()
public boolean canGotoPreviousPage()
IReportViewer
canGotoPreviousPage
in interface IReportViewer
IReportViewer.canGotoPreviousPage()
public void gotoPreviousPage()
IReportViewer
gotoPreviousPage
in interface IReportViewer
IReportViewer.gotoPreviousPage()
public void addReportViewerListener(IReportViewerListener listener)
IReportViewer
addReportViewerListener
in interface IReportViewer
listener
- the listenerIReportViewer.addReportViewerListener(com.jasperassistant.designer.viewer.IReportViewerListener)
public void removeReportViewerListener(IReportViewerListener listener)
IReportViewer
removeReportViewerListener
in interface IReportViewer
listener
- the listenerIReportViewer.removeReportViewerListener(com.jasperassistant.designer.viewer.IReportViewerListener)
public void reload()
IReportViewer
loadDocument
method.
reload
in interface IReportViewer
IReportViewer.reload()
public boolean canReload()
IReportViewer
canReload
in interface IReportViewer
IReportViewer.canReload()
public void loadDocument(java.lang.String fileName, boolean xml)
IReportViewer
JasperPrint
object or a jrprint
xml document. The format is controlled by the xml
boolean parameter.
loadDocument
in interface IReportViewer
fileName
- 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 IReportViewer
IReportViewer.getZoomLevels()
public void setZoomLevels(double[] levels)
IReportViewer
setZoomLevels
in interface IReportViewer
levels
- a non-null and non-empty array of zoom levelsIReportViewer.setZoomLevels(double[])
public void zoomIn()
IReportViewer
zoomIn
in interface IReportViewer
IReportViewer.zoomIn()
public boolean canZoomIn()
IReportViewer
canZoomIn
in interface IReportViewer
IReportViewer.canZoomIn()
public void zoomOut()
IReportViewer
zoomOut
in interface IReportViewer
IReportViewer.zoomOut()
public boolean canZoomOut()
IReportViewer
canZoomOut
in interface IReportViewer
IReportViewer.canZoomOut()
public void addHyperlinkListener(net.sf.jasperreports.view.JRHyperlinkListener listener)
IReportViewer
addHyperlinkListener
in interface IReportViewer
listener
- the listener to addIReportViewer.addHyperlinkListener(net.sf.jasperreports.view.JRHyperlinkListener)
public void removeHyperlinkListener(net.sf.jasperreports.view.JRHyperlinkListener listener)
IReportViewer
removeHyperlinkListener
in interface IReportViewer
listener
- the listener to removeIReportViewer.removeHyperlinkListener(net.sf.jasperreports.view.JRHyperlinkListener)
public net.sf.jasperreports.view.JRHyperlinkListener[] getHyperlinkListeners()
IReportViewer
getHyperlinkListeners
in interface IReportViewer
IReportViewer.getHyperlinkListeners()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |