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.

 * 

 */

/*

 * AUTHORS (In addition to CIT):

 * 2010 Institute of New Imaging Technologies (INIT): 

 *   http://www.init.uji.es

 * Geographic Information research group: 

 *   http://www.geoinfo.uji.es

 * Universitat Jaume I, Spain

 */

/**

 * 

 */

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

import java.awt.Color;

import java.awt.Component;

import java.awt.Font;

import java.awt.GridBagConstraints;

import java.awt.GridBagLayout;

import java.awt.Insets;

import java.net.URL;

import javax.swing.ImageIcon;

import javax.swing.JComponent;

import javax.swing.JLabel;

import javax.swing.JPanel;

import javax.swing.SwingConstants;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dataTypes.DataTypes;

import org.gvsig.tools.dynobject.DynField;

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

import org.gvsig.tools.swing.api.dynobject.dynfield.JDynFieldComponent;

/**

 * 

 * JLabel with a "not validated" image, whose validation is validated and shown

 * whenever the listener is triggered.

 * 

 * @author 2010 - <a href="cordinyana@gvsig.org">C?sar Ordi?ana</a> - gvSIG Team

 * @author 2010 - <a href="mailto:reinhold@uji.es">Cristian Mart?n Reinhold</a>

 *         -

 *         gvSIG Team

 * @version $Id$

 * 

 */

public class StatusLabel implements ValueChangedListener {

    /**

     * 

     */

    private static final long serialVersionUID = -8404494423411589010L;

    private static final String NOT_VALIDATED = "unavailable.png";

    private static final String VALIDATED = "transparent.png";

    private static final Color COLOR_MANDATORY = Color.RED.darker();

    private JLabel validationLabel;

    private JLabel validationMessage;

    private JPanel validationPanel;

    private JDynFieldComponent fieldComponent;

    private JLabel fieldLabel;

    private DynField dynField;

    public StatusLabel(JDynFieldComponent input, JLabel fieldLabel,

        DynField dynField) {

        this.fieldComponent = input;

        this.fieldLabel = fieldLabel;

        this.dynField = dynField;

        if (dynField == null){

            this.dynField = input.getDynField();

        }

        initUI();

    }

    private void initUI() {

        validationLabel = new JLabel();

        validationLabel.setOpaque(true);

        validationLabel.setHorizontalAlignment(SwingConstants.RIGHT);

        validationLabel.setIconTextGap(1);

        validationLabel.setText(" ");

        validationLabel.setVerticalAlignment(SwingConstants.TOP);

        validationMessage = new JLabel();

        validationLabel.setOpaque(true);

        validationLabel.setText("");

        validationLabel.setVerticalAlignment(SwingConstants.CENTER);

        fieldLabel.setOpaque(true);

        fieldLabel.setHorizontalTextPosition(SwingConstants.LEFT);

        fieldLabel.setHorizontalAlignment(SwingConstants.LEFT);

        fieldLabel.setVerticalAlignment(SwingConstants.TOP);

        if (dynField.isMandatory()) {

            fieldLabel.setForeground(COLOR_MANDATORY);

            fieldLabel.setFont(fieldLabel.getFont().deriveFont(Font.BOLD));

        }

    }

        private ImageIcon getIcon(String name, String description) {

                URL iconurl = this.getClass().getResource(name);

                ImageIcon icon = null;

                if (iconurl == null) {

                        icon = new ImageIcon();

                } else {

                        icon = new ImageIcon(iconurl);

                }

                icon.setDescription(description);

                icon.setImageObserver(fieldLabel);

                return icon;

        }

    public Component getValidationLabel() {

        return this.fieldLabel;

    }

    public Component getFieldComponent() {

        JComponent component = this.fieldComponent.asJComponent();

        component.setName(dynField.getName());

        return component;

    }

        public void setValue(Object value) {

                this.fieldComponent.setValue(value);

        }

    public Component getValidationPanel(boolean addScrollPane) {

        if (validationPanel == null) {

            validationPanel = new JPanel(new GridBagLayout());

            validationPanel.setOpaque(true);

            GridBagConstraints constr = getValidationPanelConstraints();

            constr.weightx = 0.0;

            constr.weighty = 0.0;

            constr.gridx = 0;

            constr.gridy = 1;

            constr.fill = GridBagConstraints.NONE;

            validationPanel.add(validationLabel, constr);

            constr.weightx = 1.0;

            constr.weighty = 0.0;

            constr.gridx = 0;

            constr.gridy = 0;

            if (this.dynField.getType() == DataTypes.LIST) {

                constr.gridwidth = 3;

                constr.weighty = 1.0;

            } else {

                constr.gridwidth = 2;

            }

            constr.gridwidth = 2;

            // constr.fill = GridBagConstraints.RELATIVE;

            constr.fill = GridBagConstraints.BOTH;

            constr.anchor = GridBagConstraints.NORTHWEST;

            validationPanel.add(getFieldComponent(), constr);

            constr = new GridBagConstraints();

            constr.insets = new Insets(1, 2, 2, 2);

            constr.gridx = 1;

            constr.gridy = 1;

            constr.ipadx = 5;

            constr.ipady = 1;

            constr.fill = GridBagConstraints.BOTH;

            constr.anchor = GridBagConstraints.NORTHWEST;

            validationPanel.add(validationMessage, constr);

        }

        return validationPanel; 

    }

    private GridBagConstraints getValidationPanelConstraints() {

        GridBagConstraints constr = new GridBagConstraints();

        constr.insets = new Insets(2, 2, 2, 2);

        constr.ipadx = 2;

        constr.ipady = 2;

        constr.fill = GridBagConstraints.BOTH;

        constr.anchor = GridBagConstraints.NORTHWEST;

        return constr;

    }

    /*

     * (non-Javadoc)

     * 

     * @see

     * 

     * org.gvsig.tools.swing.api.dynobject.ValueChangedListener#handleValueChanged

     * (org.gvsig.tools.swing.api.dynobject.dynfield.JDynFieldComponent)

     */

    public void handleValueChanged(JDynFieldComponent field) {

        // Set the icon and text. If icon was null, say so.

        if (!field.isValid()) {

            validationLabel.setIcon(getIcon(NOT_VALIDATED, "Not Validated"));

            // validationLabel.setToolTipText(getErrorMessage(field));

            fieldLabel.setToolTipText(getErrorMessage(field));

            validationMessage.setText(getErrorMessage(field));

        } else {

            validationLabel.setIcon(getIcon(VALIDATED, "Validated"));

            // validationLabel.setToolTipText(null);

            fieldLabel.setToolTipText(null);

            validationMessage.setText("");

        }

        updateValidationMessageStatus();

    }

    private String getErrorMessage(JDynFieldComponent field) {

        String msg = field.getValidationMessage();

                if (msg == null || msg.equals("")) {

            if (field.isMandatory()) {

                return translate("Mandatory field. Please insert value.");

            }

            return translate("Incompatible type. Not Validated");

        }

                return msg.trim();

    }

    private String translate(String message) {

        return ToolsLocator.getI18nManager().getTranslation(message);

    }

    private void updateValidationMessageStatus() {

        if (validationMessage.getText().equals("")) {

            validationMessage.setVisible(false);

            validationLabel.setVisible(false);

        } else {

            validationMessage.setVisible(true);

            validationLabel.setVisible(true);

        }

    }

}