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.spi.dynformfield;

import java.awt.BorderLayout;

import java.awt.Color;

import java.util.ArrayList;

import java.util.HashSet;

import java.util.Iterator;

import java.util.List;

import java.util.Set;

import javax.swing.Action;

import javax.swing.JComponent;

import javax.swing.JLabel;

import javax.swing.JPanel;

import javax.swing.JScrollPane;

import javax.swing.JViewport;

import javax.swing.text.JTextComponent;

import org.gvsig.tools.dynform.DynFormFieldDefinition;

import org.gvsig.tools.dynform.JDynFormField;

import org.gvsig.tools.dynform.spi.DynFormSPIManager;

import org.gvsig.tools.dynobject.DynObject;

import org.gvsig.tools.observer.Observable;

import org.gvsig.tools.observer.Observer;

import org.gvsig.tools.service.Manager;

import org.gvsig.tools.service.spi.ServiceManager;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

@SuppressWarnings({"rawtypes", "unchecked"})

public abstract class AbstractJDynFormField implements JDynFormField{

        protected static final Logger logger = LoggerFactory

                        .getLogger(AbstractJDynFormField.class);

        private DynFormSPIManager manager = null;

        private DynFormFieldDefinition definition = null;

        private JLabel jlabel = null;

        private JPanel jlabelpanel = null;

        private Set listeners = null;

        private JProblemIndicator problemIndicator = null;

        protected DynObject parameters = null;

        protected JComponent contents = null;

        private boolean readOnly = false;

        private List customActions;

        protected boolean emptyToNull = false;

        public AbstractJDynFormField(DynObject parameters,

                        ServiceManager serviceManager) {

                this.parameters = parameters;

                this.manager = (DynFormSPIManager) serviceManager;

                this.definition = this.getDefinition();

                this.listeners = new HashSet();

                this.readOnly = this.definition.isReadOnly();

                this.problemIndicator = this.manager.createProblemIndicator(this);

                this.customActions = new ArrayList<Action>();

        }

        public abstract void initComponent();

        public abstract Object getAssignedValue();

        public Object getParameterValue() {

                return this.parameters.getDynValue(DynFormSPIManager.FIELD_VALUE);

        }

        public JComponent asJComponent() {

                if (this.contents == null) {

                        this.initComponent();

                        if(!this.customActions.isEmpty()){

                                addPopupComponents();

                        }

                        if( this.readOnly ) {

                                this.setReadOnly(readOnly);

                        }

                }

                return this.contents;

        }

        public String getName() {

                return this.definition.getName();

        }

        public String getLabel() {

                if(definition.getLabel() != null)

                        return definition.getLabel();

                else

                        return this.getName();

        }

        public JComponent getJLabel() {

                if (this.jlabel == null) {

                        this.jlabel = new JLabel(this.getLabel());

                        this.jlabel.setLabelFor(this.contents);

                        if( this.getDefinition().isMandatory() ) {

                                this.jlabel.setForeground(Color.red.darker());

                        }

                        this.jlabelpanel = new JPanel();

                        this.jlabelpanel.setLayout(new BorderLayout());

                        this.jlabelpanel.add(jlabel,BorderLayout.CENTER);

                        this.jlabelpanel.add(problemIndicator.asJComponent(), BorderLayout.LINE_END);

                }

                return this.jlabelpanel;

        }

        public DynFormFieldDefinition getDefinition() {

                return (DynFormFieldDefinition) this.parameters

                                .getDynValue(DynFormSPIManager.FIELD_FIELDDEFINITION);

        }

        public Manager getManager() {

                return this.manager;

        }

        public void addListener(JDynFormFieldListener listener) {

                this.listeners.add(listener);

        }

        public void removeListener(JDynFormFieldListener listener) {

                this.listeners.remove(listener);

        }

