PropertyMemberUIWrapper.java

/*
 *
 *  * Copyright (C) 2015 CS SI
 *  *
 *  * 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, see http://www.gnu.org/licenses/
 *
 */
package org.esa.snap.ui.tooladapter.model;

import com.bc.ceres.swing.binding.BindingContext;
import org.esa.snap.core.gpf.descriptor.PropertyAttributeException;
import org.esa.snap.core.gpf.descriptor.ToolAdapterOperatorDescriptor;
import org.esa.snap.core.gpf.descriptor.ToolParameterDescriptor;

import javax.swing.*;
import java.awt.*;
import java.awt.event.FocusEvent;
import java.awt.event.FocusListener;
import java.util.logging.Logger;

/**
 * @author Ramona Manda
 */
public abstract class PropertyMemberUIWrapper implements FocusListener {

    protected String attributeName;
    protected JComponent UIComponent;
    protected int width = 0;
    protected ToolParameterDescriptor paramDescriptor;
    protected ToolAdapterOperatorDescriptor opDescriptor;
    private CallBackAfterEdit callback;
    private BindingContext context;
    private Logger logger;

    public PropertyMemberUIWrapper(String attributeName, ToolParameterDescriptor paramDescriptor, ToolAdapterOperatorDescriptor opDescriptor, BindingContext context) {
        this.attributeName = attributeName;
        this.paramDescriptor = paramDescriptor;
        this.opDescriptor = opDescriptor;
        this.context = context;
        this.logger = Logger.getLogger(PropertyMemberUIWrapper.class.getName());
    }

    public PropertyMemberUIWrapper(String attributeName, ToolParameterDescriptor paramDescriptor, ToolAdapterOperatorDescriptor opDescriptor, BindingContext context, int width, CallBackAfterEdit callback) {
        this(attributeName, paramDescriptor, opDescriptor, context);
        this.width = width;
        this.callback = callback;
        try {
            getUIComponent();
        }catch (Exception ex){
            logger.warning(ex.getMessage());
        }
    }

    public BindingContext getContext(){
        return this.context;
    }

    public ToolParameterDescriptor getParamDescriptor(){
        return this.paramDescriptor;
    }

    public String getErrorValueMessage(Object value) {
        return null;
    }

    protected abstract void setMemberValue(Object value) throws PropertyAttributeException;

    public abstract Object getMemberValue() throws PropertyAttributeException;

    public JComponent getUIComponent() throws Exception {
        if (UIComponent == null) {
            buildAndLinkUIComponent();
        }
        return UIComponent;
    }

    public JComponent reloadUIComponent(Class<?> newParamType) throws Exception{
        buildAndLinkUIComponent();
        return UIComponent;
    }

    public void buildAndLinkUIComponent() throws Exception {
        UIComponent = buildUIComponent();
        if (width != -1) {
            UIComponent.setPreferredSize(new Dimension(width, 20));
        }
        UIComponent.addFocusListener(this);
        //Object value = context.getBinding(attributeName).getPropertyValue();
        /*if(value != null) {
            if (UIComponent instanceof JTextField) {
                ((JTextField) UIComponent).setText(value.toString());
            }
            if (UIComponent instanceof JFileChooser) {
                ((JFileChooser) UIComponent).setSelectedFile(new File(value.toString()));
            }
            if (UIComponent instanceof JComboBox) {
                ((JComboBox) UIComponent).setSelectedItem(value);
            }
        }*/
    }

    protected abstract JComponent buildUIComponent() throws Exception;

    public void setMemberValueWithCheck(Object value) throws PropertyAttributeException {
        String msg = getErrorValueMessage(value);
        if (msg != null) {
            throw new PropertyAttributeException(msg);
        }
        setMemberValue(value);
    }

    public boolean memberUIComponentNeedsRevalidation() {
        return false;
    }

    public boolean propertyUIComponentsNeedsRevalidation() {
        return false;
    }

    public boolean contextUIComponentsNeedsRevalidation() {
        return false;
    }

    @Override
    public void focusGained(FocusEvent e) {
        //do nothing
    }

    @Override
    public void focusLost(FocusEvent e) {
        //save the value
        if (!e.isTemporary()) {
            try {
                if (getValueFromUIComponent().equals(getMemberValue())) {
                    return;
                }
                setMemberValueWithCheck(getValueFromUIComponent());
                if (callback != null) {
                    callback.doCallBack(null, paramDescriptor, null, attributeName);
                }
            } catch (PropertyAttributeException ex) {
                if (callback != null) {
                    callback.doCallBack(ex, paramDescriptor, null, attributeName);
                }
                UIComponent.requestFocusInWindow();
            }
        }
    }

    public void setCallback(CallBackAfterEdit callback) {
        this.callback = callback;
    }

    protected abstract Object getValueFromUIComponent() throws PropertyAttributeException;

    public interface CallBackAfterEdit {
        public void doCallBack(PropertyAttributeException exception, ToolParameterDescriptor oldProperty, ToolParameterDescriptor newProperty, String attributeName);
    }
}