/*
* This program is free software; you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software
* Foundation.
*
* You should have received a copy of the GNU Lesser General Public License along with this
* program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
* or from the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU Lesser General Public License for more details.
*
* Copyright (c) 2006 - 2013 Pentaho Corporation and Contributors. All rights reserved.
*/
package org.pentaho.reporting.engine.classic.demo.util;
import java.awt.Component;
import java.awt.event.ActionEvent;
import java.awt.event.WindowAdapter;
import java.awt.event.WindowEvent;
import java.text.MessageFormat;
import java.util.Locale;
import javax.swing.AbstractAction;
import javax.swing.Action;
import javax.swing.JComponent;
import javax.swing.JFrame;
import javax.swing.JMenu;
import javax.swing.JMenuBar;
import javax.swing.JMenuItem;
import javax.swing.JOptionPane;
import javax.swing.JScrollPane;
import javax.swing.JTable;
import javax.swing.table.TableColumn;
import javax.swing.table.TableModel;
import org.pentaho.reporting.engine.classic.core.ClassicEngineBoot;
import org.pentaho.reporting.engine.classic.core.modules.gui.base.about.AboutDialog;
import org.pentaho.reporting.engine.classic.core.modules.gui.common.DefaultIconTheme;
import org.pentaho.reporting.engine.classic.core.modules.gui.common.IconTheme;
import org.pentaho.reporting.engine.classic.core.modules.gui.commonswing.ExceptionDialog;
import org.pentaho.reporting.engine.classic.core.modules.gui.commonswing.JStatusBar;
import org.pentaho.reporting.engine.classic.core.util.ImageUtils;
import org.pentaho.reporting.engine.classic.demo.ClassicEngineDemoInfo;
import org.pentaho.reporting.libraries.base.util.ObjectUtilities;
import org.pentaho.reporting.libraries.base.util.ResourceBundleSupport;
import org.pentaho.reporting.libraries.designtime.swing.LibSwingUtil;
/**
* 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
*/
public abstract class AbstractDemoFrame extends JFrame implements DemoController
{
public static final String EMBEDDED_KEY = "org.pentaho.reporting.engine.classic.demo.Embedded";
/**
* Close action.
*/
protected class CloseAction extends AbstractAction
{
/**
* Default constructor.
*/
public CloseAction()
{
this.putValue(Action.NAME, resources.getString("action.close.name"));
this.putValue(Action.SHORT_DESCRIPTION, resources.getString("action.close.description"));
this.putValue(Action.MNEMONIC_KEY, resources.getMnemonic("action.close.mnemonic"));
this.putValue(Action.SMALL_ICON, ImageUtils.createTransparentIcon(16, 16));
this.putValue(Action.ACCELERATOR_KEY, resources.getKeyStroke("action.close.accelerator"));
this.putValue("ICON24", ImageUtils.createTransparentIcon(24, 24));
}
/**
* Receives notification of an action event.
*
* @param event the event.
*/
public void actionPerformed(final ActionEvent event)
{
attemptExit();
}
}
/**
* Window close handler.
*/
protected class CloseHandler extends WindowAdapter
{
public CloseHandler()
{
}
/**
* Handles the window closing event.
*
* @param event the window event.
*/
public void windowClosing(final WindowEvent event)
{
attemptExit();
}
}
/**
* Preview action.
*/
protected class PreviewAction extends AbstractAction
{
/**
* Default constructor.
*/
public PreviewAction()
{
this.putValue(Action.NAME, resources.getString("action.print-preview.name"));
this.putValue(Action.SHORT_DESCRIPTION, resources.getString("action.print-preview.description"));
this.putValue(Action.MNEMONIC_KEY,
resources.getMnemonic("action.print-preview.mnemonic"));
this.putValue(Action.SMALL_ICON, ImageUtils.createTransparentIcon(16, 16));
this.putValue(Action.ACCELERATOR_KEY, resources.getKeyStroke("action.print-preview.accelerator"));
this.putValue("ICON24", ImageUtils.createTransparentIcon(24, 24));
}
/**
* Receives notification of an action event.
*
* @param event the event.
*/
public void actionPerformed(final ActionEvent event)
{
attemptPreview();
}
}
/**
* About action.
*/
private class AboutAction extends AbstractAction
{
/**
* Default constructor.
*/
public AboutAction()
{
final IconTheme iconTheme = new DefaultIconTheme();
this.putValue(Action.NAME, resources.getString("action.about.name"));
this.putValue(Action.SHORT_DESCRIPTION, resources.getString("action.about.description"));
this.putValue(Action.MNEMONIC_KEY,
resources.getMnemonic("action.about.mnemonic"));
this.putValue(Action.SMALL_ICON, iconTheme.getSmallIcon(Locale.getDefault(), "action.about.small-icon"));
this.putValue("ICON24", iconTheme.getLargeIcon(Locale.getDefault(), "action.about.icon"));
}
/**
* Receives notification of an action event.
*
* @param event the event.
*/
public void actionPerformed(final ActionEvent event)
{
displayAbout();
}
}
/**
* The base resource class.
*/
public static final String RESOURCE_BASE =
"org.pentaho.reporting.engine.classic.demo.resources.demo-resources";
/**
* Localised resources.
*/
private ResourceBundleSupport resources;
/**
* The close action is called when closing the frame.
*/
private Action closeAction;
/**
* The preview action is called when the user chooses to preview the report.
*/
private Action previewAction;
/**
* About action.
*/
private AboutAction aboutAction;
/**
* A frame for displaying information about the demo application.
*/
private AboutDialog aboutFrame;
private boolean ignoreEmbeddedConfig;
private JStatusBar statusBar;
/**
* Constructs a new frame that is initially invisible.
* <p/>
* This constructor sets the component's locale property to the value returned by
* <code>JComponent.getDefaultLocale</code>.
*/
public AbstractDemoFrame()
{
resources = new ResourceBundleSupport(Locale.getDefault(), RESOURCE_BASE,
ObjectUtilities.getClassLoader(AbstractDemoFrame.class));
previewAction = new PreviewAction();
closeAction = new CloseAction();
aboutAction = new AboutAction();
statusBar = new JStatusBar();
setDefaultCloseOperation(DO_NOTHING_ON_CLOSE);
addWindowListener(new CloseHandler());
}
public boolean isIgnoreEmbeddedConfig()
{
return ignoreEmbeddedConfig;
}
public void setIgnoreEmbeddedConfig(final boolean ignoreEmbeddedConfig)
{
this.ignoreEmbeddedConfig = ignoreEmbeddedConfig;
}
/**
* Returns the resource bundle for this demo frame.
*
* @return the resource bundle for the localization.
*/
public ResourceBundleSupport getResources()
{
return resources;
}
/**
* Returns the close action implementation to handle the closing of the frame.
*
* @return the close action.
*/
public Action getCloseAction()
{
return closeAction;
}
/**
* Returns the preview action implementation to handle the preview action event.
*
* @return the preview action.
*/
public Action getPreviewAction()
{
return previewAction;
}
public AboutAction getAboutAction()
{
return aboutAction;
}
/**
* Exits the application, but only if the user agrees.
*
* @return false if the user decides not to exit the application.
*/
protected boolean attemptExit()
{
final boolean close =
JOptionPane.showConfirmDialog(this,
getResources().getString("exitdialog.message"),
getResources().getString("exitdialog.title"),
JOptionPane.YES_NO_OPTION,
JOptionPane.QUESTION_MESSAGE) == JOptionPane.YES_OPTION;
if (close)
{
if (ignoreEmbeddedConfig ||
"false".equals(ClassicEngineBoot.getInstance().getGlobalConfig().getConfigProperty
(EMBEDDED_KEY, "false")))
{
System.exit(0);
}
else
{
setVisible(false);
dispose();
}
}
return close;
}
/**
* Handler method called by the preview action. This method should perform all operations to preview the report.
*/
protected abstract void attemptPreview();
/**
* Creates a JMenu which gets initialized from the current resource bundle.
*
* @param base the resource prefix.
* @return the menu.
*/
protected JMenu createJMenu(final String base)
{
final String label = getResources().getString(base + ".name");
final Integer mnemonic = getResources().getMnemonic(base + ".mnemonic");
final JMenu menu = new JMenu(label);
if (mnemonic != null)
{
menu.setMnemonic(mnemonic.intValue());
}
return menu;
}
/**
* 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.
*
* @param localisationBase the resource prefix.
* @param e the exception.
*/
public static void showExceptionDialog
(final Component parent, final String localisationBase, final Exception e)
{
final ResourceBundleSupport resources = new ResourceBundleSupport(Locale.getDefault(), RESOURCE_BASE,
ObjectUtilities.getClassLoader(AbstractDemoFrame.class));
final String title = resources.getString(localisationBase + ".title");
final String format = resources.getString(localisationBase + ".message");
final String message = MessageFormat.format
(format, new Object[]{e.getLocalizedMessage()});
ExceptionDialog.showExceptionDialog(parent, title, message, e);
}
protected JComponent createDefaultTable(final TableModel data)
{
final JTable table = new JTable(data);
table.setAutoResizeMode(JTable.AUTO_RESIZE_OFF);
for (int columnIndex = 0; columnIndex < data
.getColumnCount(); columnIndex++)
{
final TableColumn column = table.getColumnModel().getColumn(columnIndex);
column.setMinWidth(50);
final Class c = data.getColumnClass(columnIndex);
if (c.equals(Number.class))
{
column.setCellRenderer(new NumberCellRenderer());
}
}
return new JScrollPane
(table, JScrollPane.VERTICAL_SCROLLBAR_AS_NEEDED,
JScrollPane.HORIZONTAL_SCROLLBAR_ALWAYS);
}
/**
* Displays information about the application.
*/
public synchronized void displayAbout()
{
if (aboutFrame == null)
{
aboutFrame = new AboutDialog(getResources().getString("action.about.name"),
ClassicEngineDemoInfo.getInstance());
aboutFrame.pack();
LibSwingUtil.centerFrameOnScreen(aboutFrame);
}
aboutFrame.setVisible(true);
aboutFrame.requestFocus();
}
/**
* Creates a menu bar.
*
* @return the menu bar.
*/
protected JMenuBar createMenuBar()
{
final JMenuBar mb = new JMenuBar();
final JMenu fileMenu = createJMenu("menu.file");
final JMenuItem previewItem = new JMenuItem(getPreviewAction());
final JMenuItem exitItem = new JMenuItem(getCloseAction());
fileMenu.add(previewItem);
fileMenu.addSeparator();
fileMenu.add(exitItem);
mb.add(fileMenu);
// then the help menu
final JMenu helpMenu = createJMenu("menu.help");
helpMenu.add(new JMenuItem(aboutAction));
mb.add(helpMenu);
return mb;
}
public Action getExportAction()
{
return previewAction;
}
public JStatusBar getStatusBar()
{
return statusBar;
}
}