/*

 * Copyright 1998-2001 Sun Microsystems, Inc.  All Rights Reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the LICENSE file that accompanied this code.

 *

 * This code 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

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 */

package javax.swing.colorchooser;

import javax.swing.*;

import javax.swing.event.*;

import java.awt.Color;

/**

 * A model that supports selecting a <code>Color</code>.

 *

 * @author Steve Wilson

 *

 * @see java.awt.Color

 */

public interface ColorSelectionModel {

    /**

     * Returns the selected <code>Color</code> which should be

     * non-<code>null</code>.

     *

     * @return  the selected <code>Color</code>

     * @see     #setSelectedColor

     */

    Color getSelectedColor();

    /**

     * Sets the selected color to <code>color</code>.

     * Note that setting the color to <code>null</code>

     * is undefined and may have unpredictable results.

     * This method fires a state changed event if it sets the

     * current color to a new non-<code>null</code> color.

     *

     * @param color the new <code>Color</code>

     * @see   #getSelectedColor

     * @see   #addChangeListener

     */

    void setSelectedColor(Color color);

    /**

     * Adds <code>listener</code> as a listener to changes in the model.

     * @param listener the <code>ChangeListener</code> to be added

     */

    void addChangeListener(ChangeListener listener);

    /**

     * Removes <code>listener</code> as a listener to changes in the model.

     * @param listener the <code>ChangeListener</code> to be removed

     */

    void removeChangeListener(ChangeListener listener);

}