Application: gvSIG desktop » Library: org.gvsig.tools

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 gvSIG Association.

 *

 * This program is free software; you can redistribute it and/or modify it under

 * the terms of the GNU General Public License as published by the Free Software

 * Foundation; either version 3 of the License, or (at your option) any later

 * version.

 *

 * This program 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 General Public License for more

 * details.

 *

 * You should have received a copy of the GNU General Public License along with

 * this program; if not, write to the Free Software Foundation, Inc., 51

 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

 *

 * For any additional information, do not hesitate to contact us at info AT

 * gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.tools.dynform.services.dynformset.base;

import java.awt.Cursor;

import java.awt.Dimension;

import java.awt.FlowLayout;

import java.awt.event.ActionEvent;

import java.awt.event.ActionListener;

import java.awt.event.KeyEvent;

import java.net.URL;

import java.util.ArrayList;

import java.util.HashMap;

import java.util.HashSet;

import java.util.Iterator;

import java.util.List;

import java.util.Map;

import java.util.Objects;

import java.util.Set;

import javax.swing.Action;

import javax.swing.BorderFactory;

import javax.swing.Icon;

import javax.swing.ImageIcon;

import javax.swing.JButton;

import javax.swing.JComponent;

import javax.swing.JOptionPane;

import javax.swing.JPanel;

import javax.swing.SwingConstants;

import org.apache.commons.lang3.StringUtils;

import org.gvsig.tools.ToolsLocator;

import static org.gvsig.tools.dynform.JDynFormSet.ACTION_CANCEL_NEW;

import static org.gvsig.tools.dynform.JDynFormSet.ACTION_CLOSE;

import static org.gvsig.tools.dynform.JDynFormSet.ACTION_DELETE;

import static org.gvsig.tools.dynform.JDynFormSet.ACTION_FIRST;

import static org.gvsig.tools.dynform.JDynFormSet.ACTION_NEW;

import static org.gvsig.tools.dynform.JDynFormSet.ACTION_NEXT;

import static org.gvsig.tools.dynform.JDynFormSet.ACTION_PREVIOUS;

import static org.gvsig.tools.dynform.JDynFormSet.ACTION_LAST;

import static org.gvsig.tools.dynform.JDynFormSet.ACTION_SAVE;

import static org.gvsig.tools.dynform.JDynFormSet.ACTION_SEARCH;

import static org.gvsig.tools.dynform.JDynFormSet.ACTION_SET_CURRENT_RECORD;

import org.gvsig.tools.i18n.I18nManager;

import org.gvsig.tools.swing.api.Component;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

public class FormSetButtonBar implements Component {

    protected static final Logger LOGGER = LoggerFactory

            .getLogger(FormSetButtonBar.class);

    public static final int ID_ACTION_FIRST = 1;

    public static final int ID_ACTION_PREVIOUS = 2;

    public static final int ID_ACTION_NEXT = 3;

    public static final int ID_ACTION_LAST = 4;

    public static final int ID_ACTION_SAVE = 5;

    public static final int ID_ACTION_NEW = 6;

    public static final int ID_ACTION_CANCEL_NEW = 7;

    public static final int ID_ACTION_DELETE = 8;

    public static final int ID_ACTION_SEARCH = 9;

    public static final int ID_ACTION_CLOSE = 10;

    public static final int ID_ACTION_SET_CURRENT_RECORD = 11;

    private static final int MAX_ACTIONS = 11;

    private static final int COUNTER_HEIGHT = 50;

    private static final int COUNTER_WIDTH = 100;

    public interface FormSetListener {

        public boolean doActionFirst();

        public boolean doActionPrevious();

        public boolean doActionNext();

        public boolean doActionLast();

        public boolean doActionSave();

        public boolean doActionNew();

        public boolean doActionCancelNew();

        public boolean doActionDelete();

        public boolean doActionSearch();

        public boolean doActionClose();

        public void doSetCurrentRecord(int current);

    }

    private JPanel contents = null;

    private Set listeners = null;

    private int current = 0;

    private String currentLabel = null;

