net.sf.jasperreports.view

Class JRViewer

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

net.sf.jasperreports.view.JRViewer

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, JRHyperlinkListener

Direct Known Subclasses:

JRDesignViewer

Deprecated.

Replaced by JRViewer.

public class JRViewer
extends JPanel
implements JRHyperlinkListener

Represents the built-in visual component for JasperReports.

This class is different from the rest of the classes listed previously in that it is more like a pluggable component than a utility class. It can be used in Swing-based applications to view the reports generated by the JasperReports library.

This visual component was included like a demo component to show how the core printing functionality can be used to display the reports in Swing-based applications.

The preferred way to adapt this component to a particular application is by subclassing it.

Author:

Teodor Danciu (teodord@users.sourceforge.net)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	JRViewer.ImageMapPanel Deprecated.

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected JToggleButton	btnActualSize Deprecated.
protected JButton	btnFirst Deprecated.
protected JToggleButton	btnFitPage Deprecated.
protected JToggleButton	btnFitWidth Deprecated.
protected JButton	btnLast Deprecated.
protected JButton	btnNext Deprecated.
protected JButton	btnPrevious Deprecated.
protected JButton	btnPrint Deprecated.
protected JButton	btnReload Deprecated.
protected JButton	btnSave Deprecated.
protected JButton	btnZoomIn Deprecated.
protected JButton	btnZoomOut Deprecated.
protected JComboBox	cmbZoom Deprecated.
protected int	defaultZoomIndex Deprecated.
protected boolean	isXML Deprecated.
protected JasperReportsContext	jasperReportsContext Deprecated.
protected KeyListener	keyNavigationListener Deprecated.
protected File	lastFolder Deprecated.
protected JRSaveContributor	lastSaveContributor Deprecated.
protected JLabel	lblStatus Deprecated.
protected LocalJasperReportsContext	localJasperReportsContext Deprecated.
protected float	MAX_ZOOM Deprecated.
protected float	MIN_ZOOM Deprecated.
protected JPanel	pnlSep01 Deprecated.
protected JPanel	pnlSep02 Deprecated.
protected JPanel	pnlSep03 Deprecated.
protected JPanel	pnlStatus Deprecated.
protected float	realZoom Deprecated. the zoom ration adjusted to the screen resolution.
static int	REPORT_RESOLUTION Deprecated. The DPI of the generated report.
protected String	reportFileName Deprecated.
protected List<JRSaveContributor>	saveContributors Deprecated.
protected JPanel	tlbToolBar Deprecated.
protected JTextField	txtGoTo Deprecated.
protected int	type Deprecated.
protected static int	TYPE_FILE_NAME Deprecated.
protected static int	TYPE_INPUT_STREAM Deprecated.
protected static int	TYPE_OBJECT Deprecated.
static String	VIEWER_RENDER_BUFFER_MAX_SIZE Deprecated. Maximum size (in pixels) of a buffered image that would be used by JRViewer to render a report page.
protected float	zoom Deprecated.
protected int[]	zooms Deprecated.

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
JRViewer(InputStream is, boolean isXML) Deprecated.
JRViewer(InputStream is, boolean isXML, Locale locale) Deprecated.
JRViewer(InputStream is, boolean isXML, Locale locale, ResourceBundle resBundle) Deprecated.
JRViewer(JasperPrint jrPrint) Deprecated.
JRViewer(JasperPrint jrPrint, Locale locale) Deprecated.
JRViewer(JasperPrint jrPrint, Locale locale, ResourceBundle resBundle) Deprecated.
JRViewer(JasperReportsContext jasperReportsContext, InputStream is, boolean isXML, Locale locale, ResourceBundle resBundle) Deprecated.
JRViewer(JasperReportsContext jasperReportsContext, JasperPrint jrPrint, Locale locale, ResourceBundle resBundle) Deprecated.
JRViewer(JasperReportsContext jasperReportsContext, String fileName, boolean isXML, Locale locale, ResourceBundle resBundle) Deprecated.
JRViewer(String fileName, boolean isXML) Deprecated.
JRViewer(String fileName, boolean isXML, Locale locale) Deprecated.
JRViewer(String fileName, boolean isXML, Locale locale, ResourceBundle resBundle) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
void	addHyperlinkListener(JRHyperlinkListener listener) Deprecated.
void	addSaveContributor(JRSaveContributor contributor) Deprecated.
void	clear() Deprecated.
protected void	createHyperlinks() Deprecated.
protected void	createHyperlinks(List<JRPrintElement> elements, int offsetX, int offsetY) Deprecated.
protected void	drawPageError(Graphics grx) Deprecated.
protected void	forceRefresh() Deprecated.
protected String	getBundleString(String key) Deprecated.
protected String	getFallbackTooltip(JRPrintHyperlink hyperlink) Deprecated.
protected JRGraphics2DExporter	getGraphics2DExporter() Deprecated.
JRHyperlinkListener[]	getHyperlinkListeners() Deprecated.
protected String	getHyperlinkTooltip(JRPrintHyperlink hyperlink) Deprecated.
protected JasperReportsContext	getJasperReportsContext() Deprecated.
protected Image	getPageErrorImage() Deprecated.
int	getPageIndex() Deprecated.
JRSaveContributor[]	getSaveContributors() Deprecated.
void	gotoHyperlink(JRPrintHyperlink hyperlink) Deprecated.
protected void	hyperlinkClicked(JRPrintHyperlink hyperlink) Deprecated.
protected void	initResources(Locale locale, ResourceBundle resBundle) Deprecated.
protected void	initSaveContributors() Deprecated.
protected boolean	isOnlyHyperlinkListener() Deprecated.
protected void	keyNavigate(KeyEvent evt) Deprecated.
protected void	loadReport(InputStream is, boolean isXmlReport) Deprecated.
protected void	loadReport(JasperPrint jrPrint) Deprecated.
protected void	loadReport(String fileName, boolean isXmlReport) Deprecated.
protected void	paintPage(Graphics2D grx) Deprecated.
protected void	paintPageError(Graphics2D grx) Deprecated.
protected void	refreshPage() Deprecated.
protected void	refreshTabs() Deprecated.
void	removeHyperlinkListener(JRHyperlinkListener listener) Deprecated.
void	removeSaveContributor(JRSaveContributor contributor) Deprecated.
void	setFitPageZoomRatio() Deprecated.
void	setFitWidthZoomRatio() Deprecated.
protected void	setPageImage() Deprecated.
void	setSaveContributors(JRSaveContributor[] saveContribs) Deprecated. Replaces the save contributors with the ones provided as parameter.
void	setZoomRatio(float newZoom) Deprecated.
protected void	setZooms() Deprecated.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

