Dépôt officiel du code source de l'ERP OpenConcerto

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2011-2019 OpenConcerto, by ILM Informatique. All rights reserved.

 *

 * The contents of this file are subject to the terms of the GNU General Public License Version 3

 * only ("GPL"). You may not use this file except in compliance with the License. You can obtain a

 * copy of the License at http://www.gnu.org/licenses/gpl-3.0.html See the License for the specific

 * language governing permissions and limitations under the License.

 *

 * When distributing the software, include this License Header Notice in each file.

 */

 package org.openconcerto.sql.view;

import static org.openconcerto.utils.FileUtils.FILENAME_ESCAPER;

import org.openconcerto.sql.Configuration;

import org.openconcerto.sql.State;

import org.openconcerto.sql.element.SQLComponent;

import org.openconcerto.sql.element.SQLElement;

import org.openconcerto.sql.view.list.ITableModel;

import org.openconcerto.ui.FrameUtil;

import org.openconcerto.ui.state.WindowStateManager;

import org.openconcerto.utils.StringUtils;

import java.awt.GridLayout;

import java.awt.Window;

import java.awt.event.ComponentAdapter;

import java.awt.event.ComponentEvent;

import java.beans.PropertyChangeEvent;

import java.beans.PropertyChangeListener;

import java.io.File;

import java.util.function.Function;

import javax.swing.JFrame;

import javax.swing.event.TableModelEvent;

import javax.swing.event.TableModelListener;

/**

 * Une frame affichant une liste et des boutons pour la manipuler, ainsi que des statistiques dans

 * la barre de titre.

 *

 * @author ILM Informatique 11 juin 2004

 */

public class IListFrame extends JFrame {

    public static final String SHORT_TITLE = "org.openconcerto.listframe.shortTitle";

    private static final String FILE_STRUCT_VERSION = "20160923";

    private static Function<? super SQLElement, File> CONF_DIR_FUNCTION = (elem) -> {

        final Configuration conf = Configuration.getInstance();

        return conf == null ? null : conf.getConfDir();

    };

    static synchronized public final void setConfDirFunction(final Function<? super SQLElement, File> f) {

        CONF_DIR_FUNCTION = f;

    }

    static synchronized public final File getConfDir(final SQLElement elem) {

        if (CONF_DIR_FUNCTION == null)

            return null;

        return CONF_DIR_FUNCTION.apply(elem);

    }

    // windowState-20160923/IListFrame/ARTICLE.xml

    static public final File getConfigFile(final SQLElement elem, final Class<? extends JFrame> c) {

        return getConfigFile(elem, null, c);

    }

    // windowState-20160923/IListFrame/ARTICLE-componentCode.xml

    static public final File getConfigFile(final SQLComponent comp, final Class<? extends JFrame> c) {

        return getConfigFile(comp.getElement(), comp, c);

    }

    static private final File getConfigFile(final SQLElement elem, final SQLComponent comp, final Class<? extends Window> c) {

        final String compName = comp == null ? "" : "-" + comp.getCode();

        return getConfigFile(getConfDir(elem), c, elem.getCode() + compName);

    }

    // windowState-20160923/WindowClass/code.xml

    static public final File getConfigFile(final Class<? extends Window> c, final String code) {

        return getConfigFile(getConfDir(null), c, code);

    }

    static public final File getConfigFile(final File rootDir, final Class<? extends Window> c, final String code) {

        if (rootDir == null)

            return null;

        final File structFile = new File(rootDir, "windowState-" + FILE_STRUCT_VERSION);

        return new File(structFile, c.getSimpleName() + File.separator + getConfigFileName(code));

    }

    static final String getConfigFileName(String code) {

        if (StringUtils.isEmpty(code, true))

            code = "default";

        return StringUtils.Shortener.MD5.getBoundedLengthString(FILENAME_ESCAPER.escape(code), 70) + ".xml";

    }

    private final IListPanel panel;

    private String title;

    public IListFrame(final IListPanel panel) {

        this.panel = panel;

        this.title = null;

        // rafraichir le titre à chaque changement de la liste

        this.panel.getListe().addListener(new TableModelListener() {

            public void tableChanged(TableModelEvent e) {

                setTitle();

            }

        });

        this.getPanel().getListe().addListenerOnModel(new PropertyChangeListener() {

            @Override

            public void propertyChange(PropertyChangeEvent evt) {

                if (evt.getPropertyName() == null || evt.getPropertyName().equals("loading") || evt.getPropertyName().equals("searching"))

                    setTitle();

            }

        });

        this.uiInit();

        if (State.DEBUG) {

            State.INSTANCE.frameCreated();

            this.addComponentListener(new ComponentAdapter() {

                public void componentHidden(ComponentEvent e) {

                    State.INSTANCE.frameHidden();

                }

                public void componentShown(ComponentEvent e) {

                    State.INSTANCE.frameShown();

                }

            });

        }

    }

    protected String getPlural(String s, int nb) {

        return nb + " " + s + (nb > 1 ? "s" : "");

    }

    protected void setTitle(boolean displayRowCount, boolean displayItemCount) {

        String title;

        if (this.title == null) {

            final String prefix = Boolean.getBoolean(SHORT_TITLE) ? "" : "Liste des ";

            title = prefix + this.panel.getElement().getPluralName();

        } else

            title = this.title;

        if (this.panel.getListe().isDead())

            title += ", détruite";

        else {

            if (displayRowCount) {

                final int rowCount = this.panel.getListe().getRowCount();

                title += ", " + getPlural("ligne", rowCount);

                final int total = this.panel.getListe().getTotalRowCount();

                if (total != rowCount)

                    title += " / " + total;

            }

            if (displayItemCount) {

                int count = this.panel.getListe().getItemCount();

                if (count >= 0)

                    title += ", " + this.getPlural("élément", count);

            }

            final ITableModel model = this.getPanel().getListe().getModel();

            if (model.isLoading())

                title += ", chargement en cours";

            if (model.isSearching())

                title += ", recherche en cours";

        }

        this.setTitle(title);

    }

    /**

     * Change the title of this frame from the default "Liste des " + getElement().getPluralName()

     * to <code>s</code>.

     *

     * @param s the title of this frame, can be <code>null</code> to restore the default behaviour.

     */

    public void setTextTitle(String s) {

        this.title = s;

    }

    public void setTitle() {

        this.setTitle(true, true);

    }

    final private void uiInit() {

        this.setTitle();

        this.getContentPane().setLayout(new GridLayout());

        this.getContentPane().add(this.panel);

        FrameUtil.setBounds(this);

        final File file;

        if (this.getPanel().getSQLComponent() != null)

            file = getConfigFile(this.getPanel().getSQLComponent(), this.getClass());

        else

            file = getConfigFile(this.getPanel().getElement(), this.getClass());

        if (file != null)

            new WindowStateManager(this, file).loadState();

    }

    public final IListPanel getPanel() {

        return this.panel;

    }

}