    private int numrecords = 0;

    private JPanel othersButtons;

    private final List<Action> otherActions;

    private final Map<String, JButton> otherButtons;

    private final Map<String,Integer> actionNameToId;

    private boolean readOnly = false;

    private JButton records;

    private final JButton buttons[] = new JButton[MAX_ACTIONS];

    private final Boolean activatedActions[] = new Boolean[MAX_ACTIONS];

    public FormSetButtonBar() {

        // Activamos todas las acciones por defecto

        for (int i = 0; i < this.activatedActions.length; i++) {

            this.activatedActions[i] = true;

        }

        this.actionNameToId = new HashMap();

        this.actionNameToId.put(ACTION_FIRST, ID_ACTION_FIRST);

        this.actionNameToId.put(ACTION_PREVIOUS, ID_ACTION_PREVIOUS);

        this.actionNameToId.put(ACTION_NEXT, ID_ACTION_NEXT);

        this.actionNameToId.put(ACTION_LAST, ID_ACTION_LAST);

        this.actionNameToId.put(ACTION_SAVE, ID_ACTION_SAVE);

        this.actionNameToId.put(ACTION_NEW, ID_ACTION_NEW);

        this.actionNameToId.put(ACTION_CANCEL_NEW, ID_ACTION_CANCEL_NEW);

        this.actionNameToId.put(ACTION_DELETE, ID_ACTION_DELETE);

        this.actionNameToId.put(ACTION_SEARCH, ID_ACTION_SEARCH);

        this.actionNameToId.put(ACTION_CLOSE, ID_ACTION_CLOSE);

        this.actionNameToId.put(ACTION_SET_CURRENT_RECORD, ID_ACTION_SET_CURRENT_RECORD);

        this.listeners = new HashSet();

        this.otherActions = new ArrayList<>();

        this.otherButtons = new HashMap<>();

    }

    @Override

    public JComponent asJComponent() {

        if (this.contents == null) {

            this.initComponents();

        }

        return this.contents;

    }

    public void addListener(FormSetListener listener) {

        this.listeners.add(listener);

    }

    public void removeListener(FormSetListener listener) {

        this.listeners.remove(listener);

    }

    public void fireEvent(String action, Object value) {

        Integer actionid = this.actionNameToId.get(action);

        if( actionid==null ) {

            JButton button = this.otherButtons.get(action);

            if( button != null && button.getAction()!=null ) {

                button.getAction().actionPerformed(new ActionEvent(value, 1, action));

            }

        } else {

            if (this.readOnly) {

                Iterator it = this.listeners.iterator();

                while (it.hasNext()) {

                    FormSetListener listener = (FormSetListener) it.next();

                    try {

                        switch (actionid) {

                            case ID_ACTION_FIRST:

                                listener.doActionFirst();

                                break;

                            case ID_ACTION_PREVIOUS:

                                listener.doActionPrevious();

                                break;

                            case ID_ACTION_NEXT:

                                listener.doActionNext();

                                break;

                            case ID_ACTION_LAST:

                                listener.doActionLast();

                                break;

                            case ID_ACTION_SEARCH:

                                listener.doActionSearch();

                                break;

                            case ID_ACTION_CLOSE:

                                listener.doActionClose();

                                break;

                            case ID_ACTION_SET_CURRENT_RECORD:

                                listener.doSetCurrentRecord(((Integer) value));

                                break;

                        }

                    } catch (Exception ex) {

                        LOGGER.info("Error calling listener " + listener.toString()

                                + "(" + listener.getClass().getName() + ") from "

                                + this.toString() + "(" + this.getClass().getName()

                                + ").", ex);

                    }

                }

            } else {

                Iterator it = this.listeners.iterator();

                while (it.hasNext()) {

                    FormSetListener listener = (FormSetListener) it.next();

                    try {

                        switch (actionid) {

                            case ID_ACTION_FIRST:

                                listener.doActionFirst();

                                break;

                            case ID_ACTION_PREVIOUS:

                                listener.doActionPrevious();

                                break;

                            case ID_ACTION_NEXT:

                                listener.doActionNext();

                                break;

                            case ID_ACTION_LAST:

                                listener.doActionLast();

                                break;

                            case ID_ACTION_SAVE:

                                listener.doActionSave();

                                break;

                            case ID_ACTION_NEW:

                                listener.doActionNew();

                                break;

                            case ID_ACTION_CANCEL_NEW:

                                listener.doActionCancelNew();

                                break;

                            case ID_ACTION_DELETE:

                                listener.doActionDelete();

                                break;

                            case ID_ACTION_SEARCH:

                                listener.doActionSearch();

                                break;

                            case ID_ACTION_CLOSE:

                                listener.doActionClose();

                                break;

                            case ID_ACTION_SET_CURRENT_RECORD:

                                listener.doSetCurrentRecord(((Integer) value));

                                break;

                        }

                    } catch (Exception ex) {

                        LOGGER.info("Error calling listener " + listener.toString()

                                + "(" + listener.getClass().getName() + ") from "

                                + this.toString() + "(" + this.getClass().getName()

                                + ").", ex);

                    }

                }

            }

        }

    }

