LayerEditor.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.layer;

import com.bc.ceres.glayer.Layer;

import javax.swing.JComponent;
import javax.swing.JLabel;

/**
 * An editor for a specific layer type.
 * <p>
 * <i>Note: This API is not public yet and may significantly change in the future. Use it at your own risk.</i>
 *
 * @author Norman Fomferra
 * @version $Revision$ $Date$
 * @since BEAM 4.6
 */
public interface LayerEditor {

    LayerEditor EMPTY = new AbstractLayerEditor() {
        @Override
        public JComponent createControl() {
            return new JLabel("No editor available.");
        }
    };

    /**
     * Creates the control for the user interface which is displayed
     * in the Layer Editor Toolview.
     *
     * @param layer The layer to create the control for.
     * @return The control.
     */
    JComponent createControl(Layer layer);

    /**
     * Called y the framework in order to inform this editor that it has been attached to the Layer Editor Toolview.
     */
    void handleEditorAttached();

    /**
     * Called y the framework in order to inform this editor that it has been detached from the Layer Editor Toolview.
     */
    void handleEditorDetached();

    /**
     * Called y the framework in order to inform this editor that the current layer has changed.
     * Usually the the editor control must be updated in this case.
     */
    void handleLayerContentChanged();
}