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

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

 * 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 2

 * 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.

 *

 */

package org.gvsig.tools.swing.impl.dynobject.set;

import java.awt.BorderLayout;

import java.awt.event.ActionEvent;

import javax.swing.AbstractAction;

import javax.swing.Action;

import javax.swing.Box;

import javax.swing.Icon;

import javax.swing.JComponent;

import javax.swing.JLabel;

import javax.swing.JPanel;

import javax.swing.JToolBar;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

import org.gvsig.tools.dynobject.DynObject;

import org.gvsig.tools.dynobject.DynObjectSet;

import org.gvsig.tools.exception.BaseException;

import org.gvsig.tools.observer.Observable;

import org.gvsig.tools.observer.Observer;

import org.gvsig.tools.service.Manager;

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

import org.gvsig.tools.swing.api.dynobject.DynObjectSwingManager;

import org.gvsig.tools.swing.api.dynobject.JDynObjectComponent;

import org.gvsig.tools.swing.api.dynobject.set.JDynObjectSetComponent;

/**

 * Default {@link JDynObjectSetComponent} implementation using a

 * {@link DynObjectSetModel}.

 * 

 * @author gvSIG Team

 * @version $Id$

 */

public class DefaultJDynObjectSetComponent extends JPanel implements

    JDynObjectSetComponent, Observer {

    private static final long serialVersionUID = -741238766386344850L;

    private static final Logger LOG =

        LoggerFactory.getLogger(DefaultJDynObjectSetComponent.class);

    private final DynObjectSetModel model;

    private final DynObjectSwingManager manager;

    private AbstractEnableAction firstAction;

    private AbstractEnableAction previousAction;

    private JLabel pageCountLabel;

    private AbstractEnableAction nextAction;

    private AbstractEnableAction lastAction;

    private JDynObjectComponent component;

    /**

     * Creates a new {@link DefaultJDynObjectSetComponent}.

     * 

     * @param set

     *            to render

     * @param manager

     *            which manages this component

     * @throws BaseException

     *             if there is an error creating the component

     */

    public DefaultJDynObjectSetComponent(DynObjectSet set,

        DynObjectSwingManager manager) throws BaseException {

        this(set, manager, true);

    }

    /**

     * Creates a new {@link DefaultJDynObjectSetComponent}.

     * 

     * @param set

     *            to render

     * @param manager

     *            which manages this component

     * @param isDoubleBuffered

     *            a boolean, true for double-buffering, which

     *            uses additional memory space to achieve fast, flicker-free

     *            updates

     * @throws BaseException

     *             if there is an error creating the component

     */

    public DefaultJDynObjectSetComponent(DynObjectSet set,

        DynObjectSwingManager manager, boolean isDoubleBuffered)

        throws BaseException {

        super(new BorderLayout(), isDoubleBuffered);

        this.model = new DynObjectSetModel(set);

        model.addObserver(this);

        this.manager = manager;

        initializeGUI();

    }

    /**

     * Initializes the GUI.

     */

    private void initializeGUI() {

        addDynObjectViewer();

        addDynObjectPager();

    }

    private void addDynObjectPager() {

        JToolBar toolBar = new JToolBar();

        toolBar.setRollover(true);

        toolBar.setFloatable(false);

        // Add horizontal glues to center the buttons

        toolBar.add(Box.createHorizontalGlue());

        toolBar.add(getFirstAction());

        toolBar.add(getPreviousAction());

        toolBar.addSeparator();

        toolBar.add(getPageCount());

        toolBar.addSeparator();

        toolBar.add(getNextAction());

        toolBar.add(getLastAction());

        toolBar.add(Box.createHorizontalGlue());

        add(toolBar, BorderLayout.SOUTH);

    }

    @SuppressWarnings("serial")

    private Action getFirstAction() {

        if (firstAction == null) {

            // TODO: replace the button text with an Icon

            firstAction = new AbstractEnableAction("<<") {

                public void actionPerformed(ActionEvent e) {

                    model.first();

                }

                public boolean isEnabled() {

                    return model.hasPrevious();

                };

            };

            firstAction.putValue(Action.SHORT_DESCRIPTION, "Go to first value");

            firstAction.checkEnabled();

        }

        return firstAction;

    }

    @SuppressWarnings("serial")

    private Action getPreviousAction() {

        if (previousAction == null) {

            // TODO: replace the button text with an Icon

            previousAction = new AbstractEnableAction("<") {

                public void actionPerformed(ActionEvent e) {

                    model.previous();

                }

                public boolean isEnabled() {

                    return model.hasPrevious();

                };

            };

            previousAction.checkEnabled();

            previousAction.putValue(Action.SHORT_DESCRIPTION,

                "Go to previous value");

        }

        return previousAction;

    }

    private JLabel getPageCount() {

        if (pageCountLabel == null) {

            pageCountLabel = new JLabel();

            updatePageCountLabel();

        }

        return pageCountLabel;

    }

    /**

     * 

     */

    private void updatePageCountLabel() {

        StringBuffer buffer = new StringBuffer();

        buffer.append(model.getCurrentPosition() + 1).append('/').append(

            model.getSize());

        pageCountLabel.setText(buffer.toString());

    }

    @SuppressWarnings("serial")

    private Action getNextAction() {

        if (nextAction == null) {

            // TODO: replace the button text with an Icon

            nextAction = new AbstractEnableAction(">") {

                public void actionPerformed(ActionEvent e) {

                    model.next();

                }

                public boolean isEnabled() {

                    return model.hasNext();

                };

            };

            nextAction.checkEnabled();

            nextAction.putValue(Action.SHORT_DESCRIPTION,

                "Go to following value");

        }

        return nextAction;

    }

    @SuppressWarnings("serial")

    private Action getLastAction() {

        if (lastAction == null) {

            // TODO: replace the button text with an Icon

            lastAction = new AbstractEnableAction(">>") {

                public void actionPerformed(ActionEvent e) {

                    model.last();

                }

                public boolean isEnabled() {

                    return model.hasNext();

                };

            };

            lastAction.checkEnabled();

            lastAction.putValue(Action.SHORT_DESCRIPTION, "Go to last value");

        }

        return lastAction;

    }

    private void addDynObjectViewer() {

        try {

            component =

                ToolsSwingLocator.getDynObjectSwingManager()

                    .createJDynObjectComponent(model.getCurrentDynObject());

            add(component.asJComponent(), BorderLayout.CENTER);

        } catch (BaseException e) {

            LOG.error(

                "Error creating the component to view the current DynObject in"

                    + " position: " + model.getCurrentPosition(), e);

        }

    }

    public Manager getManager() {

        return manager;

    }

    public JComponent asJComponent() {

        return this;

    }

    public DynObjectSet getDynObjectSet() {

        return model.getDynObjectSet();

    }

    public void update(Observable observable, Object notification) {

        // When the model changes the current DynObject, update the contained

        // components status

        updateDynObjectPager();

        updateDynObjectViewer();

    }

    /**

     * Updates the status of the {@link DynObject} viewer when the model changes

     * the current DynObject.

     */

    private void updateDynObjectViewer() {

        remove(component.asJComponent());

        addDynObjectViewer();

        repaint();

    }

    /**

     * Updates the status of the tool bar when the model changes the

     * current DynObject.

     */

    private void updateDynObjectPager() {

        firstAction.checkEnabled();

        previousAction.checkEnabled();

        nextAction.checkEnabled();

        lastAction.checkEnabled();

        StringBuffer buffer = new StringBuffer();

        buffer.append(model.getCurrentPosition() + 1).append('/').append(

            model.getSize());

        pageCountLabel.setText(buffer.toString());

        revalidate();

        repaint();

    }

    /**

     * Utility Action extension which adds a new checkEnabled() method to

     * set enabled or not depending on the isEnabled() method implementation.

     * That will only work as expected if the isEnabled() method implementation

     * is changed.

     * 

     * @author gvSIG Team

     * @version $Id$

     */

    @SuppressWarnings("serial")

    private static abstract class AbstractEnableAction extends AbstractAction {

        public AbstractEnableAction(Icon icon) {

            super(null, icon);

        }

        public AbstractEnableAction(String name) {

            super(name);

        }

        public void checkEnabled() {

            setEnabled(isEnabled());

        }

    }

}