    private void updateRecords() {

        setEnabled(ACTION_NEW, true);

        if (numrecords <= 0) {

            this.records.setText("0 / 0");

            setEnabled(ID_ACTION_FIRST, false);

            setEnabled(ID_ACTION_PREVIOUS, false);

            setEnabled(ID_ACTION_NEXT, false);

            setEnabled(ACTION_LAST, false);

            return;

        }

        if (this.currentLabel == null) {

            this.records.setText((current + 1) + " / " + numrecords);

        } else {

            this.records.setText(this.currentLabel + " / " + numrecords);

        }

        if (current <= 0) {

            current = 0;

            setEnabled(ID_ACTION_FIRST, false);

            setEnabled(ID_ACTION_PREVIOUS, false);

            setEnabled(ID_ACTION_NEXT, true);

            setEnabled(ACTION_LAST, true);

        } else if (current >= numrecords - 1) {

            current = numrecords - 1;

            setEnabled(ID_ACTION_NEXT, false);

            setEnabled(ACTION_LAST, false);

            setEnabled(ID_ACTION_FIRST, true);

            setEnabled(ID_ACTION_PREVIOUS, true);

        } else {

            setEnabled(ID_ACTION_NEXT, true);

            setEnabled(ACTION_LAST, true);

            setEnabled(ID_ACTION_FIRST, true);

            setEnabled(ID_ACTION_PREVIOUS, true);

        }

    }

    private void initComponents() {

        this.contents = new JPanel();

        this.contents.setLayout(new FlowLayout(FlowLayout.LEADING, 4, 4));

        this.contents.add(getStandardButtonBar());

        this.othersButtons = new JPanel();

        this.othersButtons.setLayout(new FlowLayout(FlowLayout.LEADING, 4, 4));

        this.contents.add(this.othersButtons);

        for (Action action : this.otherActions) {

            this.othersButtons.add(new JButton(action));

        }

        this.contents.add(createButton("Close", "close.png", ACTION_CLOSE, KeyEvent.VK_UNDEFINED));

        this.initButtons();

        this.updateRecords();

    }