VIEWER_RENDER_BUFFER_MAX_SIZE

public static final String VIEWER_RENDER_BUFFER_MAX_SIZE

Deprecated.

Maximum size (in pixels) of a buffered image that would be used by JRViewer to render a report page.

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.

See Also:

Constant Field Values

TYPE_FILE_NAME

protected static final int TYPE_FILE_NAME

Deprecated.

See Also:

Constant Field Values

TYPE_INPUT_STREAM

protected static final int TYPE_INPUT_STREAM

Deprecated.

See Also:

Constant Field Values

TYPE_OBJECT

protected static final int TYPE_OBJECT

Deprecated.

See Also:

Constant Field Values

REPORT_RESOLUTION

public static final int REPORT_RESOLUTION

Deprecated.

The DPI of the generated report.

See Also:

Constant Field Values

MIN_ZOOM

protected final float MIN_ZOOM

Deprecated.

See Also:

Constant Field Values

MAX_ZOOM

protected final float MAX_ZOOM

Deprecated.

See Also:

Constant Field Values

zooms

protected int[] zooms

Deprecated.

defaultZoomIndex

protected int defaultZoomIndex

Deprecated.

type

protected int type

Deprecated.

isXML

protected boolean isXML

Deprecated.

reportFileName

protected String reportFileName

Deprecated.

zoom

protected float zoom

Deprecated.

realZoom

protected float realZoom

Deprecated.

the zoom ration adjusted to the screen resolution.

