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

public class JRViewer
extends JPanel
implements JRHyperlinkListener

Version:

$Id: JRViewer.java 5425 2012-05-31 07:28:51Z lucianc $

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

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

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)
JRViewer(InputStream is, boolean isXML, Locale locale)
JRViewer(InputStream is, boolean isXML, Locale locale, ResourceBundle resBundle)
JRViewer(JasperPrint jrPrint)
JRViewer(JasperPrint jrPrint, Locale locale)
JRViewer(JasperPrint jrPrint, Locale locale, ResourceBundle resBundle)
JRViewer(JasperReportsContext jasperReportsContext, InputStream is, boolean isXML, Locale locale, ResourceBundle resBundle)
JRViewer(JasperReportsContext jasperReportsContext, JasperPrint jrPrint, Locale locale, ResourceBundle resBundle)
JRViewer(JasperReportsContext jasperReportsContext, String fileName, boolean isXML, Locale locale, ResourceBundle resBundle)
JRViewer(String fileName, boolean isXML)
JRViewer(String fileName, boolean isXML, Locale locale)
JRViewer(String fileName, boolean isXML, Locale locale, ResourceBundle resBundle)

Method Summary

Methods

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

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, 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, hide, 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

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

See Also:

Constant Field Values

TYPE_INPUT_STREAM

protected static final int TYPE_INPUT_STREAM

See Also:

Constant Field Values

TYPE_OBJECT

protected static final int TYPE_OBJECT

See Also:

Constant Field Values

REPORT_RESOLUTION

public static final int REPORT_RESOLUTION

The DPI of the generated report.

See Also:

Constant Field Values

MIN_ZOOM

protected final float MIN_ZOOM

See Also:

Constant Field Values

MAX_ZOOM

protected final float MAX_ZOOM

See Also:

Constant Field Values

zooms

protected int[] zooms

defaultZoomIndex

protected int defaultZoomIndex

type

protected int type

isXML

protected boolean isXML

reportFileName

protected String reportFileName

zoom

protected float zoom

realZoom

protected float realZoom

the zoom ration adjusted to the screen resolution.

jasperReportsContext

protected JasperReportsContext jasperReportsContext

localJasperReportsContext

protected LocalJasperReportsContext localJasperReportsContext

keyNavigationListener

protected KeyListener keyNavigationListener

saveContributors

protected List<JRSaveContributor> saveContributors

lastFolder

protected File lastFolder

lastSaveContributor

protected JRSaveContributor lastSaveContributor

btnActualSize

protected JToggleButton btnActualSize

btnFirst

protected JButton btnFirst

btnFitPage

protected JToggleButton btnFitPage

btnFitWidth

protected JToggleButton btnFitWidth

btnLast

protected JButton btnLast

btnNext

protected JButton btnNext

btnPrevious

protected JButton btnPrevious

btnPrint

protected JButton btnPrint

btnReload

protected JButton btnReload

btnSave

protected JButton btnSave

btnZoomIn

protected JButton btnZoomIn

btnZoomOut

protected JButton btnZoomOut

cmbZoom

protected JComboBox cmbZoom

lblStatus

protected JLabel lblStatus

pnlSep01

protected JPanel pnlSep01

pnlSep02

protected JPanel pnlSep02

pnlSep03

protected JPanel pnlSep03

pnlStatus

protected JPanel pnlStatus

tlbToolBar

protected JPanel tlbToolBar

txtGoTo

protected JTextField txtGoTo

Constructor Detail

JRViewer

public JRViewer(String fileName,
        boolean isXML)
         throws JRException

Throws:

JRException

See Also:

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

JRViewer

public JRViewer(InputStream is,
        boolean isXML)
         throws JRException

Throws:

JRException

See Also:

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

JRViewer

public JRViewer(JasperPrint jrPrint)

See Also:

JRViewer(JasperReportsContext, JasperPrint, Locale, ResourceBundle)

JRViewer

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

Throws:

JRException

See Also:

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

JRViewer

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

Throws:

JRException

See Also:

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

JRViewer

public JRViewer(JasperPrint jrPrint,
        Locale locale)

See Also:

JRViewer(JasperReportsContext, JasperPrint, Locale, ResourceBundle)

JRViewer

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

Throws:

JRException

See Also:

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

JRViewer

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

Throws:

JRException

See Also:

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

JRViewer

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

See Also:

JRViewer(JasperReportsContext, JasperPrint, Locale, ResourceBundle)

JRViewer

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

Throws:

JRException

JRViewer

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

Throws:

JRException

JRViewer

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

Method Detail

clear

public void clear()

setZooms

protected void setZooms()

addSaveContributor

public void addSaveContributor(JRSaveContributor contributor)

removeSaveContributor

public void removeSaveContributor(JRSaveContributor contributor)

getSaveContributors

public JRSaveContributor[] getSaveContributors()

setSaveContributors

public void setSaveContributors(JRSaveContributor[] saveContribs)

Replaces the save contributors with the ones provided as parameter.

addHyperlinkListener

public void addHyperlinkListener(JRHyperlinkListener listener)

removeHyperlinkListener

public void removeHyperlinkListener(JRHyperlinkListener listener)

getHyperlinkListeners

public JRHyperlinkListener[] getHyperlinkListeners()

initResources

protected void initResources(Locale locale,
                 ResourceBundle resBundle)

getJasperReportsContext

protected JasperReportsContext getJasperReportsContext()

getBundleString

protected String getBundleString(String key)

initSaveContributors

protected void initSaveContributors()

gotoHyperlink

public void gotoHyperlink(JRPrintHyperlink hyperlink)

Specified by:

gotoHyperlink in interface JRHyperlinkListener

isOnlyHyperlinkListener

protected boolean isOnlyHyperlinkListener()

forceRefresh

protected void forceRefresh()

hyperlinkClicked

protected void hyperlinkClicked(JRPrintHyperlink hyperlink)

getPageIndex

public int getPageIndex()

loadReport

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

Throws:

JRException

loadReport

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

Throws:

JRException

loadReport

protected void loadReport(JasperPrint jrPrint)

refreshPage

protected void refreshPage()

setPageImage

protected void setPageImage()

getPageErrorImage

protected Image getPageErrorImage()

createHyperlinks

protected void createHyperlinks()

createHyperlinks

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

getHyperlinkTooltip

protected String getHyperlinkTooltip(JRPrintHyperlink hyperlink)

getFallbackTooltip

protected String getFallbackTooltip(JRPrintHyperlink hyperlink)

setZoomRatio

public void setZoomRatio(float newZoom)

setFitWidthZoomRatio

public void setFitWidthZoomRatio()

setFitPageZoomRatio

public void setFitPageZoomRatio()

getGraphics2DExporter

protected JRGraphics2DExporter getGraphics2DExporter()
                                              throws JRException

Throws:

JRException

paintPage

protected void paintPage(Graphics2D grx)

paintPageError

protected void paintPageError(Graphics2D grx)

drawPageError

protected void drawPageError(Graphics grx)

keyNavigate

protected void keyNavigate(KeyEvent evt)