CrsForm.java

/*
 * Copyright (C) 2010 Brockmann Consult GmbH (info@brockmann-consult.de)
 *
 * 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.crs;

import org.esa.snap.core.datamodel.GeoPos;
import org.esa.snap.core.datamodel.Product;
import org.esa.snap.ui.AppContext;
import org.opengis.referencing.FactoryException;
import org.opengis.referencing.crs.CoordinateReferenceSystem;

import javax.swing.JComponent;
import javax.swing.JRadioButton;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.util.ArrayList;

/**
 * @author Marco Peters
 * @since BEAM 4.7
 */
public abstract class CrsForm {

    private AppContext appContext;
    private Product referenceProduct;
    private ArrayList<PropertyChangeListener> changeListeners;
    private JComponent crsComponent;
    private JRadioButton radioButton;

    protected CrsForm(AppContext appContext) {
        this.appContext = appContext;
        changeListeners = new ArrayList<PropertyChangeListener>();
    }

    protected abstract String getLabelText();

    boolean wrapAfterButton() {
        return false;
    }

    public final JRadioButton getRadioButton(){
        if(radioButton == null) {
            radioButton = createRadioButton();
        }
        return radioButton;
    }

    protected JRadioButton createRadioButton() {
        return new JRadioButton(getLabelText());
    }


    public abstract CoordinateReferenceSystem getCRS(GeoPos referencePos) throws FactoryException;

    public final JComponent getCrsUI() {
        if(crsComponent == null) {
            crsComponent = createCrsComponent();
        }
        return crsComponent;
    }

    protected abstract JComponent createCrsComponent();

    public void setReferenceProduct(Product product) {
        referenceProduct = product;
    }


    protected Product getReferenceProduct() {
        return referenceProduct;
    }

    protected AppContext getAppContext() {
        return appContext;
    }

    protected void fireCrsChanged() {
        for (PropertyChangeListener listener : changeListeners) {
            listener.propertyChange(new PropertyChangeEvent(this, "crs", null, null));
        }
    }

    protected boolean addCrsChangeListener(PropertyChangeListener listener) {
        if (!changeListeners.contains(listener)) {
            return changeListeners.add(listener);
        }
        return false;
    }

    protected boolean removeCrsChangeListener(PropertyChangeListener listener) {
        if (changeListeners.contains(listener)) {
            return changeListeners.remove(listener);
        }
        return false;
    }

    public abstract void prepareShow();

    public abstract void prepareHide();
}