comments and example code for slider

svn changeset:2408/svn branch:trunk

diff --git a/src/com/itmill/toolkit/ui/Slider.java b/src/com/itmill/toolkit/ui/Slider.java
index 495eac6dc877995c8adef424ae2db3b4c7851b58..19e6a1a9c97260a2e57dcf1dcadfaef558d78c62 100644 (file)
--- a/src/com/itmill/toolkit/ui/Slider.java
+++ b/src/com/itmill/toolkit/ui/Slider.java
@@ -5,6 +5,41 @@ import java.util.Map;
 import com.itmill.toolkit.terminal.PaintException;\r
 import com.itmill.toolkit.terminal.PaintTarget;\r
 \r
+/**\r
+ * TODO comment\r
+ *\r
+ * Example code:\r
+ * <code>\r
+ *     class MyPlayer extends CustomComponent implements ValueChangeListener {\r
+ *             \r
+ *             Label volumeIndicator = new Label();\r
+ *             Slider slider;\r
+ *             \r
+ *             public MyPlayer() {\r
+ *                     OrderedLayout ol = new OrderedLayout();\r
+ *                     setCompositionRoot(ol);\r
+ *                     slider = new Slider("Volume", 0, 100);\r
+ *                     slider.setImmediate(true);\r
+ *                     ol.addComponent(slider);\r
+ *                     ol.addComponent(volumeIndicator);\r
+ *                     volumeIndicator.setValue(new Double(50));\r
+ *                     slider.addListener(this);\r
+ *                     \r
+ *             }\r
+ *             \r
+ *             public void setVolume(double d) {\r
+ *                     volumeIndicator.setValue("Current volume : " + d);\r
+ *             }\r
+ *\r
+ *             public void valueChange(ValueChangeEvent event) {\r
+ *                     Double d = (Double) event.getProperty().getValue();\r
+ *                     setVolume(d.doubleValue());\r
+ *             }\r
+ *     }\r
+ *\r
+ * </code>\r
+ *\r
+ */\r
 public class Slider extends AbstractField {\r
 \r
        public static final int ORIENTATION_HORIZONTAL = 0;\r
@@ -86,6 +121,12 @@ public class Slider extends AbstractField {
                setResolution(resolution);\r
        }\r
 \r
+       /**\r
+        * Create a new slider with given range\r
+        * \r
+        * @param min\r
+        * @param max\r
+        */\r
        public Slider(int min, int max) {\r
                this();\r
                setMin(min);\r
@@ -93,11 +134,23 @@ public class Slider extends AbstractField {
                setResolution(0);\r
        }\r
 \r
+       /**\r
+        * Create a new slider with given caption and range\r
+        * \r
+        * @param caption\r
+        * @param min\r
+        * @param max\r
+        */\r
        public Slider(String caption, int min, int max) {\r
                this(min, max);\r
                setCaption(caption);\r
        }\r
 \r
+       /**\r
+        * Gets the biggest possible value in Sliders range.\r
+        * \r
+        * @return the biggest value slider can have\r
+        */\r
        public double getMax() {\r
                return max;\r
        }\r
@@ -120,6 +173,11 @@ public class Slider extends AbstractField {
                requestRepaint();\r
        }\r
 \r
+       /**\r
+        * Gets the minimum value in Sliders range.\r
+        * \r
+        * @return the smalles value slider can have\r
+        */\r
        public double getMin() {\r
                return min;\r
        }\r