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.list;

import org.openconcerto.sql.model.SQLRowAccessor;

import org.openconcerto.sql.model.SQLRowValues;

import org.openconcerto.sql.view.list.action.ListEvent;

import org.openconcerto.utils.cc.IClosure;

import org.openconcerto.utils.cc.IPredicate;

import org.openconcerto.utils.i18n.TranslationManager;

import java.awt.event.ActionEvent;

import java.util.ArrayList;

import java.util.Arrays;

import java.util.Collections;

import java.util.List;

import javax.swing.AbstractAction;

import javax.swing.Action;

import javax.swing.Icon;

import javax.swing.JButton;

import javax.swing.JMenuItem;

/**

 * An action that act on rows of a {@link IListe}. Either {@link #enabledFor(IListeEvent)} or

 * {@link #enabledFor(List)} must be overloaded.

 *

 * @author Sylvain CUAZ

 * @see IListe#addIListeAction(RowAction)

 */

public abstract class RowAction implements IListeAction {

    public static Action createAction(String name, Icon icon, final IClosure<List<? extends SQLRowAccessor>> action) {

        return new AbstractAction(name, icon) {

            @Override

            public void actionPerformed(ActionEvent e) {

                action.executeChecked(IListe.get(e).getSelectedRows());

            }

        };

    }

    public static class PredicateRowAction extends RowAction {

        private IPredicate<? super ListEvent> pred = null;

        public PredicateRowAction(Action action, boolean header) {

            super(action, header);

        }

        public PredicateRowAction(Action action, boolean header, boolean popupMenu) {

            super(action, header, popupMenu);

        }

        public PredicateRowAction(Action action, boolean header, final String id) {

            super(action, header, id);

        }

        public PredicateRowAction(Action action, boolean header, boolean popupMenu, final String id) {

            super(action, header, popupMenu, id);

        }

        public final PredicateRowAction setPredicate(IPredicate<? super ListEvent> pred) {

            if (pred == null) {

                throw new IllegalArgumentException("null predicate");

            }

            this.pred = pred;

            return this;

        }

        public final IPredicate<? super IListeEvent> getPredicate() {

            return this.pred;

        }

        @Override

        public boolean enabledFor(ListEvent evt) {

            if (this.pred == null) {

                throw new IllegalStateException("No predicate for " + this);

            }

            return this.pred.evaluateChecked(evt);

        }

    }

    private final Action action;

    private final boolean header, popupMenu;

    private List<String> path;

    private final String id;

    public RowAction(Action action, boolean header) {

        this(action, header, true);

    }

    public RowAction(Action action, boolean header, boolean popupMenu) {

        this(action, header, popupMenu, null);

    }

    public RowAction(Action action, boolean header, final String id) {

        this(action, header, true, id);

    }

    public RowAction(Action action, boolean header, boolean popupMenu, final String id) {

        super();

        this.action = action;

        this.header = header;

        this.popupMenu = popupMenu;

        this.setGroup(null);

        this.id = id;

        if (id != null && action.getValue(Action.NAME) == null)

            action.putValue(Action.NAME, TranslationManager.getInstance().getTranslationForAction(id));

    }

    public final String getID() {

        return this.id;

    }

    public final Action getAction() {

        return this.action;

    }

    public final boolean inHeader() {

        return this.header;

    }

    public final boolean inPopupMenu() {

        return this.popupMenu;

    }

    public final RowAction setGroup(String groupName) {

        this.path = Arrays.asList(groupName);

        return this;

    }

    public final RowAction setPath(List<String> path) {

        this.path = Collections.unmodifiableList(new ArrayList<String>(path));

        return this;

    }

    public final List<String> getPath() {

        return this.path;

    }

    public boolean enabledFor(List<SQLRowValues> selection) {

        throw new UnsupportedOperationException("Should overload this method or enabledFor(IListeEvent) on : " + this);

    }

    /**

     * Whether the action should be enabled in the header or in the popup.

     *

     * @param evt the state of the IListe.

     * @return <code>true</code> if the action can be performed.

     */

    public boolean enabledFor(ListEvent evt) {

        return this.enabledFor(evt.getSelectedRows());

    }

    @Override

    public ButtonsBuilder getHeaderButtons() {

        return !this.inHeader() ? ButtonsBuilder.emptyInstance() : new ButtonsBuilder().add(new JButton(getAction()), new IPredicate<IListeEvent>() {

            @Override

            public boolean evaluateChecked(IListeEvent evt) {

                return enabledFor(evt);

            }

        });

    }

    @Override

    public Action getDefaultAction(ListEvent evt) {

        return this.enabledFor(evt) ? this.getAction() : null;

    }

    @Override

    public PopupBuilder getPopupContent(PopupEvent evt) {

        if (this.inPopupMenu() && evt.isClickOnRows()) {

            final JMenuItem mi = new JMenuItem(getAction());

            mi.setEnabled(this.enabledFor(evt));

            final PopupBuilder res = new PopupBuilder();

            res.getMenu().addItem(mi, getPath());

            return res;

        } else {

            return PopupBuilder.emptyInstance();

        }

    }

    @Override

    public String toString() {

        return this.getClass().getSimpleName() + (this.getID() == null ? "" : " ID '" + this.getID()) + "' with action '" + this.getAction().getValue(Action.NAME) + "'";

    }

}