net.sf.jasperreports.swing

Class JRViewer

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

net.sf.jasperreports.swing.JRViewer

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, JRViewerListener

Direct Known Subclasses:

JRDesignViewer

public class JRViewer
extends JPanel
implements JRViewerListener

Author:

Teodor Danciu (teodord@users.sourceforge.net)

See Also:

Serialized Form

Nested Class Summary

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 JLabel	lblStatus
protected JPanel	pnlStatus
protected JRViewerToolbar	tlbToolBar
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 JRViewerController	viewerContext

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	clear()
protected JRViewerToolbar	createToolbar()
protected JRViewerPanel	createViewerPanel()
protected String	getBundleString(String key)
int	getPageIndex()
protected void	initViewerContext(JasperReportsContext jasperReportsContext, Locale locale, ResourceBundle resBundle)
protected void	initViewerContext(Locale locale, ResourceBundle resBundle) Deprecated. Replaced by initViewerContext(JasperReportsContext, Locale, ResourceBundle).
void	pageChanged()
void	setFitPageZoomRatio()
void	setFitWidthZoomRatio()
void	setZoomRatio(float zoomRatio)
void	viewerEvent(JRViewerEvent event)

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

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

viewerContext

protected JRViewerController viewerContext

lblStatus

protected JLabel lblStatus

pnlStatus

protected JPanel pnlStatus

tlbToolBar

protected JRViewerToolbar tlbToolBar

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(InputStream, boolean, Locale, ResourceBundle)

JRViewer

public JRViewer(JasperPrint jrPrint,
        Locale locale)

See Also:

JRViewer(JasperPrint, Locale, ResourceBundle)

JRViewer

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

Throws:

JRException

See Also:

JRViewer(String, boolean, Locale, ResourceBundle)

JRViewer

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

Throws:

JRException

See Also:

JRViewer(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

initViewerContext

protected void initViewerContext(Locale locale,
                     ResourceBundle resBundle)

Deprecated. Replaced by initViewerContext(JasperReportsContext, Locale, ResourceBundle).

initViewerContext

protected void initViewerContext(JasperReportsContext jasperReportsContext,
                     Locale locale,
                     ResourceBundle resBundle)

clear

public void clear()

getBundleString

protected String getBundleString(String key)

createToolbar

protected JRViewerToolbar createToolbar()

createViewerPanel

protected JRViewerPanel createViewerPanel()

setFitWidthZoomRatio

public void setFitWidthZoomRatio()

setFitPageZoomRatio

public void setFitPageZoomRatio()

getPageIndex

public int getPageIndex()

setZoomRatio

public void setZoomRatio(float zoomRatio)

pageChanged

public void pageChanged()

viewerEvent

public void viewerEvent(JRViewerEvent event)

Specified by:

viewerEvent in interface JRViewerListener