summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Gilbert <david.gilbert@object-refinery.com>2006-03-05 20:13:06 +0000
committerDavid Gilbert <david.gilbert@object-refinery.com>2006-03-05 20:13:06 +0000
commit793689d6095ef8eb832bd02f97d4fef864de6d8f (patch)
treed538a55d016b2c2e770f3a136f0d9cf0d7a1c8b6
parent278768183a1889b516bba7249ae188d988490983 (diff)
downloadclasspath-793689d6095ef8eb832bd02f97d4fef864de6d8f.tar.gz
2006-03-05 David Gilbert <david.gilbert@object-refinery.com>
* javax/swing/colorchooser/ColorSelectionModel.java: Reformatted and added API docs all over. ----------------------------------------------------------------------
-rw-r--r--ChangeLog5
-rw-r--r--javax/swing/colorchooser/ColorSelectionModel.java75
2 files changed, 45 insertions, 35 deletions
diff --git a/ChangeLog b/ChangeLog
index abfd0942b..a11a676cf 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,10 @@
2006-03-05 David Gilbert <david.gilbert@object-refinery.com>
+ * javax/swing/colorchooser/ColorSelectionModel.java: Reformatted and
+ added API docs all over.
+
+2006-03-05 David Gilbert <david.gilbert@object-refinery.com>
+
* javax/swing/filechooser/FileFilter.java:
(accept): Fixed API doc tag,
(getDescription): Likewise,
diff --git a/javax/swing/colorchooser/ColorSelectionModel.java b/javax/swing/colorchooser/ColorSelectionModel.java
index 5f3070813..b660505fc 100644
--- a/javax/swing/colorchooser/ColorSelectionModel.java
+++ b/javax/swing/colorchooser/ColorSelectionModel.java
@@ -1,5 +1,5 @@
/* ColorSelectionModel.java --
- Copyright (C) 2002, 2004 Free Software Foundation, Inc.
+ Copyright (C) 2002, 2004, 2006, Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -40,42 +40,47 @@ package javax.swing.colorchooser;
import java.awt.Color;
+import javax.swing.JColorChooser;
+import javax.swing.event.ChangeEvent;
import javax.swing.event.ChangeListener;
/**
- * ColorSelectionModel
+ * A model that is used by the {@link JColorChooser} component to represent the
+ * selected color.
+ *
* @author Andrew Selkirk
- * @version 1.0
*/
-public interface ColorSelectionModel {
-
- //-------------------------------------------------------------
- // Methods ----------------------------------------------------
- //-------------------------------------------------------------
-
- /**
- * getSelectedColor
- * @returns Color
- */
- Color getSelectedColor();
-
- /**
- * setSelectedColor
- * @param color TODO
- */
- void setSelectedColor(Color color);
-
- /**
- * addChangeListener
- * @param listener TODO
- */
- void addChangeListener(ChangeListener listener);
-
- /**
- * removeChangeListener
- * @param listener TODO
- */
- void removeChangeListener(ChangeListener listener);
-
-
-} // ColorSelectionModel
+public interface ColorSelectionModel
+{
+
+ /**
+ * Returns the selected color.
+ *
+ * @return The selected color.
+ */
+ Color getSelectedColor();
+
+ /**
+ * Sets the selected color.
+ *
+ * @param color the selected color.
+ */
+ void setSelectedColor(Color color);
+
+ /**
+ * Registers a listener to receive {@link ChangeEvent} notifications
+ * from this model.
+ *
+ * @param listener the listener.
+ */
+ void addChangeListener(ChangeListener listener);
+
+ /**
+ * Deregisters a listener so that it no longer receives {@link ChangeEvent}
+ * notifications from this action.
+ *
+ * @param listener the listener.
+ */
+ void removeChangeListener(ChangeListener listener);
+
+}