org.jfree.report.demo.helper
Class AbstractDemoFrame

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Frame
                          |
                          +--javax.swing.JFrame
                                |
                                +--org.jfree.report.demo.helper.AbstractDemoFrame
Direct Known Subclasses:
CompoundDemoFrame, InternalFrameDemoFrame, SimpleDemoFrame

public abstract class AbstractDemoFrame
extends javax.swing.JFrame
implements DemoControler

The AbstractDemoFrame provides some basic functionality shared among all demos. It provides default handlers for preview and the window-closing event as well as helper function to display error messages.

Author:
Thomas Morgner
See Also:
Serialized Form

Inner Class Summary
protected  class AbstractDemoFrame.CloseHandler
          Window close handler.
protected  class AbstractDemoFrame.DemoCloseAction
          Close action.
protected  class AbstractDemoFrame.DemoPreviewAction
          Preview action.
 
Inner classes inherited from class javax.swing.JFrame
javax.swing.JFrame.AccessibleJFrame
 
Field Summary
static java.lang.String EMBEDDED_KEY
           
static java.lang.String RESOURCE_BASE
          The base resource class.
 
Fields inherited from class javax.swing.JFrame
accessibleContext, rootPane, rootPaneCheckingEnabled
 
Fields inherited from class java.awt.Frame
CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, 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
 
Constructor Summary
AbstractDemoFrame()
          Constructs a new frame that is initially invisible.
 
Method Summary
protected  boolean attemptExit()
          Exits the application, but only if the user agrees.
protected abstract  void attemptPreview()
          Handler method called by the preview action.
protected  javax.swing.JComponent createDefaultTable(javax.swing.table.TableModel data)
           
protected  javax.swing.JMenu createJMenu(java.lang.String base)
          Creates a JMenu which gets initialized from the current resource bundle.
protected  javax.swing.JMenuBar createMenuBar()
          Creates a menu bar.
 void displayAbout()
          Displays information about the application.
 AboutAction getAboutAction()
           
 javax.swing.Action getCloseAction()
          Returns the close action implementation to handle the closing of the frame.
 javax.swing.Action getExportAction()
           
 javax.swing.Action getPreviewAction()
          Returns the preview action implementation to handle the preview action event.
 org.jfree.util.ResourceBundleSupport getResources()
          Returns the resource bundle for this demo frame.
 JStatusBar getStatusBar()
           
 boolean isIgnoreEmbeddedConfig()
           
 void setIgnoreEmbeddedConfig(boolean ignoreEmbeddedConfig)
           
static void showExceptionDialog(java.lang.String localisationBase, java.lang.Exception e)
          Shows the exception dialog by using localized messages.
 
Methods inherited from class javax.swing.JFrame
addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isRootPaneCheckingEnabled, paramString, processKeyEvent, processWindowEvent, remove, setContentPane, setDefaultCloseOperation, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, update
 
Methods inherited from class java.awt.Frame
addNotify, finalize, getCursorType, getFrames, getIconImage, getMenuBar, getState, getTitle, isResizable, remove, removeNotify, setCursor, setIconImage, setMenuBar, setResizable, setState, setTitle
 
Methods inherited from class java.awt.Window
addWindowListener, applyResourceBundle, applyResourceBundle, dispose, getFocusOwner, getInputContext, getLocale, getOwnedWindows, getOwner, getToolkit, getWarningString, hide, isShowing, pack, postEvent, processEvent, removeWindowListener, setCursor, show, toBack, toFront
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setFont, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getInputMethodRequests, getLocation, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isDisplayable, isDoubleBuffered, isEnabled, isFocusTraversable, isLightweight, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processInputMethodEvent, processMouseEvent, processMouseMotionEvent, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

EMBEDDED_KEY

public static final java.lang.String EMBEDDED_KEY

RESOURCE_BASE

public static final java.lang.String RESOURCE_BASE
The base resource class.
Constructor Detail

AbstractDemoFrame

public AbstractDemoFrame()
Constructs a new frame that is initially invisible.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

Method Detail

isIgnoreEmbeddedConfig

public boolean isIgnoreEmbeddedConfig()

setIgnoreEmbeddedConfig

public void setIgnoreEmbeddedConfig(boolean ignoreEmbeddedConfig)

getResources

public org.jfree.util.ResourceBundleSupport getResources()
Returns the resource bundle for this demo frame.
Returns:
the resource bundle for the localization.

getCloseAction

public javax.swing.Action getCloseAction()
Returns the close action implementation to handle the closing of the frame.
Returns:
the close action.

getPreviewAction

public javax.swing.Action getPreviewAction()
Returns the preview action implementation to handle the preview action event.
Returns:
the preview action.

getAboutAction

public AboutAction getAboutAction()

attemptExit

protected boolean attemptExit()
Exits the application, but only if the user agrees.
Returns:
false if the user decides not to exit the application.

attemptPreview

protected abstract void attemptPreview()
Handler method called by the preview action. This method should perform all operations to preview the report.

createJMenu

protected javax.swing.JMenu createJMenu(java.lang.String base)
Creates a JMenu which gets initialized from the current resource bundle.
Parameters:
base - the resource prefix.
Returns:
the menu.

showExceptionDialog

public static void showExceptionDialog(java.lang.String localisationBase,
                                       java.lang.Exception e)
Shows the exception dialog by using localized messages. The message base is used to construct the localisation key by appending ".title" and ".message" to the base name.
Parameters:
localisationBase - the resource prefix.
e - the exception.

createDefaultTable

protected javax.swing.JComponent createDefaultTable(javax.swing.table.TableModel data)

displayAbout

public void displayAbout()
Displays information about the application.

createMenuBar

protected javax.swing.JMenuBar createMenuBar()
Creates a menu bar.
Returns:
the menu bar.

getExportAction

public javax.swing.Action getExportAction()
Specified by:
getExportAction in interface DemoControler

getStatusBar

public JStatusBar getStatusBar()
Specified by:
getStatusBar in interface DemoControler