        protected void fireFieldChangedEvent() {

                Iterator it = this.listeners.iterator();

                while (it.hasNext()) {

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

                        try {

                                listener.fieldChanged(this);

                        } catch (Exception ex) {

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

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

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

                                                + ").", ex);

                        }

                }

        }

        protected void fireFieldEnterEvent() {

                Iterator it = this.listeners.iterator();

                while (it.hasNext()) {

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

                        try {

                                listener.fieldEnter(this);

                        } catch (Exception ex) {

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

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

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

                                                + ").", ex);

                        }

                }

        }

        protected void fireFieldExitEvent() {

                Iterator it = this.listeners.iterator();

                while (it.hasNext()) {

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

                        try {

                                listener.fieldExit(this);

                        } catch (Exception ex) {

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

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

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

                                                + ").", ex);

                        }

                }

        }

        public void fireMessageEvent(String message) {

                Iterator it = this.listeners.iterator();

                while (it.hasNext()) {

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

                        try {

                                listener.message(this, message);

                        } catch (Exception ex) {

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

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

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

                                                + ").", ex);

                        }

                }

        }

        public boolean isReadOnly() {

                return this.readOnly ;

        }

        public void setReadOnly(boolean readonly) {

                // FIXME: Implememtacion por defecto, sobreescribirla en las subclases

                // segun convenga para cada componente.

                JTextComponent x = null;

                this.readOnly = readonly;

                if( this.contents != null ) {

                        if( this.contents instanceof JTextComponent ) {

                                x = (JTextComponent) this.contents;

                                x.setEditable(!readonly);

                        } else if( this.contents instanceof JScrollPane ) {

                                try {

                                        JViewport port = ((JScrollPane)this.contents).getViewport();

                                        x = (JTextComponent)  port.getView();

                                        x.setEditable(!readonly);

                                } catch(Exception ex) {

                                        this.contents.setEnabled(!readOnly);

                                }

                        } else {

                                this.contents.setEnabled(!readOnly);

                        }

                }

        }

        public JProblemIndicator problemIndicator() {

                return this.problemIndicator;

        }

        public class IllegalFieldValue extends RuntimeException {

                /**

                 * 

                 */

                private static final long serialVersionUID = -4409236610055983438L;

                public IllegalFieldValue(JDynFormField field, String message) {

                        super("The value of field '"+field.getLabel()+"' is not valid. " + message);

                }

        }

        public String toString() {

                return super.toString() + "{" + this.getName() + "}";

        }

        public boolean isModified() {

                boolean modified = false;

                try {

                        if( !this.isReadOnly() ) {

                                Object value = this.getValue();

                                if( value == null ) {

                                        if( value != this.getAssignedValue() ) {

                                                modified = true;

                                        }

                                } else {

                                        if( ! value.equals(this.getAssignedValue()) ) {

                                                modified = true;

                                        }

                                }

                        }

                } catch(IllegalFieldValue ex) {

                        // Si es incorrecto el valor del campo decimos a capom que esta modificado.

                        modified = true;

                }

                return modified;

        }

        private void addPopupComponents(){

                Iterator it = this.customActions.iterator();

                while(it.hasNext()){

                        Object obj = it.next();

                        if(obj!=null){

                                Action act = (Action) obj;

                                if(contents instanceof SupportPopupMenu) {

                                        DynFormFieldAction sact = new DynFormFieldAction(this, act);

                                        ((SupportPopupMenu) this.contents).addActionToPopupMenu(

                                                sact.getName(), 

                                                sact);

                                }

                        }else{

                                if(contents instanceof SupportPopupMenu) {

                                        ((SupportPopupMenu) this.contents).addSeparatorToPopupMenu();

                                }        

                        }

                }

        }

        public void addActionToPopupMenu(String name, Action action) {

                if(contents != null){

                        if(contents instanceof SupportPopupMenu ) {

                                DynFormFieldAction sact = new DynFormFieldAction(this,action);

                                ((SupportPopupMenu) this.contents).addActionToPopupMenu(

                                                sact.getName(), 

                                                sact);

                        }

                }else{

                        this.customActions.add(action);

                }

        }

        public void addSeparatorToPopupMenu() {

                if(contents != null){

                        if( contents instanceof SupportPopupMenu ) {

                                ((SupportPopupMenu) this.contents).addSeparatorToPopupMenu();

                        }

                }else{

                        this.customActions.add(null);

                }

        }

        public void setTranslateEmptyToNull(boolean emptyToNull) {

          this.emptyToNull = emptyToNull;

        }

        public boolean translateEmptyToNull() {

          return this.emptyToNull;

        }

}