    private JPanel getStandardButtonBar() {

        I18nManager i18nManager = ToolsLocator.getI18nManager();

        JPanel contents = new JPanel();

        contents.setLayout(new FlowLayout(FlowLayout.LEADING, 4, 4));

        JComponent firstButton = createButton(i18nManager.getTranslation("_first"), "first.png", ACTION_FIRST, KeyEvent.CTRL_MASK + KeyEvent.VK_PAGE_UP);

        contents.add(firstButton);

        contents.add(createButton(i18nManager.getTranslation("_back"), "previous.png", ACTION_PREVIOUS, KeyEvent.VK_PAGE_UP));

        this.records = new JButton();

        this.records.setCursor(new Cursor(Cursor.HAND_CURSOR));

        this.records.setBorder(BorderFactory.createEmptyBorder());

        this.records.setBorderPainted(false);

        this.records.setFocusPainted(false);

        this.records.setContentAreaFilled(false);

        this.records.addActionListener(new ActionListener() {

            @Override

            public void actionPerformed(ActionEvent ae) {

                doGoRecord();

            }

        });

        int height = this.records.getFont().getSize();

        if (height < 16) {

            height = 16;

        }

        this.records.setPreferredSize(new Dimension(COUNTER_WIDTH, height));

        this.records.setHorizontalAlignment(SwingConstants.CENTER);

        contents.add(this.records);

        contents.add(createButton(i18nManager.getTranslation("_next"), "next.png", ACTION_NEXT, KeyEvent.VK_PAGE_DOWN));

        contents.add(createButton(i18nManager.getTranslation("_last"), "last.png", ACTION_LAST, KeyEvent.CTRL_MASK + KeyEvent.VK_PAGE_DOWN));

        contents.add(createButton(i18nManager.getTranslation("guardar"), "save.png", ACTION_SAVE, KeyEvent.CTRL_MASK + KeyEvent.VK_S));

        contents.add(createButton(i18nManager.getTranslation("nuevo"), "new.png", ACTION_NEW, KeyEvent.VK_F6));

        contents.add(createButton(i18nManager.getTranslation("cancelar nuevo"), "cancelnew.png", ACTION_CANCEL_NEW, KeyEvent.VK_F12));

        contents.add(createButton(i18nManager.getTranslation("borrar"), "delete.png", ACTION_DELETE, KeyEvent.SHIFT_MASK + KeyEvent.VK_F2));

        contents.add(createButton(i18nManager.getTranslation("search"), "search.png", ACTION_SEARCH, KeyEvent.CTRL_MASK + KeyEvent.VK_F));

        return contents;

    }

    private void doGoRecord() {

        I18nManager i18nManager = ToolsLocator.getI18nManager();

        String value = JOptionPane.showInputDialog(

                this.records,

                i18nManager.getTranslation("_Enter_the_registration_number_you_want_to_go"),

                i18nManager.getTranslation("_Go_to_record"),

                JOptionPane.QUESTION_MESSAGE

        );

        if (StringUtils.isEmpty(value)) {

            return;

        }

        int record;

        try {

            record = Integer.parseInt(value);

        } catch (Exception ex) {

            JOptionPane.showMessageDialog(

                    this.records,

                    i18nManager.getTranslation("_invalid_record_number"),

                    i18nManager.getTranslation("_Go_to_record"),

                    JOptionPane.WARNING_MESSAGE

            );

            return;

        }

        fireEvent(ACTION_SET_CURRENT_RECORD, record);

    }

    private void initButtons() {

        setActionActive(ID_ACTION_SAVE, isActionActive(ID_ACTION_SAVE));

        setActionActive(ID_ACTION_NEW, isActionActive(ID_ACTION_NEW));

        setActionActive(ID_ACTION_SEARCH, isActionActive(ID_ACTION_SEARCH));

        setActionActive(ID_ACTION_DELETE, isActionActive(ID_ACTION_DELETE));

        setActionActive(ID_ACTION_CLOSE, isActionActive(ID_ACTION_CLOSE));

    }

    private JComponent createButton(final String tip, final String image, final String action, int mnemonic) {

        int actionid = this.actionNameToId.get(action);

        URL url = this.getClass().getClassLoader().getResource("org/gvsig/tools/dynform/impl/" + image);

        Icon icon = new ImageIcon(url);

        JButton button = new JButton(icon);

        if (mnemonic != KeyEvent.VK_UNDEFINED) {

            button.setMnemonic(mnemonic);

        }

        button.setBorder(BorderFactory.createEmptyBorder());

        button.setBorderPainted(false);

        button.setFocusPainted(false);

        button.setContentAreaFilled(false);

        button.setToolTipText(tip);

        button.setCursor(new Cursor(Cursor.HAND_CURSOR));

        button.addActionListener(new ActionListener() {

            @Override

            public void actionPerformed(ActionEvent ae) {

                fireEvent(action, null);

            }

        });

        this.buttons[actionid] = button;

        return button;

    }

