01 /*
02 * Copyright 1998-2001 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * 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 * @version 1.18 05/05/07
36 * @author Steve Wilson
37 *
38 * @see java.awt.Color
39 */
40 public interface ColorSelectionModel {
41 /**
42 * Returns the selected <code>Color</code> which should be
43 * non-<code>null</code>.
44 *
45 * @return the selected <code>Color</code>
46 * @see #setSelectedColor
47 */
48 Color getSelectedColor();
49
50 /**
51 * Sets the selected color to <code>color</code>.
52 * Note that setting the color to <code>null</code>
53 * is undefined and may have unpredictable results.
54 * This method fires a state changed event if it sets the
55 * current color to a new non-<code>null</code> color.
56 *
57 * @param color the new <code>Color</code>
58 * @see #getSelectedColor
59 * @see #addChangeListener
60 */
61 void setSelectedColor(Color color);
62
63 /**
64 * Adds <code>listener</code> as a listener to changes in the model.
65 * @param listener the <code>ChangeListener</code> to be added
66 */
67 void addChangeListener(ChangeListener listener);
68
69 /**
70 * Removes <code>listener</code> as a listener to changes in the model.
71 * @param listener the <code>ChangeListener</code> to be removed
72 */
73 void removeChangeListener(ChangeListener listener);
74 }
|