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

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright 2011 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 org.openconcerto.sql.element.SQLElement;
import org.openconcerto.ui.FrameUtil;
import org.openconcerto.utils.cc.IClosure;

import java.awt.event.ActionEvent;
import java.util.Objects;

import javax.swing.AbstractAction;
import javax.swing.Action;
import javax.swing.JFrame;
import javax.swing.JMenu;
import javax.swing.JMenuItem;

/**
 * Allow to easily create JMenuItem from an SQLElement (for creating and listing). If you want
 * custom behaviour you can overload postProcessFrame(), createEditFrame() and createListFrame().
 * 
 * @author Sylvain CUAZ
 */
public class SQLMenuItemHelper {

    /**
     * Called for each new frame. This implementation does nothing.
     * 
     * @param f the new frame.
     */
    protected void postProcessFrame(JFrame f) {
        // par défaut rien
    }

    /**
     * Called for each new menu item. This implementation does nothing.
     * 
     * @param elem the element.
     */
    protected void menuItemCreated(SQLElement elem) {
        // par défaut rien
    }

    /**
     * Called for each new menu item. This implementation does nothing.
     * 
     * @param action the new action.
     */
    protected void actionCreated(AbstractSQLMenuItemAction action) {
        // par défaut rien
    }

    private final <F extends JFrame> F ppFrame(F f, IClosure<F> c) {
        // particular
        if (c != null)
            c.executeChecked(f);
        // general
        postProcessFrame(f);
        return f;
    }

    /**
     * The frame that will be displayed to create an elem.
     * 
     * @param elem the element.
     * @return the frame to be displayed, <code>null</code> to keep the default value.
     */
    protected EditFrame createEditFrame(SQLElement elem) {
        return null;
    }

    /**
     * The frame that will be displayed to list an elem.
     * 
     * @param elem the element.
     * @return the frame to be displayed, <code>null</code> to keep the default value.
     */
    protected IListFrame createListFrame(SQLElement elem) {
        return null;
    }

    public final JMenuItem createEditMenuItem(final SQLElement elem) {
        this.menuItemCreated(elem);
        return new JMenuItem(createEditAction(elem));
    }

    public final SQLElementEditAction createEditAction(final SQLElement elem) {
        final SQLElementEditAction menuItemAction = new SQLElementEditAction(elem) {
            @Override
            protected EditFrame instantiateFrame() {
                final EditFrame res = createEditFrame(getElem());
                if (res == null)
                    return super.instantiateFrame();
                else
                    return res;
            }

            @Override
            protected void initFrame(EditFrame f) {
                super.initFrame(f);
                ppFrame(f, null);
            }
        };
        this.actionCreated(menuItemAction);
        return menuItemAction;
    }

    public final JMenuItem createListMenuItem(final SQLElement elem) {
        return this.createListMenuItem(elem, null);
    }

    public final JMenuItem createListMenuItem(final SQLElement elem, final IClosure<IListFrame> initFrame) {
        this.menuItemCreated(elem);
        return new JMenuItem(createListAction(elem, initFrame));
    }

    public final SQLElementListAction createListAction(final SQLElement elem) {
        return this.createListAction(elem, null);
    }

    public final SQLElementListAction createListAction(final SQLElement elem, final IClosure<IListFrame> initFrame) {
        final SQLElementListAction menuItemAction = new SQLElementListAction(elem) {
            @Override
            protected IListFrame instantiateFrame() {
                final IListFrame res = createListFrame(getElem());
                if (res == null)
                    return super.instantiateFrame();
                else
                    return res;
            }

            @Override
            protected void initFrame(IListFrame f) {
                super.initFrame(f);
                ppFrame(f, initFrame);
            }
        };
        this.actionCreated(menuItemAction);
        return menuItemAction;
    }

    public static abstract class AbstractSQLMenuItemAction<E extends SQLElement> extends AbstractAction {

        private final E elem;
        private JFrame frame;
        private boolean cacheFrame;

        public AbstractSQLMenuItemAction(E elem, String name) {
            super(name);
            this.elem = Objects.requireNonNull(elem, "SQLElement");
            this.frame = null;
            this.cacheFrame = true;
            this.putValue(Action.ACTION_COMMAND_KEY, getClass().getName() + " with " + getElem().getCode());
        }

        public final void setCacheFrame(boolean cacheFrame) {
            if (this.cacheFrame != cacheFrame) {
                this.cacheFrame = cacheFrame;
                this.frame = null;
            }
        }

        /**
         * La frame que doit afficher cet élément de menu.
         * 
         * @return la frame de cet élément de menu.
         */
        public final JFrame getFrame() {
            if (this.cacheFrame) {
                if (this.frame == null) {
                    this.frame = this.createFrame();
                }
                return this.frame;
            } else {
                return this.createFrame();
            }
        }

        protected abstract JFrame createFrame();

        public final E getElem() {
            return this.elem;
        }

        @Override
        public void actionPerformed(ActionEvent e) {
            FrameUtil.show(this.getFrame());
        }
    }

    static abstract class GenericSQLElementAction<F extends JFrame> extends AbstractSQLMenuItemAction<SQLElement> {

        public GenericSQLElementAction(SQLElement elem, String name) {
            super(elem, name);
        }

        protected abstract F instantiateFrame();

        protected void initFrame(F f) {
        }

        @Override
        protected final F createFrame() {
            final F res = instantiateFrame();
            this.initFrame(res);
            return res;
        }
    }

    /**
     * Ajoute "Créer" et "Gérer".
     * 
     * @param menu le menu dans lequelle ajouter les éléments.
     * @param elem l'élément à manipuler.
     */
    public final void addMenuItems(JMenu menu, SQLElement elem) {
        this.addMenuItems(menu, elem, true, true);
    }

    public final void addMenuItems(JMenu menu, SQLElement elem, boolean edit, boolean list) {
        this.addMenuItems(menu, elem, edit, list, null);
    }

    /**
     * Ajoute "Créer" et/ou "Gérer" si <code>elem</code> n'est pas <code>null</code>.
     * 
     * @param menu le menu dans lequelle ajouter les éléments.
     * @param elem l'élément à manipuler, can be <code>null</code>.
     * @param edit s'il faut ajouter "Créer".
     * @param list s'il faut ajouter "Gérer".
     * @param listInit will be passed the newly created list frame, can be <code>null</code>.
     */
    public final void addMenuItems(JMenu menu, SQLElement elem, boolean edit, boolean list, final IClosure<IListFrame> listInit) {
        if (elem != null) {
            if (edit)
                menu.add(createEditMenuItem(elem));
            if (list)
                menu.add(createListMenuItem(elem, listInit));
        }
    }
}