Package org.pentaho.reporting.engine.classic.demo.util

Class AbstractDemoFrame

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

org.pentaho.reporting.engine.classic.demo.util.AbstractDemoFrame

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants, DemoController

Direct Known Subclasses:

CompoundDemoFrame, InternalFrameDemoFrame, SimpleDemoFrame

public abstract class AbstractDemoFrame
extends JFrame
implements DemoController

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractDemoFrame.CloseAction	Close action.
protected class	AbstractDemoFrame.CloseHandler	Window close handler.
protected class	AbstractDemoFrame.PreviewAction	Preview action.

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

Modifier and Type	Field	Description
static String	EMBEDDED_KEY
static 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, 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 java.awt.image.ImageObserver

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

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected boolean	attemptExit()	Exits the application, but only if the user agrees.
protected abstract void	attemptPreview()	Handler method called by the preview action.
protected JComponent	createDefaultTable(TableModel data)
protected JMenu	createJMenu(String base)	Creates a JMenu which gets initialized from the current resource bundle.
protected JMenuBar	createMenuBar()	Creates a menu bar.
void	displayAbout()	Displays information about the application.
org.pentaho.reporting.engine.classic.demo.util.AbstractDemoFrame.AboutAction	getAboutAction()
Action	getCloseAction()	Returns the close action implementation to handle the closing of the frame.
Action	getExportAction()
Action	getPreviewAction()	Returns the preview action implementation to handle the preview action event.
org.pentaho.reporting.libraries.base.util.ResourceBundleSupport	getResources()	Returns the resource bundle for this demo frame.
org.pentaho.reporting.engine.classic.core.modules.gui.commonswing.JStatusBar	getStatusBar()
boolean	isIgnoreEmbeddedConfig()
void	setIgnoreEmbeddedConfig(boolean ignoreEmbeddedConfig)
static void	showExceptionDialog(Component parent, String localisationBase, Exception e)	Shows the exception dialog by using localized messages.

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, 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, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, 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

Field Detail

EMBEDDED_KEY

public static final String EMBEDDED_KEY

See Also:

Constant Field Values

RESOURCE_BASE

public static final String RESOURCE_BASE

The base resource class.

See Also:

Constant Field Values

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.pentaho.reporting.libraries.base.util.ResourceBundleSupport getResources()

Returns the resource bundle for this demo frame.

Returns:

the resource bundle for the localization.

getCloseAction

public Action getCloseAction()

Returns the close action implementation to handle the closing of the frame.

Returns:

the close action.

getPreviewAction

public Action getPreviewAction()

Returns the preview action implementation to handle the preview action event.

Returns:

the preview action.

getAboutAction

public org.pentaho.reporting.engine.classic.demo.util.AbstractDemoFrame.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 JMenu createJMenu(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(Component parent,
                                       String localisationBase,
                                       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 JComponent createDefaultTable(TableModel data)

displayAbout

public void displayAbout()

Displays information about the application.

createMenuBar

protected JMenuBar createMenuBar()

Creates a menu bar.

Returns:

the menu bar.

getExportAction

public Action getExportAction()

Specified by:

getExportAction in interface DemoController

getStatusBar

public org.pentaho.reporting.engine.classic.core.modules.gui.commonswing.JStatusBar getStatusBar()

Specified by:

getStatusBar in interface DemoController