org.jfree.ui.about.AboutDialog Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jtstand-common Show documentation
jtstand-common is a library derived from jcommon, used by jtstand-chart, which is derived from jfreechart
There is a newer version: 1.5.9
/*
 * Copyright (c) 2009 Albert Kurucz. 
 *
 * This file, AboutDialog.java is part of JTStand.
 *
 * JTStand is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * JTStand 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.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with GTStand.  If not, see .
 */

package org.jfree.ui.about;

import java.awt.BorderLayout;
import java.awt.Dialog;
import java.awt.Dimension;
import java.awt.Frame;
import java.awt.Image;
import java.util.List;
import java.util.ResourceBundle;

import javax.swing.BorderFactory;
import javax.swing.JDialog;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JTabbedPane;
import javax.swing.JTextArea;
import javax.swing.border.Border;

import org.jfree.util.ResourceBundleWrapper;

/**
 * A dialog that displays information about the demonstration application.
 *
 * @author David Gilbert
 */
public class AboutDialog extends JDialog {

    /** The preferred size for the frame. */
    public static final Dimension PREFERRED_SIZE = new Dimension(560, 360);

    /** The default border for the panels in the tabbed pane. */
    public static final Border STANDARD_BORDER
            = BorderFactory.createEmptyBorder(5, 5, 5, 5);

    /** Localised resources. */
    private ResourceBundle resources;

    /** The application name. */
    private String application;

    /** The application version. */
    private String version;

    /** The copyright string. */
    private String copyright;

    /** Other info about the application. */
    private String info;

    /** The project logo. */
    private Image logo;

    /** A list of contributors. */
    private List contributors;

    /** The licence. */
    private String licence;

    /**
     * Constructs an about frame.
     *
     * @param title  the frame title.
     * @param project  information about the project.
     */
    public AboutDialog(final String title, final ProjectInfo project) {

        init(title,
             project.getName(),
             "Version " + project.getVersion(),
             project.getInfo(),
             project.getLogo(),
             project.getCopyright(),
             project.getLicenceText(),
             project.getContributors(),
             project);

    }

  /**
   * Creates a non-modal dialog without a title with the specifed
   * Frame as its owner.
   *
   * @param owner the Frame from which the dialog is displayed.
   * @param title  the title,
   * @param project  the project.
   */
  public AboutDialog(final Frame owner,
                     final String title,
                     final ProjectInfo project)
  {
    super(owner);
    init(title,
         project.getName(),
         "Version " + project.getVersion(),
         project.getInfo(),
         project.getLogo(),
         project.getCopyright(),
         project.getLicenceText(),
         project.getContributors(),
         project);
  }

  /**
   * Creates a non-modal dialog without a title with the specifed
   * Dialog as its owner.
   *
   * @param owner the Dialog from which the dialog is displayed.
   * @param title  the title.
   * @param project  the project.
   */
  public AboutDialog(final Dialog owner,
                     final String title,
                     final ProjectInfo project)
  {
    super(owner);
    init(title,
         project.getName(),
         "Version " + project.getVersion(),
         project.getInfo(),
         project.getLogo(),
         project.getCopyright(),
         project.getLicenceText(),
         project.getContributors(),
         project);
  }

  /**
     * Constructs an 'About' frame.
     *
     * @param title  the frame title.
     * @param application  the application name.
     * @param version  the version.
     * @param info  other info.
     * @param logo  an optional logo.
     * @param copyright  the copyright notice.
     * @param licence  the licence.
     * @param contributors  a list of developers/contributors.
     * @param libraries  a list of libraries.
     */
    private void init (final String title,
                       final String application,
                       final String version,
                       final String info,
                       final Image logo,
                       final String copyright,
                       final String licence,
                       final List contributors,
                       final ProjectInfo libraries) {

        setTitle(title);

        this.application = application;
        this.version = version;
        this.copyright = copyright;
        this.info = info;
        this.logo = logo;
        this.contributors = contributors;
        this.licence = licence;

        final String baseName = "org.jfree.ui.about.resources.AboutResources";
        this.resources = ResourceBundleWrapper.getBundle(baseName);

        final JPanel content = new JPanel(new BorderLayout());
        content.setBorder(STANDARD_BORDER);

        final JTabbedPane tabs = createTabs(libraries);
        content.add(tabs);
        setContentPane(content);

        pack();

    }

    /**
     * Returns the preferred size for the about frame.
     *
     * @return the preferred size.
     */
    public Dimension getPreferredSize() {
        return PREFERRED_SIZE;
    }

    /**
     * Creates a tabbed pane containing an about panel and a system properties
     * panel.
     *
     * @param info  project information.
     *
     * @return a tabbed pane.
     */
    private JTabbedPane createTabs(final ProjectInfo info) {

        final JTabbedPane tabs = new JTabbedPane();

        final JPanel aboutPanel = createAboutPanel(info);
        aboutPanel.setBorder(AboutDialog.STANDARD_BORDER);
        final String aboutTab = this.resources.getString(
                "about-frame.tab.about");
        tabs.add(aboutTab, aboutPanel);

        final JPanel systemPanel = new SystemPropertiesPanel();
        systemPanel.setBorder(AboutDialog.STANDARD_BORDER);
        final String systemTab = this.resources.getString(
                "about-frame.tab.system");
        tabs.add(systemTab, systemPanel);

        return tabs;

    }

    /**
     * Creates a panel showing information about the application, including the
     * name, version, copyright notice, URL for further information, and a list
     * of contributors.
     *
     * @param info  project info.
     *
     * @return a panel.
     */
    private JPanel createAboutPanel(final ProjectInfo info) {

        final JPanel about = new JPanel(new BorderLayout());

        final JPanel details = new AboutPanel(this.application, this.version,
                this.copyright, this.info, this.logo);

        boolean includetabs = false;
        final JTabbedPane tabs = new JTabbedPane();

        if (this.contributors != null) {
            final JPanel contributorsPanel = new ContributorsPanel(
                    this.contributors);
            contributorsPanel.setBorder(AboutDialog.STANDARD_BORDER);
            final String contributorsTab = this.resources.getString(
                    "about-frame.tab.contributors");
            tabs.add(contributorsTab, contributorsPanel);
            includetabs = true;
        }

        if (this.licence != null) {
            final JPanel licencePanel = createLicencePanel();
            licencePanel.setBorder(STANDARD_BORDER);
            final String licenceTab = this.resources.getString(
                    "about-frame.tab.licence");
            tabs.add(licenceTab, licencePanel);
            includetabs = true;
        }

        if (info != null) {
            final JPanel librariesPanel = new LibraryPanel(info);
            librariesPanel.setBorder(AboutDialog.STANDARD_BORDER);
            final String librariesTab = this.resources.getString(
                    "about-frame.tab.libraries");
            tabs.add(librariesTab, librariesPanel);
            includetabs = true;
        }

        about.add(details, BorderLayout.NORTH);
        if (includetabs) {
            about.add(tabs);
        }

        return about;

    }

    /**
     * Creates a panel showing the licence.
     *
     * @return a panel.
     */
    private JPanel createLicencePanel() {

        final JPanel licencePanel = new JPanel(new BorderLayout());
        final JTextArea area = new JTextArea(this.licence);
        area.setLineWrap(true);
        area.setWrapStyleWord(true);
        area.setCaretPosition(0);
        area.setEditable(false);
        licencePanel.add(new JScrollPane(area));
        return licencePanel;

    }


}