jasperReportsContext

protected JasperReportsContext jasperReportsContext

Deprecated.

localJasperReportsContext

protected LocalJasperReportsContext localJasperReportsContext

Deprecated.

keyNavigationListener

protected KeyListener keyNavigationListener

Deprecated.

saveContributors

protected List<JRSaveContributor> saveContributors

Deprecated.

lastFolder

protected File lastFolder

Deprecated.

lastSaveContributor

protected JRSaveContributor lastSaveContributor

Deprecated.

btnActualSize

protected JToggleButton btnActualSize

Deprecated.

btnFirst

protected JButton btnFirst

Deprecated.

btnFitPage

protected JToggleButton btnFitPage

Deprecated.

btnFitWidth

protected JToggleButton btnFitWidth

Deprecated.

btnLast

protected JButton btnLast

Deprecated.

btnNext

protected JButton btnNext

Deprecated.

btnPrevious

protected JButton btnPrevious

Deprecated.

btnPrint

protected JButton btnPrint

Deprecated.

btnReload

protected JButton btnReload

Deprecated.

btnSave

protected JButton btnSave

Deprecated.

btnZoomIn

protected JButton btnZoomIn

Deprecated.

btnZoomOut

protected JButton btnZoomOut

Deprecated.

cmbZoom

protected JComboBox cmbZoom

Deprecated.

lblStatus

protected JLabel lblStatus

Deprecated.

pnlSep01

protected JPanel pnlSep01

Deprecated.

pnlSep02

protected JPanel pnlSep02

Deprecated.

pnlSep03

protected JPanel pnlSep03

Deprecated.

pnlStatus

protected JPanel pnlStatus

Deprecated.

tlbToolBar

protected JPanel tlbToolBar

Deprecated.

txtGoTo

protected JTextField txtGoTo

Deprecated.

Constructor Detail

JRViewer

public JRViewer(String fileName,
        boolean isXML)
         throws JRException

Deprecated.

Throws:

JRException

See Also:

JRViewer(JasperReportsContext, String, boolean, Locale, ResourceBundle)

JRViewer

public JRViewer(InputStream is,
        boolean isXML)
         throws JRException

Deprecated.

Throws:

JRException

See Also:

JRViewer(JasperReportsContext, InputStream, boolean, Locale, ResourceBundle)

JRViewer

public JRViewer(JasperPrint jrPrint)

Deprecated.

See Also:

JRViewer(JasperReportsContext, JasperPrint, Locale, ResourceBundle)

JRViewer

public JRViewer(String fileName,
        boolean isXML,
        Locale locale)
         throws JRException

Deprecated.

Throws:

JRException

See Also:

JRViewer(JasperReportsContext, String, boolean, Locale, ResourceBundle)

JRViewer

public JRViewer(InputStream is,
        boolean isXML,
        Locale locale)
         throws JRException

Deprecated.

Throws:

JRException

See Also:

JRViewer(JasperReportsContext, InputStream, boolean, Locale, ResourceBundle)

JRViewer

public JRViewer(JasperPrint jrPrint,
        Locale locale)

Deprecated.

See Also:

JRViewer(JasperReportsContext, JasperPrint, Locale, ResourceBundle)

JRViewer

public JRViewer(String fileName,
        boolean isXML,
        Locale locale,
        ResourceBundle resBundle)
         throws JRException

Deprecated.

Throws:

JRException

See Also:

JRViewer(JasperReportsContext, String, boolean, Locale, ResourceBundle)

JRViewer

public JRViewer(InputStream is,
        boolean isXML,
        Locale locale,
        ResourceBundle resBundle)
         throws JRException

Deprecated.

Throws:

JRException

See Also:

JRViewer(JasperReportsContext, InputStream, boolean, Locale, ResourceBundle)

JRViewer

public JRViewer(JasperPrint jrPrint,
        Locale locale,
        ResourceBundle resBundle)

Deprecated.

See Also:

JRViewer(JasperReportsContext, JasperPrint, Locale, ResourceBundle)

JRViewer

