]> source.dussan.org Git - gwtquery.git/commitdiff
update javadocs
authorJulien Dramaix <julien.dramaix@gmail.com>
Fri, 22 Apr 2011 09:33:16 +0000 (09:33 +0000)
committerJulien Dramaix <julien.dramaix@gmail.com>
Fri, 22 Apr 2011 09:33:16 +0000 (09:33 +0000)
gwtquery-core/src/main/java/com/google/gwt/query/client/GQuery.java
gwtquery-core/src/main/java/com/google/gwt/query/client/LazyGQuery.java
gwtquery-core/src/main/java/com/google/gwt/query/client/plugins/Effects.java
gwtquery-core/src/main/java/com/google/gwt/query/client/plugins/LazyEffects.java

index 587edbf6d75999d0b7f90de06e46cd31bdf64c67..c0c337ac243dcb133069a821579a351a896a5f1b 100644 (file)
@@ -414,7 +414,7 @@ public class GQuery implements Lazy<GQuery, LazyGQuery> {
   private static JsNodeArray copyNodeList(NodeList<? extends Node> n) {\r
     JsNodeArray res = JsNodeArray.create();\r
     for (int i = 0; i < n.getLength(); i++) {\r
-      res.addNode(n.getItem(i));\r
+      res.addNode(n.getItem(i), i);\r
     }\r
     return res;\r
   }\r
@@ -572,11 +572,11 @@ public class GQuery implements Lazy<GQuery, LazyGQuery> {
 \r
   /**\r
    * The animate() method allows you to create animation effects on any numeric\r
-   * CSS property. All animated properties should be numeric, non-numeric cannot\r
-   * be animated using basic functionality. (For example, width, height, or left\r
-   * can be animated but background-color cannot be.) Property values are\r
-   * treated as a number of pixels unless otherwise specified. The units em and\r
-   * % can be specified where applicable.\r
+   * CSS property or any color CSS property.\r
+   * \r
+   * Concerning numeric property, values are treated as a number of pixels\r
+   * unless otherwise specified. The units em and % can be specified where\r
+   * applicable.\r
    * \r
    * Example:\r
    * \r
@@ -601,6 +601,15 @@ public class GQuery implements Lazy<GQuery, LazyGQuery> {
    *  $("#foo").animate(Properties.create("{top:'+=500px',left:'+=500px'}"), 400, Easing.SWING);\r
    * </pre>\r
    * \r
+   * For color css properties, values can be specified via hexadecimal or rgb or\r
+   * literal values.\r
+   * \r
+   * Example:\r
+   * \r
+   * <pre class="code">\r
+   *  $("#foo").animate(Properties.create("{backgroundColor:'red', color:'#ffffff', borderColor:'rgb(129, 0, 70)'}"), 400, Easing.SWING);\r
+   * </pre>\r
+   * \r
    * @param p a {@link Properties} object containing css properties to animate.\r
    * @param funcs an array of {@link Function} called once the animation is\r
    *          complete\r
@@ -613,12 +622,13 @@ public class GQuery implements Lazy<GQuery, LazyGQuery> {
   }\r
 \r
   /**\r
+   * \r
    * The animate() method allows you to create animation effects on any numeric\r
-   * CSS property. All animated properties should be numeric, non-numeric cannot\r
-   * be animated using basic functionality. (For example, width, height, or left\r
-   * can be animated but background-color cannot be.) Property values are\r
-   * treated as a number of pixels unless otherwise specified. The units em and\r
-   * % can be specified where applicable.\r
+   * CSS property or any color CSS property.\r
+   * \r
+   * Concerning numeric property, values are treated as a number of pixels\r
+   * unless otherwise specified. The units em and % can be specified where\r
+   * applicable.\r
    * \r
    * Example:\r
    * \r
@@ -650,10 +660,18 @@ public class GQuery implements Lazy<GQuery, LazyGQuery> {
    * \r
    * The duration of the animation is 500ms.\r
    * \r
+   * For color css properties, values can be specified via hexadecimal or rgb or\r
+   * literal values.\r
+   * \r
+   * Example:\r
+   * \r
+   * <pre class="code">\r
+   *  $("#foo").animate("backgroundColor:'red', color:'#ffffff', borderColor:'rgb(129, 0, 70)'");\r
+   * </pre>\r
+   * \r
    * @param prop the property to animate : "cssName:'value'"\r
    * @param funcs an array of {@link Function} called once the animation is\r
    *          complete\r
-   * @param duration the duration in milliseconds of the animation\r
    */\r
   public GQuery animate(String prop, Function... funcs) {\r
     return as(Effects).animate(prop, funcs);\r
@@ -661,12 +679,11 @@ public class GQuery implements Lazy<GQuery, LazyGQuery> {
 \r
   /**\r
    * The animate() method allows you to create animation effects on any numeric\r
-   * CSS property. All animated properties should be numeric, non-numeric cannot\r
-   * be animated using basic functionality. (For example, width, height, or left\r
-   * can be animated but background-color cannot be.) Property values are\r
-   * treated as a number of pixels unless otherwise specified. The units em and\r
-   * % can be specified where applicable.\r
+   * CSS property or any color CSS property.\r
    * \r
+   * Concerning numeric property, values are treated as a number of pixels\r
+   * unless otherwise specified. The units em and % can be specified where\r
+   * applicable.\r
    * \r
    * Example:\r
    * \r
@@ -697,6 +714,16 @@ public class GQuery implements Lazy<GQuery, LazyGQuery> {
    * </pre>\r
    * \r
    * \r
+   * For color css properties, values can be specified via hexadecimal or rgb or\r
+   * literal values.\r
+   * \r
+   * Example:\r
+   * \r
+   * <pre class="code">\r
+   *  $("#foo").animate("backgroundColor:'red', color:'#ffffff', borderColor:'rgb(129, 0, 70)', 1000");\r
+   * </pre>\r
+   * \r
+   * \r
    * @param prop the property to animate : "cssName:'value'"\r
    * @param funcs an array of {@link Function} called once the animation is\r
    *          complete\r
index 2553bb4ff07b1a5eb438812bf7724364e15d71e4..ac18ffb0560282a043284bd74e8352329a000e0d 100644 (file)
@@ -107,11 +107,11 @@ public interface LazyGQuery<T> extends LazyBase<T>{
 
   /**
    * The animate() method allows you to create animation effects on any numeric
-   * CSS property. All animated properties should be numeric, non-numeric cannot
-   * be animated using basic functionality. (For example, width, height, or left
-   * can be animated but background-color cannot be.) Property values are
-   * treated as a number of pixels unless otherwise specified. The units em and
-   * % can be specified where applicable.
+   * CSS property or any color CSS property.
+   * 
+   * Concerning numeric property, values are treated as a number of pixels
+   * unless otherwise specified. The units em and % can be specified where
+   * applicable.
    * 
    * Example:
    * 
@@ -136,6 +136,15 @@ public interface LazyGQuery<T> extends LazyBase<T>{
    *  $("#foo").animate(Properties.create("{top:'+=500px',left:'+=500px'}"), 400, Easing.SWING);
    * </pre>
    * 
+   * For color css properties, values can be specified via hexadecimal or rgb or
+   * literal values.
+   * 
+   * Example:
+   * 
+   * <pre class="code">
+   *  $("#foo").animate(Properties.create("{backgroundColor:'red', color:'#ffffff', borderColor:'rgb(129, 0, 70)'}"), 400, Easing.SWING);
+   * </pre>
+   * 
    * @param p a {@link Properties} object containing css properties to animate.
    * @param funcs an array of {@link Function} called once the animation is
    *          complete
@@ -145,12 +154,13 @@ public interface LazyGQuery<T> extends LazyBase<T>{
   LazyGQuery<T> animate(Properties p, int duration, Easing easing, Function... funcs);
 
   /**
+   * 
    * The animate() method allows you to create animation effects on any numeric
-   * CSS property. All animated properties should be numeric, non-numeric cannot
-   * be animated using basic functionality. (For example, width, height, or left
-   * can be animated but background-color cannot be.) Property values are
-   * treated as a number of pixels unless otherwise specified. The units em and
-   * % can be specified where applicable.
+   * CSS property or any color CSS property.
+   * 
+   * Concerning numeric property, values are treated as a number of pixels
+   * unless otherwise specified. The units em and % can be specified where
+   * applicable.
    * 
    * Example:
    * 
@@ -182,21 +192,28 @@ public interface LazyGQuery<T> extends LazyBase<T>{
    * 
    * The duration of the animation is 500ms.
    * 
+   * For color css properties, values can be specified via hexadecimal or rgb or
+   * literal values.
+   * 
+   * Example:
+   * 
+   * <pre class="code">
+   *  $("#foo").animate("backgroundColor:'red', color:'#ffffff', borderColor:'rgb(129, 0, 70)'");
+   * </pre>
+   * 
    * @param prop the property to animate : "cssName:'value'"
    * @param funcs an array of {@link Function} called once the animation is
    *          complete
-   * @param duration the duration in milliseconds of the animation
    */
   LazyGQuery<T> animate(String prop, Function... funcs);
 
   /**
    * The animate() method allows you to create animation effects on any numeric
-   * CSS property. All animated properties should be numeric, non-numeric cannot
-   * be animated using basic functionality. (For example, width, height, or left
-   * can be animated but background-color cannot be.) Property values are
-   * treated as a number of pixels unless otherwise specified. The units em and
-   * % can be specified where applicable.
+   * CSS property or any color CSS property.
    * 
+   * Concerning numeric property, values are treated as a number of pixels
+   * unless otherwise specified. The units em and % can be specified where
+   * applicable.
    * 
    * Example:
    * 
@@ -227,6 +244,16 @@ public interface LazyGQuery<T> extends LazyBase<T>{
    * </pre>
    * 
    * 
+   * For color css properties, values can be specified via hexadecimal or rgb or
+   * literal values.
+   * 
+   * Example:
+   * 
+   * <pre class="code">
+   *  $("#foo").animate("backgroundColor:'red', color:'#ffffff', borderColor:'rgb(129, 0, 70)', 1000");
+   * </pre>
+   * 
+   * 
    * @param prop the property to animate : "cssName:'value'"
    * @param funcs an array of {@link Function} called once the animation is
    *          complete
index ec903aa48164c3b7ac672992f18d1b2adc2cb16e..e45c1e957601247b38c9b5a5554739311c36c77b 100755 (executable)
@@ -27,10 +27,10 @@ import com.google.gwt.query.client.plugins.effects.ClipAnimation.Direction;
 import com.google.gwt.query.client.plugins.effects.PropertiesAnimation.Easing;\r
 \r
 /**\r
- *  Effects plugin for Gwt Query. \r
+ * Effects plugin for Gwt Query.\r
  */\r
-public class Effects extends QueuePlugin<Effects>  {\r
-  \r
+public class Effects extends QueuePlugin<Effects> {\r
+\r
   /**\r
    * Just a class to store predefined speed constant values.\r
    */\r
@@ -57,21 +57,45 @@ public class Effects extends QueuePlugin<Effects>  {
   }\r
 \r
   /**\r
-   * The animate() method allows us to create animation effects on any numeric CSS property. \r
-   * The only required parameter is a map of CSS properties. \r
-   * This map is similar to the one that can be sent to the .css() method, \r
-   * except that the range of properties is more restrictive.\r
-   * All animated properties should be numeric, non-numeric cannot be animated using basic functionality. \r
-   * (For example, width, height, or left can be animated but background-color cannot be.) \r
-   * Property values are treated as a number of pixels unless otherwise specified.\r
-   *  The units em and % can be specified where applicable.\r
-   *  \r
-   *  In addition to numeric values, each property can take the strings 'show', 'hide', and 'toggle'. \r
-   *  These shortcuts allow for custom hiding and showing animations that take into account the display type of the element.\r
-   *  Animated properties can also be relative. If a value is supplied with a leading += or -= \r
-   *  sequence of characters, then the target value is computed by adding or subtracting the given number \r
-   *  from the current value of the property.\r
-   */  \r
+   * The animate() method allows you to create animation effects on any numeric\r
+   * CSS property or any color CSS property.\r
+   * \r
+   * Concerning numeric property, values are treated as a number of pixels\r
+   * unless otherwise specified. The units em and % can be specified where\r
+   * applicable.\r
+   * \r
+   * Example:\r
+   * \r
+   * <pre class="code">\r
+   *  //move the element from its original position to the position top:500px and left:500px for 400ms.\r
+   *  //use a swing easing function for the transition\r
+   *  $("#foo").animate(Properties.create("{top:'500px',left:'500px'}"), 400, Easing.SWING);\r
+   * </pre>\r
+   * \r
+   * In addition to numeric values, each property can take the strings 'show',\r
+   * 'hide', and 'toggle'. These shortcuts allow for custom hiding and showing\r
+   * animations that take into account the display type of the element. Animated\r
+   * properties can also be relative. If a value is supplied with a leading +=\r
+   * or -= sequence of characters, then the target value is computed by adding\r
+   * or subtracting the given number from the current value of the property.\r
+   * \r
+   * Example:\r
+   * \r
+   * <pre class="code">\r
+   *  //move the element from its original position to 500px to the left and 5OOpx down for 400ms.\r
+   *  //use a swing easing function for the transition\r
+   *  $("#foo").animate(Properties.create("{top:'+=500px',left:'+=500px'}"), 400, Easing.SWING);\r
+   * </pre>\r
+   * \r
+   * For color css properties, values can be specified via hexadecimal or rgb or\r
+   * literal values.\r
+   * \r
+   * Example:\r
+   * \r
+   * <pre class="code">\r
+   *  $("#foo").animate(Properties.create("{backgroundColor:'red', color:'#ffffff', borderColor:'rgb(129, 0, 70)'}"), 400, Easing.SWING);\r
+   * </pre>\r
+   */\r
   public Effects animate(final Properties p, final int duration,\r
       final Easing easing, final Function... funcs) {\r
     queue(new Function() {\r
@@ -92,50 +116,112 @@ public class Effects extends QueuePlugin<Effects>  {
   }\r
 \r
   /**\r
-   * The animate() method allows us to create animation effects on any numeric CSS property. \r
-   * The only required parameter is a map of CSS properties. \r
-   * This map is similar to the one that can be sent to the .css() method, \r
-   * except that the range of properties is more restrictive.\r
-   * All animated properties should be numeric, non-numeric cannot be animated using basic functionality. \r
-   * (For example, width, height, or left can be animated but background-color cannot be.) \r
-   * Property values are treated as a number of pixels unless otherwise specified.\r
-   *  The units em and % can be specified where applicable.\r
-   *  \r
-   *  In addition to numeric values, each property can take the strings 'show', 'hide', and 'toggle'. \r
-   *  These shortcuts allow for custom hiding and showing animations that take into account the display type of the element.\r
-   *  Animated properties can also be relative. If a value is supplied with a leading += or -= \r
-   *  sequence of characters, then the target value is computed by adding or subtracting the given number \r
-   *  from the current value of the property.\r
+   * The animate() method allows you to create animation effects on any numeric\r
+   * CSS property or any color CSS property.\r
+   * \r
+   * Concerning numeric property, values are treated as a number of pixels\r
+   * unless otherwise specified. The units em and % can be specified where\r
+   * applicable.\r
+   * \r
+   * Example:\r
+   * \r
+   * <pre class="code">\r
+   *  //move the element from its original position to left:500px for 500ms\r
+   *  $("#foo").animate("left:'500'");\r
+   * </pre>\r
+   * \r
+   * In addition to numeric values, each property can take the strings 'show',\r
+   * 'hide', and 'toggle'. These shortcuts allow for custom hiding and showing\r
+   * animations that take into account the display type of the element. Animated\r
+   * properties can also be relative. If a value is supplied with a leading +=\r
+   * or -= sequence of characters, then the target value is computed by adding\r
+   * or subtracting the given number from the current value of the property.\r
+   * \r
+   * Example:\r
+   * \r
+   * <pre class="code">\r
+   *  //move the element from its original position to 500px to the left for 500ms and\r
+   *  // change the background color of the element at the end of the animation\r
+   *  $("#foo").animate("left:'+=500'", new Function(){\r
+   *                  \r
+   *                 public void f(Element e){\r
+   *                   $(e).css(CSS.BACKGROUND_COLOR.with(RGBColor.RED);\r
+   *                 }\r
+   *                 \r
+   *              });\r
+   * </pre>\r
+   * \r
+   * The duration of the animation is 500ms.\r
+   * \r
+   * For color css properties, values can be specified via hexadecimal or rgb or\r
+   * literal values.\r
+   * \r
+   * Example:\r
+   * \r
+   * <pre class="code">\r
+   *  $("#foo").animate("backgroundColor:'red', color:'#ffffff', borderColor:'rgb(129, 0, 70)'");\r
+   * </pre>\r
    */\r
   public Effects animate(String prop, Function... funcs) {\r
     return animate(prop, 500, funcs);\r
   }\r
 \r
   /**\r
-   * The animate() method allows us to create animation effects on any numeric CSS property. \r
-   * The only required parameter is a map of CSS properties. \r
-   * This map is similar to the one that can be sent to the .css() method, \r
-   * except that the range of properties is more restrictive.\r
-   * All animated properties should be numeric, non-numeric cannot be animated using basic functionality. \r
-   * (For example, width, height, or left can be animated but background-color cannot be.) \r
-   * Property values are treated as a number of pixels unless otherwise specified.\r
-   *  The units em and % can be specified where applicable.\r
-   *  \r
-   *  In addition to numeric values, each property can take the strings 'show', 'hide', and 'toggle'. \r
-   *  These shortcuts allow for custom hiding and showing animations that take into account the display type of the element.\r
-   *  Animated properties can also be relative. If a value is supplied with a leading += or -= \r
-   *  sequence of characters, then the target value is computed by adding or subtracting the given number \r
-   *  from the current value of the property.\r
-   */  \r
+   * The animate() method allows you to create animation effects on any numeric\r
+   * CSS property or any color CSS property.\r
+   * \r
+   * Concerning numeric property, values are treated as a number of pixels\r
+   * unless otherwise specified. The units em and % can be specified where\r
+   * applicable.\r
+   * \r
+   * Example:\r
+   * \r
+   * <pre class="code">\r
+   *  //move the element from its original position to left:500px for 2s\r
+   *  $("#foo").animate("left:'500px'", 2000);\r
+   * </pre>\r
+   * \r
+   * In addition to numeric values, each property can take the strings 'show',\r
+   * 'hide', and 'toggle'. These shortcuts allow for custom hiding and showing\r
+   * animations that take into account the display type of the element. Animated\r
+   * properties can also be relative. If a value is supplied with a leading +=\r
+   * or -= sequence of characters, then the target value is computed by adding\r
+   * or subtracting the given number from the current value of the property.\r
+   * \r
+   * Example:\r
+   * \r
+   * <pre class="code">\r
+   *  //move the element from its original position to 500px to the left for 1000ms and\r
+   *  // change the background color of the element at the end of the animation\r
+   *  $("#foo").animate("left:'+=500'", 1000, new Function(){\r
+   *                  \r
+   *                 public void f(Element e){\r
+   *                   $(e).css(CSS.BACKGROUND_COLOR.with(RGBColor.RED);\r
+   *                 }\r
+   *                 \r
+   *              });\r
+   * </pre>\r
+   * \r
+   * \r
+   * For color css properties, values can be specified via hexadecimal or rgb or\r
+   * literal values.\r
+   * \r
+   * Example:\r
+   * \r
+   * <pre class="code">\r
+   *  $("#foo").animate("backgroundColor:'red', color:'#ffffff', borderColor:'rgb(129, 0, 70)', 1000");\r
+   * </pre>\r
+   * \r
+   */\r
   public Effects animate(String prop, int duration, Function... funcs) {\r
     return animate($$(prop), duration, Easing.LINEAR, funcs);\r
   }\r
 \r
   /**\r
-   * Animate the set of matched elements using the clip property.\r
-   * It is possible to show or hide a set of elements, \r
-   * specify the direction of the animation and the start corner of the effect.\r
-   * Finally it executes the set of functions passed as arguments.\r
+   * Animate the set of matched elements using the clip property. It is possible\r
+   * to show or hide a set of elements, specify the direction of the animation\r
+   * and the start corner of the effect. Finally it executes the set of\r
+   * functions passed as arguments.\r
    */\r
   public Effects clip(ClipAnimation.Action a, ClipAnimation.Corner c,\r
       ClipAnimation.Direction d, Function... f) {\r
@@ -148,8 +234,9 @@ public class Effects extends QueuePlugin<Effects>  {
    * and the start corner of the effect. Finally it executes the set of\r
    * functions passed as arguments.\r
    */\r
-  public Effects clip(final ClipAnimation.Action a, final ClipAnimation.Corner c, \r
-      final ClipAnimation.Direction d, final int duration, final Function... f) {\r
+  public Effects clip(final ClipAnimation.Action a,\r
+      final ClipAnimation.Corner c, final ClipAnimation.Direction d,\r
+      final int duration, final Function... f) {\r
     queue(new Function() {\r
       public void cancel(Element e) {\r
         Animation anim = (Animation) data(e, EFFECTS_RUNNNING, null);\r
@@ -168,10 +255,10 @@ public class Effects extends QueuePlugin<Effects>  {
   }\r
 \r
   /**\r
-   * Animate the set of matched elements using the clip property.\r
-   * It is possible to show or hide a set of elements, \r
-   * specify the direction of the animation and the start corner of the effect.\r
-   * Finally it executes the set of functions passed as arguments.\r
+   * Animate the set of matched elements using the clip property. It is possible\r
+   * to show or hide a set of elements, specify the direction of the animation\r
+   * and the start corner of the effect. Finally it executes the set of\r
+   * functions passed as arguments.\r
    */\r
   public Effects clip(ClipAnimation.Action a, ClipAnimation.Corner c,\r
       Function... f) {\r
@@ -180,8 +267,8 @@ public class Effects extends QueuePlugin<Effects>  {
 \r
   /**\r
    * Reveal all matched elements by adjusting the clip property firing an\r
-   * optional callback after completion.\r
-   * The effect goes from the center to the perimeter.\r
+   * optional callback after completion. The effect goes from the center to the\r
+   * perimeter.\r
    */\r
   public Effects clipAppear(Function... f) {\r
     return clipAppear(Speed.DEFAULT, f);\r
@@ -189,8 +276,8 @@ public class Effects extends QueuePlugin<Effects>  {
 \r
   /**\r
    * Reveal all matched elements by adjusting the clip property firing an\r
-   * optional callback after completion.\r
-   * The effect goes from the center to the perimeter.\r
+   * optional callback after completion. The effect goes from the center to the\r
+   * perimeter.\r
    */\r
   public Effects clipAppear(int millisecs, Function... f) {\r
     return clip(ClipAnimation.Action.SHOW, ClipAnimation.Corner.CENTER,\r
@@ -198,18 +285,18 @@ public class Effects extends QueuePlugin<Effects>  {
   }\r
 \r
   /**\r
-   * Hide all matched elements by adjusting the clip property firing an\r
-   * optional callback after completion.\r
-   * The effect goes from the perimeter to the center.\r
+   * Hide all matched elements by adjusting the clip property firing an optional\r
+   * callback after completion. The effect goes from the perimeter to the\r
+   * center.\r
    */\r
   public Effects clipDisappear(Function... f) {\r
     return clipDisappear(Speed.DEFAULT, f);\r
   }\r
 \r
   /**\r
-   * Hide all matched elements by adjusting the clip property firing an\r
-   * optional callback after completion.\r
-   * The effect goes from the perimeter to the center.\r
+   * Hide all matched elements by adjusting the clip property firing an optional\r
+   * callback after completion. The effect goes from the perimeter to the\r
+   * center.\r
    */\r
   public Effects clipDisappear(int millisecs, Function... f) {\r
     return clip(ClipAnimation.Action.HIDE, ClipAnimation.Corner.CENTER,\r
@@ -218,8 +305,8 @@ public class Effects extends QueuePlugin<Effects>  {
 \r
   /**\r
    * Reveal all matched elements by adjusting the clip property firing an\r
-   * optional callback after completion.\r
-   * The effect goes from the top to the bottom.\r
+   * optional callback after completion. The effect goes from the top to the\r
+   * bottom.\r
    */\r
   public Effects clipDown(Function... f) {\r
     return clipDown(Speed.DEFAULT, f);\r
@@ -227,8 +314,8 @@ public class Effects extends QueuePlugin<Effects>  {
 \r
   /**\r
    * Reveal all matched elements by adjusting the clip property firing an\r
-   * optional callback after completion.\r
-   * The effect goes from the top to the bottom.\r
+   * optional callback after completion. The effect goes from the top to the\r
+   * bottom.\r
    */\r
   public Effects clipDown(int millisecs, Function... f) {\r
     return clip(Action.SHOW, ClipAnimation.Corner.TOP_LEFT,\r
@@ -236,18 +323,18 @@ public class Effects extends QueuePlugin<Effects>  {
   }\r
 \r
   /**\r
-   * Toggle the visibility of all matched elements by adjusting the clip property\r
-   * and firing an optional callback after completion.\r
-   * The effect goes from the bottom to the top.\r
+   * Toggle the visibility of all matched elements by adjusting the clip\r
+   * property and firing an optional callback after completion. The effect goes\r
+   * from the bottom to the top.\r
    */\r
   public Effects clipToggle(Function... f) {\r
     return clipToggle(Speed.DEFAULT, f);\r
   }\r
 \r
   /**\r
-   * Toggle the visibility of all matched elements by adjusting the clip property\r
-   * and firing an optional callback after completion.\r
-   * The effect goes from the bottom to the top.\r
+   * Toggle the visibility of all matched elements by adjusting the clip\r
+   * property and firing an optional callback after completion. The effect goes\r
+   * from the bottom to the top.\r
    */\r
   public Effects clipToggle(int millisecs, Function... f) {\r
     return clip(Action.TOGGLE, ClipAnimation.Corner.TOP_LEFT,\r
@@ -255,18 +342,16 @@ public class Effects extends QueuePlugin<Effects>  {
   }\r
 \r
   /**\r
-   * Hide all matched elements by adjusting the clip property firing an\r
-   * optional callback after completion.\r
-   * The effect goes from the bottom to the top.\r
+   * Hide all matched elements by adjusting the clip property firing an optional\r
+   * callback after completion. The effect goes from the bottom to the top.\r
    */\r
   public Effects clipUp(Function... f) {\r
     return clipUp(Speed.DEFAULT, f);\r
   }\r
 \r
   /**\r
-   * Hide all matched elements by adjusting the clip property firing an\r
-   * optional callback after completion.\r
-   * The effect goes from the bottom to the top.\r
+   * Hide all matched elements by adjusting the clip property firing an optional\r
+   * callback after completion. The effect goes from the bottom to the top.\r
    */\r
   public Effects clipUp(int millisecs, Function... f) {\r
     return clip(Action.HIDE, ClipAnimation.Corner.TOP_LEFT,\r
@@ -278,7 +363,7 @@ public class Effects extends QueuePlugin<Effects>  {
    * optional callback after completion. Only the opacity is adjusted for this\r
    * animation, meaning that all of the matched elements should already have\r
    * some form of height and width associated with them.\r
-   */  \r
+   */\r
   public Effects fadeIn(Function... f) {\r
     return fadeIn(Speed.DEFAULT, f);\r
   }\r
@@ -299,7 +384,7 @@ public class Effects extends QueuePlugin<Effects>  {
    * the opacity is adjusted for this animation, meaning that all of the matched\r
    * elements should already have some form of height and width associated with\r
    * them.\r
-   */  \r
+   */\r
   public Effects fadeOut(Function... f) {\r
     return fadeOut(Speed.DEFAULT, f);\r
   }\r
@@ -310,11 +395,11 @@ public class Effects extends QueuePlugin<Effects>  {
    * the opacity is adjusted for this animation, meaning that all of the matched\r
    * elements should already have some form of height and width associated with\r
    * them.\r
-   */  \r
+   */\r
   public Effects fadeOut(int millisecs, Function... f) {\r
     return animate("opacity: 'hide'", millisecs, f);\r
   };\r
-  \r
+\r
   /**\r
    * Fade the opacity of all matched elements to a specified opacity and firing\r
    * an optional callback after completion. Only the opacity is adjusted for\r
@@ -378,16 +463,16 @@ public class Effects extends QueuePlugin<Effects>  {
   }\r
 \r
   /**\r
-   * Reveal all matched elements by adjusting their width and firing an\r
-   * optional callback after completion.\r
+   * Reveal all matched elements by adjusting their width and firing an optional\r
+   * callback after completion.\r
    */\r
   public Effects slideRight(Function... f) {\r
     return slideRight(Speed.DEFAULT, f);\r
   }\r
 \r
   /**\r
-   * Reveal all matched elements by adjusting their width and firing an\r
-   * optional callback after completion.\r
+   * Reveal all matched elements by adjusting their width and firing an optional\r
+   * callback after completion.\r
    */\r
   public Effects slideRight(final int millisecs, Function... f) {\r
     return animate("width: 'show'", millisecs, f);\r
index d62d037ab9d0a329c4feb22979dbb2e42af9e58d..e036169ba947e1ad6d945eb7ab0a2ada63ac1afd 100644 (file)
@@ -29,64 +29,150 @@ import com.google.gwt.query.client.LazyBase;
 public interface LazyEffects<T> extends LazyBase<T>{
 
   /**
-   * The animate() method allows us to create animation effects on any numeric CSS property. 
-   * The only required parameter is a map of CSS properties. 
-   * This map is similar to the one that can be sent to the .css() method, 
-   * except that the range of properties is more restrictive.
-   * All animated properties should be numeric, non-numeric cannot be animated using basic functionality. 
-   * (For example, width, height, or left can be animated but background-color cannot be.) 
-   * Property values are treated as a number of pixels unless otherwise specified.
-   *  The units em and % can be specified where applicable.
-   *  
-   *  In addition to numeric values, each property can take the strings 'show', 'hide', and 'toggle'. 
-   *  These shortcuts allow for custom hiding and showing animations that take into account the display type of the element.
-   *  Animated properties can also be relative. If a value is supplied with a leading += or -= 
-   *  sequence of characters, then the target value is computed by adding or subtracting the given number 
-   *  from the current value of the property.
-   */  
+   * The animate() method allows you to create animation effects on any numeric
+   * CSS property or any color CSS property.
+   * 
+   * Concerning numeric property, values are treated as a number of pixels
+   * unless otherwise specified. The units em and % can be specified where
+   * applicable.
+   * 
+   * Example:
+   * 
+   * <pre class="code">
+   *  //move the element from its original position to the position top:500px and left:500px for 400ms.
+   *  //use a swing easing function for the transition
+   *  $("#foo").animate(Properties.create("{top:'500px',left:'500px'}"), 400, Easing.SWING);
+   * </pre>
+   * 
+   * In addition to numeric values, each property can take the strings 'show',
+   * 'hide', and 'toggle'. These shortcuts allow for custom hiding and showing
+   * animations that take into account the display type of the element. Animated
+   * properties can also be relative. If a value is supplied with a leading +=
+   * or -= sequence of characters, then the target value is computed by adding
+   * or subtracting the given number from the current value of the property.
+   * 
+   * Example:
+   * 
+   * <pre class="code">
+   *  //move the element from its original position to 500px to the left and 5OOpx down for 400ms.
+   *  //use a swing easing function for the transition
+   *  $("#foo").animate(Properties.create("{top:'+=500px',left:'+=500px'}"), 400, Easing.SWING);
+   * </pre>
+   * 
+   * For color css properties, values can be specified via hexadecimal or rgb or
+   * literal values.
+   * 
+   * Example:
+   * 
+   * <pre class="code">
+   *  $("#foo").animate(Properties.create("{backgroundColor:'red', color:'#ffffff', borderColor:'rgb(129, 0, 70)'}"), 400, Easing.SWING);
+   * </pre>
+   */
   LazyEffects<T> animate(Properties p, int duration, Easing easing, Function... funcs);
 
   /**
-   * The animate() method allows us to create animation effects on any numeric CSS property. 
-   * The only required parameter is a map of CSS properties. 
-   * This map is similar to the one that can be sent to the .css() method, 
-   * except that the range of properties is more restrictive.
-   * All animated properties should be numeric, non-numeric cannot be animated using basic functionality. 
-   * (For example, width, height, or left can be animated but background-color cannot be.) 
-   * Property values are treated as a number of pixels unless otherwise specified.
-   *  The units em and % can be specified where applicable.
-   *  
-   *  In addition to numeric values, each property can take the strings 'show', 'hide', and 'toggle'. 
-   *  These shortcuts allow for custom hiding and showing animations that take into account the display type of the element.
-   *  Animated properties can also be relative. If a value is supplied with a leading += or -= 
-   *  sequence of characters, then the target value is computed by adding or subtracting the given number 
-   *  from the current value of the property.
+   * The animate() method allows you to create animation effects on any numeric
+   * CSS property or any color CSS property.
+   * 
+   * Concerning numeric property, values are treated as a number of pixels
+   * unless otherwise specified. The units em and % can be specified where
+   * applicable.
+   * 
+   * Example:
+   * 
+   * <pre class="code">
+   *  //move the element from its original position to left:500px for 500ms
+   *  $("#foo").animate("left:'500'");
+   * </pre>
+   * 
+   * In addition to numeric values, each property can take the strings 'show',
+   * 'hide', and 'toggle'. These shortcuts allow for custom hiding and showing
+   * animations that take into account the display type of the element. Animated
+   * properties can also be relative. If a value is supplied with a leading +=
+   * or -= sequence of characters, then the target value is computed by adding
+   * or subtracting the given number from the current value of the property.
+   * 
+   * Example:
+   * 
+   * <pre class="code">
+   *  //move the element from its original position to 500px to the left for 500ms and
+   *  // change the background color of the element at the end of the animation
+   *  $("#foo").animate("left:'+=500'", new Function(){
+   *                  
+   *                 public void f(Element e){
+   *                   $(e).css(CSS.BACKGROUND_COLOR.with(RGBColor.RED);
+   *                 }
+   *                 
+   *              });
+   * </pre>
+   * 
+   * The duration of the animation is 500ms.
+   * 
+   * For color css properties, values can be specified via hexadecimal or rgb or
+   * literal values.
+   * 
+   * Example:
+   * 
+   * <pre class="code">
+   *  $("#foo").animate("backgroundColor:'red', color:'#ffffff', borderColor:'rgb(129, 0, 70)'");
+   * </pre>
    */
   LazyEffects<T> animate(String prop, Function... funcs);
 
   /**
-   * The animate() method allows us to create animation effects on any numeric CSS property. 
-   * The only required parameter is a map of CSS properties. 
-   * This map is similar to the one that can be sent to the .css() method, 
-   * except that the range of properties is more restrictive.
-   * All animated properties should be numeric, non-numeric cannot be animated using basic functionality. 
-   * (For example, width, height, or left can be animated but background-color cannot be.) 
-   * Property values are treated as a number of pixels unless otherwise specified.
-   *  The units em and % can be specified where applicable.
-   *  
-   *  In addition to numeric values, each property can take the strings 'show', 'hide', and 'toggle'. 
-   *  These shortcuts allow for custom hiding and showing animations that take into account the display type of the element.
-   *  Animated properties can also be relative. If a value is supplied with a leading += or -= 
-   *  sequence of characters, then the target value is computed by adding or subtracting the given number 
-   *  from the current value of the property.
-   */  
+   * The animate() method allows you to create animation effects on any numeric
+   * CSS property or any color CSS property.
+   * 
+   * Concerning numeric property, values are treated as a number of pixels
+   * unless otherwise specified. The units em and % can be specified where
+   * applicable.
+   * 
+   * Example:
+   * 
+   * <pre class="code">
+   *  //move the element from its original position to left:500px for 2s
+   *  $("#foo").animate("left:'500px'", 2000);
+   * </pre>
+   * 
+   * In addition to numeric values, each property can take the strings 'show',
+   * 'hide', and 'toggle'. These shortcuts allow for custom hiding and showing
+   * animations that take into account the display type of the element. Animated
+   * properties can also be relative. If a value is supplied with a leading +=
+   * or -= sequence of characters, then the target value is computed by adding
+   * or subtracting the given number from the current value of the property.
+   * 
+   * Example:
+   * 
+   * <pre class="code">
+   *  //move the element from its original position to 500px to the left for 1000ms and
+   *  // change the background color of the element at the end of the animation
+   *  $("#foo").animate("left:'+=500'", 1000, new Function(){
+   *                  
+   *                 public void f(Element e){
+   *                   $(e).css(CSS.BACKGROUND_COLOR.with(RGBColor.RED);
+   *                 }
+   *                 
+   *              });
+   * </pre>
+   * 
+   * 
+   * For color css properties, values can be specified via hexadecimal or rgb or
+   * literal values.
+   * 
+   * Example:
+   * 
+   * <pre class="code">
+   *  $("#foo").animate("backgroundColor:'red', color:'#ffffff', borderColor:'rgb(129, 0, 70)', 1000");
+   * </pre>
+   * 
+   */
   LazyEffects<T> animate(String prop, int duration, Function... funcs);
 
   /**
-   * Animate the set of matched elements using the clip property.
-   * It is possible to show or hide a set of elements, 
-   * specify the direction of the animation and the start corner of the effect.
-   * Finally it executes the set of functions passed as arguments.
+   * Animate the set of matched elements using the clip property. It is possible
+   * to show or hide a set of elements, specify the direction of the animation
+   * and the start corner of the effect. Finally it executes the set of
+   * functions passed as arguments.
    */
   LazyEffects<T> clip(ClipAnimation.Action a, ClipAnimation.Corner c, ClipAnimation.Direction d, Function... f);
 
@@ -99,80 +185,78 @@ public interface LazyEffects<T> extends LazyBase<T>{
   LazyEffects<T> clip(ClipAnimation.Action a, ClipAnimation.Corner c, ClipAnimation.Direction d, int duration, Function... f);
 
   /**
-   * Animate the set of matched elements using the clip property.
-   * It is possible to show or hide a set of elements, 
-   * specify the direction of the animation and the start corner of the effect.
-   * Finally it executes the set of functions passed as arguments.
+   * Animate the set of matched elements using the clip property. It is possible
+   * to show or hide a set of elements, specify the direction of the animation
+   * and the start corner of the effect. Finally it executes the set of
+   * functions passed as arguments.
    */
   LazyEffects<T> clip(ClipAnimation.Action a, ClipAnimation.Corner c, Function... f);
 
   /**
    * Reveal all matched elements by adjusting the clip property firing an
-   * optional callback after completion.
-   * The effect goes from the center to the perimeter.
+   * optional callback after completion. The effect goes from the center to the
+   * perimeter.
    */
   LazyEffects<T> clipAppear(Function... f);
 
   /**
    * Reveal all matched elements by adjusting the clip property firing an
-   * optional callback after completion.
-   * The effect goes from the center to the perimeter.
+   * optional callback after completion. The effect goes from the center to the
+   * perimeter.
    */
   LazyEffects<T> clipAppear(int millisecs, Function... f);
 
   /**
-   * Hide all matched elements by adjusting the clip property firing an
-   * optional callback after completion.
-   * The effect goes from the perimeter to the center.
+   * Hide all matched elements by adjusting the clip property firing an optional
+   * callback after completion. The effect goes from the perimeter to the
+   * center.
    */
   LazyEffects<T> clipDisappear(Function... f);
 
   /**
-   * Hide all matched elements by adjusting the clip property firing an
-   * optional callback after completion.
-   * The effect goes from the perimeter to the center.
+   * Hide all matched elements by adjusting the clip property firing an optional
+   * callback after completion. The effect goes from the perimeter to the
+   * center.
    */
   LazyEffects<T> clipDisappear(int millisecs, Function... f);
 
   /**
    * Reveal all matched elements by adjusting the clip property firing an
-   * optional callback after completion.
-   * The effect goes from the top to the bottom.
+   * optional callback after completion. The effect goes from the top to the
+   * bottom.
    */
   LazyEffects<T> clipDown(Function... f);
 
   /**
    * Reveal all matched elements by adjusting the clip property firing an
-   * optional callback after completion.
-   * The effect goes from the top to the bottom.
+   * optional callback after completion. The effect goes from the top to the
+   * bottom.
    */
   LazyEffects<T> clipDown(int millisecs, Function... f);
 
   /**
-   * Toggle the visibility of all matched elements by adjusting the clip property
-   * and firing an optional callback after completion.
-   * The effect goes from the bottom to the top.
+   * Toggle the visibility of all matched elements by adjusting the clip
+   * property and firing an optional callback after completion. The effect goes
+   * from the bottom to the top.
    */
   LazyEffects<T> clipToggle(Function... f);
 
   /**
-   * Toggle the visibility of all matched elements by adjusting the clip property
-   * and firing an optional callback after completion.
-   * The effect goes from the bottom to the top.
+   * Toggle the visibility of all matched elements by adjusting the clip
+   * property and firing an optional callback after completion. The effect goes
+   * from the bottom to the top.
    */
   LazyEffects<T> clipToggle(int millisecs, Function... f);
 
   /**
-   * Hide all matched elements by adjusting the clip property firing an
-   * optional callback after completion.
-   * The effect goes from the bottom to the top.
+   * Hide all matched elements by adjusting the clip property firing an optional
+   * callback after completion. The effect goes from the bottom to the top.
    */
   LazyEffects<T> clipUp(Function... f);
 
   /**
-   * Hide all matched elements by adjusting the clip property firing an
-   * optional callback after completion.
-   * The effect goes from the bottom to the top.
+   * Hide all matched elements by adjusting the clip property firing an optional
+   * callback after completion. The effect goes from the bottom to the top.
    */
   LazyEffects<T> clipUp(int millisecs, Function... f);
 
@@ -181,7 +265,7 @@ public interface LazyEffects<T> extends LazyBase<T>{
    * optional callback after completion. Only the opacity is adjusted for this
    * animation, meaning that all of the matched elements should already have
    * some form of height and width associated with them.
-   */  
+   */
   LazyEffects<T> fadeIn(Function... f);
 
   /**
@@ -198,7 +282,7 @@ public interface LazyEffects<T> extends LazyBase<T>{
    * the opacity is adjusted for this animation, meaning that all of the matched
    * elements should already have some form of height and width associated with
    * them.
-   */  
+   */
   LazyEffects<T> fadeOut(Function... f);
 
   /**
@@ -207,7 +291,7 @@ public interface LazyEffects<T> extends LazyBase<T>{
    * the opacity is adjusted for this animation, meaning that all of the matched
    * elements should already have some form of height and width associated with
    * them.
-   */  
+   */
   LazyEffects<T> fadeOut(int millisecs, Function... f);
 
   /**
@@ -259,14 +343,14 @@ public interface LazyEffects<T> extends LazyBase<T>{
   LazyEffects<T> slideLeft(int millisecs, Function... f);
 
   /**
-   * Reveal all matched elements by adjusting their width and firing an
-   * optional callback after completion.
+   * Reveal all matched elements by adjusting their width and firing an optional
+   * callback after completion.
    */
   LazyEffects<T> slideRight(Function... f);
 
   /**
-   * Reveal all matched elements by adjusting their width and firing an
-   * optional callback after completion.
+   * Reveal all matched elements by adjusting their width and firing an optional
+   * callback after completion.
    */
   LazyEffects<T> slideRight(int millisecs, Function... f);