You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@wicket.apache.org by mg...@apache.org on 2013/08/14 11:41:41 UTC
[12/37] git commit: added documentation to throttlesettings
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/67d8bc8d
Tree: http://git-wip-us.apache.org/repos/asf/wicket/tree/67d8bc8d
Diff: http://git-wip-us.apache.org/repos/asf/wicket/diff/67d8bc8d
Branch: refs/heads/5299-ajax-strategy
Commit: 67d8bc8d5e7da7a778ebdcc7d650953b112b88b3
Parents: 05a7eec
Author: Carl-Eric Menzel <cm...@wicketbuch.de>
Authored: Sun Aug 4 17:13:03 2013 +0200
Committer: Carl-Eric Menzel <cm...@wicketbuch.de>
Committed: Tue Aug 6 15:49:37 2013 +0200
----------------------------------------------------------------------
.../apache/wicket/ajax/attributes/ThrottlingSettings.java | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/wicket/blob/67d8bc8d/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 df830da..a724b3d 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
@@ -72,6 +72,11 @@ 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()
@@ -85,7 +90,8 @@ public class ThrottlingSettings implements IClusterable
* after the <strong>last</strong> 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;
}
@@ -94,4 +100,4 @@ public class ThrottlingSettings implements IClusterable
this.postponeTimerOnUpdate = postponeTimerOnUpdate;
}
-}
+}
\ No newline at end of file