    public void setEnabled(int action, boolean enabled) {

        JButton button = this.buttons[action];

        if (enabled) {

            button.setEnabled(true);

        } else {

            button.setEnabled(false);

        }

    }

    public void setVisible(int action, boolean visible) {

        JButton button = this.buttons[action];

        if (visible) {

            button.setVisible(true);

        } else {

            button.setVisible(false);

        }

    }

    public void setVisible(String id, boolean visible) {

        Integer x = this.actionNameToId.get(id);

        if( x!=null ) {

            this.buttons[x].setVisible(visible);

            return;

        }

        JButton button = this.otherButtons.get(id);

        if (button == null) {

            return;

        }

        button.setVisible(visible);

    }

    public void setEnabled(String id, boolean enabled) {

        Integer x = this.actionNameToId.get(id);

        if( x!=null ) { // Ojo, si quito el intValue a veces falla

            this.buttons[x.intValue()].setEnabled(enabled);

            return;

        }

        JButton button = this.otherButtons.get(id);

        if (button == null) {

            return;

        }

        button.setEnabled(enabled);

    }

    public boolean isEnabled(String id) {

        Integer x = this.actionNameToId.get(id);

        if( x!=null ) {

            return this.buttons[x].isEnabled();

        }

        JButton button = this.otherButtons.get(id);

        if (button == null) {

            throw new IllegalArgumentException("Don't exists action '" + id + "'.");

        }

        return button.isEnabled();

    }

    public JComponent getActionButton(String id) {

        Integer x = this.actionNameToId.get(id);

        if( x!=null ) {

            return this.buttons[x];

        }

        JButton button = this.otherButtons.get(id);

        return button;

    }

    public boolean isVisible(String id) {

        Integer x = this.actionNameToId.get(id);

        if( x!=null ) {

            return this.buttons[x].isVisible();

        }

        JButton button = this.otherButtons.get(id);

        if (button == null) {

            throw new IllegalArgumentException("Don't exists action '" + id + "'.");

        }

        return button.isVisible();

    }

    public void setCurrent(int current) {

        this.current = current;

        updateRecords();

    }

    public void setCurrentLabel(String label) {

        this.currentLabel = label;

        updateRecords();

    }

    public void setNumrecords(int numrecords) {

        this.numrecords = numrecords;

        updateRecords();

    }

    public void setActionActive(int action, boolean active) {

        if (action == ID_ACTION_SAVE || action == ID_ACTION_DELETE

                || action == ID_ACTION_NEW || action == ID_ACTION_SEARCH

                || action == ID_ACTION_CLOSE) {

            if (this.contents == null) {

                this.initComponents();

            }

            this.activatedActions[action] = active;

            this.buttons[action].setVisible(active);

        }

    }

    public boolean isActionActive(int action) {

        return this.activatedActions[action];

    }

    public void setReadOnly(boolean readOnly) {

        this.readOnly = readOnly;

        this.setEnabled(ID_ACTION_SAVE, !readOnly);

        this.setEnabled(ACTION_NEW, !readOnly);

        this.setEnabled(ID_ACTION_CANCEL_NEW, !readOnly);

        this.setEnabled(ACTION_DELETE, !readOnly);

        this.setEnabled(ID_ACTION_SEARCH, true);

        this.setEnabled(ACTION_CLOSE, true);

        updateRecords();

    }

    public void addAction(Action action) {

        this.otherActions.add(action);

        if (this.contents == null) {

            return;

        }

        JButton button = new JButton(action);

        button.setBorder(BorderFactory.createEmptyBorder());

        button.setBorderPainted(false);

        button.setFocusPainted(false);

        button.setContentAreaFilled(false);

        button.setCursor(new Cursor(Cursor.HAND_CURSOR));

        String id = Objects.toString(action.getValue(Action.ACTION_COMMAND_KEY), null);

        if (!StringUtils.isEmpty(id)) {

            this.otherButtons.put(id, button);

        }

        this.othersButtons.add(button);

    }

}