[trident~source:106] Javadocs + code cleanup

[kirillg@kenai.com]

Project:    trident
Repository: source
Revision:   106
Author:     kirillg
Date:       2010-03-08 04:40:07 UTC
Link:       

Log Message:
------------
Javadocs + code cleanup


Revisions:
----------
106


Modified Paths:
---------------
src/test/CustomSetter.java
src/test/CustomAccessor.java
src/org/pushingpixels/trident/Timeline.java
src/test/HelloWorld.java


Diffs:
------
Index: src/test/CustomSetter.java
===================================================================
--- src/test/CustomSetter.java  (revision 105)
+++ src/test/CustomSetter.java  (revision 106)
@@ -15,7 +15,7 @@
                PropertySetter<Float> propertySetter = new 
PropertySetter<Float>() {
                        @Override
                        public void set(Object obj, String fieldName, Float 
value) {
-                               SimpleDateFormat sdf = new 
SimpleDateFormat("ss:SSS");
+                               SimpleDateFormat sdf = new 
SimpleDateFormat("ss.SSS");
                                float oldValue = helloWorld.value;
                                System.out.println(sdf.format(new Date()) + " 
: " + oldValue
                                                + " -> " + value);
Index: src/test/HelloWorld.java
===================================================================
--- src/test/HelloWorld.java    (revision 105)
+++ src/test/HelloWorld.java    (revision 106)
@@ -20,5 +20,6 @@
                        Thread.sleep(3000);
                } catch (Exception exc) {
                }
+
        }
 }
Index: src/test/CustomAccessor.java
===================================================================
--- src/test/CustomAccessor.java        (revision 105)
+++ src/test/CustomAccessor.java        (revision 106)
@@ -21,7 +21,7 @@
 
                        @Override
                        public void set(Object obj, String fieldName, Float 
value) {
-                               SimpleDateFormat sdf = new 
SimpleDateFormat("ss:SSS");
+                               SimpleDateFormat sdf = new 
SimpleDateFormat("ss.SSS");
                                float oldValue = 
helloWorld.values.get("value");
                                System.out.println(sdf.format(new Date()) + " 
: " + oldValue
                                                + " -> " + value);
Index: src/org/pushingpixels/trident/Timeline.java
===================================================================
--- src/org/pushingpixels/trident/Timeline.java (revision 105)
+++ src/org/pushingpixels/trident/Timeline.java (revision 106)
@@ -470,16 +470,47 @@
                                });
        }
 
+       /**
+        * Cancels this timeline. The timeline transitions to the
+        * {@link TimelineState#CANCELLED} state, preserving its current 
timeline
+        * position. After application callbacks and field interpolations are 
done
+        * on the {@link TimelineState#CANCELLED} state, the timeline 
transitions to
+        * the {@link TimelineState#IDLE} state. Application callbacks and 
field
+        * interpolations are done on this state as well.
+        * 
+        * @see #end()
+        * @see #abort()
+        */
        public void cancel() {
                TimelineEngine.getInstance().runTimelineOperation(this,
                                TimelineOperationKind.CANCEL, null);
        }
 
+       /**
+        * Ends this timeline. The timeline transitions to the
+        * {@link TimelineState#DONE} state, with the timeline position set 
to 0.0
+        * or 1.0 - based on the direction of the timeline. After application
+        * callbacks and field interpolations are done on the
+        * {@link TimelineState#DONE} state, the timeline transitions to the
+        * {@link TimelineState#IDLE} state. Application callbacks and field
+        * interpolations are done on this state as well.
+        * 
+        * @see #cancel()
+        * @see #abort()
+        */
        public void end() {
                TimelineEngine.getInstance().runTimelineOperation(this,
                                TimelineOperationKind.END, null);
        }
 
+       /**
+        * Aborts this timeline. The timeline transitions to the
+        * {@link TimelineState#IDLE} state. No application callbacks or field
+        * interpolations are done.
+        * 
+        * @see #cancel()
+        * @see #end()
+        */
        public void abort() {
                TimelineEngine.getInstance().runTimelineOperation(this,
                                TimelineOperationKind.ABORT, null);