/*
 This file is part of the software framework JStatCom, 
 a library for building applications for data based analysis.

 Copyright (C) 2000-2005  Markus Kraetzig

 This library is free software; you can redistribute it and/or modify
 it under the terms of the GNU Lesser General Public License as
 published by the Free Software Foundation; either version 2.1 of the
 License, or (at your option) any later version.

 This library 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
 Lesser General Public License for more details.

 You should have received a copy of the GNU Lesser General Public
 License along with this library; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 USA
 */

package com.jstatcom.model.control;

import javax.swing.JPanel;

import com.jstatcom.model.Symbol;
import com.jstatcom.model.SymbolEvent;
import com.jstatcom.model.SymbolListener;

/**
 * To be subclassed by all panels that are used in SymbolFrame to
 * display a certain data object.
 * 
 * @author Markus Kraetzig 
 */
public abstract class SymbolPanel extends JPanel implements SymbolListener {

    /**
     * Sets the symbol to be displayed by this panel.
     * 
     * @param symbol
     */
    public abstract void setSymbol(Symbol symbol);

    /**
     * Update the symbol display.
     * 
     * @param evt
     *            the symbol event
     */
    public void valueChanged(SymbolEvent evt) {
        setSymbol(evt.getSource());
    }

    /**
     * Sets whether data in this symbol panel should be editable.
     * 
     * @param editable
     *            true if editable, false is
     *            default
     */
    public abstract void setSymbolEditable(boolean editable);

}