net.sf.jasperreports.swing.JRViewer Maven / Gradle / Ivy
/*
* JasperReports - Free Java Reporting Library.
* Copyright (C) 2001 - 2014 TIBCO Software Inc. All rights reserved.
* http://www.jaspersoft.com
*
* Unless you have purchased a commercial license agreement from Jaspersoft,
* the following license terms apply:
*
* This program is part of JasperReports.
*
* JasperReports is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* JasperReports is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with JasperReports. If not, see
* If rendering a report page would require an image larger than this threshold
* (i.e. image width x image height > maximum size), the report page will be rendered directly on the viewer component.
*
*
* If this property is zero or negative, buffered images will never be user to render a report page.
* By default, this property is set to 0.
*
*/
public static final String VIEWER_RENDER_BUFFER_MAX_SIZE = JRPropertiesUtil.PROPERTY_PREFIX + "viewer.render.buffer.max.size";
protected JRViewerController viewerContext;
/**
* @see #JRViewer(JasperReportsContext, String, boolean, Locale, ResourceBundle)
*/
public JRViewer(String fileName, boolean isXML) throws JRException
{
this(fileName, isXML, null);
}
/**
* @see #JRViewer(JasperReportsContext, InputStream, boolean, Locale, ResourceBundle)
*/
public JRViewer(InputStream is, boolean isXML) throws JRException
{
this(is, isXML, null);
}
/**
* @see #JRViewer(JasperReportsContext, JasperPrint, Locale, ResourceBundle)
*/
public JRViewer(JasperPrint jrPrint)
{
this(jrPrint, null);
}
/**
* @see #JRViewer(JasperReportsContext, String, boolean, Locale, ResourceBundle)
*/
public JRViewer(String fileName, boolean isXML, Locale locale) throws JRException
{
this(fileName, isXML, locale, null);
}
/**
* @see #JRViewer(InputStream, boolean, Locale, ResourceBundle)
*/
public JRViewer(InputStream is, boolean isXML, Locale locale) throws JRException
{
this(is, isXML, locale, null);
}
/**
* @see #JRViewer(JasperPrint, Locale, ResourceBundle)
*/
public JRViewer(JasperPrint jrPrint, Locale locale)
{
this(jrPrint, locale, null);
}
/**
* @see #JRViewer(String, boolean, Locale, ResourceBundle)
*/
public JRViewer(String fileName, boolean isXML, Locale locale, ResourceBundle resBundle) throws JRException
{
this(
DefaultJasperReportsContext.getInstance(),
fileName,
isXML,
locale,
resBundle
);
}
/**
* @see #JRViewer(InputStream, boolean, Locale, ResourceBundle)
*/
public JRViewer(InputStream is, boolean isXML, Locale locale, ResourceBundle resBundle) throws JRException
{
this(
DefaultJasperReportsContext.getInstance(),
is,
isXML,
locale,
resBundle
);
}
/**
* @see #JRViewer(JasperReportsContext, JasperPrint, Locale, ResourceBundle)
*/
public JRViewer(JasperPrint jrPrint, Locale locale, ResourceBundle resBundle)
{
this(
DefaultJasperReportsContext.getInstance(),
jrPrint,
locale,
resBundle
);
}
/**
*
*/
public JRViewer(
JasperReportsContext jasperReportsContext,
String fileName,
boolean isXML,
Locale locale,
ResourceBundle resBundle
) throws JRException
{
initViewerContext(jasperReportsContext, locale, resBundle);
initComponents();
viewerContext.loadReport(fileName, isXML);
tlbToolBar.init();
}
/**
*
*/
public JRViewer(
JasperReportsContext jasperReportsContext,
InputStream is,
boolean isXML,
Locale locale,
ResourceBundle resBundle
) throws JRException
{
initViewerContext(jasperReportsContext, locale, resBundle);
initComponents();
viewerContext.loadReport(is, isXML);
tlbToolBar.init();
}
/**
*
*/
public JRViewer(
JasperReportsContext jasperReportsContext,
JasperPrint jrPrint,
Locale locale,
ResourceBundle resBundle
)
{
initViewerContext(jasperReportsContext, locale, resBundle);
initComponents();
viewerContext.loadReport(jrPrint);
tlbToolBar.init();
}
/**
*
*/
protected void initViewerContext(JasperReportsContext jasperReportsContext, Locale locale, ResourceBundle resBundle)
{
viewerContext = new JRViewerController(jasperReportsContext, locale, resBundle);
setLocale(viewerContext.getLocale());
viewerContext.addListener(this);
}
/**
*
*/
public void clear()
{
emptyContainer(this);
viewerContext.clear();
}
/**
*
*/
protected String getBundleString(String key)
{
return viewerContext.getBundleString(key);
}
/** This method is called from within the constructor to
* initialize the form.
* WARNING: Do NOT modify this code. The content of this method is
* always regenerated by the Form Editor.
*/
// //GEN-BEGIN:initComponents
private void initComponents() {
tlbToolBar = createToolbar();
pnlMain = createViewerPanel();
lblStatus = new javax.swing.JLabel();
pnlStatus = new javax.swing.JPanel();
pnlStatus.setLayout(new java.awt.FlowLayout(java.awt.FlowLayout.CENTER, 0, 0));
lblStatus.setFont(new java.awt.Font("Dialog", 1, 10));
lblStatus.setText("Page i of n");
pnlStatus.add(lblStatus);
setLayout(new java.awt.BorderLayout());
add(tlbToolBar, java.awt.BorderLayout.NORTH);
add(pnlMain, java.awt.BorderLayout.CENTER);
add(pnlStatus, java.awt.BorderLayout.SOUTH);
KeyListener keyNavigationListener = pnlMain.getKeyNavigationListener();
addKeyListener(keyNavigationListener);
tlbToolBar.addComponentKeyListener(keyNavigationListener);
}
// //GEN-END:initComponents
protected JRViewerToolbar createToolbar()
{
return new JRViewerToolbar(viewerContext);
}
//FIXME add a method to do addHyperlinkListener without subclassing
protected JRViewerPanel createViewerPanel()
{
return new JRViewerPanel(viewerContext);
}
public void setFitWidthZoomRatio()
{
pnlMain.setFitWidthZoomRatio();
}
public void setFitPageZoomRatio()
{
pnlMain.setFitPageZoomRatio();
}
/**
*/
public int getPageIndex()
{
return viewerContext.getPageIndex();
}
/**
*/
private void emptyContainer(Container container)
{
Component[] components = container.getComponents();
if (components != null)
{
for(int i = 0; i < components.length; i++)
{
if (components[i] instanceof Container)
{
emptyContainer((Container)components[i]);
}
}
}
components = null;
container.removeAll();
container = null;
}
public void setZoomRatio(float zoomRatio)
{
viewerContext.setZoomRatio(zoomRatio);
}
public void pageChanged()
{
if (viewerContext.hasPages())
{
lblStatus.setText(
MessageFormat.format(
getBundleString("page"),
new Object[]{Integer.valueOf(viewerContext.getPageIndex() + 1),
Integer.valueOf(viewerContext.getPageCount())}
)
);
}
else
{
lblStatus.setText("");
}
}
@Override
public void viewerEvent(JRViewerEvent event)
{
switch (event.getCode())
{
case JRViewerEvent.EVENT_PAGE_CHANGED:
pageChanged();
break;
case JRViewerEvent.EVENT_REPORT_LOAD_FAILED:
JOptionPane.showMessageDialog(this, getBundleString("error.loading"));
break;
}
}
// Variables declaration - do not modify//GEN-BEGIN:variables
protected javax.swing.JLabel lblStatus;
private JRViewerPanel pnlMain;
protected javax.swing.JPanel pnlStatus;
protected JRViewerToolbar tlbToolBar;
// End of variables declaration//GEN-END:variables
}