Updated Branches: refs/heads/wicket-6.x a0868b017 -> 9a1c52217
added documentation to throttlesettings Project: http://git-wip-us.apache.org/repos/asf/wicket/repo Commit: http://git-wip-us.apache.org/repos/asf/wicket/commit/9a1c5221 Tree: http://git-wip-us.apache.org/repos/asf/wicket/tree/9a1c5221 Diff: http://git-wip-us.apache.org/repos/asf/wicket/diff/9a1c5221 Branch: refs/heads/wicket-6.x Commit: 9a1c52217a6b74430e1f7cf04e7fee3aa85d2ad0 Parents: a0868b0 Author: Carl-Eric Menzel <cmen...@wicketbuch.de> Authored: Sun Aug 4 17:13:03 2013 +0200 Committer: Carl-Eric Menzel <cmen...@wicketbuch.de> Committed: Tue Aug 6 15:44:08 2013 +0200 ---------------------------------------------------------------------- .../ajax/attributes/ThrottlingSettings.java | 41 +++++++++++++------- 1 file changed, 27 insertions(+), 14 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/wicket/blob/9a1c5221/wicket-core/src/main/java/org/apache/wicket/ajax/attributes/ThrottlingSettings.java ---------------------------------------------------------------------- diff --git a/wicket-core/src/main/java/org/apache/wicket/ajax/attributes/ThrottlingSettings.java b/wicket-core/src/main/java/org/apache/wicket/ajax/attributes/ThrottlingSettings.java index a737cfe..29fe800 100644 --- a/wicket-core/src/main/java/org/apache/wicket/ajax/attributes/ThrottlingSettings.java +++ b/wicket-core/src/main/java/org/apache/wicket/ajax/attributes/ThrottlingSettings.java @@ -16,12 +16,13 @@ */ package org.apache.wicket.ajax.attributes; +import org.apache.wicket.markup.html.WebComponent; import org.apache.wicket.util.io.IClusterable; import org.apache.wicket.util.time.Duration; /** * Class to keep track of throttling settings. - * + * * @author ivaynberg */ public class ThrottlingSettings implements IClusterable @@ -34,9 +35,11 @@ public class ThrottlingSettings implements IClusterable /** * Construct. - * - * @param id throttle id - * @param delay throttle delay + * + * @param id + * throttle id + * @param delay + * throttle delay */ public ThrottlingSettings(final String id, final Duration delay) { @@ -45,12 +48,16 @@ public class ThrottlingSettings implements IClusterable /** * Construct. - * - * @param id throttle id - * @param delay throttle delay - * @param postponeTimerOnUpdate postpone timer + * + * @param id + * throttle id + * @param delay + * throttle delay + * @param postponeTimerOnUpdate + * postpone timer */ - public ThrottlingSettings(final String id, final Duration delay, final boolean postponeTimerOnUpdate) + public ThrottlingSettings(final String id, final Duration delay, + final boolean postponeTimerOnUpdate) { this.id = id; this.delay = delay; @@ -66,7 +73,13 @@ public class ThrottlingSettings implements IClusterable } /** + * This id is used by the client-side throttling code to keep track of the various event + * throttles. Normally you can just use any unique ID here, such as the component's markupId ( + * {@link WebComponent#getMarkupId()}). To unite several different events with one throttle, + * give them the same ID. + * * @return throttle id + * */ public String getId() { @@ -74,12 +87,12 @@ public class ThrottlingSettings implements IClusterable } /** - * If it is set to true, then the timer is reset each time the throttle function - * gets called. Use this behaviour if you want something to happen at X milliseconds - * after the *last* call to throttle. If the parameter is not set, or set to false, - * then the timer is not reset. + * If it is set to true, then the timer is reset each time the throttle function gets called. + * Use this behaviour if you want something to happen at X milliseconds after the *last* call to + * throttle. If the parameter is not set, or set to false, then the timer is not reset. */ - public boolean getPostponeTimerOnUpdate() { + public boolean getPostponeTimerOnUpdate() + { return postponeTimerOnUpdate; } } \ No newline at end of file
