J. Duke | 319a3b9 | 2007-12-01 00:00:00 +0000 | [diff] [blame^] | 1 | /* |
| 2 | * Copyright 1998-2001 Sun Microsystems, Inc. All Rights Reserved. |
| 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 | * |
| 5 | * This code is free software; you can redistribute it and/or modify it |
| 6 | * under the terms of the GNU General Public License version 2 only, as |
| 7 | * published by the Free Software Foundation. Sun designates this |
| 8 | * particular file as subject to the "Classpath" exception as provided |
| 9 | * by Sun in the LICENSE file that accompanied this code. |
| 10 | * |
| 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| 15 | * accompanied this code). |
| 16 | * |
| 17 | * You should have received a copy of the GNU General Public License version |
| 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| 20 | * |
| 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| 23 | * have any questions. |
| 24 | */ |
| 25 | |
| 26 | package javax.swing.colorchooser; |
| 27 | |
| 28 | import javax.swing.*; |
| 29 | import javax.swing.event.*; |
| 30 | import java.awt.Color; |
| 31 | |
| 32 | /** |
| 33 | * A model that supports selecting a <code>Color</code>. |
| 34 | * |
| 35 | * @author Steve Wilson |
| 36 | * |
| 37 | * @see java.awt.Color |
| 38 | */ |
| 39 | public interface ColorSelectionModel { |
| 40 | /** |
| 41 | * Returns the selected <code>Color</code> which should be |
| 42 | * non-<code>null</code>. |
| 43 | * |
| 44 | * @return the selected <code>Color</code> |
| 45 | * @see #setSelectedColor |
| 46 | */ |
| 47 | Color getSelectedColor(); |
| 48 | |
| 49 | /** |
| 50 | * Sets the selected color to <code>color</code>. |
| 51 | * Note that setting the color to <code>null</code> |
| 52 | * is undefined and may have unpredictable results. |
| 53 | * This method fires a state changed event if it sets the |
| 54 | * current color to a new non-<code>null</code> color. |
| 55 | * |
| 56 | * @param color the new <code>Color</code> |
| 57 | * @see #getSelectedColor |
| 58 | * @see #addChangeListener |
| 59 | */ |
| 60 | void setSelectedColor(Color color); |
| 61 | |
| 62 | /** |
| 63 | * Adds <code>listener</code> as a listener to changes in the model. |
| 64 | * @param listener the <code>ChangeListener</code> to be added |
| 65 | */ |
| 66 | void addChangeListener(ChangeListener listener); |
| 67 | |
| 68 | /** |
| 69 | * Removes <code>listener</code> as a listener to changes in the model. |
| 70 | * @param listener the <code>ChangeListener</code> to be removed |
| 71 | */ |
| 72 | void removeChangeListener(ChangeListener listener); |
| 73 | } |