package jmri.jmrit.beantable;

import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;

import java.awt.Component;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.text.MessageFormat;

import javax.swing.BoxLayout;
import javax.swing.JMenu;
import javax.swing.JMenuBar;
import javax.swing.JMenuItem;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JTable;
import javax.swing.SortOrder;
import javax.swing.table.TableRowSorter;

import jmri.NamedBean;
import jmri.swing.RowSorterUtil;
import jmri.util.AlphanumComparator;

/**
 * Provide a JFrame to display a table of NamedBeans.
 * <p>
 * This is used when a table is opened by itself, without
 * being embedded in a selection frame.  Typically, this 
 * happens when the table is opened from a startup action.
 * <p>
 * This frame includes the table itself at the top, plus a "bottom area" for
 * things like an Add... button and checkboxes that control display options.
 * <p>
 * The usual menus are also provided here.
 * <p>
 * Specific uses are customized via the BeanTableDataModel implementation they
 * provide, and by providing a {@link #extras} implementation that can in turn
 * invoke {@link #addToBottomBox} as needed.
 *
 * @author Bob Jacobsen Copyright (C) 2003
 */
public class BeanTableFrame<E extends NamedBean> extends jmri.util.JmriJFrame {

    BeanTableDataModel<E> dataModel;
    JTable dataTable;
    final JPanel bottomBox;  // panel at bottom for extra buttons etc

    public BeanTableFrame() {
        super();
        bottomBox = new JPanel();
        bottomBox.setLayout(new jmri.util.swing.WrapLayout( jmri.util.swing.WrapLayout.LEFT, 20, 5));
    }

    public BeanTableFrame(String s) {
        super(s);
        bottomBox = new JPanel();
        bottomBox.setLayout(new jmri.util.swing.WrapLayout( jmri.util.swing.WrapLayout.LEFT, 20, 5));
    }

    public BeanTableFrame(BeanTableDataModel<E> model, String helpTarget, JTable dataTab) {

        this();
        dataModel = model;
        this.dataTable = dataTab;

        JScrollPane dataScroll = new JScrollPane(dataTable);

        // give system name column as smarter sorter and use it initially
        TableRowSorter<BeanTableDataModel<?>> sorter = new TableRowSorter<>(dataModel);

        // use NamedBean's built-in Comparator interface for sorting the system name column
        RowSorterUtil.setSortOrder(sorter, BeanTableDataModel.SYSNAMECOL, SortOrder.ASCENDING);

        sorter.setComparator(BeanTableDataModel.USERNAMECOL, new AlphanumComparator());
        RowSorterUtil.setSortOrder(sorter, BeanTableDataModel.USERNAMECOL, SortOrder.ASCENDING);

        this.dataTable.setRowSorter(sorter);

        // configure items for GUI
        dataModel.configureTable(dataTable);

        // general GUI config
        getContentPane().setLayout(new BoxLayout(getContentPane(), BoxLayout.Y_AXIS));

        // add save menu item
        JMenuBar menuBar = new JMenuBar();
        JMenu fileMenu = new JMenu(Bundle.getMessage("MenuFile"));
        menuBar.add(fileMenu);
        fileMenu.add(new jmri.configurexml.StoreMenu());

        JMenuItem printItem = new JMenuItem(Bundle.getMessage("PrintTable"));
        fileMenu.add(printItem);
        printItem.addActionListener(new ActionListener() {
            @Override
            public void actionPerformed(ActionEvent e) {
                try {
                    // MessageFormat headerFormat = new MessageFormat(getTitle());  // not used below
                    MessageFormat footerFormat = new MessageFormat(getTitle() + " page {0,number}");
                    dataTable.print(JTable.PrintMode.FIT_WIDTH, null, footerFormat);
                } catch (java.awt.print.PrinterException e1) {
                    log.warn("error printing: {}", e1, e1);
                }
            }
        });

        JMenuItem exportItem = new JMenuItem(Bundle.getMessage("ExportTable"));
        fileMenu.add(exportItem);
        exportItem.addActionListener((ActionEvent e) -> {
            dataModel.exportToCSV(null);
        });

        setJMenuBar(menuBar);

        addHelpMenu(helpTarget, true);

        // install items in GUI
        getContentPane().add(dataScroll);
        getContentPane().add(bottomBox);

        // add extras, if desired by subclass
        extras();

        // set Viewport preferred size from size of table
        java.awt.Dimension dataTableSize = dataTable.getPreferredSize();
        // width is right, but if table is empty, it's not high
        // enough to reserve much space.
        dataTableSize.height = Math.max(dataTableSize.height, 400);
        dataScroll.getViewport().setPreferredSize(dataTableSize);

        // set preferred scrolling options
        dataScroll.setHorizontalScrollBarPolicy(JScrollPane.HORIZONTAL_SCROLLBAR_ALWAYS);
        dataScroll.setVerticalScrollBarPolicy(JScrollPane.VERTICAL_SCROLLBAR_ALWAYS);
        dataModel.persistTable(dataTable);
    }

    /**
     * Hook to allow sub-types to install more items in GUI
     */
    void extras() {
    }

    /**
     * Add a component to the bottom box. Takes care of organising glue, struts
     * etc
     *
     * @param comp {@link Component} to add
     * @param c    Class name
     */
    @SuppressFBWarnings(value = "UUF_UNUSED_FIELD",
            justification = "param c is required in the listedtableframe")
    protected void addToBottomBox(Component comp, String c) {
       bottomBox.add(comp);
    }

    public JTable getTable() {
        return dataTable;
    }
    
    @Override
    public void dispose() {
        if (dataModel != null) {
            dataModel.stopPersistingTable(dataTable);
            dataModel.dispose();
        }
        dataModel = null;
        dataTable = null;
        super.dispose();
    }

    private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(BeanTableFrame.class);

}