net.sf.jasperreports.view

Class JasperDesignViewer

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

net.sf.jasperreports.view.JasperDesignViewer

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public class JasperDesignViewer
extends JFrame

This class can be used at design time to preview the report templates. It was included in the main library as a development tool in order to make up for the missing visual designer.

The class is a simple Swing-based Java application that can load and display a report template either in its raw JRXML form or in its compiled form. Even though it is not a complex GUI application and lacks advanced functionality like dragging and dropping visual report elements, it is a very helpful tool. All the supplied JasperReports samples were initially created using this design viewer.

All the supplied samples already have Ant tasks in their build.xml files that will launch this design viewer to display the report templates. There are two Ant tasks for each sample report: viewDesign and viewDesignXML. The first one loads the compiled report template that is normally found in the *.jasper file. The second one loads the JRXML report template, which is more useful since you can edit the JRXML file and click the Reload button to immediately see the modification on the screen.

Author:

Teodor Danciu (teodord@users.sourceforge.net)

See Also:

Serialized Form

Nested Class Summary

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

JFrame.AccessibleJFrame

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

Frame.AccessibleAWTFrame

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

Window.AccessibleAWTWindow, Window.Type

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 inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
JasperDesignViewer(InputStream is, boolean isXML)
JasperDesignViewer(JasperReportsContext jasperReportsContext, InputStream is, boolean isXML)
JasperDesignViewer(JasperReportsContext jasperReportsContext, JRReport report)
JasperDesignViewer(JasperReportsContext jasperReportsContext, String sourceFile, boolean isXML)
JasperDesignViewer(JRReport report)
JasperDesignViewer(String sourceFile, boolean isXML)

Method Summary

Modifier and Type	Method and Description
static void	main(String[] args)
static void	viewReportDesign(InputStream is, boolean isXML)
static void	viewReportDesign(JasperReportsContext jasperReportsContext, InputStream is, boolean isXML)
static void	viewReportDesign(JasperReportsContext jasperReportsContext, JRReport report)
static void	viewReportDesign(JasperReportsContext jasperReportsContext, String sourceFile, boolean isXML)
static void	viewReportDesign(JRReport report)
static void	viewReportDesign(String sourceFile, boolean isXML)

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Constructor Detail

JasperDesignViewer

public JasperDesignViewer(String sourceFile,
                          boolean isXML)
                   throws JRException

Throws:

JRException

See Also:

JasperDesignViewer(JasperReportsContext, String, boolean)

JasperDesignViewer

public JasperDesignViewer(InputStream is,
                          boolean isXML)
                   throws JRException

Throws:

JRException

See Also:

JasperDesignViewer(JasperReportsContext, InputStream, boolean)

JasperDesignViewer

public JasperDesignViewer(JRReport report)
                   throws JRException

Throws:

JRException

See Also:

JasperDesignViewer(JasperReportsContext, JRReport)

JasperDesignViewer

public JasperDesignViewer(JasperReportsContext jasperReportsContext,
                          String sourceFile,
                          boolean isXML)
                   throws JRException

Throws:

JRException

JasperDesignViewer

public JasperDesignViewer(JasperReportsContext jasperReportsContext,
                          InputStream is,
                          boolean isXML)
                   throws JRException

Throws:

JRException

JasperDesignViewer

public JasperDesignViewer(JasperReportsContext jasperReportsContext,
                          JRReport report)
                   throws JRException

Throws:

JRException

Method Detail

main

public static void main(String[] args)

Parameters:

args - the command line arguments

viewReportDesign

public static void viewReportDesign(String sourceFile,
                                    boolean isXML)
                             throws JRException

Throws:

JRException

See Also:

viewReportDesign(JasperReportsContext, String, boolean)

viewReportDesign

public static void viewReportDesign(InputStream is,
                                    boolean isXML)
                             throws JRException

Throws:

JRException

See Also:

viewReportDesign(JasperReportsContext, InputStream, boolean)

viewReportDesign

public static void viewReportDesign(JRReport report)
                             throws JRException

Throws:

JRException

See Also:

viewReportDesign(JasperReportsContext, JRReport)

viewReportDesign

public static void viewReportDesign(JasperReportsContext jasperReportsContext,
                                    String sourceFile,
                                    boolean isXML)
                             throws JRException

Throws:

JRException

viewReportDesign

public static void viewReportDesign(JasperReportsContext jasperReportsContext,
                                    InputStream is,
                                    boolean isXML)
                             throws JRException

Throws:

JRException

viewReportDesign

public static void viewReportDesign(JasperReportsContext jasperReportsContext,
                                    JRReport report)
                             throws JRException

Throws:

JRException