Application: gvSIG desktop

/**

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

 */

/*

 * AUTHORS (In addition to CIT):

 * 2008 {DiSiD Technologies}  {Create a Table component for Features}

 */

package org.gvsig.fmap.mapcontrol.dal.feature.swing;

import java.awt.BorderLayout;

import static java.awt.BorderLayout.CENTER;

import java.awt.Component;

import javax.swing.AbstractListModel;

import javax.swing.JButton;

import javax.swing.JLabel;

import javax.swing.JList;

import javax.swing.JPanel;

import javax.swing.JScrollPane;

import javax.swing.JTable;

import javax.swing.ListCellRenderer;

import javax.swing.ListModel;

import javax.swing.UIManager;

import javax.swing.table.JTableHeader;

import org.gvsig.fmap.dal.DataStoreNotification;

import org.gvsig.fmap.dal.exception.DataException;

import org.gvsig.fmap.dal.feature.Feature;

import org.gvsig.fmap.dal.feature.FeatureQuery;

import org.gvsig.fmap.dal.feature.FeatureStore;

import org.gvsig.fmap.mapcontrol.dal.feature.swing.table.ConfigurableFeatureTableModel;

import org.gvsig.fmap.mapcontrol.dal.feature.swing.table.FeatureTableConfigurationPanel;

import org.gvsig.i18n.Messages;

import org.gvsig.tools.exception.BaseException;

import org.gvsig.tools.observer.Observable;

import org.gvsig.tools.observer.Observer;

/**

 * Panel to show a table of Feature data.

 * 

 * @author <a href="mailto:cordin@disid.com">C?sar Ordi?ana</a>

 */

public class FeatureTablePanel extends JPanel implements Observer {

    private static final long serialVersionUID = -9199073063283531216L;

    private ConfigurableFeatureTableModel tableModel;

    private JScrollPane jScrollPane = null;

    private FeatureTable table = null;

    private JPanel selectionPanel;

    private JLabel selectionLabel;

    /**

     * Constructs a Panel to show a table with the features of a FeatureStore.

     * 

     * @param featureStore

     *            to extract the features from

     * @throws BaseException

     *             if there is an error reading data from the FeatureStore

     */

    public FeatureTablePanel(FeatureStore featureStore) throws BaseException {

        this(featureStore, true);

    }

    /**

     * Constructs a Panel to show a table with the features of a FeatureStore.

     * 

     * @param featureStore

     *            to extract the features from

     * @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 reading data from the FeatureStore

     */

    public FeatureTablePanel(FeatureStore featureStore, boolean isDoubleBuffered)

        throws BaseException {

        this(featureStore, null, isDoubleBuffered);

    }

    /**

     * @throws BaseException

     * 

     */

    public FeatureTablePanel(FeatureStore featureStore,

        FeatureQuery featureQuery) throws BaseException {

        this(featureStore, featureQuery, true);

    }

    /**

     * @param isDoubleBuffered

     * @throws BaseException

     */

    public FeatureTablePanel(FeatureStore featureStore,

        FeatureQuery featureQuery, boolean isDoubleBuffered)

        throws BaseException {

        this(createModel(featureStore, featureQuery));

    }

    public FeatureTablePanel(ConfigurableFeatureTableModel tableModel)

        throws DataException {

        this(tableModel, true);

    }

    public FeatureTablePanel(ConfigurableFeatureTableModel tableModel,

        boolean isDoubleBuffered) throws DataException {

        super(isDoubleBuffered);

        this.tableModel = tableModel;

        this.setLayout(new BorderLayout());

        this.add(getJScrollPane(), BorderLayout.CENTER);

        this.add(getSelectionPanel(), BorderLayout.SOUTH);

        tableModel.getFeatureStore().addObserver(this);

    }

    private JPanel getSelectionPanel() {

        if (selectionPanel == null) {

            selectionLabel = new JLabel();

            selectionLabel.setText(getFeatureSelectionSize() + " / "

                + getTableModel().getHelper().getTotalSize() + " "

                + Messages.getText("registros_seleccionados_total") + ".");

            selectionPanel = new JPanel();

            selectionPanel.add(selectionLabel, BorderLayout.EAST);

        }

        return selectionPanel;

    }

    private void updateSelection() {

        selectionLabel.setText(getFeatureSelectionSize() + " / "

            + getTableModel().getRowCount() + " "

            + Messages.getText("registros_seleccionados_total") + ".");

    }

