AbstractFeatureInfoDisplay.java

/***************************************************
*
* cismet GmbH, Saarbruecken, Germany
*
*              ... and it just works.
*
****************************************************/
package de.cismet.cismap.commons.gui.featureinfowidget;

import javax.swing.JComponent;
import javax.swing.JPanel;

/**
 * DOCUMENT ME!
 *
 * @author   martin.scholl@cismet.de
 * @version  $Revision$, $Date$
 */
public abstract class AbstractFeatureInfoDisplay<T> extends JPanel implements FeatureInfoDisplay<T> {

    //~ Instance fields --------------------------------------------------------

    private final FeatureInfoDisplayKey displayKey;

    //~ Constructors -----------------------------------------------------------

    /**
     * Creates a new AbstractFeatureInfoDisplay object.
     *
     * @param   displayKey  the {@link FeatureInfoDisplayKey} of this display
     *
     * @throws  IllegalArgumentException  if the given display key is <code>null</code>
     */
    public AbstractFeatureInfoDisplay(final FeatureInfoDisplayKey displayKey) {
        if (displayKey == null) {
            throw new IllegalArgumentException("not allowed to use null display key"); // NOI18N
        }

        this.displayKey = displayKey;
    }

    //~ Methods ----------------------------------------------------------------

    @Override
    public final JComponent getDisplayComponent() {
        return this;
    }

    @Override
    public FeatureInfoDisplayKey getDisplayKey() {
        return displayKey;
    }
}