public JRViewer(JasperReportsContext jasperReportsContext,
        String fileName,
        boolean isXML,
        Locale locale,
        ResourceBundle resBundle)
         throws JRException

Deprecated.

Throws:

JRException

JRViewer

public JRViewer(JasperReportsContext jasperReportsContext,
        InputStream is,
        boolean isXML,
        Locale locale,
        ResourceBundle resBundle)
         throws JRException

Deprecated.

Throws:

JRException

JRViewer

public JRViewer(JasperReportsContext jasperReportsContext,
        JasperPrint jrPrint,
        Locale locale,
        ResourceBundle resBundle)

Deprecated.

Method Detail

clear

public void clear()

Deprecated.

setZooms

protected void setZooms()

Deprecated.

addSaveContributor

public void addSaveContributor(JRSaveContributor contributor)

Deprecated.

removeSaveContributor

public void removeSaveContributor(JRSaveContributor contributor)

Deprecated.

getSaveContributors

public JRSaveContributor[] getSaveContributors()

Deprecated.

setSaveContributors

public void setSaveContributors(JRSaveContributor[] saveContribs)

Deprecated.

Replaces the save contributors with the ones provided as parameter.

addHyperlinkListener

public void addHyperlinkListener(JRHyperlinkListener listener)

Deprecated.

removeHyperlinkListener

public void removeHyperlinkListener(JRHyperlinkListener listener)

Deprecated.

getHyperlinkListeners

public JRHyperlinkListener[] getHyperlinkListeners()

Deprecated.

initResources

protected void initResources(Locale locale,
                 ResourceBundle resBundle)

Deprecated.

getJasperReportsContext

protected JasperReportsContext getJasperReportsContext()

Deprecated.

getBundleString

protected String getBundleString(String key)

Deprecated.

initSaveContributors

protected void initSaveContributors()

Deprecated.

gotoHyperlink

public void gotoHyperlink(JRPrintHyperlink hyperlink)

Deprecated.

Specified by:

gotoHyperlink in interface JRHyperlinkListener

isOnlyHyperlinkListener

protected boolean isOnlyHyperlinkListener()

Deprecated.

forceRefresh

protected void forceRefresh()

Deprecated.

hyperlinkClicked

protected void hyperlinkClicked(JRPrintHyperlink hyperlink)

Deprecated.

getPageIndex

public int getPageIndex()

Deprecated.

loadReport

protected void loadReport(String fileName,
              boolean isXmlReport)
                   throws JRException

Deprecated.

Throws:

JRException

loadReport

protected void loadReport(InputStream is,
              boolean isXmlReport)
                   throws JRException

Deprecated.

Throws:

JRException

loadReport

protected void loadReport(JasperPrint jrPrint)

Deprecated.

refreshTabs

protected void refreshTabs()

Deprecated.

refreshPage

protected void refreshPage()

Deprecated.

setPageImage

protected void setPageImage()

Deprecated.

getPageErrorImage

protected Image getPageErrorImage()

Deprecated.

createHyperlinks

protected void createHyperlinks()

Deprecated.

createHyperlinks

protected void createHyperlinks(List<JRPrintElement> elements,
                    int offsetX,
                    int offsetY)

Deprecated.

getHyperlinkTooltip

protected String getHyperlinkTooltip(JRPrintHyperlink hyperlink)

Deprecated.

getFallbackTooltip

protected String getFallbackTooltip(JRPrintHyperlink hyperlink)

Deprecated.

setZoomRatio

public void setZoomRatio(float newZoom)

Deprecated.

setFitWidthZoomRatio

public void setFitWidthZoomRatio()

Deprecated.

setFitPageZoomRatio

public void setFitPageZoomRatio()

Deprecated.

getGraphics2DExporter

protected JRGraphics2DExporter getGraphics2DExporter()
                                              throws JRException

Deprecated.

Throws:

JRException

paintPage

protected void paintPage(Graphics2D grx)

Deprecated.

paintPageError

protected void paintPageError(Graphics2D grx)

Deprecated.

drawPageError

protected void drawPageError(Graphics grx)

Deprecated.

keyNavigate

protected void keyNavigate(KeyEvent evt)

Deprecated.