    private long getFeatureSelectionSize() {

        try {

            return getFeatureStore().getFeatureSelection().getSize();

        } catch (DataException e) {

            throw new RuntimeException("Error updating selection information",

                e);

        }

    }

    public JPanel createConfigurationPanel() {

        return new FeatureTableConfigurationPanel(tableModel);

    }

    /**

     * Returns the internal Table Model for the Features of the FeatureStore.

     * 

     * @return the internal Table Model

     */

    public ConfigurableFeatureTableModel getTableModel() {

        return tableModel;

    }

    /**

     * Returns the {@link FeatureStore} of the {@link Feature}s being shown in

     * the table.

     * 

     * @return the store of the features

     */

    public FeatureStore getFeatureStore() {

        return getTableModel().getFeatureStore();

    }

    /**

     * Returns the FeatureQuery used to get the Features.

     * 

     * @return the FeatureQuery

     */

    public FeatureQuery getFeatureQuery() {

        return getTableModel().getFeatureQuery();

    }

    /**

     * Sets that the selected Features to be viewed first.

     */

    public void setSelectionUp(boolean selectionUp) {

        try {

            getTable().setSelectionUp(selectionUp);

        } catch (DataException e) {

            throw new RuntimeException("Error setting the selection up", e);

        }

    }

    private static ConfigurableFeatureTableModel createModel(

        FeatureStore featureStore, FeatureQuery featureQuery)

        throws BaseException {

        FeatureQuery query =

            featureQuery == null ? featureStore.createFeatureQuery()

                : featureQuery;

        return new ConfigurableFeatureTableModel(featureStore, query);

    }

    public FeatureTable getTable() throws DataException {

        if (table == null) {

            table = new FeatureTable(tableModel);

            // Change the selection model to link with the FeatureStore

            // selection

            // through the FeatureTableModel

            table.setRowSelectionAllowed(true);

            table.setColumnSelectionAllowed(false);

            // table.setSelectionModel(new FeatureSelectionModel(tableModel));

        }

        return table;

    }

    /**

     * This method initializes jScrollPane

     * 

     * @return javax.swing.JScrollPane

     * @throws DataException

     */

    private JScrollPane getJScrollPane() throws DataException {

        if (jScrollPane == null) {

            FeatureTable theTable = getTable();

            jScrollPane = new JScrollPane();

            jScrollPane.setViewportView(theTable);

            jScrollPane.setRowHeaderView(getRowHeader(theTable));

        }

        return jScrollPane;

    }

    private static class RowHeaderRenderer extends JButton implements ListCellRenderer {

        RowHeaderRenderer(JTable table) {

          JTableHeader header = table.getTableHeader();

          setOpaque(true);

          setBorder(UIManager.getBorder("TableHeader.cellBorder"));

          setHorizontalAlignment(CENTER);

          setForeground(header.getForeground());

          setBackground(header.getBackground());

          setFont(header.getFont());

        }

        public Component getListCellRendererComponent(JList list, Object value,

            int index, boolean isSelected, boolean cellHasFocus) {

          setText((value == null) ? "" : value.toString());

          return this;

        }

    }

    private JList getRowHeader(final FeatureTable theTable) {

      ListModel lm = new AbstractListModel() {

        public int getSize() {

          return theTable.getRowCount();

        }

        public Object getElementAt(int index) {

          return String.valueOf(index+1);

        }

      };

      JList rowHeader = new JList(lm);

      rowHeader.setCellRenderer(new RowHeaderRenderer(theTable));

      rowHeader.setFixedCellWidth(50);

      rowHeader.setFixedCellHeight(table.getRowHeight()); //+ table.getRowMargin());

      return rowHeader;

    }

    public void update(Observable observable, Object notification) {

        // If selection changes from nothing selected to anything selected

        // or the reverse, update selection info

        if (notification instanceof DataStoreNotification) {

            String type = ((DataStoreNotification) notification).getType();

            if (DataStoreNotification.SELECTION_CHANGE.equals(type)) {

                updateSelection();

            }

        }

    }

    // public void valueChanged(ListSelectionEvent e) {

    // updateSelection();

    // updateUI();

    // }

    //

    // public void tableChanged(TableModelEvent e) {

    // updateSelection();

    // updateUI();

    // }

}